Loading...
Searching...
No Matches
Functions | |
| int | cached_cell_len (str text) |
| int | cell_len (str text, Callable[[str], int] _cell_len=cached_cell_len) |
| int | get_character_cell_size (str character) |
| int | _get_codepoint_cell_size (int codepoint) |
| str | set_cell_size (str text, int total) |
| List[str] | chop_cells (str text, int max_size, int position=0) |
Variables | |
| _is_single_cell_widths = re.compile("^[\u0020-\u006f\u00a0\u02ff\u0370-\u0482]*$").match | |
Function Documentation
◆ _get_codepoint_cell_size()
|
protected |
Get the cell size of a character.
Args:
codepoint (int): Codepoint of a character.
Returns:
int: Number of cells (0, 1 or 2) occupied by that character.
Definition at line 59 of file cells.py.
59def _get_codepoint_cell_size(codepoint: int) -> int:
60 """Get the cell size of a character.
61
62 Args:
63 codepoint (int): Codepoint of a character.
64
65 Returns:
66 int: Number of cells (0, 1 or 2) occupied by that character.
67 """
68
69 _table = CELL_WIDTHS
70 lower_bound = 0
71 upper_bound = len(_table) - 1
72 index = (lower_bound + upper_bound) // 2
73 while True:
74 start, end, width = _table[index]
75 if codepoint < start:
76 upper_bound = index - 1
77 elif codepoint > end:
78 lower_bound = index + 1
79 else:
80 return 0 if width == -1 else width
81 if upper_bound < lower_bound:
82 break
83 index = (lower_bound + upper_bound) // 2
84 return 1
85
86
References i.
Referenced by pip._vendor.rich.cells.get_character_cell_size().
Here is the caller graph for this function:
◆ cached_cell_len()
| int cached_cell_len | ( | str | text | ) |
Get the number of cells required to display text.
This method always caches, which may use up a lot of memory. It is recommended to use
`cell_len` over this method.
Args:
text (str): Text to display.
Returns:
int: Get the number of cells required to display text.
Definition at line 12 of file cells.py.
12def cached_cell_len(text: str) -> int:
13 """Get the number of cells required to display text.
14
15 This method always caches, which may use up a lot of memory. It is recommended to use
16 `cell_len` over this method.
17
18 Args:
19 text (str): Text to display.
20
21 Returns:
22 int: Get the number of cells required to display text.
23 """
24 _get_size = get_character_cell_size
26 return total_size
27
28
References i.
◆ cell_len()
| int cell_len | ( | str | text, |
| Callable[[str], int] | _cell_len = cached_cell_len |
||
| ) |
Get the number of cells required to display text.
Args:
text (str): Text to display.
Returns:
int: Get the number of cells required to display text.
Definition at line 29 of file cells.py.
29def cell_len(text: str, _cell_len: Callable[[str], int] = cached_cell_len) -> int:
30 """Get the number of cells required to display text.
31
32 Args:
33 text (str): Text to display.
34
35 Returns:
36 int: Get the number of cells required to display text.
37 """
40 _get_size = get_character_cell_size
42 return total_size
43
44
45@lru_cache(maxsize=4096)
References i.
◆ chop_cells()
| List[str] chop_cells | ( | str | text, |
| int | max_size, | ||
| int | position = 0 |
||
| ) |
Break text in to equal (cell) length strings, returning the characters in reverse order
Definition at line 124 of file cells.py.
124def chop_cells(text: str, max_size: int, position: int = 0) -> List[str]:
125 """Break text in to equal (cell) length strings, returning the characters in reverse
126 order"""
127 _get_character_cell_size = get_character_cell_size
128 characters = [
129 (character, _get_character_cell_size(character)) for character in text
130 ]
131 total_size = position
132 lines: List[List[str]] = [[]]
133 append = lines[-1].append
134
135 for character, size in reversed(characters):
136 if total_size + size > max_size:
137 lines.append([character])
138 append = lines[-1].append
139 total_size = size
140 else:
141 total_size += size
142 append(character)
143
144 return ["".join(line) for line in lines]
145
146
◆ get_character_cell_size()
| int get_character_cell_size | ( | str | character | ) |
Get the cell size of a character.
Args:
character (str): A single character.
Returns:
int: Number of cells (0, 1 or 2) occupied by that character.
Definition at line 46 of file cells.py.
46def get_character_cell_size(character: str) -> int:
47 """Get the cell size of a character.
48
49 Args:
50 character (str): A single character.
51
52 Returns:
53 int: Number of cells (0, 1 or 2) occupied by that character.
54 """
56
57
58@lru_cache(maxsize=4096)
References pip._vendor.rich.cells._get_codepoint_cell_size(), and i.
Here is the call graph for this function:
◆ set_cell_size()
| str set_cell_size | ( | str | text, |
| int | total | ||
| ) |
Set the length of a string to fit within given number of cells.
Definition at line 87 of file cells.py.
87def set_cell_size(text: str, total: int) -> str:
88 """Set the length of a string to fit within given number of cells."""
89
90 if _is_single_cell_widths(text):
91 size = len(text)
92 if size < total:
93 return text + " " * (total - size)
94 return text[:total]
95
96 if total <= 0:
97 return ""
98 cell_size = cell_len(text)
99 if cell_size == total:
100 return text
101 if cell_size < total:
102 return text + " " * (total - cell_size)
103
104 start = 0
105 end = len(text)
106
107 # Binary search until we find the right size
108 while True:
109 pos = (start + end) // 2
110 before = text[: pos + 1]
111 before_len = cell_len(before)
112 if before_len == total + 1 and cell_len(before[-1]) == 2:
113 return before[:-1] + " "
114 if before_len == total:
115 return before
116 if before_len > total:
117 end = pos
118 else:
119 start = pos
120
121
122# TODO: This is inefficient
123# TODO: This might not work with CWJ type characters
References pip._vendor.rich.cells._is_single_cell_widths, and i.
Variable Documentation
◆ _is_single_cell_widths
|
protected |
Definition at line 8 of file cells.py.
Referenced by pip._vendor.rich.cells.set_cell_size().
