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 |
|
No summary |
Class |
|
Syntax highlighter for Python values. |
Function | colorize |
Used to colorize type annotations and parameters default values. |
Function | colorize |
No summary |
Function | decode |
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 | _ |
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 | _ |
Undocumented |
Class | _ |
A context manager that can add enclosing delimiters to nested operators when needed. |
Class | _ |
Add parent attribute to ast nodes instances. |
Exception | _ |
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 | _ |
A control-flow exception that is raised when PyvalColorizer exeeds the maximum number of allowed lines. |
Function | _bytes |
Undocumented |
Function | _get |
Undocumented |
Function | _str |
Encode a string such that it's correctly represented inside simple quotes. |
Used to colorize type annotations and parameters default values.
Parameters | |
pyval:Any | Undocumented |
Returns | |
ColorizedPyvalRepr | colorize_pyval(pyval, linelen=None, linebreakok=False) |
Parameters | |
pyval:Any | Undocumented |
linelen:Optional[ | Undocumented |
maxlines:int | Undocumented |
linebreakok:bool | Undocumented |
Returns | |
ColorizedPyvalRepr | A ColorizedPyvalRepr describing the given pyval. |
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'
Parameters | |
s:bytes | Undocumented |
Returns | |
str | Undocumented |