Terminal (version 0.1.0)
index
Terminal.html

This package implements tools to build python package and tools.

 
Classes
       
Terminal(builtins.object)
Terminal

 
class Terminal(Terminal)
    This class implements function to use ANSI console
characters.
 
 
Method resolution order:
Terminal
Terminal
builtins.object

Methods inherited from Terminal:
backspace() -> None
This function places the cursor on the precedent character.
bell() -> None
This function play system sound.
bold() -> None
This function adds bold.
carriage_return() -> None
This function places the cursor on the first column.
change_background_color(color: str, mode: int = 1) -> None
This function changes background color.
change_background_color_3bytes(red: int, green: int, blue: int) -> None
This function changes background color
using the 3 bytes mode.
change_background_color_8bits(color: int) -> None
This function changes background color
using the 8 bits mode.
change_foreground_color(color: str, mode: int = 1) -> None
This function changes foreground color.
change_foreground_color_3bytes(red: int, green: int, blue: int) -> None
This function changes foreground color
using the 3 bytes mode.
change_foreground_color_8bits(color: int) -> None
This function changes foreground color
using the 8 bits mode.
 
2**3 == 8 -> RED
2**3 == 8 -> GREEN
2**2 == 4 -> BLUE
 
RRRGGGBB
 
(0b111 << 5) + (0b111 << 2) + 0b11
 
(7 << 5) + (7 << 2) + 3
clean() -> None
This function cleans the console.
cursor_back(n: int = 0) -> None
This function go to the precedent character.
cursor_down(n: int = 0) -> None
This function got to the next line
(keep the same position on the next line).
cursor_forward(n: int = 0) -> None
This function go to the next character.
cursor_horizontal_absolute(n: int = 0) -> None
This function go to the start of the line.
cursor_horizontale_verticale_position(line: int, position: int) -> None
This function go to line:position.
cursor_next_line(n: int = 0) -> None
This function go to the next line
(on the first character of the next line).
cursor_position(line: int, position: int) -> None
This function go to line:position.
cursor_previous_line(n: int = 0) -> None
This function go to the precedent line
(on the first character of the precedent line).
cursor_up(n: int = 0) -> None
This function go to the precedent line
(keep the same position on the precedent line).
device_status_report() -> Tuple[bytes, bytes]
This function reports the cursor position.
erase_in_display(mode: int = 0) -> None
This function clears a part of the screen.
 
mode == 0 -> clear screen between cursor and end.
mode == 1 -> clear screen between cursor and start.
mode == 2 -> clear screen.
mode == 3 -> clear screen and saved buffer.
erase_in_line(n: int = 0) -> None
This function clears a part of the line.
faint() -> None
This function adds intensity.
font(font: int) -> None
This function changes font.
gothic() -> None
Characters legible but marked as if for deletion.
hide() -> None
This function adds hide.
italic() -> None
This function adds italic.
line_feed() -> None
This function places the cursor on the next line.
no_blink() -> None
This function removes underline.
no_bold() -> None
This function removes bold.
no_hide() -> None
This function removes hide.
no_intensity() -> None
This function removes intensity.
no_italic() -> None
This function removes italic.
no_reverse() -> None
This function replace colors (background/foreground).
no_underline() -> None
This function removes underline.
not_crossed_out() -> None
This function removes hide.
rapid_blink() -> None
Sets blinking to greter than 150 times per minute.
reset() -> None
This function resets colors (background and foreground).
reset_background() -> None
This function resets the background color.
reset_foreground() -> None
This function resets the foreground color.
restore_position() -> None
This function restore the saved position.
restore_saved_cursor_position() -> None
This function save the cursor position.
reverse() -> None
This function reverses colors (background/foreground).
save_current_cursor_position() -> None
This function save the cursor position.
save_position() -> None
This function saves the cursor position.
scroll_down(n: int = 0) -> None
This function scroll whole page down.
scroll_up(n: int = 0) -> None
This function scroll whole page up.
slow_blink() -> None
Sets blinking to less than 150 times per minute.
strike() -> None
Characters legible but marked as if for deletion.
tab() -> None
This function places the cursor on the next multiple of 8.
underline() -> None
This function adds underline.

Data descriptors inherited from Terminal:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)

 
Data
        __all__ = ['Terminal']
__annotations__ = {'char_ANSI': <class 'str'>, 'char_special_ANSI': <class 'str'>, 'stdout_flush': <class 'collections.abc.Callable'>, 'stdout_write': <class 'collections.abc.Callable'>}
__author_email__ = 'mauricelambert434@gmail.com'
__copyright__ = '\nPythonToolsKit Copyright (C) 2022 Maurice Lam...ome to redistribute it\nunder certain conditions.\n'
__description__ = '\nThis package implements tools to build python package and tools.\n'
__license__ = 'GPL-3.0 License'
__maintainer__ = 'Maurice Lambert'
__maintainer_email__ = 'mauricelambert434@gmail.com'
__url__ = 'https://github.com/mauricelambert/PythonToolsKit'

 
Author
        Maurice Lambert