postgast 0.0.1__tar.gz

postgast-0.0.1/.gitignore

@@ -0,0 +1,212 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+
+# C extensions (except vendored submodule)
+*.so
+!vendor/**/*.so
+
+# Vendored native libraries placed by build hook (not checked in)
+src/postgast/libpg_query.*
+src/postgast/pg_query.dll
+
+# 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
+
+# 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
+
+# Cursor
+#  Cursor is an AI-powered code editor. `.cursorignore` specifies files/directories to
+#  exclude from AI features like autocomplete and code analysis. Recommended for sensitive data
+#  refer to https://docs.cursor.com/context/ignore-files
+.cursorignore
+.cursorindexingignore
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/

postgast-0.0.1/LICENSE

@@ -0,0 +1,24 @@
+BSD 2-Clause License
+
+Copyright (c) 2026, Edward Jones
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

postgast-0.0.1/PKG-INFO

@@ -0,0 +1,122 @@
+Metadata-Version: 2.4
+Name: postgast
+Version: 0.0.1
+Summary: Python bindings to libpg_query — parse, deparse, normalize, fingerprint, split, and scan PostgreSQL SQL
+Project-URL: Homepage, https://github.com/eddieland/postgast
+Project-URL: Repository, https://github.com/eddieland/postgast
+Project-URL: Issues, https://github.com/eddieland/postgast/issues
+Project-URL: Changelog, https://github.com/eddieland/postgast/releases
+Project-URL: Documentation, https://postgast.readthedocs.io
+Author-email: Edward Jones <edwardrjones97@gmail.com>
+License-Expression: BSD-2-Clause
+License-File: LICENSE
+Keywords: ast,libpg_query,parser,postgresql,sql
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: BSD License
+Classifier: Operating System :: MacOS
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+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 :: Database
+Classifier: Topic :: Software Development :: Libraries
+Classifier: Typing :: Typed
+Requires-Python: >=3.10
+Requires-Dist: protobuf
+Provides-Extra: docs
+Requires-Dist: furo>=2024.8; extra == 'docs'
+Requires-Dist: sphinx-autodoc-typehints>=2.0; extra == 'docs'
+Requires-Dist: sphinx-copybutton>=0.5; extra == 'docs'
+Requires-Dist: sphinx>=8.0; extra == 'docs'
+Provides-Extra: recipes
+Requires-Dist: marimo>=0.10; extra == 'recipes'
+Requires-Dist: pyzmq>=27.1.0; extra == 'recipes'
+Description-Content-Type: text/markdown
+
+# postgast
+
+[![PyPI](https://img.shields.io/pypi/v/postgast)](https://pypi.org/project/postgast/)
+[![Python](https://img.shields.io/pypi/pyversions/postgast)](https://pypi.org/project/postgast/)
+[![License](https://img.shields.io/pypi/l/postgast)](https://github.com/eddieland/postgast/blob/main/LICENSE)
+[![CI](https://img.shields.io/github/actions/workflow/status/eddieland/postgast/ci.yml?label=CI)](https://github.com/eddieland/postgast/actions/workflows/ci.yml)
+[![Coverage](https://codecov.io/gh/eddieland/postgast/graph/badge.svg)](https://codecov.io/gh/eddieland/postgast)
+[![Docs](https://readthedocs.org/projects/postgast/badge/?version=latest)](https://postgast.readthedocs.io)
+[![Downloads](https://img.shields.io/pypi/dm/postgast)](https://pypi.org/project/postgast/)
+
+BSD-licensed Python bindings to [libpg_query](https://github.com/pganalyze/libpg_query), the PostgreSQL parser extracted
+as a standalone C library.
+
+Parse, deparse, normalize, fingerprint, split, and scan PostgreSQL SQL statements from Python with a minimal dependency
+footprint — just `protobuf` and the vendored C library.
+
+## Features
+
+| Feature          | Status                                    | Description                                                                |
+| ---------------- | ----------------------------------------- | -------------------------------------------------------------------------- |
+| **Parse**        | [Available](openspec/specs/parse/)        | SQL text to protobuf AST                                                   |
+| **Deparse**      | [Available](openspec/specs/deparse/)      | AST back to SQL text                                                       |
+| **Normalize**    | [Available](openspec/specs/normalize/)    | Replace constants with parameter placeholders                              |
+| **Fingerprint**  | [Available](openspec/specs/fingerprint/)  | Identify structurally equivalent statements                                |
+| **Split**        | [Available](openspec/specs/split/)        | Split multi-statement strings (respects strings, comments, dollar-quoting) |
+| **Scan**         | [Available](openspec/specs/scan/)         | Tokenize SQL with keyword classification                                   |
+| **Tree Walking** | [Available](openspec/specs/tree-walking/) | Walk/visit AST nodes with depth-first traversal and visitor pattern        |
+| **AST Helpers**  | [Available](openspec/specs/ast-helpers/)  | Extract tables, columns, functions; generate DROP from CREATE DDL          |
+
+Built on `libpg_query` 17-latest (PostgreSQL 17 parser).
+
+## Installation
+
+```bash
+pip install postgast
+```
+
+## Quick Start
+
+```python
+import postgast
+
+# Parse a query into an AST
+tree = postgast.parse("SELECT id, name FROM users WHERE active = true")
+
+# Deparse an AST back to SQL
+sql = postgast.deparse(tree)
+
+# Normalize a query (replace constants with placeholders)
+normalized = postgast.normalize("SELECT * FROM users WHERE id = 42")
+# => "SELECT * FROM users WHERE id = $1"
+
+# Fingerprint a query
+fp = postgast.fingerprint("SELECT * FROM users WHERE id = 42")
+
+# Split a multi-statement string
+stmts = postgast.split("SELECT 1; SELECT 2;")
+# => ["SELECT 1", "SELECT 2"]
+```
+
+## Motivation
+
+[pglast](https://github.com/lelit/pglast) is an excellent library that wraps `libpg_query` for Python, but it is
+licensed under GPLv3, which makes it unusable in many commercial and permissively-licensed projects. `postgast` provides
+a BSD-licensed alternative that leans directly on `libpg_query`'s C API via `ctypes`, keeping the implementation minimal
+and the dependency footprint small.
+
+## How It Works
+
+`postgast` calls `libpg_query`'s C functions directly through Python's `ctypes` module. Parse results are returned as
+protobuf messages, deserialized into Python objects. There is no Cython, no Rust, and no C extension module to compile —
+just a vendored shared library and pure Python on top.
+
+## License
+
+BSD 2-Clause. See [LICENSE](LICENSE) for details.
+
+`libpg_query` is licensed under the
+[BSD 3-Clause License](https://github.com/pganalyze/libpg_query/blob/17-latest/LICENSE). Portions of the PostgreSQL
+source code used by `libpg_query` are licensed under the
+[PostgreSQL License](https://www.postgresql.org/about/licence/).

postgast-0.0.1/README.md

@@ -0,0 +1,81 @@
+# postgast
+
+[![PyPI](https://img.shields.io/pypi/v/postgast)](https://pypi.org/project/postgast/)
+[![Python](https://img.shields.io/pypi/pyversions/postgast)](https://pypi.org/project/postgast/)
+[![License](https://img.shields.io/pypi/l/postgast)](https://github.com/eddieland/postgast/blob/main/LICENSE)
+[![CI](https://img.shields.io/github/actions/workflow/status/eddieland/postgast/ci.yml?label=CI)](https://github.com/eddieland/postgast/actions/workflows/ci.yml)
+[![Coverage](https://codecov.io/gh/eddieland/postgast/graph/badge.svg)](https://codecov.io/gh/eddieland/postgast)
+[![Docs](https://readthedocs.org/projects/postgast/badge/?version=latest)](https://postgast.readthedocs.io)
+[![Downloads](https://img.shields.io/pypi/dm/postgast)](https://pypi.org/project/postgast/)
+
+BSD-licensed Python bindings to [libpg_query](https://github.com/pganalyze/libpg_query), the PostgreSQL parser extracted
+as a standalone C library.
+
+Parse, deparse, normalize, fingerprint, split, and scan PostgreSQL SQL statements from Python with a minimal dependency
+footprint — just `protobuf` and the vendored C library.
+
+## Features
+
+| Feature          | Status                                    | Description                                                                |
+| ---------------- | ----------------------------------------- | -------------------------------------------------------------------------- |
+| **Parse**        | [Available](openspec/specs/parse/)        | SQL text to protobuf AST                                                   |
+| **Deparse**      | [Available](openspec/specs/deparse/)      | AST back to SQL text                                                       |
+| **Normalize**    | [Available](openspec/specs/normalize/)    | Replace constants with parameter placeholders                              |
+| **Fingerprint**  | [Available](openspec/specs/fingerprint/)  | Identify structurally equivalent statements                                |
+| **Split**        | [Available](openspec/specs/split/)        | Split multi-statement strings (respects strings, comments, dollar-quoting) |
+| **Scan**         | [Available](openspec/specs/scan/)         | Tokenize SQL with keyword classification                                   |
+| **Tree Walking** | [Available](openspec/specs/tree-walking/) | Walk/visit AST nodes with depth-first traversal and visitor pattern        |
+| **AST Helpers**  | [Available](openspec/specs/ast-helpers/)  | Extract tables, columns, functions; generate DROP from CREATE DDL          |
+
+Built on `libpg_query` 17-latest (PostgreSQL 17 parser).
+
+## Installation
+
+```bash
+pip install postgast
+```
+
+## Quick Start
+
+```python
+import postgast
+
+# Parse a query into an AST
+tree = postgast.parse("SELECT id, name FROM users WHERE active = true")
+
+# Deparse an AST back to SQL
+sql = postgast.deparse(tree)
+
+# Normalize a query (replace constants with placeholders)
+normalized = postgast.normalize("SELECT * FROM users WHERE id = 42")
+# => "SELECT * FROM users WHERE id = $1"
+
+# Fingerprint a query
+fp = postgast.fingerprint("SELECT * FROM users WHERE id = 42")
+
+# Split a multi-statement string
+stmts = postgast.split("SELECT 1; SELECT 2;")
+# => ["SELECT 1", "SELECT 2"]
+```
+
+## Motivation
+
+[pglast](https://github.com/lelit/pglast) is an excellent library that wraps `libpg_query` for Python, but it is
+licensed under GPLv3, which makes it unusable in many commercial and permissively-licensed projects. `postgast` provides
+a BSD-licensed alternative that leans directly on `libpg_query`'s C API via `ctypes`, keeping the implementation minimal
+and the dependency footprint small.
+
+## How It Works
+
+`postgast` calls `libpg_query`'s C functions directly through Python's `ctypes` module. Parse results are returned as
+protobuf messages, deserialized into Python objects. There is no Cython, no Rust, and no C extension module to compile —
+just a vendored shared library and pure Python on top.
+
+## License
+
+BSD 2-Clause. See [LICENSE](LICENSE) for details.
+
+`libpg_query` is licensed under the
+[BSD 3-Clause License](https://github.com/pganalyze/libpg_query/blob/17-latest/LICENSE). Portions of the PostgreSQL
+source code used by `libpg_query` are licensed under the
+[PostgreSQL License](https://www.postgresql.org/about/licence/).

postgast-0.0.1/hatch_build.py

@@ -0,0 +1,75 @@
+"""Custom hatchling build hook that compiles libpg_query and bundles the shared library."""
+
+from __future__ import annotations
+
+import os
+import platform
+import subprocess
+from pathlib import Path
+from typing import Any
+
+from hatchling.builders.hooks.plugin.interface import BuildHookInterface
+
+_LIB_NAMES = {
+    "Linux": "libpg_query.so",
+    "Darwin": "libpg_query.dylib",
+    "Windows": "pg_query.dll",
+}
+
+
+class CustomBuildHook(BuildHookInterface):
+    """Build hook that compiles libpg_query and includes it in the wheel."""
+
+    PLUGIN_NAME = "custom"
+
+    def initialize(self, version: str, build_data: dict[str, Any]) -> None:
+        """Compile libpg_query and inject the shared library into the wheel.
+
+        Set ``POSTGAST_SKIP_NATIVE_BUILD=1`` to skip compilation (useful in CI
+        where the native library is built in a separate step).
+        """
+        if os.environ.get("POSTGAST_SKIP_NATIVE_BUILD"):
+            self.app.display_warning("POSTGAST_SKIP_NATIVE_BUILD is set — skipping native library build.")
+            return
+
+        root = Path(self.root)
+        libpg_query_dir = root / "vendor" / "libpg_query"
+
+        makefile = libpg_query_dir / "Makefile"
+        if not makefile.exists():
+            self.app.display_warning(
+                "vendor/libpg_query/Makefile not found — skipping native library build. "
+                "Run 'git submodule update --init' to fetch the source."
+            )
+            return
+
+        system = platform.system()
+        lib_name = _LIB_NAMES.get(system)
+        if lib_name is None:
+            msg = f"Unsupported platform: {system}"
+            raise RuntimeError(msg)
+
+        # Compile the shared library.
+        if system == "Windows":
+            subprocess.check_call(["nmake", "/F", "Makefile.msvc"], cwd=libpg_query_dir)
+        else:
+            subprocess.check_call(["make", "build_shared"], cwd=libpg_query_dir)
+
+        lib_path = libpg_query_dir / lib_name
+        if not lib_path.exists():
+            msg = f"Expected shared library not found after build: {lib_path}"
+            raise RuntimeError(msg)
+
+        # Include the shared library in the wheel alongside the postgast package.
+        build_data["force_include"][str(lib_path)] = f"postgast/{lib_name}"
+
+        # Mark as platform-specific wheel (not pure Python).
+        build_data["infer_tag"] = True
+        build_data["pure_python"] = False
+
+    def clean(self, versions: list[str]) -> None:
+        """Remove compiled artifacts from the vendor directory."""
+        root = Path(self.root)
+        libpg_query_dir = root / "vendor" / "libpg_query"
+        if libpg_query_dir.exists():
+            subprocess.call(["make", "clean"], cwd=libpg_query_dir)