sqlnbfmt 0.4.0__tar.gz → 0.4.2__tar.gz

sqlnbfmt-0.4.2/.github/workflows/ci-and-publish.yml

@@ -0,0 +1,42 @@
+name: Python CI and Publish to PyPI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+  release:
+    types: [created]
+  workflow_dispatch:
+    inputs:
+      run_publish:
+        description: 'Set to true to run the publish job'
+        required: false
+        default: 'false'
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: astral-sh/setup-uv@v3
+        with:
+          enable-cache: true
+          cache-dependency-glob: "pyproject.toml"
+      - run: uv python install 3.12
+      - run: uv sync --all-extras --dev
+      - run: uv run pytest
+
+  publish:
+    needs: test
+    if: github.event_name == 'release' || (github.event_name == 'workflow_dispatch' && github.event.inputs.run_publish == 'true')
+    runs-on: ubuntu-latest
+    permissions:
+      id-token: write
+    steps:
+      - uses: actions/checkout@v4
+      - uses: astral-sh/setup-uv@v3
+        with:
+          enable-cache: true
+      - run: uv python install 3.12
+      - run: uv build --no-sources
+      - uses: pypa/gh-action-pypi-publish@release/v1

sqlnbfmt-0.4.2/.gitignore

@@ -0,0 +1,163 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$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
+
+# 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
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/latest/usage/project/#working-with-version-control
+.pdm.toml
+.pdm-python
+.pdm-build/
+
+# 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
+.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/
+.DS_STORE

sqlnbfmt-0.4.2/.pre-commit-config.yaml

@@ -0,0 +1,41 @@
+repos:
+  # Linting + formatting (Astral)
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.15.6
+    hooks:
+      - id: ruff
+        args: [--fix]
+      - id: ruff-format
+
+  # File quality + security
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v6.0.0
+    hooks:
+      - id: check-ast
+      - id: check-yaml
+      - id: check-toml
+      - id: check-json
+      - id: check-merge-conflict
+      - id: check-added-large-files
+      - id: debug-statements
+      - id: detect-private-key
+      - id: trailing-whitespace
+      - id: end-of-file-fixer
+
+  # Validate pyproject.toml against PEP 621
+  - repo: https://github.com/abravalheri/validate-pyproject
+    rev: v0.25
+    hooks:
+      - id: validate-pyproject
+
+  # Local hooks
+  - repo: local
+    hooks:
+      # Fast unit tests
+      - id: pytest-fast
+        name: pytest (fast)
+        entry: uv run pytest tests/ -x -q --timeout=10
+        language: system
+        types: [python]
+        pass_filenames: false
+        stages: [pre-push]

sqlnbfmt-0.4.2/.pre-commit-hooks.yaml

@@ -0,0 +1,35 @@
+- id: sqlnbfmt
+  name: SQL Notebook Formatter
+  description: Format SQL queries in Jupyter notebooks
+  entry: sqlnbfmt
+  language: python
+  types: [jupyter]
+  require_serial: true
+  minimum_pre_commit_version: '3.0.0'
+
+- id: sqlnbfmt-check
+  name: SQL Notebook Formatter (check)
+  description: Check SQL formatting in Jupyter notebooks without modifying files
+  entry: sqlnbfmt --check
+  language: python
+  types: [jupyter]
+  require_serial: true
+  minimum_pre_commit_version: '3.0.0'
+
+- id: sqlnbfmt-py
+  name: SQL Python File Formatter
+  description: Format SQL queries in Python files (e.g. Marimo notebooks)
+  entry: sqlnbfmt
+  language: python
+  types: [python]
+  require_serial: true
+  minimum_pre_commit_version: '3.0.0'
+
+- id: sqlnbfmt-py-check
+  name: SQL Python File Formatter (check)
+  description: Check SQL formatting in Python files without modifying files
+  entry: sqlnbfmt --check
+  language: python
+  types: [python]
+  require_serial: true
+  minimum_pre_commit_version: '3.0.0'

sqlnbfmt-0.4.2/.python-version

@@ -0,0 +1 @@
+3.12

sqlnbfmt-0.4.2/CHANGELOG.md

@@ -0,0 +1,143 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [0.4.2] - Unreleased
+
+### Added
+
+- **Jupyter server extension**: `pip install sqlnbfmt` now auto-registers with jupyterlab-code-formatter — no manual config needed
+
+### Changed
+
+- Switched build system from setuptools to hatchling
+- Updated JupyterLab docs to use `jupyter_server_config.py` (modern) instead of `jupyter_notebook_config.py` (legacy)
+
+## [0.4.0] - 2026-03-24
+
+### Added
+
+- **Marimo notebook support**: format SQL in Marimo `.py` notebooks via `mo.sql()` calls — same `sqlnbfmt` command, auto-detected by file extension
+- **Python file support**: `sqlnbfmt` now accepts `.py` files alongside `.ipynb` — works on any Python file containing SQL strings
+- **JupyterLab integration**: `sqlnbfmt.jupyterlab_integration.register()` for use with `jupyterlab-code-formatter`
+- `format_cell_source()` public API for formatting a single cell's source code
+- `_format_python_source()`, `process_python_file()`, `diff_python_file()` public API for programmatic use
+- `sql` added to default recognized function names (matches `mo.sql()`, etc.)
+- `sqlnbfmt-py` and `sqlnbfmt-py-check` pre-commit hooks for Python files
+- Marimo eval fixtures: `marimo_basic_sql`, `marimo_fstring_interpolation`, `marimo_complex_sql`, `marimo_multi_cell_mixed`, `marimo_comment_preservation`, `marimo_multi_statement`, `marimo_skip_hint`, `marimo_non_sql_unchanged`, `marimo_idempotency`
+
+### Fixed
+
+- Idempotency: already-formatted SQL in triple-quoted strings (with leading whitespace/indentation) is no longer re-formatted on every run
+
+### Changed
+
+- CLI description and help text updated to reflect multi-format support
+- Project description and keywords updated for Marimo discoverability
+
+## [0.3.2] - 2026-03-16
+
+### Fixed
+
+- Multiple SQL statements in a single cell are no longer concatenated on one line — each statement now starts on its own line after the `;` separator ([#3](https://github.com/flyersworder/sqlnbfmt/issues/3))
+
+### Changed
+
+- SQL parsing switched from `sqlglot.parse_one()` to `sqlglot.parse()` to correctly handle multi-statement inputs
+
+### Added
+
+- `multi_statement` eval fixture case covering `DROP TABLE` + `CREATE TABLE` sequences
+
+## [0.3.1] - 2026-03-15
+
+### Fixed
+
+- `diff_notebook()` no longer duplicates cell-processing logic — extracted shared `_format_cells()` helper to prevent future divergence
+- `--check --diff` combined mode no longer double-counts notebooks or processes them twice
+- Skip hint (`# sqlnbfmt: skip`) no longer triggers on string literals containing the directive — only dedicated comment lines are recognised
+- `load_config()` with a partial config file (missing keys) now falls back to built-in defaults instead of empty sets
+- `load_config()` with an empty YAML file no longer raises `AttributeError`
+- In-function SQL indentation now respects `indent_width` config instead of hardcoded 4 spaces
+
+### Added
+
+- `main()` integration tests for `--diff`, `--check`, and `--check --diff` exit code behavior
+- Docstring on `_has_skip_hint()` clarifying that inline trailing comments are intentionally ignored
+
+## [0.3.0] - 2026-03-15
+
+### Added
+
+- **Zero-config defaults**: sqlnbfmt now works out of the box without a `config.yaml` file — built-in defaults for SQL keywords, function names, and decorators
+- **`--check` mode**: verify formatting without modifying files; exits with code 1 if changes are needed (CI-friendly)
+- **`--diff` mode**: print a unified diff of formatting changes without modifying files
+- **Skip hints**: add `# sqlnbfmt: skip` to any cell to skip formatting
+- **`sqlnbfmt-check` pre-commit hook**: a read-only hook variant for CI pipelines
+- Cell index in all warning/debug messages for easier debugging
+- PyPI keywords and project URLs in package metadata
+- `skip_hint` eval fixture case
+
+### Changed
+
+- `--config` argument is now optional (defaults to built-in settings instead of requiring `config.yaml`)
+- `load_config()` accepts `None` to return defaults; passing a missing path still raises `FileNotFoundError`
+- Version bumped to 0.3.0
+
+## [0.2.0] - 2026-03-15
+
+### Fixed
+
+- Python comments in code cells are no longer stripped during formatting ([#2](https://github.com/flyersworder/sqlnbfmt/issues/2))
+
+### Changed
+
+- Replaced AST-mutation approach (`ast.NodeTransformer` + `astor` + `black`) with surgical string replacement (`ast.NodeVisitor` + offset-based text splicing), preserving all non-SQL content exactly
+- Removed `astor` and `black` from dependencies — fewer install requirements
+- CI publish now uses PyPI Trusted Publishers (OIDC) instead of API tokens
+- Migrated `tool.uv.dev-dependencies` to `dependency-groups.dev` (PEP 735)
+- Updated `actions/checkout` from v3 to v4
+
+### Added
+
+- Python 3.13 classifier
+- Comment-preservation test case
+
+### Fixed
+
+- Typo in config.yaml: `exeucte_query` → `execute_query`
+
+## [0.1.9] - 2025-01-01
+
+### Changed
+
+- Updated dependencies (attrs, black, referencing, sqlglot, typing-extensions)
+
+## [0.1.8] - 2024-12-01
+
+### Fixed
+
+- First-line indentation error for in-function SQL
+- New-line handling issues in formatted output
+- Introduced `black` formatter to resolve in-function SQL formatting edge cases
+
+## [0.1.7] - 2024-11-01
+
+### Added
+
+- Pre-commit hook support
+- F-string SQL formatting (with and without variables)
+- In-function SQL formatting (e.g., `pd.read_sql(...)`)
+
+## [0.1.0] - 2024-10-01
+
+### Added
+
+- Initial release
+- SQL formatting in Jupyter notebook code cells using sqlglot
+- Support for `%sql` / `%%sql` magic commands
+- Configurable SQL keywords, function names, and formatting options
+- GitHub Actions CI pipeline

{sqlnbfmt-0.4.0/sqlnbfmt.egg-info → sqlnbfmt-0.4.2}/PKG-INFO

@@ -1,31 +1,30 @@
 Metadata-Version: 2.4
 Name: sqlnbfmt
-Version: 0.4.0
+Version: 0.4.2
 Summary: A tool to format SQL code in Jupyter notebooks and Marimo notebooks.
-Author-email: Qing <qingye779@gmail.com>
-License: MIT
 Project-URL: Homepage, https://github.com/flyersworder/sqlnbfmt
 Project-URL: Repository, https://github.com/flyersworder/sqlnbfmt
 Project-URL: Changelog, https://github.com/flyersworder/sqlnbfmt/blob/main/CHANGELOG.md
 Project-URL: Issues, https://github.com/flyersworder/sqlnbfmt/issues
-Keywords: sql,jupyter,marimo,notebook,formatter,sqlglot,pre-commit
+Author-email: Qing <qingye779@gmail.com>
+License: MIT
+License-File: LICENSE
+Keywords: formatter,jupyter,marimo,notebook,pre-commit,sql,sqlglot
 Classifier: Development Status :: 4 - Beta
+Classifier: Framework :: Jupyter
 Classifier: Intended Audience :: Developers
 Classifier: Intended Audience :: Science/Research
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
-Classifier: Topic :: Software Development :: Quality Assurance
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
-Classifier: Framework :: Jupyter
+Classifier: Topic :: Software Development :: Quality Assurance
 Requires-Python: >=3.12
-Description-Content-Type: text/markdown
-License-File: LICENSE
 Requires-Dist: nbformat>=5.10.4
 Requires-Dist: pyyaml>=6.0.2
 Requires-Dist: sqlglot>=25.27.0
-Dynamic: license-file
+Description-Content-Type: text/markdown
 
 # sqlnbfmt
 
@@ -48,6 +47,7 @@ A SQL formatter for Jupyter Notebooks and Marimo notebooks. `sqlnbfmt` automatic
 - **CI-Friendly**: `--check` mode exits non-zero when formatting is needed; `--diff` shows what would change
 - **Skip Hints**: Add `# sqlnbfmt: skip` to any cell to exclude it from formatting
 - **Pre-commit Ready**: Seamlessly integrates with pre-commit hooks
+- **JupyterLab Plugin**: Works with `jupyterlab-code-formatter` for interactive format-on-save
 - **Lightweight**: Only three runtime dependencies (sqlglot, nbformat, pyyaml)
 
 ## Installation
@@ -94,6 +94,22 @@ Add a `# sqlnbfmt: skip` comment to skip formatting. In Jupyter notebooks this a
 query = "select * from my_special_table where id = 1"
 ```
 
+### JupyterLab Integration
+
+Format SQL cells interactively with [jupyterlab-code-formatter](https://github.com/jupyterlab-contrib/jupyterlab_code_formatter):
+
+```bash
+pip install sqlnbfmt jupyterlab-code-formatter
+```
+
+That's it — sqlnbfmt auto-registers as a Jupyter server extension. In JupyterLab, use **Edit > Format Cell** or configure format-on-save in Settings > Code Formatter, and select "Apply SQL Notebook Formatter".
+
+To customize the dialect, add this to `~/.jupyter/jupyter_server_config.py`:
+```python
+from sqlnbfmt.jupyterlab_integration import register
+register(dialect="postgres")
+```
+
 ### Pre-commit Integration
 
 1. Install pre-commit:

{sqlnbfmt-0.4.0 → sqlnbfmt-0.4.2}/README.md

@@ -19,6 +19,7 @@ A SQL formatter for Jupyter Notebooks and Marimo notebooks. `sqlnbfmt` automatic
 - **CI-Friendly**: `--check` mode exits non-zero when formatting is needed; `--diff` shows what would change
 - **Skip Hints**: Add `# sqlnbfmt: skip` to any cell to exclude it from formatting
 - **Pre-commit Ready**: Seamlessly integrates with pre-commit hooks
+- **JupyterLab Plugin**: Works with `jupyterlab-code-formatter` for interactive format-on-save
 - **Lightweight**: Only three runtime dependencies (sqlglot, nbformat, pyyaml)
 
 ## Installation
@@ -65,6 +66,22 @@ Add a `# sqlnbfmt: skip` comment to skip formatting. In Jupyter notebooks this a
 query = "select * from my_special_table where id = 1"
 ```
 
+### JupyterLab Integration
+
+Format SQL cells interactively with [jupyterlab-code-formatter](https://github.com/jupyterlab-contrib/jupyterlab_code_formatter):
+
+```bash
+pip install sqlnbfmt jupyterlab-code-formatter
+```
+
+That's it — sqlnbfmt auto-registers as a Jupyter server extension. In JupyterLab, use **Edit > Format Cell** or configure format-on-save in Settings > Code Formatter, and select "Apply SQL Notebook Formatter".
+
+To customize the dialect, add this to `~/.jupyter/jupyter_server_config.py`:
+```python
+from sqlnbfmt.jupyterlab_integration import register
+register(dialect="postgres")
+```
+
 ### Pre-commit Integration
 
 1. Install pre-commit:

sqlnbfmt-0.4.2/config.yaml

@@ -0,0 +1,49 @@
+# Optional — sqlnbfmt works without this file using built-in defaults.
+# Use this file only to override specific settings.
+# config.yaml
+
+sql_keywords:
+  - SELECT
+  - FROM
+  - WHERE
+  - INSERT
+  - UPDATE
+  - DELETE
+  - WITH
+  - JOIN
+  - CREATE
+  - DROP
+  - ALTER
+  - TRUNCATE
+  - UNION
+  - EXCEPT
+  - INTERSECT
+  - GROUP BY
+  - ORDER BY
+  - HAVING
+  - LIMIT
+  - OFFSET
+  - DISTINCT
+
+function_names:
+  - read_sql
+  - read_sql_query
+  - read_sql_table
+  - execute
+  - executescript
+  - fetchall
+  - fetchone
+  - fetchmany
+  - execute_query
+
+# Decorator names that contain SQL
+sql_decorators:
+  - sql_decorator
+  - query
+  - sql_query
+  - db_query
+
+# Formatting options
+formatting_options:
+  single_line_threshold: 80  # Maximum length for single-line SQL
+  indent_width: 4           # Number of spaces for indentation

sqlnbfmt-0.4.2/jupyter-config/sqlnbfmt.json

@@ -0,0 +1,7 @@
+{
+  "ServerApp": {
+    "jpserver_extensions": {
+      "sqlnbfmt": true
+    }
+  }
+}

{sqlnbfmt-0.4.0 → sqlnbfmt-0.4.2}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "sqlnbfmt"
-version = "0.4.0"
+version = "0.4.2"
 description = "A tool to format SQL code in Jupyter notebooks and Marimo notebooks."
 authors = [
   { name = "Qing", email = "qingye779@gmail.com" }
@@ -44,16 +44,16 @@ dev = [
 ]
 
 [build-system]
-requires = ["setuptools>=61.0", "wheel"]
-build-backend = "setuptools.build_meta"
+requires = ["hatchling"]
+build-backend = "hatchling.build"
 
 [tool.pytest.ini_options]
 markers = [
     "integration: mark a test as an integration test."
 ]
 
+[tool.hatch.build.targets.wheel.shared-data]
+"jupyter-config/sqlnbfmt.json" = "etc/jupyter/jupyter_server_config.d/sqlnbfmt.json"
+
 [tool.ruff]
 extend-exclude = ["tests/eval/*/"]
-
-[tool.setuptools.package-data]
-sqlnbfmt = [".pre-commit-hooks.yaml"]

sqlnbfmt-0.4.2/sqlnbfmt/__init__.py

@@ -0,0 +1,15 @@
+def _jupyter_server_extension_points():
+    return [{"module": "sqlnbfmt"}]
+
+
+def _load_jupyter_server_extension(server_app):
+    try:
+        from sqlnbfmt.jupyterlab_integration import register
+
+        register()
+        server_app.log.info(
+            "sqlnbfmt: registered SQL formatter with jupyterlab-code-formatter"
+        )
+    except Exception:
+        # jupyterlab-code-formatter not installed — silently skip
+        pass