typedargs.basic_structures module

Basic structures used to describe parameters and return values.

Summary

Classes:

ParameterInfo	param type_class:  class of parameter value type
ReturnInfo	param type_class:  class of parameter value type

Reference

class typedargs.basic_structures.ParameterInfo(type_class: Optional[type], type_name: Optional[str], validators: Optional[list], desc: Optional[str])

Bases: object

Parameters:

• type_class – class of parameter value type
• type_name – parameter type name
• validators – list of validators
• desc – parameter description

class typedargs.basic_structures.ReturnInfo(type_class: Optional[type], type_name: Optional[str], formatter: Optional[tuple], is_data: Optional[bool], desc: Optional[str])

Bases: object

Parameters:

• type_class – class of parameter value type
• type_name – parameter type name
• formatter – parameter string formatter name
• is_data – True if annotated function returns any data
• desc – parameter description