module documentation

Undocumented

Class Flags Flags that map to parsed keys/namespaces.
Class NestedDict Undocumented
Class Output Undocumented
Function create_dict_rule Undocumented
Function create_list_rule Undocumented
Function is_unicode_scalar_value Undocumented
Function key_value_rule Undocumented
Function make_safe_parse_float A decorator to make `parse_float` safe.
Function parse_array Undocumented
Function parse_basic_str Undocumented
Function parse_basic_str_escape Undocumented
Function parse_basic_str_escape_multiline Undocumented
Function parse_hex_char Undocumented
Function parse_inline_table Undocumented
Function parse_key Undocumented
Function parse_key_part Undocumented
Function parse_key_value_pair Undocumented
Function parse_literal_str Undocumented
Function parse_multiline_str Undocumented
Function parse_one_line_basic_str Undocumented
Function parse_value Undocumented
Function skip_chars Undocumented
Function skip_comment Undocumented
Function skip_comments_and_array_ws Undocumented
Function skip_until Undocumented
Function suffixed_err Return a `TOMLDecodeError` where error message is suffixed with coordinates in source.
Constant ASCII_CTRL Undocumented
Constant BARE_KEY_CHARS Undocumented
Constant BASIC_STR_ESCAPE_REPLACEMENTS Undocumented
Constant HEXDIGIT_CHARS Undocumented
Constant ILLEGAL_BASIC_STR_CHARS Undocumented
Constant ILLEGAL_MULTILINE_BASIC_STR_CHARS Undocumented
Constant KEY_INITIAL_CHARS Undocumented
Constant TOML_WS Undocumented
Constant TOML_WS_AND_NEWLINE Undocumented
def create_dict_rule(src: str, pos: Pos, out: Output) -> tuple[Pos, Key]: (source)

Undocumented

def create_list_rule(src: str, pos: Pos, out: Output) -> tuple[Pos, Key]: (source)

Undocumented

def is_unicode_scalar_value(codepoint: int) -> bool: (source)

Undocumented

def key_value_rule(src: str, pos: Pos, out: Output, header: Key, parse_float: ParseFloat) -> Pos: (source)

Undocumented

def make_safe_parse_float(parse_float: ParseFloat) -> ParseFloat: (source)

A decorator to make `parse_float` safe. `parse_float` must not return dicts or lists, because these types would be mixed with parsed TOML tables and arrays, thus confusing the parser. The returned decorated callable raises `ValueError` instead of returning illegal types.

def parse_array(src: str, pos: Pos, parse_float: ParseFloat) -> tuple[Pos, list]: (source)

Undocumented

def parse_basic_str(src: str, pos: Pos, *, multiline: bool) -> tuple[Pos, str]: (source)

Undocumented

def parse_basic_str_escape(src: str, pos: Pos, *, multiline: bool = False) -> tuple[Pos, str]: (source)

Undocumented

def parse_basic_str_escape_multiline(src: str, pos: Pos) -> tuple[Pos, str]: (source)

Undocumented

def parse_hex_char(src: str, pos: Pos, hex_len: int) -> tuple[Pos, str]: (source)

Undocumented

def parse_inline_table(src: str, pos: Pos, parse_float: ParseFloat) -> tuple[Pos, dict]: (source)

Undocumented

def parse_key(src: str, pos: Pos) -> tuple[Pos, Key]: (source)

Undocumented

def parse_key_part(src: str, pos: Pos) -> tuple[Pos, str]: (source)

Undocumented

def parse_key_value_pair(src: str, pos: Pos, parse_float: ParseFloat) -> tuple[Pos, Key, Any]: (source)

Undocumented

def parse_literal_str(src: str, pos: Pos) -> tuple[Pos, str]: (source)

Undocumented

def parse_multiline_str(src: str, pos: Pos, *, literal: bool) -> tuple[Pos, str]: (source)

Undocumented

def parse_one_line_basic_str(src: str, pos: Pos) -> tuple[Pos, str]: (source)

Undocumented

def parse_value(src: str, pos: Pos, parse_float: ParseFloat) -> tuple[Pos, Any]: (source)

Undocumented

def skip_chars(src: str, pos: Pos, chars: Iterable[str]) -> Pos: (source)

Undocumented

def skip_comment(src: str, pos: Pos) -> Pos: (source)

Undocumented

def skip_comments_and_array_ws(src: str, pos: Pos) -> Pos: (source)

Undocumented

def skip_until(src: str, pos: Pos, expect: str, *, error_on: frozenset[str], error_on_eof: bool) -> Pos: (source)

Undocumented

def suffixed_err(src: str, pos: Pos, msg: str) -> TOMLDecodeError: (source)

Return a `TOMLDecodeError` where error message is suffixed with coordinates in source.

ASCII_CTRL = (source)

Undocumented

Value
frozenset((chr(i) for i in range(32)))|frozenset(chr(127))
BARE_KEY_CHARS = (source)

Undocumented

Value
frozenset((string.ascii_letters+string.digits)+'-_')
BASIC_STR_ESCAPE_REPLACEMENTS = (source)

Undocumented

Value
MappingProxyType({'\\b': '\x08',
                  '\\t': '\t',
                  '\\n': '''
''',
                  '\\f': '\f',
                  '\\r': '\r',
                  '\\"': '"',
...
HEXDIGIT_CHARS = (source)

Undocumented

Value
frozenset(string.hexdigits)
ILLEGAL_BASIC_STR_CHARS = (source)

Undocumented

Value
ASCII_CTRL-frozenset('\t')
ILLEGAL_MULTILINE_BASIC_STR_CHARS = (source)

Undocumented

Value
ASCII_CTRL-frozenset('\t\n')
KEY_INITIAL_CHARS = (source)

Undocumented

Value
BARE_KEY_CHARS|frozenset('"\'')

Undocumented

Value
frozenset(' \t')
TOML_WS_AND_NEWLINE = (source)

Undocumented

Value
TOML_WS|frozenset('\n')