sdkagent

wcwidth API reference

59 public APIs from wcwidth (jquast/wcwidth) — 17 classes, 20 functions, 22 methods. Signatures extracted by static analysis of the actual source.

Repository: jquast/wcwidth

KindCount
Classes17
Functions20
Methods22

API list

classbin.update-tables.GraphemeRegistryRenderCtx
Render context for the grapheme override hash registry.
classbin.update-tables.GraphemeTableRenderCtx
Render context for grapheme tables (latest version only).
classbin.update-tables.MergedOverridesCategory
A single category within the merged overrides table.
classbin.update-tables.RenderDefinition
Base class, do not instantiate it directly.
methodbin.update-tables.RenderDefinition.generate() -> Iterator[str]
Just like jinja2.Template.generate.
methodbin.update-tables.RenderDefinition.render() -> str
Just like jinja2.Template.render.
classbin.update-tables.TableEntry
An entry of a unicode table.
methodbin.update-tables.TableEntry.filter_by_category_width(wide:int) -> bool
Return whether entry matches displayed width.
classbin.update-tables.TermProgramTableRenderCtx
Render context for terminal program data.
classbin.update-tables.UnicodeDataFile
Helper class for fetching Unicode Data Files.
methodbin.update-tables.UnicodeDataFile.EmojiData(version:UnicodeVersion) -> str
Fetch emoji-data.txt for Extended_Pictographic property.
methodbin.update-tables.UnicodeDataFile.do_retrieve(url:str, fname:str) -> None
Retrieve given url to target filepath fname.
methodbin.update-tables.UnicodeDataFile.do_retrieve_udhr_combined(url:str, fname:str) -> None
Fetch UDHR zip file, extract, and combine all translations.
classbin.update-tables.UnicodeVersion
A class for comparable unicode version.
methodbin.update-tables.UnicodeVersion.parse(version_str:str) -> UnicodeVersion
Parse a version string.
funcbin.update-tables.dedup_override_table(table:Mapping[str, TerminalOverrides]) -> DedupedOverrides
Deduplicate override table by hashing.
funcbin.update-tables.fetch_all_data_files(fetch_all_versions:bool=False) -> None
Fetch all required Unicode data files.
funcbin.update-tables.main(only_fetch:bool=False, fetch_all_versions:bool=False, check_last_modified:bool=False) -> None
Update east-asian, combining and zero width tables.
funcbin.update-tables.parse_args() -> dict[str, Any]
Parse command-line arguments.
funcbin.update-tables.parse_category_ambiguous(fname:str) -> TableDef
Parse EastAsianWidth.txt for 'A' (Ambiguous) category.
funcbin.update-tables.parse_derived_core_property(fname:str, property_name:str) -> set[int]
Parse DerivedCoreProperties.txt for a specific property.
funcbin.update-tables.parse_extended_pictographic(fname:str) -> TableDef
Parse emoji-data.txt for Extended_Pictographic property.
funcbin.update-tables.parse_indic_syllabic_category(fname:str) -> dict[str, TableDef]
Parse IndicSyllabicCategory.txt for Consonant property.
funcbin.update-tables.parse_unicode_table(file:Iterable[str]) -> Iterator[TableEntry]
Parse unicode tables.
funcbin.update-tables.parse_wchar_codepoint(wchar:str) -> int
Extract the primary codepoint from a wchar string.
funcbin.update-tables.values_to_hex_ranges(values:set[int]) -> list[tuple[str, str, str]]
Convert a set of codepoint integers to hex range descriptions.
classbin.wcwidth-browser.Pager
A less(1)-like browser for browsing unicode characters.
methodbin.wcwidth-browser.Pager.on_resize(*args)
Signal handler callback for SIGWINCH.
methodbin.wcwidth-browser.Pager.run(writer, reader)
Pager entry point.
classbin.wcwidth-browser.Screen
Represents terminal style, data dimensions, and drawables.
methodbin.wcwidth-browser.Screen.head_item()
Text of a single column heading.
methodbin.wcwidth-browser.Screen.hint_width()
Width of a column segment.
methodbin.wcwidth-browser.Screen.num_columns()
Number of columns displayed.
methodbin.wcwidth-browser.Screen.num_rows()
Number of rows displayed.
methodbin.wcwidth-browser.Screen.row_begins()
Top row displayed for content.
methodbin.wcwidth-browser.Screen.row_ends()
Bottom of page.
classbin.wcwidth-browser.Style
Styling decorator class instance for terminal output.
classbin.wcwidth-browser.WcCombinedCharacterGenerator
Generator yields unicode characters with combining.
funcbin.wcwidth-browser.main(opts)
Program entry point.
funcbin.wcwidth-browser.readline(term, width)
A rudimentary readline implementation.
funcbin.wcwidth-libc-comparator.main(using_locale=('en_US', 'UTF-8'))
Program entry point.
classwcwidth._constants.TerminalOverrides
Pre-merged override range tuples for a single terminal.
funcwcwidth._constants.resolve_terminal(term_program:bool | str=False) -> str | None
Resolve a terminal identifier to its canonical name.
funcwcwidth.bisearch.bisearch(ucs:int, table:tuple[tuple[int, int], ...]) -> int
Binary search in interval table.
funcwcwidth.escape_sequences.strip_sequences(text:str) -> str
Return text with all terminal escape sequences removed.
classwcwidth.grapheme.BreakResult
Result of grapheme cluster break decision.
classwcwidth.grapheme.GCB
Grapheme Cluster Break property values.
funcwcwidth.grapheme.grapheme_boundary_before(unistr:str, pos:int) -> int
Find the grapheme cluster boundary immediately before a position.
classwcwidth.hyperlink.Hyperlink
A complete OSC 8 hyperlink with target and inner text.
methodwcwidth.hyperlink.Hyperlink.find_close(text:str, open_end:int) -> tuple[int, int]
Find the matching OSC 8 close sequence.
methodwcwidth.hyperlink.Hyperlink.make_sequence() -> str
Rebuild the complete OSC 8 hyperlink escape sequence.
classwcwidth.hyperlink.HyperlinkParams
Parsed parameters from an OSC 8 hyperlink open sequence.
methodwcwidth.hyperlink.HyperlinkParams.make_close() -> str
Generate the OSC 8 close escape sequence.
methodwcwidth.hyperlink.HyperlinkParams.make_open() -> str
Generate the OSC 8 open escape sequence.
methodwcwidth.hyperlink.HyperlinkParams.parse(seq:str) -> HyperlinkParams | None
Parse an OSC 8 open sequence string.
funcwcwidth.sgr_state.propagate_sgr(lines:Sequence[str]) -> list[str]
Propagate SGR codes across wrapped lines.
funcwcwidth.table_grapheme_overrides.get(term_canonical:str) -> dict[str, int]
Return grapheme override dict for a terminal, or an empty dict.
methodwcwidth.text_sizing.TextSizingParams.from_params(raw:str, control_codes:str='parse') -> TextSizingParams
Parse colon-separated ``key=value`` metadata string.
methodwcwidth.text_sizing.TextSizingParams.make_sequence() -> str
Build and return sub-part of an OSC 66 sequence.

About this data

These signatures were extracted from the public source of jquast/wcwidth using Python's ast module. Argument names, default values, type annotations and return types are taken verbatim from the code. Implementation bodies are never stored. See how it works for details.

Back to all 805 libraries