module documentation
Like the docspec classes, but with ast attributes and few goodies added such that efficient
processing can be done on these objects afterwards.
| Notes | |
| This part of the model is never instanciated as-is, the pydocspec.* classes are always used. The attributes in the pydocspec.* classes are not initialized by default (they are populated by the processor), whereas the attributes listed in this module's classes that re initialized directly by the builder. This is why we maintain a separation between the two models. This way. we can use stricter typing information in the processor and avoid relying on features that are not yet ready. | |
Some attributes are implemented as property in this package. These attributes depends on the object place in the tree, so they are computed each time.
Namely: ApiObject.full_name, ApiObject.dottedname, ApiObject.module, ApiObject.scope. |
| Class | |
No class docstring; 2/4 properties, 1/1 instance variable, 0/2 class variable, 6/13 methods documented |
| Class | |
Represents a Function argument. |
| Class | |
Undocumented |
| Class | |
Represents a class definition. |
| Class | |
Represents a decorator on a Class or Function. |
| Class | |
Undocumented |
| Class | |
Represents a function definition. |
| Class | |
This mixin adds a __getitem__ method to a class or module. It makes it easier to access members of an object. |
| Class | |
Represents an imported name. It can be used to properly find the full name target of a link written with a local name. |
| Class | |
Represents a module, basically a named container for code/API objects. Modules may be nested in other modules. |
| Class | |
No class docstring; 2/2 instance variables, 1/1 class variable, 1/4 method documented |
| Class | |
Represents a variable assignment. |
| Function | tree |
Undocumented |