pydocspec.processor.Processor

class documentation

class Processor: (source)

Populate pydocspec attributes by applying processing to a newly created pydocspec.TreeRoot instance coming from the astbuilder.

At the point of the post processing, the root pydocspec.Module instances should have already been added to the pydocspec.TreeRoot.root_modules attribute.

Post-build is done when there are no more unprocessed modules.

Analysis of relations between documentables should be done in post-build, without the risk of drawing incorrect conclusions because modules were not fully processed yet.

Attributes:: post_build_visitor: visitors.ApiObjectVisitor

Method	`post_build`	Apply post-build process on the tree. This is required. Called automatically when using `astbuilder.Builder`.
Instance Variable	`visitor_extensions`	Post-build visitor extensions.

def post_build(self, root): (source)

Apply post-build process on the tree. This is required. Called automatically when using astbuilder.Builder.

root: pydocspec.TreeRoot
pp = processor.Processor()
pp.visitor_extensions.add(MyCustomVisitor)
pp.post_build(root)

Parameters
root:`pydocspec.TreeRoot`	Undocumented
Note
If you are creating a tree manually, you should run this on your tree as well.

visitor_extensions: Set[Union[visitors.ApiObjectVisitorExt, Type[visitors.ApiObjectVisitorExt]]] = (source)

Post-build visitor extensions.