pydoctor.epydoc.markup._pyval_repr

module documentation
(source)

Syntax highlighter for Python values. Currently provides special colorization support for:

  • lists, tuples, sets, frozensets, dicts
  • numbers
  • strings
  • compiled regexps
  • a variety of AST expressions

The highlighter also takes care of line-wrapping, and automatically stops generating repr output as soon as it has exceeded the specified number of lines (which should make it faster than pprint for large values). It does not bother to do automatic cycle detection, because maxlines is typically around 5, so it's really not worth it.

The syntax-highlighted output is encoded using a ParsedDocstring, which can then be used to generate output in a variety of formats.

Implementation note: we use exact tests for builtin classes (list, etc) rather than using isinstance, because subclasses might override __repr__.

Usage: >>>

Class ColorizedPyvalRepr No summary
Class PyvalColorizer Syntax highlighter for Python AST (and some builtins types).
Function colorize_inline_pyval Used to colorize type annotations and parameters default values.
Function colorize_pyval Get a ColorizedPyvalRepr instance for this piece of ast.
Function decode_with_backslashreplace Convert the given 8-bit string into unicode, treating any character c such that ord(c)<128 as an ascii character, and converting any c such that ord(c)>128 into a backslashed escape sequence.
Class _ColorizerState An object uesd to keep track of the current state of the pyval colorizer. The mark()/restore() methods can be used to set a backup point, and restore back to that backup point. This is used by several colorization methods that first try colorizing their object on a single line (setting linebreakok=False); and then fall back on a multi-line output if that fails.
Class _MarkedColorizerState Undocumented
Class _OperatorDelimiter A context manager that can add enclosing delimiters to nested operators when needed.
Exception _Linebreak A control-flow exception that is raised when PyvalColorizer generates a string containing a newline, but the state object's linebreakok variable is False.
Exception _Maxlines A control-flow exception that is raised when PyvalColorizer exeeds the maximum number of allowed lines.
Function _bytes_escape Undocumented
Function _get_str_func Undocumented
Function _str_escape Encode a string such that it's correctly represented inside simple quotes.
def colorize_inline_pyval(pyval: Any, refmap: dict[str, str] | None = None, is_annotation: bool = False) -> ColorizedPyvalRepr: (source)

Used to colorize type annotations and parameters default values.

Returns
ColorizedPyvalReprcolorize_pyval(pyval, linelen=None, linebreakok=False)
def colorize_pyval(pyval: Any, linelen: int | None, maxlines: int, linebreakok: bool = True, refmap: dict[str, str] | None = None, is_annotation: bool = False) -> ColorizedPyvalRepr: (source)

Get a ColorizedPyvalRepr instance for this piece of ast.

Parameters
pyval:AnyUndocumented
linelen:int | NoneUndocumented
maxlines:intUndocumented
linebreakok:boolUndocumented
refmap:dict[str, str] | NoneA mapping that maps local names to full names. This can be used to explicitely links some objects by assigning an explicit 'refuri' value on the obj_reference node. This can be used for cases the where the linker might be wrong, obviously this is just a workaround.
is_annotation:boolUndocumented
Returns
ColorizedPyvalReprA ColorizedPyvalRepr describing the given pyval.
def decode_with_backslashreplace(s: bytes) -> str: (source)

Convert the given 8-bit string into unicode, treating any character c such that ord(c)<128 as an ascii character, and converting any c such that ord(c)>128 into a backslashed escape sequence.

>>> decode_with_backslashreplace(b'abc\xff\xe8')
'abc\\xff\\xe8'
def _bytes_escape(b: bytes) -> str: (source)

Undocumented

def _get_str_func(pyval: AnyStr) -> Callable[[str], AnyStr]: (source)

Undocumented

def _str_escape(s: str) -> str: (source)

Encode a string such that it's correctly represented inside simple quotes.