abc.ABCpydocspec._c3linear.GenericMRO - Generic class to encapsulate the c3 linearizations for any kind of class types.pydocspec.basebuilder.BaseBuilder - Undocumentedpydocspec.ext._AstroidTransform - Base class to customize astroid inference system with a bridge to pydocspec tree.pydocspec.ext.AstroidInferenceTip - Encapsulate an astroid inference tip to be registered with the ExtRegistrar.pydocspec.ext.default.infer__all__.InferenceTip__all__Variable - Infernce tip for the __all__ variable. Accounts for module level modifications of the __all__ list.pydocspec.ext.AstroidTransform - Encapsulate an astroid transform to be registered with the ExtRegistrar.pydocspec.genericvisitor.Visitor - "Visitor" pattern abstract superclass implementation for tree traversals.BaseCollector[_model.Module, _model.ApiObject]pydocspec.basebuilder.Collector - Base class to organize a tree of pydocspec objects.pydocspec.astbuilder.BuilderVisitor - No class docstring; 0/1 instance variable, 0/1 class variable, 8/26 methods documentedpydocspec.converter._ConverterVisitor - Visit each docspec objects of a module and create their pydocspec augmented counterparts.Deque[Optional['T']]pydocspec._c3linear.GenericMRO.Dependency - No class docstring; 1/2 property documenteddocspec.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.docspec.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...docspec.HasMembers - Base class for API objects that can have members, e.g. #Class and #Module.docspec.Class - Represents a class definition.docspec.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...docspec.Indirection - Represents an imported name. It can be used to properly find the full name target of a link written with a local name.docspec.Variable - Represents a variable assignment (e.g. for global variables (often used as constants) or class members).docspec.Argument - Represents a #Function argument.docspec.Decoration - Represents a decorator on a #Class or #Function.docspec.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.docspec.Location - Represents the location of an #ApiObject by a filename and line number.enum.Enumdocspec.Argument.Type - 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. ...docspec.ClassSemantic - A list of well-known properties and behaviour that can be attributed to a class.docspec.FunctionSemantic - A list of well-known properties and behaviour that can be attributed to a function.docspec.VariableSemantic - A list of well-known properties and behaviour that can be attributed to a variable/constant.pydocspec._docspec.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. ...pydocspec._docspec.ClassSemantic - A list of well-known properties and behaviour that can be attributed to a class.pydocspec._docspec.FunctionSemantic - A list of well-known properties and behaviour that can be attributed to a function.pydocspec._docspec.VariableSemantic - A list of well-known properties and behaviour that can be attributed to a variable/constant.pydocspec.astbuilder.ProcessingState - Undocumentedpydocspec.genericvisitor.When - This enumeration contains the different times an extension is used.Exceptionpydocspec.astbuilder.CyclicImport - Raised when trying to re-processed a module that is not totally processed yet.pydocspec.genericvisitor.Visitor._TreePruningException - Base class for Visitor-related tree pruning exceptions.pydocspec.genericvisitor.Visitor.SkipChildren - Do not visit any children of the current node. The current node's siblings and depart_... method are not affected.pydocspec.genericvisitor.Visitor.SkipDeparture - Do not call the current node's depart_... method. The current node's children and siblings are not affected.pydocspec.genericvisitor.Visitor.SkipNode - Do not visit the current node's children, and do not call the current node's depart_... method.pydocspec.genericvisitor.Visitor.SkipSiblings - Do not visit any more siblings (to the right) of the current node. The current node's children and its depart_... method are not affected.Generic[_EnumT]pydocspec.converter._SemanticsConverter - UndocumentedGeneric[_KT, _VT]pydocspec.dupsafedict.DuplicateSafeDict - Dictionnary that do not discard old objects when they are overriden, but instead, only updates a reference to the new object.Generic[ApiObjectT]pydocspec.basebuilder.MarkedTreeWalkingState - Undocumentedpydocspec.basebuilder.TreeWalkingState - UndocumentedGeneric[ModuleT, ApiObjectT]pydocspec.basebuilder.BaseCollector - No class docstring; 0/1 property, 1/4 instance variable, 2/5 methods documentedGeneric[T]pydocspec._c3linear.GenericMRO - Generic class to encapsulate the c3 linearizations for any kind of class types.pydocspec.genericvisitor.Visitor - "Visitor" pattern abstract superclass implementation for tree traversals.pydocspec.genericvisitor.VisitorExtensionList - This class helps iterating on visitor extensions that should run at different times.MutableMapping[_KT, _VT]pydocspec.dupsafedict.DuplicateSafeDict - Dictionnary that do not discard old objects when they are overriden, but instead, only updates a reference to the new object.PartialVisitor[T]pydocspec.genericvisitor.VisitorExtension - The node visitor extension base class, to inherit from.pydocspec._c3linear.GenericMRO.DependencyList - A class represents list of linearizations (dependencies) The last element of DependencyList is a list of parents. It's needed to the merge process preserves the local precedence order of direct parent classes.pydocspec._c3linear.GenericMRO[pydocspec.Class]pydocspec.processor.class_attr.MRO - Implements MRO resoling for pydocspec.Class instances.pydocspec._docspec._HasInitAttribsMethod - No class docstring; 1/1 method documentedpydocspec._docspec.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.pydocspec._docspec.HasMembers - Base class for API objects that can have members, e.g. #Class and #Module.pydocspec._docspec.Class - Represents a class definition.pydocspec._model.Class - Represents a class definition.pydocspec.Class - Represents a class definition.pydocspec._docspec.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...pydocspec._model.Module - Represents a module, basically a named container for code/API objects. Modules may be nested in other modules.pydocspec.Module - Represents a module, basically a named container for code/API objects. Modules may be nested in other modulespydocspec._docspec.Inheritable - Base class for inheritable objects.pydocspec._docspec.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...pydocspec._model.Function - Represents a function definition.pydocspec.Function - Represents a function definition.pydocspec._docspec.Indirection - Represents an imported name. It can be used to properly find the full name target of a link written with a local name.pydocspec._model.Indirection - Represents an imported name. It can be used to properly find the full name target of a link written with a local name.pydocspec.Indirection - Represents an imported name. It can be used to properly find the full name target of a link written with a local name.pydocspec._docspec.Variable - Represents a variable assignment (e.g. for global variables (often used as constants) or class members).pydocspec._model.Variable - Represents a variable assignment.pydocspec.Variable - Represents a variable assignment.pydocspec._model.ApiObject - No class docstring; 2/4 properties, 1/1 instance variable, 0/2 class variable, 6/13 methods documentedpydocspec._model.Class - Represents a class definition.pydocspec.Class - Represents a class definition.pydocspec._model.Function - Represents a function definition.pydocspec.Function - Represents a function definition.pydocspec._model.Indirection - Represents an imported name. It can be used to properly find the full name target of a link written with a local name.pydocspec.Indirection - Represents an imported name. It can be used to properly find the full name target of a link written with a local name.pydocspec._model.Module - Represents a module, basically a named container for code/API objects. Modules may be nested in other modules.pydocspec.Module - Represents a module, basically a named container for code/API objects. Modules may be nested in other modulespydocspec._model.Variable - Represents a variable assignment.pydocspec.Variable - Represents a variable assignment.pydocspec.ApiObject - An augmented docspec.ApiObject, with functionalities to resolve names for the python language.pydocspec.Class - Represents a class definition.pydocspec.Function - Represents a function definition.pydocspec.Indirection - Represents an imported name. It can be used to properly find the full name target of a link written with a local name.pydocspec.Module - Represents a module, basically a named container for code/API objects. Modules may be nested in other modulespydocspec.Variable - Represents a variable assignment.pydocspec._docspec.Argument - Represents a #Function argument.pydocspec._model.Argument - Represents a Function argument.pydocspec._docspec.Decoration - Represents a decorator on a #Class or #Function.pydocspec._model.Decoration - Represents a decorator on a Class or Function.pydocspec._docspec.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.pydocspec._model.Docstring - Undocumentedpydocspec._docspec.Location - Represents the location of an #ApiObject by a filename and line number.pydocspec._docspec.upstream - No summarypydocspec._model.CanTriggerWarnings - Undocumentedpydocspec._model.ApiObject - No class docstring; 2/4 properties, 1/1 instance variable, 0/2 class variable, 6/13 methods documentedpydocspec._model.Class - Represents a class definition.pydocspec.Class - Represents a class definition.pydocspec._model.Function - Represents a function definition.pydocspec.Function - Represents a function definition.pydocspec._model.Indirection - Represents an imported name. It can be used to properly find the full name target of a link written with a local name.pydocspec.Indirection - Represents an imported name. It can be used to properly find the full name target of a link written with a local name.pydocspec._model.Module - Represents a module, basically a named container for code/API objects. Modules may be nested in other modules.pydocspec.Module - Represents a module, basically a named container for code/API objects. Modules may be nested in other modulespydocspec._model.Variable - Represents a variable assignment.pydocspec.Variable - Represents a variable assignment.pydocspec.ApiObject - An augmented docspec.ApiObject, with functionalities to resolve names for the python language.pydocspec.Class - Represents a class definition.pydocspec.Function - Represents a function definition.pydocspec.Indirection - Represents an imported name. It can be used to properly find the full name target of a link written with a local name.pydocspec.Module - Represents a module, basically a named container for code/API objects. Modules may be nested in other modulespydocspec.Variable - Represents a variable assignment.pydocspec._model.Argument - Represents a Function argument.pydocspec._model.Decoration - Represents a decorator on a Class or Function.pydocspec._model.Docstring - Undocumentedpydocspec._model.GetMembersMixin - This mixin adds a __getitem__ method to a class or module. It makes it easier to access members of an object.pydocspec._model.ApiObject - No class docstring; 2/4 properties, 1/1 instance variable, 0/2 class variable, 6/13 methods documentedpydocspec._model.Class - Represents a class definition.pydocspec.Class - Represents a class definition.pydocspec._model.Function - Represents a function definition.pydocspec.Function - Represents a function definition.pydocspec._model.Indirection - Represents an imported name. It can be used to properly find the full name target of a link written with a local name.pydocspec.Indirection - Represents an imported name. It can be used to properly find the full name target of a link written with a local name.pydocspec._model.Module - Represents a module, basically a named container for code/API objects. Modules may be nested in other modules.pydocspec.Module - Represents a module, basically a named container for code/API objects. Modules may be nested in other modulespydocspec._model.Variable - Represents a variable assignment.pydocspec.Variable - Represents a variable assignment.pydocspec.ApiObject - An augmented docspec.ApiObject, with functionalities to resolve names for the python language.pydocspec.Class - Represents a class definition.pydocspec.Function - Represents a function definition.pydocspec.Indirection - Represents an imported name. It can be used to properly find the full name target of a link written with a local name.pydocspec.Module - Represents a module, basically a named container for code/API objects. Modules may be nested in other modulespydocspec.Variable - Represents a variable assignment.pydocspec._model.TreeRoot - No class docstring; 2/2 instance variables, 1/1 class variable, 1/4 method documentedpydocspec.TreeRoot - A collection of related documentable objects, also known as "the system".pydocspec.astbuilder._AstSpecFactory - Undocumentedpydocspec.astbuilder.Builder - Coordinate the process of parsing and analysing the ast trees.pydocspec.astroidutils._NodeFactory - Easy create NodeNG instances.pydocspec.astroidutils.NodeVisitor - A node visitor base class that walks the abstract syntax tree and calls a visitor function for every node found. This function may return a value which is forwarded by the visit method. This class is meant to be subclassed, with the subclass adding visitor methods...pydocspec.astroidutils.NodeTransformer - A NodeVisitor subclass that walks the abstract syntax tree and allows modification of nodes. The NodeTransformer will walk the AST and use the return value of the visitor methods to replace or remove the old node...pydocspec.astroidutils._AnnotationStringParser - Implementation of unstring_annotation.pydocspec.astroidutils.SignatureBuilder - Builds a signature, parameter by parameter, with customizable value formatter and signature classes.pydocspec.astroidutils.ValueFormatter - Formats values stored in AST expressions back to source code. Used for presenting default values of parameters and annotations.pydocspec.basebuilder.BaseCollector[docspec.Module, docspec.ApiObject]pydocspec.converter._BackConverterVisitor - Undocumentedpydocspec.ClassInheritedMember - Undocumentedpydocspec.converter._BackConverter - Converts pydocspec objects back to docspec in order to serialize them.pydocspec.converter._Converter - Converts docspec objects to their pydocspec augmented version.pydocspec.dottedname.DottedName - A sequence of identifiers, separated by periods, used to name a Python variable, value, or argument. The identifiers that make up a dotted name can be accessed using the indexing operator:pydocspec.ext.ClassMixin - Undocumentedpydocspec.ext.ApiObjectMixin - Undocumentedpydocspec.ext.opt.docstring.HasParsedDocstring - Undocumentedpydocspec.ext.HasMembersMixin - Undocumentedpydocspec.ext.opt.attrs.AttrsClassMixin - No class docstring; 2/2 properties documentedpydocspec.ext.opt.dataclasses.DataClassesClassMixin - No class docstring; 1/1 property documentedpydocspec.ext.DecorationMixin - Undocumentedpydocspec.ext.default.dup.DuplicateHandler - Handle duplicatespydocspec.ext.DocstringMixin - Undocumentedpydocspec.ext.ExtRegistrar - The extension registrar interface class.pydocspec.ext.FunctionMixin - Undocumentedpydocspec.ext.ApiObjectMixin - Undocumentedpydocspec.ext.opt.docstring.HasParsedDocstring - Undocumentedpydocspec.ext.InheritableMixin - Undocumentedpydocspec.ext.IndirectionMixin - Undocumentedpydocspec.ext.ApiObjectMixin - Undocumentedpydocspec.ext.opt.docstring.HasParsedDocstring - Undocumentedpydocspec.ext.LocationMixin - Undocumentedpydocspec.ext.ModuleMixin - Undocumentedpydocspec.ext.ApiObjectMixin - Undocumentedpydocspec.ext.opt.docstring.HasParsedDocstring - Undocumentedpydocspec.ext.HasMembersMixin - Undocumentedpydocspec.ext.VariableMixin - Undocumentedpydocspec.ext.ApiObjectMixin - Undocumentedpydocspec.ext.opt.docstring.HasParsedDocstring - Undocumentedpydocspec.ext.InheritableMixin - Undocumentedpydocspec.ext.opt.attrs.AttrsDataMixin - No class docstring; 1/1 property documentedpydocspec.ext.opt.dataclasses.DataClassesDataMixin - No class docstring; 1/1 property documentedpydocspec.genericvisitor.CustomizableVisitor['pydocspec.ApiObject']pydocspec.visitors.ApiObjectVisitor - Undocumentedpydocspec.converter._BackConverterVisitor - Undocumentedpydocspec.visitors.FilterVisitor - Visits objects applying the predicate. If the predicate returrns a False value, the object will be removed from it's containing list.pydocspec.visitors.PrintVisitor - Visit objects and print each object with the defined format string. Available substitutions are:pydocspec.visitors.ReprVisitor - Format a representation of a arbitrary ApiObject, including nested members of the tree.pydocspec.genericvisitor.CustomizableVisitor[astroid.nodes.NodeNG]pydocspec.visitors.AstVisitor - Undocumentedpydocspec.ext.default.infer__all__.Infer__all__Operations - Walks the module level ast tree and infer list operations results to self.names.pydocspec.genericvisitor.PartialVisitor[astroid.nodes.NodeNG]pydocspec.visitors.AstVisitor - Undocumentedpydocspec.ext.default.infer__all__.Infer__all__Operations - Walks the module level ast tree and infer list operations results to self.names.pydocspec.genericvisitor.Visitor['pydocspec.ApiObject']pydocspec.visitors._ApiObjectVisitorGetChildren - Undocumentedpydocspec.visitors.ApiObjectVisitor - Undocumentedpydocspec.converter._BackConverterVisitor - Undocumentedpydocspec.visitors.FilterVisitor - Visits objects applying the predicate. If the predicate returrns a False value, the object will be removed from it's containing list.pydocspec.visitors.PrintVisitor - Visit objects and print each object with the defined format string. Available substitutions are:pydocspec.visitors.ReprVisitor - Format a representation of a arbitrary ApiObject, including nested members of the tree.pydocspec.visitors.ApiObjectVisitorExt - Undocumentedpydocspec.genericvisitor.Visitor[_docspec.docspecApiObjectT]pydocspec.visitors._docspecApiObjectVisitor - Undocumentedpydocspec.converter._ConverterVisitor - Visit each docspec objects of a module and create their pydocspec augmented counterparts.pydocspec.genericvisitor.Visitor[astroid.nodes.NodeNG]pydocspec.visitors._ASTVisitorGetChildren - Undocumentedpydocspec.visitors.AstVisitor - Undocumentedpydocspec.ext.default.infer__all__.Infer__all__Operations - Walks the module level ast tree and infer list operations results to self.names.pydocspec.visitors.AstVisitorExt - Undocumentedpydocspec.visitors._ASTVisitorGetChildrenBodyOnly - No class docstring; 1/1 class method documentedpydocspec.genericvisitor.VisitorExtension['pydocspec.ApiObject']pydocspec.visitors.ApiObjectVisitorExt - Undocumentedpydocspec.genericvisitor.VisitorExtension[astroid.nodes.NodeNG]pydocspec.visitors.AstVisitorExt - Undocumentedpydocspec.Options - Undocumentedpydocspec.processor.Processor - Populate pydocspec attributes by applying processing to a newly created pydocspec.TreeRoot instance coming from the astbuilder.pydocspec.specfactory.GenericFactory - No class docstring; 0/2 instance variable, 2/4 methods documentedpydocspec.specfactory.Factory - Classes are created dynamically with type such that they can inherith from customizable mixin classes.pydocspec.test._back_converter_round_trip1 - No class docstring; 1/1 static method documentedpydocspec.test._default_astbuilder - No class docstring; 1/1 static method documentedpydocspec.test._docspec_python - Undocumentedpydocspec.test._optional_extensions_enabled - Undocumentedpydocspec.test.test_astroidutils.TestAstroidUtilsAndExpandName - Undocumentedpydocspec.visitors.ApiObjectVisitorpydocspec.processor.PostBuildVisitor0 - Undocumentedpydocspec.processor.PostBuildVisitor1 - Undocumentedpydocspec.visitors.ApiObjectVisitorExtpydocspec.ext.ApiObjectVisitorExt - Undocumentedpydocspec.ext.opt.docstring.DocstringParsingVis - Undocumentedpydocspec.processor._DocSourcesSetter - Undocumentedpydocspec.processor._DuplicateWhoShadowsWhoHandling - Undocumentedpydocspec.processor._MroFromAstroidSetter - Set Class.mro attribute based on astroid to be able to correctly populate the resolved_bases attribute with our own resolve_name() function.pydocspec.visitors.AstVisitorpydocspec.astbuilder.BuilderVisitor - No class docstring; 0/1 instance variable, 0/1 class variable, 8/26 methods documentedpydocspec.visitors.AstVisitorExtpydocspec.ext.AstVisitorExt - Undocumentedtyping.Protocolpydocspec.converter._EnumMeta - Undocumentedtyping_extensions.Protocolpydocspec.astroidutils._NodeConstructorMethod - Undocumentedpydocspec.test.CapLog - Undocumentedpydocspec.test.CapSys - Undocumentedpydocspec.test.CaptureResult - Undocumentedpydocspec.test.ModFromTextFunction - Undocumentedunittest.TestCasepydocspec.test.test_astroidutils.CopyLocationTests - Undocumentedpydocspec.test.test_astroidutils.FixMissingLocationTests - Undocumentedpydocspec.test.test_astroidutils.InferTypeAnnotationTests - Undocumentedpydocspec.test.test_astroidutils.LiteralEvalTests - Undocumentedpydocspec.test.test_astroidutils.NodeVisitorTests - Undocumentedpydocspec.test.test_astroidutils.UnstringAnnotationTests - UndocumentedValueErrorpydocspec.dottedname.DottedName.InvalidDottedName - An exception raised by the DottedName constructor when one of its arguments is not a valid dotted name.Visitor[T]pydocspec.genericvisitor.CustomizableVisitor - A visitor that can be composed by other vistitors.pydocspec.genericvisitor.PartialVisitor - Visitor class that do not have to define all possible visit_.* methods since it overrides the default behaviour of unknown_visit() and unknown_departure() not to raise NotImplementedError.