pydoctor.epydoc2stan.FieldHandler

class documentation

class FieldHandler: (source)

Constructor: FieldHandler(obj)

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'/'keyword' 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 Returns the Field name and trigger a few warnings for a few scenarios. Note that the return type could be VariableArgument or KeywordArgument or str.
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: model.Documentable): (source)

Undocumented

def format(self) -> Tag: (source)

Undocumented

def handle(self, field: Field): (source)

Undocumented

def handle_author(self, field: Field): (source)

Undocumented

def handle_keyword(self, field: Field): (source)

Undocumented

def handle_note(self, field: Field): (source)

Undocumented

def handle_param(self, field: Field): (source)

Undocumented

def handle_raises(self, field: Field): (source)

Undocumented

def handle_return(self, field: Field): (source)

Undocumented

def handle_returntype(self, field: Field): (source)

Undocumented

def handle_seealso(self, field: Field): (source)

Undocumented

def handle_since(self, field: Field): (source)

Undocumented

def handle_type(self, field: Field): (source)

Undocumented

def handle_warns(self, field: Field): (source)

Undocumented

def handle_yield(self, field: Field): (source)

Undocumented

def handle_yieldtype(self, field: Field): (source)

Undocumented

def handled_elsewhere(self, field: Field): (source)

Undocumented

def handleUnknownField(self, field: Field): (source)

Undocumented

def resolve_types(self): (source)

Merge information from 'param'/'keyword' fields and AST analysis.

def set_param_types_from_annotations(self, annotations: Mapping[str, ast.expr | None]): (source)

Undocumented

authors: list[Field] = (source)

Undocumented

notes: list[Field] = (source)

Undocumented

obj = (source)

Undocumented

parameter_descs: list[ParamDesc | KeywordDesc] = (source)

Undocumented

raise_descs: list[RaisesDesc] = (source)

Undocumented

return_desc: ReturnDesc | None = (source)

Undocumented

seealsos: list[Field] = (source)

Undocumented

sinces: list[Field] = (source)

Undocumented

types: dict[str, ParamType | None] = (source)

Undocumented

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

Undocumented

warns_desc: list[FieldDesc] = (source)

Undocumented

yields_desc: FieldDesc | None = (source)

Undocumented

@staticmethod
def _report_unexpected_argument(field: Field): (source)

Undocumented

def _handle_param_name(self, field: Field) -> str | None: (source)

Returns the Field name and trigger a few warnings for a few scenarios. Note that the return type could be VariableArgument or KeywordArgument or str.

def _handle_param_not_found(self, name: str, field: Field): (source)

Figure out if the parameter might exist despite not being found in this documentable's code, warn if not.

_linker = (source)

Undocumented