pydoctor.epydoc2stan.FieldHandler

class documentation

class FieldHandler:

View In Hierarchy

Undocumented

Method __init__ Undocumented
Method format Undocumented
Method handle Undocumented
Method handle​_author Undocumented
Method handle​_keyword Undocumented
Method handle​_note Undocumented
Method handle​_param Undocumented
Method handle​_raises Undocumented
Method handle​_return Undocumented
Method handle​_returntype Undocumented
Method handle​_seealso Undocumented
Method handle​_since Undocumented
Method handle​_type Undocumented
Method handle​_warns Undocumented
Method handle​_yield Undocumented
Method handle​_yieldtype Undocumented
Method handled​_elsewhere Undocumented
Method handle​Unknown​Field Undocumented
Method resolve​_types Merge information from 'param' fields and AST analysis.
Method set​_param​_types​_from​_annotations Undocumented
Instance Variable authors Undocumented
Instance Variable notes Undocumented
Instance Variable obj Undocumented
Instance Variable parameter​_descs Undocumented
Instance Variable raise​_descs Undocumented
Instance Variable return​_desc Undocumented
Instance Variable seealsos Undocumented
Instance Variable sinces Undocumented
Instance Variable types Undocumented
Instance Variable unknowns Undocumented
Instance Variable warns​_desc Undocumented
Instance Variable yields​_desc Undocumented
Static Method ​_report​_unexpected​_argument Undocumented
Method ​_handle​_param​_name Undocumented
Method ​_handle​_param​_not​_found Figure out if the parameter might exist despite not being found in this documentable's code, warn if not.
Instance Variable ​_linker Undocumented
def __init__(self, obj):

Undocumented

Parameters
obj:model.DocumentableUndocumented
def format(self):

Undocumented

Returns
TagUndocumented
def handle(self, field):

Undocumented

Parameters
field:FieldUndocumented
def handle_author(self, field):

Undocumented

Parameters
field:FieldUndocumented
def handle_keyword(self, field):

Undocumented

Parameters
field:FieldUndocumented
def handle_note(self, field):

Undocumented

Parameters
field:FieldUndocumented
def handle_param(self, field):

Undocumented

Parameters
field:FieldUndocumented
def handle_raises(self, field):

Undocumented

Parameters
field:FieldUndocumented
def handle_return(self, field):

Undocumented

Parameters
field:FieldUndocumented
def handle_returntype(self, field):

Undocumented

Parameters
field:FieldUndocumented
def handle_seealso(self, field):

Undocumented

Parameters
field:FieldUndocumented
def handle_since(self, field):

Undocumented

Parameters
field:FieldUndocumented
def handle_type(self, field):

Undocumented

Parameters
field:FieldUndocumented
def handle_warns(self, field):

Undocumented

Parameters
field:FieldUndocumented
def handle_yield(self, field):

Undocumented

Parameters
field:FieldUndocumented
def handle_yieldtype(self, field):

Undocumented

Parameters
field:FieldUndocumented
def handled_elsewhere(self, field):

Undocumented

Parameters
field:FieldUndocumented
def handleUnknownField(self, field):

Undocumented

Parameters
field:FieldUndocumented
def resolve_types(self):
Merge information from 'param' fields and AST analysis.
def set_param_types_from_annotations(self, annotations):

Undocumented

Parameters
annotations:Mapping[str, Optional[ast.expr]]Undocumented
authors: List[Field] =

Undocumented

notes: List[Field] =

Undocumented

obj =

Undocumented

parameter_descs =

Undocumented

raise_descs: List[RaisesDesc] =

Undocumented

return_desc =

Undocumented

seealsos: List[Field] =

Undocumented

sinces: List[Field] =

Undocumented

types: Dict[str, Optional[Tag]] =

Undocumented

unknowns: DefaultDict[str, List[FieldDesc]] =

Undocumented

warns_desc: List[FieldDesc] =

Undocumented

yields_desc =

Undocumented

@staticmethod
def _report_unexpected_argument(field):

Undocumented

Parameters
field:FieldUndocumented
def _handle_param_name(self, field):

Undocumented

Parameters
field:FieldUndocumented
Returns
Optional[str]Undocumented
def _handle_param_not_found(self, name, field):
Figure out if the parameter might exist despite not being found in this documentable's code, warn if not.
Parameters
name:strUndocumented
field:FieldUndocumented
_linker =

Undocumented