pydocspec._docspec

module documentation
(source)

Mirrors docspec model, but without using dataclasses (and without deprecated attributes).

Class ApiObject The base class for representing "API Objects". Any API object is any addressable entity in code, be that a variable/constant, function, class or module.
Class Argument Represents a #Function argument.
Class ArgumentType The type of the argument. This is currently very Python-centric, however most other languages should be able to represent the various argument types with a subset of these types without additions (e.g. ...
Class Class Represents a class definition.
Class ClassSemantic A list of well-known properties and behaviour that can be attributed to a class.
Class Decoration Represents a decorator on a #Class or #Function.
Class Docstring Represents a docstring for an #APIObject, i.e. it's content and location. This class is a subclass of str for backwards compatibility reasons. Use the #content property to access the docstring content over the #Docstring value directory.
Class Function Represents a function definition. This can be in a #Module for plain functions or in a #Class for methods. The #decorations need to be introspected to understand if the function has a special purpose (e...
Class FunctionSemantic A list of well-known properties and behaviour that can be attributed to a function.
Class HasMembers Base class for API objects that can have members, e.g. #Class and #Module.
Class Indirection Represents an imported name. It can be used to properly find the full name target of a link written with a local name.
Class Inheritable Base class for inheritable objects.
Class Location Represents the location of an #ApiObject by a filename and line number.
Class Module Represents a module, basically a named container for code/API objects. Modules may be nested in other modules. Be aware that for historical reasons, some loaders lile #docspec_python by default do not return nested modules, even if nesting would be appropriate (and instead the #Module...
Class upstream No summary
Class Variable Represents a variable assignment (e.g. for global variables (often used as constants) or class members).
Class VariableSemantic A list of well-known properties and behaviour that can be attributed to a variable/constant.
Variable __author__ Undocumented
Variable __version__ The target docspec version: update me when syncing features from upstream.
Variable docspecApiObjectT Undocumented
Class _HasInitAttribsMethod No class docstring; 1/1 method documented
__author__: str = (source)

Undocumented

__version__: str = (source)

The target docspec version: update me when syncing features from upstream.

docspecApiObjectT = (source)

Undocumented