pydocspec.visitors.FilterVisitor

class documentation

class FilterVisitor(ApiObjectVisitor): (source)

View In Hierarchy

Visits objects applying the predicate. If the predicate returrns a False value, the object will be removed from it's containing list.

Usage::
module: pydocspec.Module # removes entries starting by one underscore that are not dunder methods, aka private API. predicate = lambda ob: not ob.name.startswith("_") or ob.name.startswith("__") and ob.name.endswith("__") filter_visitor = FilterVisitor(predicate) filter_visitor.walk(module)
Method __init__ Undocumented
Method apply_predicate_on_members Undocumented
Method unknown_departure Undocumented
Method unknown_visit Undocumented
Instance Variable predicate Undocumented

Inherited from _ApiObjectVisitorGetChildren (via ApiObjectVisitor):

Class Method get_children Undocumented
def __init__(self, predicate): (source)

Undocumented

Parameters
predicate:t.Callable[[pydocspec.ApiObject], bool]Undocumented
def apply_predicate_on_members(self, ob): (source)

Undocumented

Parameters
ob:pydocspec.ApiObjectUndocumented
def unknown_departure(self, ob): (source)

Undocumented

Parameters
ob:pydocspec.ApiObjectUndocumented
def unknown_visit(self, ob): (source)

Undocumented

Parameters
ob:pydocspec.ApiObjectUndocumented
predicate = (source)

Undocumented