pydoctor.epydoc.markup._types.ParsedTypeDocstring

class documentation

class ParsedTypeDocstring(TypeDocstring, ParsedDocstring): (source)

Constructor: ParsedTypeDocstring(annotation, warns_on_unknown_tokens, lineno)

View In Hierarchy

Add ParsedDocstring interface on top of TypeDocstring and allow to parse types from nodes.Node objects, providing the --process-types option.

Method __init__ Undocumented
Method to_node Not implemented at this time :/
Method to_stan Present the type as a stan tree.
Constant FIELDS Undocumented
Property has_body Does this docstring have a non-empty body?
Method _convert_obj_tokens_to_stan Convert TokenType.OBJ and PEP 484 like TokenType.DELIMITER type to stan, merge them together. Leave the rest untouched.
Method _convert_type_spec_to_stan Convert type to Tag object.
Method _tokenize_node_type_spec Undocumented
Instance Variable _lineno Undocumented
Instance Variable _tokens Undocumented

Inherited from TypeDocstring:

Method __str__ No summary
Instance Variable warnings Undocumented
Class Method _tokenize_type_spec Split the string in tokens for further processing.
Static Method _recombine_set_tokens Merge the special literal choices tokens together.
Method _build_tokens Undocumented
Method _convert_type_spec_to_rst Undocumented
Method _token_type Find the type of a token. Types are defined in C{TokenType} enum.
Method _trigger_warnings Append some warnings.
Class Variable _ast_like_delimiters_regex Undocumented
Class Variable _ast_like_delimiters_regex_str Undocumented
Class Variable _default_regex Undocumented
Class Variable _natural_language_delimiters_regex Undocumented
Class Variable _natural_language_delimiters_regex_str Undocumented
Class Variable _token_regex Undocumented
Instance Variable _annotation Undocumented
Instance Variable _warns_on_unknown_tokens Undocumented

Inherited from ParsedDocstring (via TypeDocstring):

Method get_summary Returns the summary of this docstring.
Method get_toc The table of contents of the docstring if titles are defined or None.
Method to_text Translate this docstring to a string. The default implementation depends on to_node.
Instance Variable fields A list of Fields, each of which encodes a single field. The field's bodies are encoded as ParsedDocstrings.
Instance Variable _stan Undocumented
def __init__(self, annotation: nodes.document | str, warns_on_unknown_tokens: bool = False, lineno: int = 0): (source)
overrides pydoctor.napoleon.docstring.TypeDocstring.__init__

Undocumented

def to_node(self) -> nodes.document: (source)
overrides pydoctor.epydoc.markup.ParsedDocstring.to_node

Not implemented at this time :/

def to_stan(self, docstring_linker: DocstringLinker) -> Tag: (source)
overrides pydoctor.epydoc.markup.ParsedDocstring.to_stan

Present the type as a stan tree.

FIELDS: tuple[str, ...] = (source)

Undocumented

Value
('type', 'rtype', 'ytype', 'returntype', 'yieldtype')
has_body: bool = (source)
overrides pydoctor.epydoc.markup.ParsedDocstring.has_body

Does this docstring have a non-empty body?

The body is the part of the docstring that remains after the fields have been split off.

def _convert_obj_tokens_to_stan(self, tokens: list[tuple[Any, TokenType]], docstring_linker: DocstringLinker) -> list[tuple[Any, TokenType]]: (source)

Convert TokenType.OBJ and PEP 484 like TokenType.DELIMITER type to stan, merge them together. Leave the rest untouched.

Parameters
tokens:list[tuple[Any, TokenType]]List of tuples: (token, type)
docstring_linker:DocstringLinkerUndocumented
Returns
list[tuple[Any, TokenType]]Undocumented
def _convert_type_spec_to_stan(self, docstring_linker: DocstringLinker) -> Tag: (source)

Convert type to Tag object.

def _tokenize_node_type_spec(self, spec: nodes.document) -> list[str | nodes.Node]: (source)

Undocumented

_lineno = (source)

Undocumented

_tokens: list[tuple[str | nodes.Node, TokenType]] = (source)
overrides pydoctor.napoleon.docstring.TypeDocstring._tokens

Undocumented