class documentation

class TerminalController: (source)

构造函数: TerminalController(term_stream)

查看层次结构

一个可用于可移植地生成格式化输出到终端的类。

TerminalController 定义了一组实例变量,这些变量的值被初始化为执行给定操作所需的控制序列。这些可以简单地包含在终端的正常输出中:

>>> term = TerminalController()
>>> print('This is '+term.GREEN+'green'+term.NORMAL)
This is green

或者,可以使用render()方法,该方法将${action}替换为执行action所需的字符串:

>>> term = TerminalController()
>>> print(term.render('This is ${GREEN}green${NORMAL}'))
This is green

如果终端不支持给定的操作,则相应实例变量的值将被设置为''。因此,上述代码仍然可以在不支持颜色的终端上工作,只是它们的输出将不会着色。此外,这意味着您可以通过简单地测试相应实例变量的真值来测试终端是否支持给定的操作:

>>> term = TerminalController()
>>> if term.CLEAR_SCREEN:
...     print 'This terminal supports clearning the screen.'
...

最后,如果终端的宽度和高度已知,那么它们将被存储在COLSLINES属性中。

作者
爱德华·洛佩尔
方法 __init__ 创建一个TerminalController并使用当前终端的适当值初始化其属性。term_stream是用于终端输出的流;如果此流不是tty,则假定终端为哑终端(i...
方法 render 将给定模板字符串中的每个 $-替换 替换为相应的终端控制字符串(如果已定义)或 ''(如果未定义)。
常量 BG_BLACK 未记录
常量 BG_BLUE 未记录
常量 BG_CYAN 未记录
常量 BG_GREEN 未记录
常量 BG_MAGENTA 未记录
常量 BG_RED 未记录
常量 BG_WHITE 未记录
常量 BG_YELLOW 未记录
常量 BLACK 未记录
常量 BLINK 未记录
常量 BLUE 未记录
常量 BOL 未记录
常量 BOLD 未记录
常量 CLEAR_BOL 未记录
常量 CLEAR_EOL 未记录
常量 CLEAR_EOS 未记录
常量 CLEAR_SCREEN 未记录
常量 CYAN 未记录
常量 DIM 未记录
常量 DOWN 未记录
常量 GREEN 未记录
常量 HIDE_CURSOR 未记录
常量 LEFT 未记录
常量 MAGENTA 未记录
常量 NORMAL 未记录
常量 RED 未记录
常量 REVERSE 未记录
常量 RIGHT 未记录
常量 SHOW_CURSOR 未记录
常量 UP 未记录
常量 WHITE 未记录
常量 YELLOW 未记录
实例变量 COLS 未记录
实例变量 LINES 未记录
静态方法 _tigetstr 重写字符串功能以移除现代终端不需要的“延迟”
静态方法 _tparm 未记录
方法 _render_sub render的辅助函数
常量 _ANSICOLORS 未记录
常量 _COLORS 未记录
常量 _STRING_CAPABILITIES 未记录
def __init__(self, term_stream=sys.stdout): (source)

创建一个TerminalController并使用当前终端的适当值初始化其属性。term_stream是用于终端输出的流;如果此流不是tty,则假定终端为哑终端(即没有功能)。

def render(self, template): (source)

将给定模板字符串中的每个 $-替换 替换为相应的终端控制字符串(如果已定义)或 ''(如果未定义)。

BG_BLACK: str = (source)

未记录

''

未记录

''

未记录

''
BG_GREEN: str = (source)

未记录

''
BG_MAGENTA: str = (source)

未记录

''

未记录

''
BG_WHITE: str = (source)

未记录

''
BG_YELLOW: str = (source)

未记录

''

未记录

''

未记录

''

未记录

''

未记录

''

未记录

''
CLEAR_BOL: str = (source)

未记录

''
CLEAR_EOL: str = (source)

未记录

''
CLEAR_EOS: str = (source)

未记录

''
CLEAR_SCREEN: str = (source)

未记录

''

未记录

''

未记录

''

未记录

''

未记录

''
HIDE_CURSOR: str = (source)

未记录

''

未记录

''

未记录

''

未记录

''

未记录

''

未记录

''

未记录

''
SHOW_CURSOR: str = (source)

未记录

''

未记录

''

未记录

''

未记录

''

未记录

未记录

@staticmethod
def _tigetstr(cap_name): (source)

重写字符串功能以移除现代终端不需要的“延迟”

@staticmethod
def _tparm(cap_name, param): (source)

未记录

def _render_sub(self, match): (source)

render的辅助函数

_ANSICOLORS = (source)

未记录

'BLACK RED GREEN YELLOW BLUE MAGENTA CYAN WHITE'.split()

未记录

'BLACK BLUE GREEN CYAN RED MAGENTA YELLOW WHITE'.split()
_STRING_CAPABILITIES = (source)

未记录

'\n    BOL=cr UP=cuu1 DOWN=cud1 LEFT=cub1 RIGHT=cuf1\n    CLEAR_SCREEN=clear CLE
AR_EOL=el CLEAR_BOL=el1 CLEAR_EOS=ed BOLD=bold\n    BLINK=blink DIM=dim REVERSE=
rev UNDERLINE=smul NORMAL=sgr0\n    HIDE_CURSOR=cinvis SHOW_CURSOR=cnorm'.split(
)