DEFAULT_HEIGHT = 24
module-attribute
Default screen height
DEFAULT_WIDTH = 80
module-attribute
Default screen width
Screen
Source code in pzp/screen.py
33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 |
|
__init__(stream=sys.stderr, fullscreen=True, height=None)
Initialize screen
Parameters:
Name | Type | Description | Default |
---|---|---|---|
stream |
TextIO
|
Output stream |
sys.stderr
|
fullscreen |
bool
|
Full screen mode |
True
|
height |
Optional[int]
|
Screen height |
None
|
Attributes:
Name | Type | Description |
---|---|---|
stream |
Output stream |
|
data |
Data to be written on the stream |
|
fullscreen |
Full screen mode |
|
height |
Screen height |
Source code in pzp/screen.py
34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 |
|
bold()
Set bold mode
Source code in pzp/screen.py
116 117 118 119 |
|
cleanup()
Clean screen and restore cursor position
Source code in pzp/screen.py
82 83 84 85 86 87 88 89 |
|
erase_line()
Erase the current line
Source code in pzp/screen.py
126 127 128 129 |
|
erase_lines(lines)
Erase n lines
Parameters:
Name | Type | Description | Default |
---|---|---|---|
lines |
int
|
number of lines to be erased |
required |
Source code in pzp/screen.py
131 132 133 134 135 136 137 138 139 |
|
erase_screen()
Erase the screen
Source code in pzp/screen.py
121 122 123 124 |
|
flush()
Write data to the stream and flush it
Source code in pzp/screen.py
75 76 77 78 79 80 |
|
get_terminal_height()
classmethod
Get the terminal height
Returns:
Name | Type | Description |
---|---|---|
height |
int
|
terminal height |
Source code in pzp/screen.py
60 61 62 63 64 65 66 67 68 |
|
move_down(lines)
Move cursor down If the cursor is already at the edge of the screen, this has no effect.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
lines |
int
|
number of lines |
required |
Source code in pzp/screen.py
151 152 153 154 155 156 157 158 159 |
|
move_left(characters)
Move cursor left If the cursor is already at the edge of the screen, this has no effect.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
characters |
int
|
number of characters |
required |
Source code in pzp/screen.py
173 174 175 176 177 178 179 180 181 182 183 |
|
move_right(characters)
Move cursor right If the cursor is already at the edge of the screen, this has no effect.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
characters |
int
|
number of characters |
required |
Source code in pzp/screen.py
161 162 163 164 165 166 167 168 169 170 171 |
|
move_up(lines)
Move cursor up If the cursor is already at the edge of the screen, this has no effect.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
lines |
int
|
number of lines |
required |
Source code in pzp/screen.py
141 142 143 144 145 146 147 148 149 |
|
nl(lines=1)
Add n newlines
Parameters:
Name | Type | Description | Default |
---|---|---|---|
lines |
int
|
number of newlines to be added |
1
|
Source code in pzp/screen.py
91 92 93 94 95 96 97 98 99 |
|
reset()
Reset style and color
Source code in pzp/screen.py
111 112 113 114 |
|
space(num=1)
Add n spaces
Parameters:
Name | Type | Description | Default |
---|---|---|---|
num |
int
|
number of spaces |
1
|
Source code in pzp/screen.py
101 102 103 104 105 106 107 108 109 |
|
write(line)
Add data to be written on the stream
Source code in pzp/screen.py
70 71 72 73 |
|