Trees | Indices | Help |
---|
|
A class that can be used to portably generate formatted output to a terminal.
`TerminalController` defines a set of instance variables whose values are initialized to the control sequence necessary to perform a given action. These can be simply included in normal output to the terminal:
>>> term = TerminalController() >>> print 'This is '+term.GREEN+'green'+term.NORMAL
Alternatively, the `render()` method can used, which replaces '${action}' with the string required to perform 'action':
>>> term = TerminalController() >>> print term.render('This is ${GREEN}green${NORMAL}')
If the terminal doesn't support a given action, then the value of the corresponding instance variable will be set to ''. As a result, the above code will still work on terminals that do not support color, except that their output will not be colored. Also, this means that you can test whether the terminal supports a given action by simply testing the truth value of the corresponding instance variable:
>>> term = TerminalController() >>> if term.CLEAR_SCREEN: ... print 'This terminal supports clearning the screen.'
Finally, if the width and height of the terminal are known, then they will be stored in the `COLS` and `LINES` attributes.
|
|||
|
|||
|
|||
|
|||
|
|
|||
BOL =
Move the cursor to the beginning of the line |
|||
UP =
Move the cursor up one line |
|||
DOWN =
Move the cursor down one line |
|||
LEFT =
Move the cursor left one char |
|||
RIGHT =
Move the cursor right one char |
|||
CLEAR_SCREEN =
Clear the screen and move to home position |
|||
CLEAR_EOL =
Clear to the end of the line. |
|||
CLEAR_BOL =
Clear to the beginning of the line. |
|||
CLEAR_EOS =
Clear to the end of the screen |
|||
BOLD =
Turn on bold mode |
|||
BLINK =
Turn on blink mode |
|||
DIM =
Turn on half-bright mode |
|||
REVERSE =
Turn on reverse-video mode |
|||
NORMAL =
Turn off all modes |
|||
HIDE_CURSOR =
Make the cursor invisible |
|||
SHOW_CURSOR =
Make the cursor visible |
|||
COLS = None Width of the terminal (None for unknown) |
|||
LINES = None Height of the terminal (None for unknown) |
|||
WHITE =
|
|||
YELLOW =
|
|||
MAGENTA =
|
|||
RED =
|
|||
CYAN =
|
|||
GREEN =
|
|||
BLUE =
|
|||
BLACK =
|
|||
BG_CYAN =
|
|||
BG_GREEN =
|
|||
BG_BLUE =
|
|||
BG_BLACK =
|
|||
BG_WHITE =
|
|||
BG_YELLOW =
|
|||
BG_MAGENTA =
|
|||
BG_RED =
|
|||
_STRING_CAPABILITIES =
|
|||
_COLORS =
|
|||
_ANSICOLORS =
|
|
Create a `TerminalController` and initialize its attributes with appropriate values for the current terminal. `term_stream` is the stream that will be used for terminal output; if this stream is not a tty, then the terminal is assumed to be a dumb terminal (i.e., have no capabilities). |
|
_STRING_CAPABILITIES
|
_COLORS
|
_ANSICOLORS
|
Trees | Indices | Help |
---|
Generated by Epydoc 3.0.1 on Tue Aug 13 06:17:08 2013 | http://epydoc.sourceforge.net |