mirrors/LibCST
1
0
Fork 0
mirror of https://github.com/Instagram/LibCST.git synced 2025-12-23 10:35:53 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

add docs of ParentNodeProvider

Browse source
This commit is contained in:
Jimmy Lai 2019-09-26 01:18:49 -07:00 • committed by jimmylai
parent 132549db56
commit db6092dffd
2 changed files with 14 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

13
docs/source/metadata.rst
View file

@ -67,7 +67,8 @@ your provider does not use the visitor pattern for computing metadata for a tree
Metadata Providers
------------------
:class:`~libcst.metadata.BasicPositionProvider`, :class:`~libcst.metadata.SyntacticPositionProvider`,
:class:`~libcst.metadata.ExpressionContextProvider` and :class:`~libcst.metadata.ScopeProvider`
:class:`~libcst.metadata.ExpressionContextProvider`, :class:`~libcst.metadata.ScopeProvider` and
:class:`~libcst.metadata.ParentNodeProvider`
are currently provided. Each metadata provider may has its own custom data structure.
Position Metadata
@ -131,3 +132,13 @@ There were four different type of scope in Python: :class:`~libcst.metadata.Glob
.. autoclass:: libcst.metadata.FunctionScope
.. autoclass:: libcst.metadata.ClassScope
.. autoclass:: libcst.metadata.ComprehensionScope
Parent Node Metadata
--------------------
A :class:`~libcst.CSTNode` only has attributes link to its child nodes and thus only top-down
tree traversal is doable. Sometimes user may want to access the parent :class:`~libcst.CSTNode`
for more information or traverse in buttom-up manner.
We provide :class:`~libcst.metadata.ParentNodeProvider` for those use cases.
.. autoclass:: libcst.metadata.ParentNodeProvider
:no-undoc-members:

2
libcst/metadata/__init__.py
View file

@ -9,6 +9,7 @@ from libcst.metadata.expression_context_provider import (
ExpressionContext,
ExpressionContextProvider,
)
from libcst.metadata.parent_node_provider import ParentNodeProvider
from libcst.metadata.position_provider import (
BasicPositionProvider,
SyntacticPositionProvider,
@ -42,4 +43,5 @@ __all__ = [
"ClassScope",
"ComprehensionScope",
"ScopeProvider",
"ParentNodeProvider",
]