pydoctor.epydoc.doctest

module documentation

(source)

Syntax highlighting for blocks of Python code.

Function	`colorize_codeblock`	Colorize a string containing only Python code. This method differs from `colorize_doctest` in that it will not search for doctest prompts when deciding how to colorize the string.
Function	`colorize_codeblock_body`	Undocumented
Function	`colorize_doctest`	Perform syntax highlighting on the given doctest string, and return the resulting HTML code.
Function	`colorize_doctest_body`	Undocumented
Function	`subfunc`	Undocumented
Constant	`DEFINE_FUNC_RE`	A regexp that decomposes function definitions.
Constant	`DOCTEST_DIRECTIVE_RE`	A regexp that matches doctest directives.
Constant	`DOCTEST_EXAMPLE_RE`	This regular expression is used to find doctest examples in a string. This is copied from the standard Python doctest.py module (after the refactoring in Python 2.4+).
Constant	`DOCTEST_RE`	A regexp that matches all of the regions of a doctest block that should be colored.
Constant	`EXCEPT_RE`	A regexp that matches doctest exception blocks.
Constant	`PROMPT2_RE`	A regexp that matches Python "..." prompts.
Constant	`PROMPT_RE`	A regexp that matches Python prompts
Constant	`_BUILTIN_GRP`	A regexp group that matches Python builtins.
Constant	`_BUILTINS`	A list of all Python builtins.
Constant	`_COMMENT_GRP`	A regexp group that matches Python comments.
Constant	`_DEFINE_GRP`	A regexp group that matches function and class definitions.
Constant	`_KEYWORD_GRP`	A regexp group that matches keywords.
Constant	`_KEYWORDS`	A list of the names of all Python keywords.
Constant	`_PROMPT1_GRP`	A regexp group that matches Python ">>>" prompts.
Constant	`_PROMPT2_GRP`	A regexp group that matches Python "..." prompts.
Constant	`_STRING_GRP`	A regexp group that matches Python strings.

def colorize_codeblock(s: str) -> Tag: (source) ¶

Colorize a string containing only Python code. This method differs from colorize_doctest in that it will not search for doctest prompts when deciding how to colorize the string.

This code consists of a <pre> block with class=py-doctest. Syntax highlighting is performed using the following CSS classes:

py-keyword -- a Python keyword (for, if, etc.)
py-builtin -- a Python builtin name (abs, dir, etc.)
py-string -- a string literal
py-comment -- a comment
py-except -- an exception traceback (up to the next >>>)
py-output -- the output from a doctest block.
py-defname -- the name of a function or class defined by a def or class statement.

def colorize_codeblock_body(s: str) -> Iterator[Tag | str]: (source) ¶

Undocumented

def colorize_doctest(s: str) -> Tag: (source) ¶

Perform syntax highlighting on the given doctest string, and return the resulting HTML code.

This code consists of a <pre> block with class=py-doctest. Syntax highlighting is performed using the following CSS classes:

py-prompt -- the Python PS1 prompt (>>>)
py-more -- the Python PS2 prompt (...)
the CSS classes output by colorize_codeblock

def colorize_doctest_body(s: str) -> Iterator[str | Tag]: (source) ¶

Undocumented

def subfunc(match: Match[str]) -> Iterator[Tag | str]: (source) ¶

Undocumented

DEFINE_FUNC_RE = (source) ¶

A regexp that decomposes function definitions.

Value

re.compile(r'(?P<def>\w+)(?P<space>\s+)(?P<name>\w+)')

DOCTEST_DIRECTIVE_RE = (source) ¶

A regexp that matches doctest directives.

Value

re.compile(r'#[ \t]*doctest:.*')

DOCTEST_EXAMPLE_RE = (source) ¶

This regular expression is used to find doctest examples in a string. This is copied from the standard Python doctest.py module (after the refactoring in Python 2.4+).

Value

re.compile('''
    # Source consists of a PS1 line followed by zero or more PS2 lines.
    (?P<source>
        (?:^(?P<indent> [ ]*) >>>    .*)    # PS1 line
        (?:\\n           [ ]*  \\.\\.\\. .*)*   # PS2 lines
        \\n?)
    # Want consists of any non-blank lines that do not start with PS1.
...

DOCTEST_RE = (source) ¶

A regexp that matches all of the regions of a doctest block that should be colored.

Value

re.compile(f'((?P<STRING>{_STRING_GRP})|(?P<COMMENT>{_COMMENT_GRP})|(?P<DEFINE>{↵
_DEFINE_GRP})|(?P<KEYWORD>{_KEYWORD_GRP})|(?P<BUILTIN>{_BUILTIN_GRP})|(?P<PROMPT↵
1>{_PROMPT1_GRP})|(?P<PROMPT2>{_PROMPT2_GRP})|(?P<EOS>\\Z))',
           (re.MULTILINE | re.DOTALL))

EXCEPT_RE = (source) ¶

A regexp that matches doctest exception blocks.

Value

re.compile(r'^[ \t]*Traceback \(most recent call last\):.*',
           (re.DOTALL | re.MULTILINE))

PROMPT2_RE = (source) ¶

A regexp that matches Python "..." prompts.

Value

re.compile(f'({_PROMPT2_GRP})', (re.MULTILINE | re.DOTALL))

PROMPT_RE = (source) ¶

A regexp that matches Python prompts

Value

re.compile(f'({_PROMPT1_GRP}|{_PROMPT2_GRP})', (re.MULTILINE | re.DOTALL))

_BUILTIN_GRP = (source) ¶

A regexp group that matches Python builtins.

Value

'(?<!\\.)(?:%s)' % '|'.join((f'\\b{_BI}\\b' for _BI in _BUILTINS))

_BUILTINS = (source) ¶

A list of all Python builtins.

Value

[_BI for _BI in dir(builtins) if not _BI.startswith('__')]

_COMMENT_GRP: str = (source) ¶

A regexp group that matches Python comments.

Value

'(#.*?$)'

_DEFINE_GRP: str = (source) ¶

A regexp group that matches function and class definitions.

Value

'\\b(?:def|class)[ \\t]+\\w+'

_KEYWORD_GRP = (source) ¶

A regexp group that matches keywords.

Value

'|'.join((f'\\b{_KW}\\b' for _KW in _KEYWORDS))

_KEYWORDS: list[str] = (source) ¶

A list of the names of all Python keywords.

Value

['and',
 'as',
 'assert',
 'async',
 'await',
 'break',
 'class',
...

_PROMPT1_GRP: str = (source) ¶

A regexp group that matches Python ">>>" prompts.

Value

'^[ \\t]*>>>(?:[ \\t]|$)'

_PROMPT2_GRP: str = (source) ¶

A regexp group that matches Python "..." prompts.

Value

'^[ \\t]*\\.\\.\\.(?:[ \\t]|$)'

_STRING_GRP = (source) ¶

A regexp group that matches Python strings.

Value

'|'.join(['("""("""|.*?((?!").)"""))',
          '("("|.*?((?!").)"))',
          '(\'\'\'(\'\'\'|.*?[^\\\\\']\'\'\'))',
          '(\'(\'|.*?[^\\\\\']\'))'])