def visit_batched(
node: CSTNodeT,
visitors: Iterable[BatchableCSTVisitor],
before_visit: Optional[VisitorMethod] = None,
after_leave: Optional[VisitorMethod] = None,
use_compatible: bool = True, # TODO: remove this
) -> CSTNodeT:
"""
Returns the result of running all visitors [visitors] over [node].
[before_visit] and [after_leave] are provided as optional hooks to
execute before visit_* and after leave_* methods are executed by the
batched visitor.
"""
# TODO: remove compatiblity hack
if use_compatible:
from libcst._nodes._module import Module
if isinstance(node, Module):
from contextlib import ExitStack
from libcst.metadata.wrapper import MetadataWrapper
wrapper = MetadataWrapper(node)
with ExitStack() as stack:
# Resolve dependencies of visitors
for v in visitors:
stack.enter_context(v.resolve(wrapper))
batched_visitor = make_batched(visitors, before_visit,
after_leave)
return cast(
CSTNodeT,
wrapper.module.visit(batched_visitor,
use_compatible=False),
)
batched_visitor = make_batched(visitors, before_visit, after_leave)
return cast(CSTNodeT, node.visit(batched_visitor))
# end compatible
batched_visitor = make_batched(visitors, before_visit, after_leave)
return cast(CSTNodeT, node.visit(batched_visitor, use_compatible=False))
def visit_batched(
node: CSTNodeT,
visitors: Iterable[BatchableCSTVisitor],
before_visit: Optional[VisitorMethod] = None,
after_leave: Optional[VisitorMethod] = None,
) -> CSTNodeT:
"""
Returns the result of running all visitors [visitors] over [node].
[before_visit] and [after_leave] are provided as optional hooks to
execute before visit_* and after leave_* methods are executed by the
batched visitor.
"""
visitor_methods = _get_visitor_methods(visitors)
batched_visitor = _BatchedCSTVisitor(visitor_methods,
before_visit=before_visit,
after_leave=after_leave)
return cast(CSTNodeT, node.visit(batched_visitor))
def visit_batched(
node: CSTNodeT,
batchable_visitors: Iterable[BatchableCSTVisitor],
before_visit: Optional[VisitorMethod] = None,
after_leave: Optional[VisitorMethod] = None,
) -> CSTNodeT:
"""
Do a batched traversal over ``node`` with all ``visitors``.
``before_visit`` and ``after_leave`` are provided as optional hooks to
execute before the ``visit_<Type[CSTNode]>`` and ``leave_<Type[CSTNode]>``
methods from each visitor in ``visitor`` are executed by the batched visitor.
This function does not handle metadata dependency resolution for ``visitors``.
See :func:`~libcst.MetadataWrapper.visit_batched` from
:class:`~libcst.MetadataWrapper` for batched traversal with metadata dependency
resolution.
"""
visitor_methods = _get_visitor_methods(batchable_visitors)
batched_visitor = _BatchedCSTVisitor(visitor_methods,
before_visit=before_visit,
after_leave=after_leave)
return cast(CSTNodeT, node.visit(batched_visitor))