pydoctor.epydoc.markup._pyval_repr.PyvalColorizer

class documentation

class PyvalColorizer:

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`	No summary
Method	`_trim_result`	Undocumented

def __init__(self, linelen, maxlines, linebreakok=True):

Undocumented

Parameters
linelen:`Optional[int]`	Undocumented
maxlines:`int`	Undocumented
linebreakok:`bool`	Undocumented

def colorize(self, pyval):

Entry Point.

Parameters
pyval:`Any`	Undocumented
Returns
`ColorizedPyvalRepr`	Undocumented

COLON_TAG =

Undocumented

Value

None

COMMA_TAG =

Undocumented

Value

None

CONST_TAG =

Undocumented

Value

None

ELLIPSIS =

Undocumented

Value

nodes.inline('...', '...',
             classes=[ELLIPSIS_TAG])

ELLIPSIS_TAG: str =

Undocumented

Value

'variable-ellipsis'

GENERIC_OBJECT_RE =

Undocumented

Value

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

GROUP_TAG =

Undocumented

Value

None

LINEWRAP =

Undocumented

Value

nodes.inline('', chr(8629),
             classes=[LINEWRAP_TAG])

LINEWRAP_TAG: str =

Undocumented

Value

'variable-linewrap'

LINK_TAG: str =

Undocumented

Value

'variable-link'

NEWLINE =

Undocumented

Value

nodes.Text('\n', '\n')

NUMBER_TAG =

Undocumented

Value

None

QUOTE_TAG: str =

Undocumented

Value

'variable-quote'

RE_CHAR_TAG =

Undocumented

Value

None

RE_COMPILE_SIGNATURE =

Undocumented

Value

signature(re.compile)

RE_FLAGS_TAG: str =

Undocumented

Value

're-flags'

RE_GROUP_TAG: str =

Undocumented

Value

're-group'

RE_OP_TAG: str =

Undocumented

Value

're-op'

RE_REF_TAG: str =

Undocumented

Value

're-ref'

STRING_TAG: str =

Undocumented

Value

'variable-string'

UNKNOWN_REPR =

Undocumented

Value

nodes.inline('??', '??',
             classes=[UNKNOWN_TAG])

UNKNOWN_TAG: str =

Undocumented

Value

'variable-unknown'

WORD_BREAK_OPPORTUNITY =

Undocumented

Value

wbr()

linebreakok =

Undocumented

linelen: Optional[int] =

Undocumented

maxlines: Union[int, float] =

Undocumented

@staticmethod
def _get_ast_constant_val(node):

Undocumented

Parameters
node:`ast.AST`	Undocumented
Returns
`Any`	Undocumented

@staticmethod
def _is_ast_constant(node):

Undocumented

Parameters
node:`ast.AST`	Undocumented
Returns
`bool`	Undocumented

def _colorize(self, pyval, state):

Undocumented

Parameters
pyval:`Any`	Undocumented
state:`_ColorizerState`	Undocumented

def _colorize_ast(self, pyval, state):

Undocumented

Parameters
pyval:`ast.AST`	Undocumented
state:`_ColorizerState`	Undocumented

def _colorize_ast_attribute(self, pyval, state):

Undocumented

Parameters
pyval:`ast.Attribute`	Undocumented
state:`_ColorizerState`	Undocumented

def _colorize_ast_binary_op(self, pyval, state):

Undocumented

Parameters
pyval:`ast.BinOp`	Undocumented
state:`_ColorizerState`	Undocumented

def _colorize_ast_bool_op(self, pyval, state):

Undocumented

Parameters
pyval:`ast.BoolOp`	Undocumented
state:`_ColorizerState`	Undocumented

def _colorize_ast_call(self, node, state):

Undocumented

Parameters
node:`ast.Call`	Undocumented
state:`_ColorizerState`	Undocumented

def _colorize_ast_call_generic(self, node, state):

Undocumented

Parameters
node:`ast.Call`	Undocumented
state:`_ColorizerState`	Undocumented

def _colorize_ast_constant(self, pyval, state):

Undocumented

Parameters
pyval:`ast.AST`	Undocumented
state:`_ColorizerState`	Undocumented

def _colorize_ast_generic(self, pyval, state):

Undocumented

Parameters
pyval:`ast.AST`	Undocumented
state:`_ColorizerState`	Undocumented

def _colorize_ast_name(self, pyval, state):

Undocumented

Parameters
pyval:`ast.Name`	Undocumented
state:`_ColorizerState`	Undocumented

def _colorize_ast_re(self, node, state):

Undocumented

Parameters
node:`ast.Call`	Undocumented
state:`_ColorizerState`	Undocumented

def _colorize_ast_subscript(self, node, state):

Undocumented

Parameters
node:`ast.Subscript`	Undocumented
state:`_ColorizerState`	Undocumented

def _colorize_ast_unary_op(self, pyval, state):

Undocumented

Parameters
pyval:`ast.UnaryOp`	Undocumented
state:`_ColorizerState`	Undocumented

def _colorize_dict(self, items, state, prefix, suffix):

Undocumented

Parameters
items:`Iterable[Tuple[Any, Any]]`	Undocumented
state:`_ColorizerState`	Undocumented
prefix:`str`	Undocumented
suffix:`str`	Undocumented

def _colorize_iter(self, pyval, state, prefix=None, suffix=None):

Undocumented

Parameters
pyval:`Iterable[Any]`	Undocumented
state:`_ColorizerState`	Undocumented
prefix:`Optional[AnyStr]`	Undocumented
suffix:`Optional[AnyStr]`	Undocumented

def _colorize_re_flags(self, flags, state):

Undocumented

Parameters
flags:`int`	Undocumented
state:`_ColorizerState`	Undocumented

def _colorize_re_pattern(self, pat, state, prefix):

Undocumented

Parameters
pat:`AnyStr`	Undocumented
state:`_ColorizerState`	Undocumented
prefix:`AnyStr`	Undocumented

def _colorize_re_pattern_str(self, pat, state):

Undocumented

Parameters
pat:`AnyStr`	Undocumented
state:`_ColorizerState`	Undocumented

def _colorize_re_tree(self, tree, state, noparen, groups):

Undocumented

Parameters
tree:`Sequence[Tuple[sre_constants._NamedIntConstant, Any]]`	Undocumented
state:`_ColorizerState`	Undocumented
noparen:`bool`	Undocumented
groups:`Dict[int, str]`	Undocumented

def _colorize_str(self, pyval, state, prefix, escape_fcn):

Undocumented

Parameters
pyval:`AnyStr`	Undocumented
state:`_ColorizerState`	Undocumented
prefix:`AnyStr`	Undocumented
escape_fcn:`Callable[[AnyStr], str]`	Undocumented

def _insert_comma(self, indent, state):

Undocumented

Parameters
indent:`int`	Undocumented
state:`_ColorizerState`	Undocumented

def _multiline(self, func, pyval, state, **kwargs):

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:`_ColorizerState`	Undocumented
**kwargs:`Any`	Undocumented

def _output(self, s, css_class, state, link=False):

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:`AnyStr`	Undocumented
css_class:`Optional[str]`	Undocumented
state:`_ColorizerState`	Undocumented
link:`bool`	Undocumented

def _trim_result(self, result, num_chars):

Undocumented

Parameters
result:`List[nodes.Node]`	Undocumented
num_chars:`int`	Undocumented