ParserAbstract
ClassAbstractSource
ParserAbstract()
This is an abstract class requiring further implementation.
The abstract class of a module parser.
The parser is called when a member is detected in the module structure.
Arguments
Initialization function is not specified.
Abstract methods
parse_class
self.parse_class(obj: DocClass)
Parse a member object when it is a class.
Requires
| Name | Type | Required | |
|---|---|---|---|
obj | DocClass | The class information to be parsed. |
parse_dataclass
self.parse_dataclass(obj: DocDataClass)
Parse a member object when it is a data class.
Requires
| Name | Type | Required | |
|---|---|---|---|
obj | DocDataClass | The data class information to be parsed. |
parse_enum
self.parse_enum(obj: DocEnum)
Parse a member object when it is an enum class.
Requires
| Name | Type | Required | |
|---|---|---|---|
obj | DocEnum | The enum class information to be parsed. |
parse_function
self.parse_function(obj: DocFunction)
Parse a member object when it is a function.
Requires
| Name | Type | Required | |
|---|---|---|---|
obj | DocFunction | The function information to be parsed. |
parse_module
self.parse_module(obj: DocModule)
Parse a member object when it is a module.
Requires
| Name | Type | Required | |
|---|---|---|---|
obj | DocModule | The module information to be parsed. |
parse_protocol
self.parse_protocol(obj: DocProtocol)
Parse a member object when it is a protocol class.
Requires
| Name | Type | Required | |
|---|---|---|---|
obj | DocProtocol | The protocol information to be parsed. |
parse_typealias
self.parse_typealias(obj: DocTypeAlias)
Parse a member object when it is a type alias.
Requires
| Name | Type | Required | |
|---|---|---|---|
obj | DocTypeAlias | The alias information to be parsed. |
parse_typeddict
self.parse_typeddict(obj: DocTypedDict)
Parse a member object when it is a typed dictionary class.
Requires
| Name | Type | Required | |
|---|---|---|---|
obj | DocTypedDict | The typed dictionary information to be parsed. |
Methods
parse
self.parse(obj: Any)
Parse a member.
Requires
| Name | Type | Required | |
|---|---|---|---|
obj | Any | The member touched during the module walk. It will be parsed according to the member data type. For example, a function will be parsed by parse_function(obj). |