summaryrefslogtreecommitdiffstats
path: root/third_party/python/blessed/blessed/terminal.pyi
blob: 3d8eea4db7613328ec69c4d7ab371ae5636e299c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
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
# std imports
from typing import IO, Any, List, Tuple, Union, Optional, OrderedDict, ContextManager

# local
from .keyboard import Keystroke
from .sequences import Termcap
from .formatters import (FormattingString,
                         NullCallableString,
                         ParameterizingString,
                         FormattingOtherString)

HAS_TTY: bool

class Terminal:
    caps: OrderedDict[str, Termcap]
    errors: List[str] = ...
    def __init__(
        self,
        kind: Optional[str] = ...,
        stream: Optional[IO[str]] = ...,
        force_styling: bool = ...,
    ) -> None: ...
    def __getattr__(
        self, attr: str
    ) -> Union[NullCallableString, ParameterizingString, FormattingString]: ...
    @property
    def kind(self) -> str: ...
    @property
    def does_styling(self) -> bool: ...
    @property
    def is_a_tty(self) -> bool: ...
    @property
    def height(self) -> int: ...
    @property
    def width(self) -> int: ...
    @property
    def pixel_height(self) -> int: ...
    @property
    def pixel_width(self) -> int: ...
    def location(
        self, x: Optional[int] = ..., y: Optional[int] = ...
    ) -> ContextManager[None]: ...
    def get_location(self, timeout: Optional[float] = ...) -> Tuple[int, int]: ...
    def fullscreen(self) -> ContextManager[None]: ...
    def hidden_cursor(self) -> ContextManager[None]: ...
    def move_xy(self, x: int, y: int) -> ParameterizingString: ...
    def move_yx(self, y: int, x: int) -> ParameterizingString: ...
    @property
    def move_left(self) -> FormattingOtherString: ...
    @property
    def move_right(self) -> FormattingOtherString: ...
    @property
    def move_up(self) -> FormattingOtherString: ...
    @property
    def move_down(self) -> FormattingOtherString: ...
    @property
    def color(self) -> Union[NullCallableString, ParameterizingString]: ...
    def color_rgb(self, red: int, green: int, blue: int) -> FormattingString: ...
    @property
    def on_color(self) -> Union[NullCallableString, ParameterizingString]: ...
    def on_color_rgb(self, red: int, green: int, blue: int) -> FormattingString: ...
    def formatter(self, value: str) -> Union[NullCallableString, FormattingString]: ...
    def rgb_downconvert(self, red: int, green: int, blue: int) -> int: ...
    @property
    def normal(self) -> str: ...
    def link(self, url: str, text: str, url_id: str = ...) -> str: ...
    @property
    def stream(self) -> IO[str]: ...
    @property
    def number_of_colors(self) -> int: ...
    @number_of_colors.setter
    def number_of_colors(self, value: int) -> None: ...
    @property
    def color_distance_algorithm(self) -> str: ...
    @color_distance_algorithm.setter
    def color_distance_algorithm(self, value: str) -> None: ...
    def ljust(
        self, text: str, width: Optional[int] = ..., fillchar: str = ...
    ) -> str: ...
    def rjust(
        self, text: str, width: Optional[int] = ..., fillchar: str = ...
    ) -> str: ...
    def center(
        self, text: str, width: Optional[int] = ..., fillchar: str = ...
    ) -> str: ...
    def truncate(self, text: str, width: Optional[int] = ...) -> str: ...
    def length(self, text: str) -> int: ...
    def strip(self, text: str, chars: Optional[str] = ...) -> str: ...
    def rstrip(self, text: str, chars: Optional[str] = ...) -> str: ...
    def lstrip(self, text: str, chars: Optional[str] = ...) -> str: ...
    def strip_seqs(self, text: str) -> str: ...
    def split_seqs(self, text: str, maxsplit: int) -> List[str]: ...
    def wrap(
        self, text: str, width: Optional[int] = ..., **kwargs: Any
    ) -> List[str]: ...
    def getch(self) -> str: ...
    def ungetch(self, text: str) -> None: ...
    def kbhit(self, timeout: Optional[float] = ...) -> bool: ...
    def cbreak(self) -> ContextManager[None]: ...
    def raw(self) -> ContextManager[None]: ...
    def keypad(self) -> ContextManager[None]: ...
    def inkey(
        self, timeout: Optional[float] = ..., esc_delay: float = ...
    ) -> Keystroke: ...

class WINSZ: ...