mirror of
https://github.com/Instagram/LibCST.git
synced 2025-12-23 10:35:53 +00:00
efc53af608
* Make the nodes fields filtering process - from libcst.tool - public, so that other libraries may provide their own custom representation of LibCST graphs. * Create functions to access & filter CST-node fields (with appropriate docstrings & tests), in libcst.helpers * Add new CST-node fields functions to helpers documentation.
49 lines
1.5 KiB
ReStructuredText
49 lines
1.5 KiB
ReStructuredText
=======
|
|
Helpers
|
|
=======
|
|
|
|
Helpers are higher level functions built for reducing recurring code boilerplate.
|
|
We add helpers as method of ``CSTNode`` or ``libcst.helpers`` package based on those principles:
|
|
|
|
- ``CSTNode`` method: simple, read-only and only require data of the direct children of a CSTNode.
|
|
- ``libcst.helpers``: node transforms or require recursively traversing the syntax tree.
|
|
|
|
Construction Helpers
|
|
--------------------
|
|
|
|
Functions that assist in creating a new LibCST tree.
|
|
|
|
.. autofunction:: libcst.helpers.parse_template_module
|
|
.. autofunction:: libcst.helpers.parse_template_expression
|
|
.. autofunction:: libcst.helpers.parse_template_statement
|
|
|
|
Transformation Helpers
|
|
----------------------
|
|
|
|
Functions that assist in transforming an existing LibCST node.
|
|
|
|
.. autofunction:: libcst.helpers.insert_header_comments
|
|
|
|
Traversing Helpers
|
|
------------------
|
|
|
|
Functions that assist in traversing an existing LibCST tree.
|
|
|
|
.. autofunction:: libcst.helpers.get_full_name_for_node
|
|
.. autofunction:: libcst.helpers.get_full_name_for_node_or_raise
|
|
.. autofunction:: libcst.helpers.ensure_type
|
|
|
|
Node fields filtering Helpers
|
|
-----------------------------
|
|
|
|
Function that assist when handling CST nodes' fields.
|
|
|
|
.. autofunction:: libcst.helpers.filter_node_fields
|
|
|
|
And lower level functions:
|
|
|
|
.. autofunction:: libcst.helpers.get_node_fields
|
|
.. autofunction:: libcst.helpers.is_whitespace_node_field
|
|
.. autofunction:: libcst.helpers.is_syntax_node_field
|
|
.. autofunction:: libcst.helpers.is_default_node_field
|
|
.. autofunction:: libcst.helpers.get_field_default_value
|