ast-explore 0.1.0__py3-none-any.whl

ast_explore/__init__.py

@@ -0,0 +1,48 @@
+"""Tool for exploring the AST of given Python source code."""
+
+import ast
+import importlib.metadata
+import sys
+from collections.abc import Iterator
+
+__version__ = importlib.metadata.version(__name__)
+
+
+PYTHON_VERSION = f'{sys.version_info.major}.{sys.version_info.minor}'
+
+
+def ast_node_types_generator() -> Iterator[str]:
+    """
+    Generator for getting the names of all the AST node types.
+
+    Yields
+    ------
+    Iterator[str]
+        Names of each of the AST node types.
+    """
+    seen = set()
+
+    def subclass_generator(base_class: type) -> Iterator[str]:
+        """
+        Generator for getting the names of all of a class's subclasses recursively.
+
+        Parameters
+        ----------
+        base_class : type
+            The class for which to grab all subclasses.
+
+        Yields
+        ------
+        Iterator[str]
+            Names of each subclass, regardless of how many levels deep.
+        """
+        for subclass in base_class.__subclasses__():
+            if subclass not in seen:
+                seen.add(subclass)
+                yield subclass.__name__
+                yield from subclass_generator(subclass)
+
+    yield from subclass_generator(ast.AST)
+
+
+__all__ = ['PYTHON_VERSION', '__version__', 'ast_node_types_generator']

ast_explore/cli.py

@@ -0,0 +1,130 @@
+"""CLI for exploring an AST of Python source code."""
+
+import argparse
+import difflib
+from collections.abc import Sequence
+from typing import cast
+
+from . import __version__, ast_node_types_generator
+from .explorer import NodeExplorer
+
+
+def validate_node_type(node_type: str) -> str:
+    """
+    Validate node type is an AST node.
+
+    Parameters
+    ----------
+    node_type : str
+        The node type to validate.
+
+    Returns
+    -------
+    str
+        The node type, if it is valid.
+
+    Raises
+    ------
+    argparse.ArgumentTypeError
+        This is raised when the node type is not valid, and an attempt will be made to
+        suggest a close match for a valid node type (if one exists).
+    """
+    if (
+        not node_type
+        or (node_name := node_type.removeprefix('ast.')) in ast_node_types_generator()
+    ):
+        return node_type
+
+    msg = f'Unknown AST node type "{node_name}".'
+    if did_you_mean := difflib.get_close_matches(
+        node_name, ast_node_types_generator(), n=1
+    ):
+        msg += f' Did you mean "{did_you_mean[0]}"?'
+    raise argparse.ArgumentTypeError(msg)
+
+
+def get_parser() -> argparse.ArgumentParser:
+    """
+    Get an argument parser for the AST explorer CLI.
+
+    Returns
+    -------
+    argparse.ArgumentParser
+        The configured argument parser.
+    """
+    parser = argparse.ArgumentParser(
+        description='Traverse the AST of the input source code and explore the nodes encountered'
+    )
+
+    parser.add_argument(
+        '-v', '--version', action='version', version=f'%(prog)s {__version__}'
+    )
+
+    parser.add_argument(
+        metavar='source_code',
+        dest='source_code_file_path',
+        help='Source code file to analyze',
+    )
+
+    parser.add_argument(
+        '--types',
+        nargs='*',
+        help=(
+            'node types to explore (e.g., --types Try ExceptionHandler). '
+            "If you don't provide any specific types, all will be explored."
+        ),
+        type=validate_node_type,
+    )
+
+    parser.add_argument(
+        '--interactive',
+        action='store_true',
+        help=(
+            'whether to run in interactive mode, which allows the user to decide '
+            'whether they want to visit a given node.'
+        ),
+    )
+
+    return parser
+
+
+def main(argv: Sequence[str] | None = None) -> int:
+    """
+    Explore the AST of a given Python source code module.
+
+    Parameters
+    ----------
+    argv : Sequence[str] | None, optional
+        The arguments passed on the command line.
+
+    Returns
+    -------
+    int
+        Exit code for the process. Non-zero exit codes mean something went wrong.
+    """
+    args = get_parser().parse_args(argv)
+
+    try:
+        visitor = NodeExplorer(args.source_code_file_path, args.types, args.interactive)
+    except (FileNotFoundError, SyntaxError):
+        return 1
+    except Exception as exc:
+        print(exc)
+        return 1
+
+    try:
+        visitor.run()
+    except KeyboardInterrupt:
+        print('\n🛑 Exiting...')
+        return 0
+    except SystemExit as exit:
+        return cast('int', exit.code)
+    except Exception as exc:
+        print(exc)
+        return 1
+
+    return 0
+
+
+if __name__ == '__main__':
+    raise SystemExit(main())

ast_explore/display.py

@@ -0,0 +1,129 @@
+"""Display utilities."""
+
+# mypy: disable-error-code="attr-defined"
+import ast
+import itertools
+import math
+import operator
+import shutil
+
+TERMINAL_WIDTH, TERMINAL_HEIGHT = shutil.get_terminal_size()
+
+
+def print_header(title: str, symbol: str) -> None:
+    """
+    Print a header section with the title centered.
+
+    Parameters
+    ----------
+    title : str
+        The title of the section.
+    symbol : str
+        The symbol to use to build the border.
+    """
+    line = symbol * TERMINAL_WIDTH
+    title_line = f'{title:^{TERMINAL_WIDTH}}'
+
+    if len(title) < TERMINAL_WIDTH - 6:
+        border = symbol * 2
+        title_line = border + title_line[2:-2] + border
+
+    print(line, title_line, line, sep='\n', end='\n\n')
+
+
+def print_section_divider(symbol: str) -> None:
+    """
+    Print section divider.
+
+    Parameters
+    ----------
+    symbol : str
+        The symbol to use for the divider.
+    """
+    print(f'{symbol * TERMINAL_WIDTH}\n')
+
+
+def print_source_code(
+    source_code: str, node: ast.AST, max_lines: int | None = None
+) -> None:
+    """
+    Print a source code segment with line numbers.
+
+    Parameters
+    ----------
+    source_code : str
+        The source code.
+    node : ast.AST
+        The AST node.
+    max_lines : int | None, optional
+        The maximum number of lines to show. By default, show as many lines as can fit
+        in the terminal window.
+    """
+    code_lines = source_code.splitlines()
+
+    start_line_number = node.lineno
+    highlight_line_number = None
+
+    arrow = '   '
+    underline = None
+    if node.lineno == node.end_lineno:
+        highlight_line_number = node.lineno
+        start_line_number = max(1, start_line_number - 2)
+
+        code_segment = list(
+            itertools.dropwhile(
+                operator.not_, code_lines[start_line_number - 1 : highlight_line_number]
+            )
+        )
+
+        if (width := node.end_col_offset - node.col_offset) < len(code_segment[-1]):
+            underline = '^' * width
+    else:
+        code_segment = (
+            ast.get_source_segment(source_code, node, padded=True) or ''
+        ).splitlines()
+
+    if (num_lines := len(code_segment)) > 1 and (
+        num_lines > (node.end_lineno - node.lineno + 1)
+    ):
+        arrow = '-> '
+
+    end_line_number = num_lines + start_line_number
+
+    digits = math.ceil(math.log10(end_line_number))
+    if arrow:
+        digits += len(arrow)
+
+    padding = digits
+    separator = ' | '
+
+    def _get_line_prefix(
+        line_number: int, node: ast.AST
+    ) -> str:  # numpydoc ignore=PR01,RT01
+        """Helper function to get the prefix for the line of source code."""
+        text = (
+            f'{arrow}{line_number}'
+            if node.lineno <= line_number <= node.end_lineno
+            else line_number
+        )
+        return f'{f"{text}":>{padding}}'
+
+    print('\n🐍 Source code represented by the node:')
+    print(
+        *(
+            [
+                f'{f"{_get_line_prefix(line_number, node)}":>{padding}}{separator}{code}'
+                for line_number, code in zip(
+                    range(start_line_number, end_line_number),
+                    code_segment[: max_lines or TERMINAL_HEIGHT],
+                    strict=False,
+                )
+            ]
+        ),
+        sep='\n',
+        end='\n',
+    )
+
+    if underline:
+        print(f'{" ":>{padding}}{separator}{" ":>{node.col_offset}}{underline}')
+    print()

ast_explore/explorer.py

@@ -0,0 +1,251 @@
+"""Traverse the AST to provide information on desired nodes."""
+
+import ast
+import contextlib
+import itertools
+import os
+import reprlib
+import time
+from collections.abc import Sequence
+from pathlib import Path
+from typing import cast
+
+from . import PYTHON_VERSION, ast_node_types_generator
+from .display import print_header, print_section_divider, print_source_code
+
+
+class NodeExplorer(ast.NodeVisitor):
+    """
+    Node visitor capable of interactively exploring nodes of the AST during traversal.
+
+    Parameters
+    ----------
+    source_code_file_path : str | os.PathLike[str]
+        Path to the Python source code to explore. The code must be valid Python syntax.
+    nodes_to_explore : Sequence[str] | Sequence[type[ast.AST]] | None
+        The types of nodes to explore. When set to ``None``, the traversal will explore
+        each node encountered. Provide a sequence of strings (*e.g.*, ``['Try', 'Assert']``)
+        or :mod:`ast` types (*e.g.*, ``[ast.Try, ast.Assert]``) to only explore specific
+        node types.
+    interactive : bool, default=False
+        Whether to explore the AST interactively, in which case the traversal will stop
+        to show you information about the node and wait for you to decide the next step.
+    """
+
+    def __init__(
+        self,
+        source_code_file_path: str | os.PathLike[str],
+        nodes_to_explore: Sequence[str] | Sequence[type[ast.AST]] | None,
+        interactive: bool = False,
+    ) -> None:
+        self._nodes_visited = itertools.count(1)
+
+        file_path = Path(source_code_file_path).resolve()
+        print(f'📖 Reading Python source code from {file_path}...')
+
+        try:
+            self._source_code = file_path.read_text()
+        except FileNotFoundError as exc:
+            print(f'⚠️  {exc.strerror}')
+            raise
+
+        print(f'🔍 Parsing into a Python {PYTHON_VERSION} AST...')
+        try:
+            self.tree = ast.parse(self._source_code)
+        except SyntaxError:
+            print('⚠️  Input source code is not syntactically-correct')
+            raise
+
+        match nodes_to_explore:
+            case None:
+                self._nodes_to_explore = set(ast_node_types_generator())
+            case [str(), *other_node_types] if all(
+                isinstance(node_type, str) for node_type in other_node_types
+            ):
+                self._nodes_to_explore = {
+                    node_type.removeprefix('ast.') for node_type in nodes_to_explore
+                }
+            case [type(), *other_node_types] if all(
+                issubclass(node_type, ast.AST) for node_type in other_node_types
+            ):
+                self._nodes_to_explore = {
+                    cast('str', node_type.__name__) for node_type in nodes_to_explore
+                }
+            case _:
+                raise TypeError(
+                    'nodes_to_explore must be a sequence of strings or AST classes, if not None'
+                )
+
+        self.stack: list[str] = []
+        self._interactive = interactive
+
+    def _prompt_user(self, prompt: str) -> bool:
+        """
+        Prompt user (when in interactive mode) or return ``True``.
+
+        Parameters
+        ----------
+        prompt : str
+            The prompt. Supported options will be appended automatically.
+
+        Returns
+        -------
+        bool
+            Whether the user wants to explore further.
+
+        Raises
+        ------
+        SystemExit
+            This is raised when the user requests to quit.
+        """
+        if self._interactive:
+            user_input = (
+                input(f'❓ {prompt} [y]es [n]o [q]uit: ').casefold().strip()[:1]
+            )
+
+            match user_input:
+                case 'q':
+                    print('🛑 Quitting...')
+                    raise SystemExit(0)
+                case 'n':
+                    return False
+                case 'y' | '':
+                    print()
+                    return True
+                case _:
+                    print(f'🫤  Invalid response "{user_input}"')
+                    time.sleep(1)
+                    return self._prompt_user(prompt)
+
+        return True
+
+    def _show_source_code(self, node: ast.AST) -> None:
+        """
+        Show the source code for a given node (if applicable).
+
+        Parameters
+        ----------
+        node : ast.AST
+            The node to explore.
+        """
+        try:
+            print_source_code(self._source_code, node)
+
+            if self._prompt_user('Show location fields?'):
+                location_fields = [
+                    'lineno',
+                    'end_lineno',
+                    'col_offset',
+                    'end_col_offset',
+                ]
+                gap = max(len(field) for field in location_fields)
+                print(
+                    '📍 Location in the source code:',
+                    *[
+                        f'   - {key:<{gap + 1}}: {getattr(node, key)}'
+                        for key in location_fields
+                    ],
+                    sep='\n',
+                    end='\n\n',
+                )
+        except (AttributeError, TypeError):
+            print('\n📍 This node type does not have any line number information.\n')
+
+    def _show_node_specific_fields(self, node: ast.AST) -> None:
+        """
+        Show node-specific fields and their values.
+
+        Parameters
+        ----------
+        node : ast.AST
+            The node to explore.
+        """
+        if self._prompt_user('Do you want more information on this node?'):
+            match node:
+                case ast.Load() | ast.Store() | ast.Del():
+                    print(
+                        '💡 This node specifies the context in which a variable',
+                        '(ast.Name) is used.',
+                    )
+                case ast.Module():
+                    print('📝', end=' ')
+                    if docstring := ast.get_docstring(node):
+                        print(f'Module docstring: {reprlib.repr(docstring)}')
+                    else:
+                        print('Docstring is missing.')
+                    print()
+                case _:
+                    with contextlib.suppress(TypeError):
+                        if not ast.get_docstring(node):  # type: ignore[arg-type]
+                            print('📝 Docstring is missing.\n')
+
+            if node_specific_fields := [
+                (key, reprlib.repr(value)) for key, value in ast.iter_fields(node)
+            ]:
+                gap = max(len(key) for key, _ in node_specific_fields)
+                print(
+                    '✨ AST node-specific fields and their values:',
+                    *[
+                        f'   - {key:<{gap + 1}}: {value}'
+                        for key, value in node_specific_fields
+                    ],
+                    sep='\n',
+                )
+
+    def _explore(self, node: ast.AST) -> None:
+        """
+        Explore an AST node.
+
+        Parameters
+        ----------
+        node : ast.AST
+            The node to explore.
+        """
+        node_name = node.__class__.__name__
+        node_class = f'{node.__module__}.{node_name}'
+
+        if node_name in self._nodes_to_explore:
+            list_item = (
+                f'{next(self._nodes_visited)}. {node_name} '
+                f'(https://docs.python.org/{PYTHON_VERSION}/library/ast.html#{node_class})'
+            )
+            print_header(list_item, '*')
+
+            print(
+                '🌲 Path to this node from the root node of the AST:',
+                ' -> '.join(self.stack),
+                sep='\n   ',
+            )
+
+            self._show_source_code(node)
+            self._show_node_specific_fields(node)
+            print()
+
+            if not self._prompt_user('Continue traversal?'):
+                print('🛑 Stopping traversal...')
+                raise SystemExit(0)
+
+            if self._interactive:
+                print(f'🚀 Leaving {node_name} node...')
+                print()
+
+    def generic_visit(self, node: ast.AST) -> None:
+        """
+        Visit each node, with the option to explore before continuing the traversal.
+
+        Parameters
+        ----------
+        node : ast.AST
+            The AST node to visit.
+        """
+        self.stack.append(node.__class__.__name__)
+        self._explore(node)
+        super().generic_visit(node)
+        self.stack.pop()
+
+    def run(self) -> None:
+        """Traverse the AST from the root to the leaves."""
+        print('✅ Ready to explore the AST! Starting depth-first traversal...\n')
+        self.visit(self.tree)
+        print_section_divider('*')
+        print('🏆 Traversal completed!')

ast_explore-0.1.0.dist-info/METADATA

@@ -0,0 +1,482 @@
+Metadata-Version: 2.4
+Name: ast-explore
+Version: 0.1.0
+Summary: Tool for exploring the AST of given Python source code.
+Project-URL: Documentation, https://github.com/stefmolin/ast-explore
+Project-URL: Homepage, https://github.com/stefmolin/ast-explore
+Project-URL: Source, https://github.com/stefmolin/ast-explore
+Author-email: Stefanie Molin <ast-explore@stefaniemolin.com>
+License:                                  Apache License
+                                   Version 2.0, January 2004
+                                http://www.apache.org/licenses/
+        
+           TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+        
+           1. Definitions.
+        
+              "License" shall mean the terms and conditions for use, reproduction,
+              and distribution as defined by Sections 1 through 9 of this document.
+        
+              "Licensor" shall mean the copyright owner or entity authorized by
+              the copyright owner that is granting the License.
+        
+              "Legal Entity" shall mean the union of the acting entity and all
+              other entities that control, are controlled by, or are under common
+              control with that entity. For the purposes of this definition,
+              "control" means (i) the power, direct or indirect, to cause the
+              direction or management of such entity, whether by contract or
+              otherwise, or (ii) ownership of fifty percent (50%) or more of the
+              outstanding shares, or (iii) beneficial ownership of such entity.
+        
+              "You" (or "Your") shall mean an individual or Legal Entity
+              exercising permissions granted by this License.
+        
+              "Source" form shall mean the preferred form for making modifications,
+              including but not limited to software source code, documentation
+              source, and configuration files.
+        
+              "Object" form shall mean any form resulting from mechanical
+              transformation or translation of a Source form, including but
+              not limited to compiled object code, generated documentation,
+              and conversions to other media types.
+        
+              "Work" shall mean the work of authorship, whether in Source or
+              Object form, made available under the License, as indicated by a
+              copyright notice that is included in or attached to the work
+              (an example is provided in the Appendix below).
+        
+              "Derivative Works" shall mean any work, whether in Source or Object
+              form, that is based on (or derived from) the Work and for which the
+              editorial revisions, annotations, elaborations, or other modifications
+              represent, as a whole, an original work of authorship. For the purposes
+              of this License, Derivative Works shall not include works that remain
+              separable from, or merely link (or bind by name) to the interfaces of,
+              the Work and Derivative Works thereof.
+        
+              "Contribution" shall mean any work of authorship, including
+              the original version of the Work and any modifications or additions
+              to that Work or Derivative Works thereof, that is intentionally
+              submitted to Licensor for inclusion in the Work by the copyright owner
+              or by an individual or Legal Entity authorized to submit on behalf of
+              the copyright owner. For the purposes of this definition, "submitted"
+              means any form of electronic, verbal, or written communication sent
+              to the Licensor or its representatives, including but not limited to
+              communication on electronic mailing lists, source code control systems,
+              and issue tracking systems that are managed by, or on behalf of, the
+              Licensor for the purpose of discussing and improving the Work, but
+              excluding communication that is conspicuously marked or otherwise
+              designated in writing by the copyright owner as "Not a Contribution."
+        
+              "Contributor" shall mean Licensor and any individual or Legal Entity
+              on behalf of whom a Contribution has been received by Licensor and
+              subsequently incorporated within the Work.
+        
+           2. Grant of Copyright License. Subject to the terms and conditions of
+              this License, each Contributor hereby grants to You a perpetual,
+              worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+              copyright license to reproduce, prepare Derivative Works of,
+              publicly display, publicly perform, sublicense, and distribute the
+              Work and such Derivative Works in Source or Object form.
+        
+           3. Grant of Patent License. Subject to the terms and conditions of
+              this License, each Contributor hereby grants to You a perpetual,
+              worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+              (except as stated in this section) patent license to make, have made,
+              use, offer to sell, sell, import, and otherwise transfer the Work,
+              where such license applies only to those patent claims licensable
+              by such Contributor that are necessarily infringed by their
+              Contribution(s) alone or by combination of their Contribution(s)
+              with the Work to which such Contribution(s) was submitted. If You
+              institute patent litigation against any entity (including a
+              cross-claim or counterclaim in a lawsuit) alleging that the Work
+              or a Contribution incorporated within the Work constitutes direct
+              or contributory patent infringement, then any patent licenses
+              granted to You under this License for that Work shall terminate
+              as of the date such litigation is filed.
+        
+           4. Redistribution. You may reproduce and distribute copies of the
+              Work or Derivative Works thereof in any medium, with or without
+              modifications, and in Source or Object form, provided that You
+              meet the following conditions:
+        
+              (a) You must give any other recipients of the Work or
+                  Derivative Works a copy of this License; and
+        
+              (b) You must cause any modified files to carry prominent notices
+                  stating that You changed the files; and
+        
+              (c) You must retain, in the Source form of any Derivative Works
+                  that You distribute, all copyright, patent, trademark, and
+                  attribution notices from the Source form of the Work,
+                  excluding those notices that do not pertain to any part of
+                  the Derivative Works; and
+        
+              (d) If the Work includes a "NOTICE" text file as part of its
+                  distribution, then any Derivative Works that You distribute must
+                  include a readable copy of the attribution notices contained
+                  within such NOTICE file, excluding those notices that do not
+                  pertain to any part of the Derivative Works, in at least one
+                  of the following places: within a NOTICE text file distributed
+                  as part of the Derivative Works; within the Source form or
+                  documentation, if provided along with the Derivative Works; or,
+                  within a display generated by the Derivative Works, if and
+                  wherever such third-party notices normally appear. The contents
+                  of the NOTICE file are for informational purposes only and
+                  do not modify the License. You may add Your own attribution
+                  notices within Derivative Works that You distribute, alongside
+                  or as an addendum to the NOTICE text from the Work, provided
+                  that such additional attribution notices cannot be construed
+                  as modifying the License.
+        
+              You may add Your own copyright statement to Your modifications and
+              may provide additional or different license terms and conditions
+              for use, reproduction, or distribution of Your modifications, or
+              for any such Derivative Works as a whole, provided Your use,
+              reproduction, and distribution of the Work otherwise complies with
+              the conditions stated in this License.
+        
+           5. Submission of Contributions. Unless You explicitly state otherwise,
+              any Contribution intentionally submitted for inclusion in the Work
+              by You to the Licensor shall be under the terms and conditions of
+              this License, without any additional terms or conditions.
+              Notwithstanding the above, nothing herein shall supersede or modify
+              the terms of any separate license agreement you may have executed
+              with Licensor regarding such Contributions.
+        
+           6. Trademarks. This License does not grant permission to use the trade
+              names, trademarks, service marks, or product names of the Licensor,
+              except as required for reasonable and customary use in describing the
+              origin of the Work and reproducing the content of the NOTICE file.
+        
+           7. Disclaimer of Warranty. Unless required by applicable law or
+              agreed to in writing, Licensor provides the Work (and each
+              Contributor provides its Contributions) on an "AS IS" BASIS,
+              WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+              implied, including, without limitation, any warranties or conditions
+              of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+              PARTICULAR PURPOSE. You are solely responsible for determining the
+              appropriateness of using or redistributing the Work and assume any
+              risks associated with Your exercise of permissions under this License.
+        
+           8. Limitation of Liability. In no event and under no legal theory,
+              whether in tort (including negligence), contract, or otherwise,
+              unless required by applicable law (such as deliberate and grossly
+              negligent acts) or agreed to in writing, shall any Contributor be
+              liable to You for damages, including any direct, indirect, special,
+              incidental, or consequential damages of any character arising as a
+              result of this License or out of the use or inability to use the
+              Work (including but not limited to damages for loss of goodwill,
+              work stoppage, computer failure or malfunction, or any and all
+              other commercial damages or losses), even if such Contributor
+              has been advised of the possibility of such damages.
+        
+           9. Accepting Warranty or Additional Liability. While redistributing
+              the Work or Derivative Works thereof, You may choose to offer,
+              and charge a fee for, acceptance of support, warranty, indemnity,
+              or other liability obligations and/or rights consistent with this
+              License. However, in accepting such obligations, You may act only
+              on Your own behalf and on Your sole responsibility, not on behalf
+              of any other Contributor, and only if You agree to indemnify,
+              defend, and hold each Contributor harmless for any liability
+              incurred by, or claims asserted against, such Contributor by reason
+              of your accepting any such warranty or additional liability.
+        
+           END OF TERMS AND CONDITIONS
+        
+           APPENDIX: How to apply the Apache License to your work.
+        
+              To apply the Apache License to your work, attach the following
+              boilerplate notice, with the fields enclosed by brackets "[]"
+              replaced with your own identifying information. (Don't include
+              the brackets!)  The text should be enclosed in the appropriate
+              comment syntax for the file format. We also recommend that a
+              file or class name and description of purpose be included on the
+              same "printed page" as the copyright notice for easier
+              identification within third-party archives.
+        
+           Copyright [yyyy] [name of copyright owner]
+        
+           Licensed under the Apache License, Version 2.0 (the "License");
+           you may not use this file except in compliance with the License.
+           You may obtain a copy of the License at
+        
+               http://www.apache.org/licenses/LICENSE-2.0
+        
+           Unless required by applicable law or agreed to in writing, software
+           distributed under the License is distributed on an "AS IS" BASIS,
+           WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+           See the License for the specific language governing permissions and
+           limitations under the License.
+License-File: LICENSE
+Keywords: ast,ast explainer,ast explorer,ast viewer
+Classifier: Development Status :: 3 - Alpha
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+
+# ast-explore
+
+Tool for exploring the AST of given Python source code.
+
+## Installation
+
+This package is available on PyPI. To use it, you can either install with `pip`:
+
+```shell
+pip install ast-explore
+```
+
+or use it with `uv` directly:
+
+```shell
+uvx ast-explore --help
+```
+
+## Usage
+
+At a minimum, you must provide a Python file to analyze:
+
+```shell
+# previously-installed with pip:
+ast-explore source_code.py
+
+# with uv:
+uvx ast-explore source_code.py
+```
+
+This will extract all possible data points from every node in the AST generated from that source code and print it to the screen. You may wish to pipe the results to a file or `less` to process.
+
+Here's a partial example of the output:
+
+```
+📖 Reading Python source code from /.../source_code.py...
+🔍 Parsing into a Python 3.14 AST...
+✅ Ready to explore the AST! Starting depth-first traversal...
+
+********************************************************************************
+**    1. Module (https://docs.python.org/3.14/library/ast.html#ast.Module)    **
+********************************************************************************
+
+🌲 Path to this node from the root node of the AST:
+   Module
+
+📍 This node type does not have any line number information.
+
+📝 Docstring is missing.
+
+✨ AST node-specific fields and their values:
+   - body         : [FunctionDef(n...ype_params=[])]
+   - type_ignores : []
+
+********************************************************************************
+ 2. FunctionDef (https://docs.python.org/3.14/library/ast.html#ast.FunctionDef)
+********************************************************************************
+
+🌲 Path to this node from the root node of the AST:
+   Module -> FunctionDef
+
+🐍 Source code represented by the node:
+   1 | def strip_password(x: dict[str, str]) -> None:
+   2 |     try:
+   3 |         del x['password']
+   4 |     except KeyError:
+   5 |         pass
+
+📍 Location in the source code:
+   - lineno         : 1
+   - end_lineno     : 5
+   - col_offset     : 0
+   - end_col_offset : 12
+
+📝 Docstring is missing.
+
+✨ AST node-specific fields and their values:
+   - name           : 'strip_password'
+   - args           : arguments(pos..., defaults=[])
+   - body           : [Try(body=[Del... finalbody=[])]
+   - decorator_list : []
+   - returns        : Constant(value...ne, kind=None)
+   - type_comment   : None
+   - type_params    : []
+
+********************************************************************************
+   3. arguments (https://docs.python.org/3.14/library/ast.html#ast.arguments)
+********************************************************************************
+
+🌲 Path to this node from the root node of the AST:
+   Module -> FunctionDef -> arguments
+
+📍 This node type does not have any line number information.
+
+✨ AST node-specific fields and their values:
+   - posonlyargs : []
+   - args        : [arg(arg='x', ..._comment=None)]
+   - vararg      : None
+   - kwonlyargs  : []
+   - kw_defaults : []
+   - kwarg       : None
+   - defaults    : []
+
+********************************************************************************
+**       4. arg (https://docs.python.org/3.14/library/ast.html#ast.arg)       **
+********************************************************************************
+
+🌲 Path to this node from the root node of the AST:
+   Module -> FunctionDef -> arguments -> arg
+
+🐍 Source code represented by the node:
+   1 | def strip_password(x: dict[str, str]) -> None:
+     |                    ^^^^^^^^^^^^^^^^^
+
+📍 Location in the source code:
+   - lineno         : 1
+   - end_lineno     : 1
+   - col_offset     : 19
+   - end_col_offset : 36
+
+✨ AST node-specific fields and their values:
+   - arg          : 'x'
+   - annotation   : Subscript(val...), ctx=Load())
+   - type_comment : None
+```
+
+### Specifying nodes of interest
+
+Use the `--types` argument to list the nodes you want to explore and only information about those nodes will be shown. Here, we only care about function definition nodes:
+
+```shell
+# previously-installed with pip:
+ast-explore source_code.py --types FunctionDef AsyncFunctionDef
+
+# with uv:
+uvx ast-explore source_code.py --types FunctionDef AsyncFunctionDef
+```
+
+Here's an example of the result (there are no async functions in the file analyzed):
+
+```
+📖 Reading Python source code from /.../source-code.py...
+🔍 Parsing into a Python 3.14 AST...
+✅ Ready to explore the AST! Starting depth-first traversal...
+
+********************************************************************************
+ 1. FunctionDef (https://docs.python.org/3.14/library/ast.html#ast.FunctionDef)
+********************************************************************************
+
+🌲 Path to this node from the root node of the AST:
+   Module -> FunctionDef
+
+🐍 Source code represented by the node:
+   1 | def strip_password(x: dict[str, str]) -> None:
+   2 |     try:
+   3 |         del x['password']
+   4 |     except KeyError:
+   5 |         pass
+
+📍 Location in the source code:
+   - lineno         : 1
+   - end_lineno     : 5
+   - col_offset     : 0
+   - end_col_offset : 12
+
+📝 Docstring is missing.
+
+✨ AST node-specific fields and their values:
+   - name           : 'strip_password'
+   - args           : arguments(pos..., defaults=[])
+   - body           : [Try(body=[Del... finalbody=[])]
+   - decorator_list : []
+   - returns        : Constant(value...ne, kind=None)
+   - type_comment   : None
+   - type_params    : []
+
+********************************************************************************
+
+🏆 Traversal completed!
+```
+
+### Interactive mode
+
+Use interactive mode to step through the AST one node at a time:
+
+```shell
+# previously-installed with pip:
+ast-explore source_code.py --interactive
+
+# with uv:
+uvx ast-explore source_code.py --interactive
+```
+
+Here's what that looks like:
+
+```
+📖 Reading Python source code from /.../source_code.py...
+🔍 Parsing into a Python 3.14 AST...
+✅ Ready to explore the AST! Starting depth-first traversal...
+
+********************************************************************************
+**    1. Module (https://docs.python.org/3.14/library/ast.html#ast.Module)    **
+********************************************************************************
+
+🌲 Path to this node from the root node of the AST:
+   Module
+
+📍 This node type does not have any line number information.
+
+❓ Do you want more information on this node? [y]es [n]o [q]uit:
+```
+
+Of course, you can combine `--interactive` with `--types` to customize your exploration. Here we interactively visit all `try` blocks:
+
+```shell
+# previously-installed with pip:
+ast-explore source_code.py --interactive --types Try
+
+# with uv:
+uvx ast-explore source_code.py --interactive --types Try
+```
+
+Note that the first node we encounter is now the `ast.Try` node and not the `ast.Module` node we saw without specifying `--types`:
+
+```
+📖 Reading Python source code from /.../source_code.py...
+🔍 Parsing into a Python 3.14 AST...
+✅ Ready to explore the AST! Starting depth-first traversal...
+
+********************************************************************************
+**       1. Try (https://docs.python.org/3.14/library/ast.html#ast.Try)       **
+********************************************************************************
+
+🌲 Path to this node from the root node of the AST:
+   Module -> FunctionDef -> Try
+
+🐍 Source code represented by the node:
+   2 |     try:
+   3 |         del x['password']
+   4 |     except KeyError:
+   5 |         pass
+
+❓ Show location fields? [y]es [n]o [q]uit: y
+
+📍 Location in the source code:
+   - lineno         : 2
+   - end_lineno     : 5
+   - col_offset     : 4
+   - end_col_offset : 12
+
+❓ Do you want more information on this node? [y]es [n]o [q]uit: y
+
+✨ AST node-specific fields and their values:
+   - body      : [Delete(target..., ctx=Del())])]
+   - handlers  : [ExceptHandler...body=[Pass()])]
+   - orelse    : []
+   - finalbody : []
+
+❓ Continue traversal? [y]es [n]o [q]uit:
+```

ast_explore-0.1.0.dist-info/RECORD

@@ -0,0 +1,9 @@
+ast_explore/__init__.py,sha256=Y7ZwoeiSsIeRE5DONj16amYHASjgp2sxFutyD7CaW4s,1262
+ast_explore/cli.py,sha256=5d5I98tx_mthgEVMp7k9ohHGt9azL9oCJF9YiwWdM8I,3221
+ast_explore/display.py,sha256=S7xi2rbCc9ynLfEmpfJx0kw6AGFrFnvPBRzu1OlAc9M,3421
+ast_explore/explorer.py,sha256=i5sh28hZKbvFImN8ZaEcGg9p8UKXbEmpiLC5jWywxSc,8710
+ast_explore-0.1.0.dist-info/METADATA,sha256=oQyODg7pkcWs17DasdN533EGZDYi4hcmH78xsYQyR-c,21892
+ast_explore-0.1.0.dist-info/WHEEL,sha256=mffPy8wBnZQn2VnJUU5jE99KsxaSfiyMHV9Yt0aLVxs,87
+ast_explore-0.1.0.dist-info/entry_points.txt,sha256=ALv810QHY9nNXMNkVxcDeSXkLp15rDWoU57lXJ3iUz4,53
+ast_explore-0.1.0.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+ast_explore-0.1.0.dist-info/RECORD,,

ast_explore-0.1.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.30.1
+Root-Is-Purelib: true
+Tag: py3-none-any

ast_explore-0.1.0.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+ast-explore = ast_explore.cli:main

ast_explore-0.1.0.dist-info/licenses/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.