ast-pattern-engine 0.1.0__tar.gz → 1.0.0__tar.gz

ast_pattern_engine-1.0.0/.github/workflows/ci.yml

@@ -0,0 +1,44 @@
+name: CI
+
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    branches: [ "main" ]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.10", "3.11", "3.12", "3.13", "3.14"]
+
+    steps:
+    - uses: actions/checkout@v4
+    
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v5
+      with:
+        python-version: ${{ matrix.python-version }}
+        
+    - name: Install uv
+      uses: astral-sh/setup-uv@v5
+      with:
+        enable-cache: true
+        
+    - name: Install dependencies
+      run: uv sync --all-extras
+      
+    - name: Check formatting with Ruff
+      run: uv run ruff format --check
+      
+    - name: Lint with Ruff
+      run: uv run ruff check
+      
+    - name: Run tests with pytest
+      run: uv run pytest --cov=src --cov-report=xml
+      
+    - name: Upload coverage reports to Codecov
+      uses: codecov/codecov-action@v4
+      env:
+        CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}

ast_pattern_engine-1.0.0/.gitignore

@@ -0,0 +1,218 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#   Usually these files are written by a python script from a template
+#   before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py.cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+.python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+# Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+# poetry.lock
+# poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+# pdm.lock
+# pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+# pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# Redis
+*.rdb
+*.aof
+*.pid
+
+# RabbitMQ
+mnesia/
+rabbitmq/
+rabbitmq-data/
+
+# ActiveMQ
+activemq-data/
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#   JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#   be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#   and can be added to the global gitignore or merged into this file.  For a more nuclear
+#   option (not recommended) you can uncomment the following to ignore the entire idea folder.
+# .idea/
+
+# Abstra
+#   Abstra is an AI-powered process automation framework.
+#   Ignore directories containing user credentials, local state, and settings.
+#   Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#   Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore 
+#   that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#   and can be added to the global gitignore or merged into this file. However, if you prefer, 
+#   you could uncomment the following to ignore the entire vscode folder
+.vscode/
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/
+
+# Streamlit
+.streamlit/secrets.toml
+
+scratch/

ast_pattern_engine-1.0.0/LICENSE

@@ -0,0 +1,7 @@
+Copyright 2026 80sVectorz
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

ast_pattern_engine-1.0.0/PKG-INFO

@@ -0,0 +1,103 @@
+Metadata-Version: 2.4
+Name: ast-pattern-engine
+Version: 1.0.0
+Summary: A library for regex-inspired fine-grained AST pattern matching and replacing
+Project-URL: Homepage, https://github.com/80sVectorz/ast_pattern_engine
+Project-URL: Repository, https://github.com/80sVectorz/ast_pattern_engine
+Author-email: 80sVectorz <66908776+80sVectorz@users.noreply.github.com>
+License-File: LICENSE
+Keywords: ast,codemod,dsl,pattern-matching,refactoring
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Software Development :: Code Generators
+Classifier: Topic :: Software Development :: Compilers
+Requires-Python: >=3.10
+Provides-Extra: dev
+Requires-Dist: pytest; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# AST Pattern Engine
+
+A powerful, programmatic, regex-inspired AST pattern matching and manipulation library for Python.
+
+## Philosophy: The "Gradual Pipeline"
+
+Instead of relying on fragile regex on source code or magic string-to-AST parsers, `ast_pattern_engine` provides an internal DSL for building explicit, structural patterns. 
+
+It is designed with a "Gradual Pipeline" philosophy: instead of writing one massive, monolithic pattern expression to do everything at once, you chain small, focused patterns and visitors. Like casting a wide net and progressively filtering down in stages. 
+
+## Installation
+
+```bash
+pip install ast_pattern_engine
+```
+```bash
+uv add ast_pattern_engine
+```
+
+*(Requires Python 3.10+)*
+
+## Quick Start
+
+Here is a simple pipeline that rewrites `dict.get("key")` calls into direct subscript access `dict["key"]`:
+
+```python
+from typing import Any
+import ast
+from ast_pattern_engine import BottomUpPatternTransformer, Bind, NodePattern
+
+source = "value = my_dict.get(other_dict.get('foo'))"
+tree = ast.parse(source)
+
+# 1. Build the explicit structural pattern
+# Matches: <obj>.get(<key>)
+pattern = [
+    NodePattern(
+        ast.Call,
+        func=NodePattern(ast.Attribute, attr="get", value=Bind("obj")),
+        args=Bind("key"),
+    )
+]
+
+# 2. Define the rewrite logic
+def rewrite_dict_get(bindings: dict[str, Any]) -> list[ast.AST]:
+    obj = bindings["obj"]
+    key = bindings["key"][0]  # args is a list
+
+    # Return the new node to replace the matched node
+    new_node = ast.Subscript(value=obj, slice=key, ctx=ast.Load())
+    return [new_node]
+
+# 3. Apply the transformer
+# We use BottomUpPatternTransformer so nested `.get()` calls
+# are safely transformed from the inside-out.
+transformer = BottomUpPatternTransformer(pattern, {"key": rewrite_dict_get})
+transformer.visit(tree)
+
+print(ast.unparse(tree))
+# Output: value = my_dict[other_dict['foo']]
+```
+
+*(See the `examples/` directory for full runnable code).*
+
+## Primitives
+
+The engine provides several primitives to build robust sequences:
+- `NodePattern`: Match specific AST node types and assert on their fields.
+- `Collect` / `Bind`: Extract sub-trees out of a matched pattern to use in your handlers.
+- `OneOf`: Match one of several possible patterns (similar to regex `|`).
+- `Repetition`: Match a pattern sequentially 1 or more times (similar to regex `*` and `+`).
+- `Optional`: Match a pattern 0 or 1 times (similar to regex `?`).
+- `Filter`: Apply arbitrary Python lambdas to check node states during matching.
+
+## Templates
+
+To reduce boilerplate when building patterns, the library includes a `templates` module with helpers for common operations:
+- `match_call(func_name, **kwargs)`
+- `match_assign(target_name, value)`
+- `match_in_expr(pattern)`

ast_pattern_engine-1.0.0/README.md

@@ -0,0 +1,80 @@
+# AST Pattern Engine
+
+A powerful, programmatic, regex-inspired AST pattern matching and manipulation library for Python.
+
+## Philosophy: The "Gradual Pipeline"
+
+Instead of relying on fragile regex on source code or magic string-to-AST parsers, `ast_pattern_engine` provides an internal DSL for building explicit, structural patterns. 
+
+It is designed with a "Gradual Pipeline" philosophy: instead of writing one massive, monolithic pattern expression to do everything at once, you chain small, focused patterns and visitors. Like casting a wide net and progressively filtering down in stages. 
+
+## Installation
+
+```bash
+pip install ast_pattern_engine
+```
+```bash
+uv add ast_pattern_engine
+```
+
+*(Requires Python 3.10+)*
+
+## Quick Start
+
+Here is a simple pipeline that rewrites `dict.get("key")` calls into direct subscript access `dict["key"]`:
+
+```python
+from typing import Any
+import ast
+from ast_pattern_engine import BottomUpPatternTransformer, Bind, NodePattern
+
+source = "value = my_dict.get(other_dict.get('foo'))"
+tree = ast.parse(source)
+
+# 1. Build the explicit structural pattern
+# Matches: <obj>.get(<key>)
+pattern = [
+    NodePattern(
+        ast.Call,
+        func=NodePattern(ast.Attribute, attr="get", value=Bind("obj")),
+        args=Bind("key"),
+    )
+]
+
+# 2. Define the rewrite logic
+def rewrite_dict_get(bindings: dict[str, Any]) -> list[ast.AST]:
+    obj = bindings["obj"]
+    key = bindings["key"][0]  # args is a list
+
+    # Return the new node to replace the matched node
+    new_node = ast.Subscript(value=obj, slice=key, ctx=ast.Load())
+    return [new_node]
+
+# 3. Apply the transformer
+# We use BottomUpPatternTransformer so nested `.get()` calls
+# are safely transformed from the inside-out.
+transformer = BottomUpPatternTransformer(pattern, {"key": rewrite_dict_get})
+transformer.visit(tree)
+
+print(ast.unparse(tree))
+# Output: value = my_dict[other_dict['foo']]
+```
+
+*(See the `examples/` directory for full runnable code).*
+
+## Primitives
+
+The engine provides several primitives to build robust sequences:
+- `NodePattern`: Match specific AST node types and assert on their fields.
+- `Collect` / `Bind`: Extract sub-trees out of a matched pattern to use in your handlers.
+- `OneOf`: Match one of several possible patterns (similar to regex `|`).
+- `Repetition`: Match a pattern sequentially 1 or more times (similar to regex `*` and `+`).
+- `Optional`: Match a pattern 0 or 1 times (similar to regex `?`).
+- `Filter`: Apply arbitrary Python lambdas to check node states during matching.
+
+## Templates
+
+To reduce boilerplate when building patterns, the library includes a `templates` module with helpers for common operations:
+- `match_call(func_name, **kwargs)`
+- `match_assign(target_name, value)`
+- `match_in_expr(pattern)`

ast_pattern_engine-1.0.0/examples/dict_get_rewrite.py

@@ -0,0 +1,49 @@
+"""Dictionary get method rewrite example.
+
+This example shows how to use the AST Pattern Engine to rewrite all `dict.get("key")` calls
+into direct dictionary subscript access `dict["key"]`.
+"""
+
+from typing import Any
+import ast
+from ast_pattern_engine import BottomUpPatternTransformer, Bind, NodePattern
+
+
+def test_dict_get_rewrite() -> None:
+    source = "value = my_dict.get(other_dict.get('foo'))"
+    tree = ast.parse(source)
+
+    # 1. Build the explicit structural pattern
+    # Matches: <obj>.get(<key>)
+    pattern = [
+        NodePattern(
+            ast.Call,
+            func=NodePattern(ast.Attribute, attr="get", value=Bind("obj")),
+            args=Bind("key"),
+        )
+    ]
+
+    # 2. Define the rewrite logic
+    def rewrite_dict_get(bindings: dict[str, Any]) -> list[ast.AST]:
+        obj = bindings["obj"]
+        key = bindings["key"][0]  # args is a list
+
+        # Return the new node to replace the matched node
+        new_node = ast.Subscript(value=obj, slice=key, ctx=ast.Load())
+        return [new_node]
+
+    # 3. Apply the transformer
+    # We use BottomUpPatternTransformer so that nested `.get()` calls
+    # are transformed from the inside-out successfully.
+    transformer = BottomUpPatternTransformer(pattern, {"key": rewrite_dict_get})
+    transformer.visit(tree)
+
+    new_source = ast.unparse(tree)
+    print("Rewritten source:\n", new_source)
+
+    # Assert for validation
+    assert new_source == "value = my_dict[other_dict['foo']]"
+
+
+if __name__ == "__main__":
+    test_dict_get_rewrite()

ast_pattern_engine-1.0.0/pyproject.toml

@@ -0,0 +1,43 @@
+[project]
+name = "ast-pattern-engine"
+version = "1.0.0"
+description = "A library for regex-inspired fine-grained AST pattern matching and replacing"
+readme = "README.md"
+authors = [
+    { name = "80sVectorz", email = "66908776+80sVectorz@users.noreply.github.com" }
+]
+requires-python = ">=3.10"
+keywords = ["ast", "pattern-matching", "refactoring", "codemod", "dsl"]
+classifiers = [
+    "Intended Audience :: Developers",
+    "Topic :: Software Development :: Code Generators",
+    "Topic :: Software Development :: Compilers",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
+    "License :: OSI Approved :: MIT License",
+]
+dependencies = []
+
+[project.urls]
+Homepage = "https://github.com/80sVectorz/ast_pattern_engine"
+Repository = "https://github.com/80sVectorz/ast_pattern_engine"
+
+[project.optional-dependencies]
+dev = ["pytest"]
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[tool.pytest.ini_options]
+addopts = "-q"
+filterwarnings = "error"
+pythonpath = ["src"]
+
+[dependency-groups]
+dev = [
+    "pytest-cov>=7.1.0",
+]

ast_pattern_engine-1.0.0/src/ast_pattern_engine/__init__.py

@@ -0,0 +1,63 @@
+"""AST Pattern Engine - A programmatic, regex-inspired AST pattern matching and manipulation library."""
+
+from .core import Pattern, SequencePattern
+from .engine import match_sequence
+from .nodes.basic import (
+    NodePattern,
+    WildCard,
+    Collect,
+    Filter,
+    Not,
+    Contains,
+    AllOf,
+    AnyOf,
+    Bind,
+)
+from .nodes.sequences import (
+    Repetition,
+    PatternGroup,
+    OneOf,
+    Optional,
+)
+from .visitors import (
+    PatternTransformer,
+    BottomUpPatternTransformer,
+    PatternFinder,
+    SingleOccurrenceFinder,
+)
+from .templates import (
+    match_in_expr,
+    match_call,
+    match_assign,
+)
+
+__all__ = [
+    # Core
+    "Pattern",
+    "SequencePattern",
+    "match_sequence",
+    # Basic Nodes
+    "NodePattern",
+    "WildCard",
+    "Collect",
+    "Filter",
+    "Not",
+    "Contains",
+    "AllOf",
+    "AnyOf",
+    "Bind",
+    # Sequences
+    "Repetition",
+    "PatternGroup",
+    "OneOf",
+    "Optional",
+    # Visitors
+    "PatternTransformer",
+    "BottomUpPatternTransformer",
+    "PatternFinder",
+    "SingleOccurrenceFinder",
+    # Templates
+    "match_in_expr",
+    "match_call",
+    "match_assign",
+]

ast_pattern_engine-1.0.0/src/ast_pattern_engine/core.py

@@ -0,0 +1,29 @@
+from __future__ import annotations
+import ast
+from typing import Any
+
+
+class Pattern(ast.AST):
+    """Base class for AST matching patterns."""
+
+    # public API
+    def match_node(
+        self, node: object, bindings: dict[str, object] | None = None, *, _force_list: bool = False
+    ):
+        """Match *node* and return updated *bindings* or *None*."""
+        raise NotImplementedError
+
+    # helpers
+    @staticmethod
+    def _to_list(val: Any) -> list[Any]:
+        return val if isinstance(val, list) else [val]
+
+
+class SequencePattern(Pattern):
+    def match_node(
+        self, node: object, bindings: dict[str, object] | None = None, *, _force_list: bool = False
+    ):
+        # Matching is handled by engine._match_sequence
+        raise NotImplementedError(
+            f"{self.__class__.__name__} node does not support matching single AST node."
+        )