pydoctor.epydoc.markup._pyval_repr.PyvalColorizer

class documentation

class PyvalColorizer: (source)

View In Hierarchy

Syntax highlighter for Python values.

Method __init__ Undocumented
Method colorize Entry Point.
Constant COLON_TAG Undocumented
Constant COMMA_TAG Undocumented
Constant CONST_TAG Undocumented
Constant ELLIPSIS Undocumented
Constant ELLIPSIS_TAG Undocumented
Constant GENERIC_OBJECT_RE Undocumented
Constant GROUP_TAG Undocumented
Constant LINEWRAP Undocumented
Constant LINEWRAP_TAG Undocumented
Constant LINK_TAG Undocumented
Constant NEWLINE Undocumented
Constant NUMBER_TAG Undocumented
Constant QUOTE_TAG Undocumented
Constant RE_CHAR_TAG Undocumented
Constant RE_COMPILE_SIGNATURE Undocumented
Constant RE_FLAGS_TAG Undocumented
Constant RE_GROUP_TAG Undocumented
Constant RE_OP_TAG Undocumented
Constant RE_REF_TAG Undocumented
Constant STRING_TAG Undocumented
Constant UNKNOWN_REPR Undocumented
Constant UNKNOWN_TAG Undocumented
Constant WORD_BREAK_OPPORTUNITY Undocumented
Instance Variable linebreakok Undocumented
Instance Variable linelen Undocumented
Instance Variable maxlines Undocumented
Static Method _get_ast_constant_val Undocumented
Static Method _is_ast_constant Undocumented
Method _colorize Undocumented
Method _colorize_ast Undocumented
Method _colorize_ast_attribute Undocumented
Method _colorize_ast_binary_op Undocumented
Method _colorize_ast_bool_op Undocumented
Method _colorize_ast_call Undocumented
Method _colorize_ast_call_generic Undocumented
Method _colorize_ast_constant Undocumented
Method _colorize_ast_generic Undocumented
Method _colorize_ast_name Undocumented
Method _colorize_ast_re Undocumented
Method _colorize_ast_subscript Undocumented
Method _colorize_ast_unary_op Undocumented
Method _colorize_dict Undocumented
Method _colorize_iter Undocumented
Method _colorize_re_flags Undocumented
Method _colorize_re_pattern Undocumented
Method _colorize_re_pattern_str Undocumented
Method _colorize_re_tree Undocumented
Method _colorize_str Undocumented
Method _insert_comma Undocumented
Method _multiline Helper for container-type colorizers. First, try calling func(pyval, state, **kwargs) with linebreakok set to false; and if that fails, then try again with it set to true.
Method _output Add the string s to the result list, tagging its contents with the specified css_class. Any lines that go beyond PyvalColorizer.linelen will be line-wrapped. If the total number of lines exceeds PyvalColorizer.maxlines...
Method _trim_result Undocumented
def __init__(self, linelen, maxlines, linebreakok=True): (source)

Undocumented

Parameters
linelen:Optional[int]Undocumented
maxlines:intUndocumented
linebreakok:boolUndocumented
def colorize(self, pyval): (source)

Entry Point.

Parameters
pyval:AnyUndocumented
Returns
ColorizedPyvalReprUndocumented
COLON_TAG = (source)

Undocumented

Value
None
COMMA_TAG = (source)

Undocumented

Value
None
CONST_TAG = (source)

Undocumented

Value
None
ELLIPSIS = (source)

Undocumented

Value
nodes.inline('...', '...',
             classes=[ELLIPSIS_TAG])
ELLIPSIS_TAG: str = (source)

Undocumented

Value
'variable-ellipsis'
GENERIC_OBJECT_RE = (source)

Undocumented

Value
re.compile(r'^<(?P<descr>.*) at (?P<addr>0x[0-9a-f]+)>$',
           re.IGNORECASE)
GROUP_TAG = (source)

Undocumented

Value
None
LINEWRAP = (source)

Undocumented

Value
nodes.inline('', chr(8629),
             classes=[LINEWRAP_TAG])
LINEWRAP_TAG: str = (source)

Undocumented

Value
'variable-linewrap'
LINK_TAG: str = (source)

Undocumented

Value
'variable-link'
NEWLINE = (source)

Undocumented

Value
nodes.Text('\n')
NUMBER_TAG = (source)

Undocumented

Value
None
QUOTE_TAG: str = (source)

Undocumented

Value
'variable-quote'
RE_CHAR_TAG = (source)

Undocumented

Value
None
RE_COMPILE_SIGNATURE = (source)

Undocumented

Value
signature(re.compile)
RE_FLAGS_TAG: str = (source)

Undocumented

Value
're-flags'
RE_GROUP_TAG: str = (source)

Undocumented

Value
're-group'
RE_OP_TAG: str = (source)

Undocumented

Value
're-op'
RE_REF_TAG: str = (source)

Undocumented

Value
're-ref'
STRING_TAG: str = (source)

Undocumented

Value
'variable-string'
UNKNOWN_REPR = (source)

Undocumented

Value
nodes.inline('??', '??',
             classes=[UNKNOWN_TAG])
UNKNOWN_TAG: str = (source)

Undocumented

Value
'variable-unknown'
WORD_BREAK_OPPORTUNITY = (source)

Undocumented

Value
wbr()
linebreakok = (source)

Undocumented

linelen: Optional[int] = (source)

Undocumented

maxlines: Union[int, float] = (source)

Undocumented

@staticmethod
def _get_ast_constant_val(node): (source)

Undocumented

Parameters
node:ast.ASTUndocumented
Returns
AnyUndocumented
@staticmethod
def _is_ast_constant(node): (source)

Undocumented

Parameters
node:ast.ASTUndocumented
Returns
boolUndocumented
def _colorize(self, pyval, state): (source)

Undocumented

Parameters
pyval:AnyUndocumented
state:_ColorizerStateUndocumented
def _colorize_ast(self, pyval, state): (source)

Undocumented

Parameters
pyval:ast.ASTUndocumented
state:_ColorizerStateUndocumented
def _colorize_ast_attribute(self, pyval, state): (source)

Undocumented

Parameters
pyval:ast.AttributeUndocumented
state:_ColorizerStateUndocumented
def _colorize_ast_binary_op(self, pyval, state): (source)

Undocumented

Parameters
pyval:ast.BinOpUndocumented
state:_ColorizerStateUndocumented
def _colorize_ast_bool_op(self, pyval, state): (source)

Undocumented

Parameters
pyval:ast.BoolOpUndocumented
state:_ColorizerStateUndocumented
def _colorize_ast_call(self, node, state): (source)

Undocumented

Parameters
node:ast.CallUndocumented
state:_ColorizerStateUndocumented
def _colorize_ast_call_generic(self, node, state): (source)

Undocumented

Parameters
node:ast.CallUndocumented
state:_ColorizerStateUndocumented
def _colorize_ast_constant(self, pyval, state): (source)

Undocumented

Parameters
pyval:ast.ASTUndocumented
state:_ColorizerStateUndocumented
def _colorize_ast_generic(self, pyval, state): (source)

Undocumented

Parameters
pyval:ast.ASTUndocumented
state:_ColorizerStateUndocumented
def _colorize_ast_name(self, pyval, state): (source)

Undocumented

Parameters
pyval:ast.NameUndocumented
state:_ColorizerStateUndocumented
def _colorize_ast_re(self, node, state): (source)

Undocumented

Parameters
node:ast.CallUndocumented
state:_ColorizerStateUndocumented
def _colorize_ast_subscript(self, node, state): (source)

Undocumented

Parameters
node:ast.SubscriptUndocumented
state:_ColorizerStateUndocumented
def _colorize_ast_unary_op(self, pyval, state): (source)

Undocumented

Parameters
pyval:ast.UnaryOpUndocumented
state:_ColorizerStateUndocumented
def _colorize_dict(self, items, state, prefix, suffix): (source)

Undocumented

Parameters
items:Iterable[Tuple[Any, Any]]Undocumented
state:_ColorizerStateUndocumented
prefix:strUndocumented
suffix:strUndocumented
def _colorize_iter(self, pyval, state, prefix=None, suffix=None): (source)

Undocumented

Parameters
pyval:Iterable[Any]Undocumented
state:_ColorizerStateUndocumented
prefix:Optional[AnyStr]Undocumented
suffix:Optional[AnyStr]Undocumented
def _colorize_re_flags(self, flags, state): (source)

Undocumented

Parameters
flags:intUndocumented
state:_ColorizerStateUndocumented
def _colorize_re_pattern(self, pat, state, prefix): (source)

Undocumented

Parameters
pat:AnyStrUndocumented
state:_ColorizerStateUndocumented
prefix:AnyStrUndocumented
def _colorize_re_pattern_str(self, pat, state): (source)

Undocumented

Parameters
pat:AnyStrUndocumented
state:_ColorizerStateUndocumented
def _colorize_re_tree(self, tree, state, noparen, groups): (source)

Undocumented

Parameters
tree:Sequence[Tuple[sre_constants._NamedIntConstant, Any]]Undocumented
state:_ColorizerStateUndocumented
noparen:boolUndocumented
groups:Dict[int, str]Undocumented
def _colorize_str(self, pyval, state, prefix, escape_fcn): (source)

Undocumented

Parameters
pyval:AnyStrUndocumented
state:_ColorizerStateUndocumented
prefix:AnyStrUndocumented
escape_fcn:Callable[[AnyStr], str]Undocumented
def _insert_comma(self, indent, state): (source)

Undocumented

Parameters
indent:intUndocumented
state:_ColorizerStateUndocumented
def _multiline(self, func, pyval, state, **kwargs): (source)

Helper for container-type colorizers. First, try calling func(pyval, state, **kwargs) with linebreakok set to false; and if that fails, then try again with it set to true.

Parameters
func:Callable[..., None]Undocumented
pyval:Iterable[Any]Undocumented
state:_ColorizerStateUndocumented
**kwargs:AnyUndocumented
def _output(self, s, css_class, state, link=False): (source)

Add the string s to the result list, tagging its contents with the specified css_class. Any lines that go beyond PyvalColorizer.linelen will be line-wrapped. If the total number of lines exceeds PyvalColorizer.maxlines, then raise a _Maxlines exception.

Parameters
s:AnyStrUndocumented
css_class:Optional[str]Undocumented
state:_ColorizerStateUndocumented
link:boolUndocumented
def _trim_result(self, result, num_chars): (source)

Undocumented

Parameters
result:List[nodes.Node]Undocumented
num_chars:intUndocumented