Undocumented
Module | __main__ |
Undocumented |
From __init__.py
:
Class |
|
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 |
|
Represents a #Function argument. |
Class |
|
Represents a class definition. |
Class |
|
A list of well-known properties and behaviour that can be attributed to a class. |
Class |
|
Represents a decorator on a #Class or #Function. |
Class |
|
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 |
|
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 |
|
A list of well-known properties and behaviour that can be attributed to a function. |
Class |
|
Base class for objects that have a #Location. |
Class |
|
Base class for API objects that can have members, e.g. #Class and #Module. |
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 the location of an #ApiObject by a filename and line number. |
Class |
|
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 |
|
Represents a variable assignment (e.g. for global variables (often used as constants) or class members). |
Class |
|
A list of well-known properties and behaviour that can be attributed to a variable/constant. |
Function | dump |
Dumps a module to the specified target or returns it as plain structured data. |
Function | filter |
Visits all *objects* recursively, applying the *predicate* in the specified *order*. If the predicate returrns #False, the object will be removed from it's containing list. |
Function | get |
Generic function to retrieve a member from an API object. This will always return #None for objects that don't support members (eg. #Function and #Variable). |
Function | load |
Loads a #Module from the specified *source*, which may be either a filename, a file-like object to read from or plain structured data. |
Function | load |
Loads a stream of modules from the specified *source*. Similar to #load_module(), the *source* can be a filename, file-like object or a list of plain structured data to deserialize from. |
Function | visit |
Visits all *objects*, applying *func* in the specified *order*. |
Variable | __author__ |
Undocumented |
Variable | __version__ |
Undocumented |
Type Alias | _ |
Undocumented |
Type Alias | _ |
Undocumented |
Variable | _ |
Undocumented |
Variable | _ |
Undocumented |
t.Union[ str, t.TextIO, t.Dict[ str, t.Any]]
, filename: t.Optional[ str]
= None, loader: t.Callable[ [ t.IO[ str]], t.Any]
= json.load) -> Module
:
(source)
¶
Loads a #Module from the specified *source*, which may be either a filename, a file-like object to read from or plain structured data. # Arguments source: The JSON source to load the module from. filename: The name of the source. This will be displayed in error messages if the deserialization fails. loader: A function for loading plain structured data from a file-like object. Defaults to #json.load(). # Returns The loaded `Module` object.
t.Union[ str, t.TextIO, t.Iterable[ t.Any]]
, filename: t.Optional[ str]
= None, loader: t.Callable[ [ t.IO[ str]], t.Any]
= json.load) -> t.Iterable[ Module]
:
(source)
¶
Loads a stream of modules from the specified *source*. Similar to #load_module(), the *source* can be a filename, file-like object or a list of plain structured data to deserialize from.
Module
, target: t.Union[ str, t.IO[ str]]
, dumper: t.Callable[ [ t.Any, t.IO[ str]], None]
= json.dump):Module
, target: None
= None, dumper: t.Callable[ [ t.Any, t.IO[ str]], None]
= json.dump) -> t.Dict[ str, t.Any]
:Dumps a module to the specified target or returns it as plain structured data.
t.MutableSequence[ ApiObject]
, predicate: t.Callable[ [ ApiObject], bool]
, order: str
= 'pre') -> t.MutableSequence[ ApiObject]
:
(source)
¶
Visits all *objects* recursively, applying the *predicate* in the specified *order*. If the predicate returrns #False, the object will be removed from it's containing list. If an object is removed in pre-order, it's members will not be visited. :param objects: A list of objects to visit recursively. This list will be modified if the *predicate* returns #False for an object. :param predicate: The function to apply over all visited objects. :param order: The order in which the objects are visited. The default order is `'pre'` in which case the *predicate* is called before visiting the object's members. The order may also be `'post'`.
t.Sequence[ ApiObject]
, func: t.Callable[ [ ApiObject], t.Any]
, order: str
= 'pre'):
(source)
¶
Visits all *objects*, applying *func* in the specified *order*.