pydocspec.astroidutils.SignatureBuilder

class documentation

class SignatureBuilder: (source)

View In Hierarchy

Builds a signature, parameter by parameter, with customizable value formatter and signature classes.

Method add_param Undocumented
Method get_signature Undocumented
Method set_return_annotation Undocumented
Instance Variable signature_class Undocumented
Instance Variable value_formatter_class Undocumented
Instance Variable _parameters Undocumented
Instance Variable _return_annotation Undocumented
def add_param(self, name, kind, default=None, annotation=None): (source)

Undocumented

Parameters
name:strUndocumented
kind:inspect._ParameterKindUndocumented
default:Optional[Any]Undocumented
annotation:Optional[Any]Undocumented
def get_signature(self): (source)

Undocumented

Returns
inspect.SignatureUndocumented
def set_return_annotation(self, annotation): (source)

Undocumented

Parameters
annotation:Optional[Any]Undocumented
signature_class: Type[inspect.Signature] = (source)

Undocumented

value_formatter_class: Type[ValueFormatter] = (source)

Undocumented

_parameters: List[inspect.Parameter] = (source)

Undocumented

_return_annotation = (source)

Undocumented