pg.typing.Argument¶

Accessible via pg.typing.Argument.

class Argument(name, kind, value_spec, description=None)[source]¶

Definition for a callable argument.

Classes:

Kind(value)

Arugment kind.

Methods:

`from_annotation`(name, kind, annotation[, ...])	Creates an argument from annotation.
`from_parameter`(param[, description, ...])	Creates an argument from inspect.Parameter.
`to_field`()	Converts current argument to a pg.typing.Field object.

class Kind(value)[source]¶

Bases: Enum

Arugment kind.

Methods:

from_parameter(parameter)

Returns Argument.Kind from inspect.Parameter.

classmethod from_parameter(parameter)¶

Returns Argument.Kind from inspect.Parameter.

classmethod from_annotation(name, kind, annotation, auto_typing=False, parent_module=None)[source]¶

Creates an argument from annotation.

classmethod from_parameter(param, description=None, auto_typing=True, parent_module=None)[source]¶

Creates an argument from inspect.Parameter.

Converts current argument to a pg.typing.Field object.