pydoctor.epydoc2stan.FieldHandler

class documentation

class FieldHandler: (source)

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 handleUnknownField 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): (source)

Undocumented

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

Undocumented

Returns
TagUndocumented
def handle(self, field): (source)

Undocumented

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

Undocumented

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

Undocumented

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

Undocumented

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

Undocumented

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

Undocumented

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

Undocumented

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

Undocumented

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

Undocumented

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

Undocumented

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

Undocumented

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

Undocumented

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

Undocumented

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

Undocumented

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

Undocumented

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

Undocumented

Parameters
field:FieldUndocumented
def resolve_types(self): (source)

Merge information from 'param' fields and AST analysis.

def set_param_types_from_annotations(self, annotations): (source)

Undocumented

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

Undocumented

notes: List[Field] = (source)

Undocumented

obj = (source)

Undocumented

parameter_descs = (source)

Undocumented

raise_descs: List[RaisesDesc] = (source)

Undocumented

return_desc = (source)

Undocumented

seealsos: List[Field] = (source)

Undocumented

sinces: List[Field] = (source)

Undocumented

types: Dict[str, Optional[Tag]] = (source)

Undocumented

unknowns: DefaultDict[str, List[FieldDesc]] = (source)

Undocumented

warns_desc: List[FieldDesc] = (source)

Undocumented

yields_desc = (source)

Undocumented

@staticmethod
def _report_unexpected_argument(field): (source)

Undocumented

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

Undocumented

Parameters
field:FieldUndocumented
Returns
Optional[str]Undocumented
def _handle_param_not_found(self, name, field): (source)

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 = (source)

Undocumented