sqlnbfmt 0.4.2__tar.gz → 0.5.0__tar.gz

sqlnbfmt-0.5.0/.github/dependabot.yml

@@ -0,0 +1,23 @@
+version: 2
+updates:
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+      day: "monday"
+    labels:
+      - "dependencies"
+
+  - package-ecosystem: "pip"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+      day: "monday"
+    open-pull-requests-limit: 10
+    labels:
+      - "dependencies"
+    groups:
+      minor-and-patch:
+        update-types:
+          - "minor"
+          - "patch"

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

@@ -0,0 +1,55 @@
+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'
+
+permissions: {}
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+    steps:
+      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
+      - uses: astral-sh/setup-uv@1c37ad07a6a961277cf70c0d37d6f313000f5884 # v10.3.0
+        with:
+          enable-cache: true
+          cache-dependency-glob: "pyproject.toml"
+      - run: uv python install 3.12
+      - run: uv sync --all-extras --dev --frozen
+      - run: uv run pytest
+
+  security:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+    steps:
+      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
+      - uses: astral-sh/setup-uv@1c37ad07a6a961277cf70c0d37d6f313000f5884 # v10.3.0
+      - run: uvx uv-secure uv.lock
+
+  publish:
+    needs: [test, security]
+    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@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
+      - uses: astral-sh/setup-uv@1c37ad07a6a961277cf70c0d37d6f313000f5884 # v10.3.0
+        with:
+          enable-cache: true
+      - run: uv python install 3.12
+      - run: uv build --no-sources
+      - uses: pypa/gh-action-pypi-publish@dc37677b2e1c63e2034f94d8a5b11f265b73ba33 # v1.14.2

{sqlnbfmt-0.4.2 → sqlnbfmt-0.5.0}/.pre-commit-config.yaml

@@ -1,9 +1,9 @@
 repos:
   # Linting + formatting (Astral)
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.15.6
+    rev: v0.17.1
     hooks:
-      - id: ruff
+      - id: ruff-check
         args: [--fix]
       - id: ruff-format
 
@@ -24,7 +24,7 @@ repos:
 
   # Validate pyproject.toml against PEP 621
   - repo: https://github.com/abravalheri/validate-pyproject
-    rev: v0.25
+    rev: '0.26'
     hooks:
       - id: validate-pyproject
 

{sqlnbfmt-0.4.2 → sqlnbfmt-0.5.0}/CHANGELOG.md

@@ -5,7 +5,29 @@ 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
+## [0.5.0] - 2026-10-15
+
+### Added
+
+- **`pyproject.toml` configuration**: set options in a `[tool.sqlnbfmt]` table instead of a separate YAML file. Without `--config`, sqlnbfmt uses the nearest `pyproject.toml` that has the table, searching up to the repository root. The JupyterLab integration uses the same discovery ([#22](https://github.com/flyersworder/sqlnbfmt/issues/22))
+- `--config` accepts a `.toml` path as well as YAML
+- `dialect` config option (in `[tool.sqlnbfmt]` or YAML), so the dialect no longer has to be passed as `--dialect` on every run; `--dialect` still overrides it
+
+### Changed
+
+- Config values are now type-checked: a wrong type (e.g. a string where a list is expected) is reported as an error naming the file. Previously such values were silently mis-parsed or crashed with a traceback
+- Unknown config options now produce a warning instead of being silently ignored
+
+### Fixed
+
+- SQL passed to a function call is now indented relative to the line the call is on, and a closing `)` or remaining arguments no longer land at column 0. This was most visible in Marimo cells, where every `mo.sql(...)` sits inside a function. It had regressed in 0.3.0, when the `black` post-processing pass was removed. Code already formatted by an earlier version keeps its layout until its SQL changes
+- The Jupyter server extension no longer overrides a formatter registered in `jupyter_server_config.py` (e.g. `register(dialect="postgres")`), and it now logs configuration errors instead of silently not registering
+- An unknown dialect (e.g. `--dialect postgress`) is now rejected with a suggestion. Previously every SQL string silently failed to parse, so `--check` reported all files as properly formatted
+- The `config.yaml` template was missing the `sql` function name (default since 0.4.0). Because config lists replace the defaults, copying the template silently disabled Marimo `mo.sql()` formatting. The README now states the replace semantics explicitly
+- Upgraded locked dependencies, including sqlglot 29 → 30 (formatting output unchanged across the eval suite)
+- A skipped Jupyter extension registration is now logged at debug level instead of being silently swallowed
+
+## [0.4.2] - 2026-03-24
 
 ### Added
 

{sqlnbfmt-0.4.2 → sqlnbfmt-0.5.0}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.4
+Metadata-Version: 2.5
 Name: sqlnbfmt
-Version: 0.4.2
+Version: 0.5.0
 Summary: A tool to format SQL code in Jupyter notebooks and Marimo notebooks.
 Project-URL: Homepage, https://github.com/flyersworder/sqlnbfmt
 Project-URL: Repository, https://github.com/flyersworder/sqlnbfmt
@@ -104,7 +104,7 @@ 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`:
+The extension uses `[tool.sqlnbfmt]` (including `dialect`) from the nearest `pyproject.toml` of the directory you start Jupyter in. To set the dialect explicitly instead, add this to `~/.jupyter/jupyter_server_config.py`:
 ```python
 from sqlnbfmt.jupyterlab_integration import register
 register(dialect="postgres")
@@ -121,7 +121,7 @@ pip install pre-commit
 ```yaml
 repos:
   - repo: https://github.com/flyersworder/sqlnbfmt
-    rev: v0.4.0
+    rev: v0.5.0
     hooks:
       - id: sqlnbfmt
         types: [jupyter]
@@ -133,7 +133,7 @@ To also format Marimo notebooks (Python files), add the Python hook:
         files: '\.py$'  # optionally narrow with: files: 'marimo_.*\.py$'
 ```
 
-All arguments are optional. To specify a dialect or custom config:
+All arguments are optional. Settings in `[tool.sqlnbfmt]` in your `pyproject.toml` are picked up automatically (see [Configuration](#configuration)); alternatively pass them as arguments:
 ```yaml
         args: [--dialect, postgres, --config, config.yaml]
 ```
@@ -162,19 +162,38 @@ Use `--check` in GitHub Actions to enforce formatting:
 
 ## Configuration
 
-`sqlnbfmt` works without any configuration file. A `config.yaml` is only needed to override defaults.
+`sqlnbfmt` works without any configuration. To override defaults, use a `[tool.sqlnbfmt]` table in `pyproject.toml` or a separate YAML file.
 
-Create a `config.yaml` file to customize formatting behavior. [Here](https://github.com/flyersworder/sqlnbfmt/blob/main/config.yaml) is a template.
+### pyproject.toml
+
+```toml
+[tool.sqlnbfmt]
+dialect = "postgres"
+
+[tool.sqlnbfmt.formatting_options]
+indent_width = 2
+```
+
+`sqlnbfmt` searches the current directory and its parents for the nearest `pyproject.toml` with a `[tool.sqlnbfmt]` table, stopping at the repository root (the directory containing `.git`). A `pyproject.toml` without that table is skipped, so a sub-package's file doesn't hide the repository-level configuration. The JupyterLab integration does the same, starting from the Jupyter server's working directory.
+
+### YAML file
+
+Pass a YAML file with `--config config.yaml`. [Here](https://github.com/flyersworder/sqlnbfmt/blob/main/config.yaml) is a template. `--config` also accepts a `.toml` path, which is read from its `[tool.sqlnbfmt]` table.
+
+When `--config` is given, `pyproject.toml` discovery is skipped. Options you don't set keep their defaults, and unknown option names produce a warning.
 
 ### Configuration Options
 
 | Option | Description | Default |
 |--------|-------------|---------|
+| `dialect` | SQL dialect passed to sqlglot (e.g. `postgres`, `mysql`, `bigquery`); `--dialect` overrides it | none (generic SQL) |
 | `sql_keywords` | SQL keywords to recognize and format | Common SQL keywords |
-| `function_names` | Python functions containing SQL code | `read_sql`, `execute`, etc. |
+| `function_names` | Python functions containing SQL code | `read_sql`, `execute`, `sql` (Marimo's `mo.sql`), etc. |
 | `sql_decorators` | Decorators indicating SQL code | `query`, `sql_query`, etc. |
-| `single_line_threshold` | Maximum length before splitting SQL | 80 |
-| `indent_width` | Number of spaces for indentation | 4 |
+| `formatting_options.single_line_threshold` | Maximum length before splitting SQL | 80 |
+| `formatting_options.indent_width` | Number of spaces for indentation | 4 |
+
+`sql_keywords`, `function_names` and `sql_decorators` **replace** the built-in lists rather than extending them. Copy the defaults you still rely on from the [template](https://github.com/flyersworder/sqlnbfmt/blob/main/config.yaml); for example, keep `sql` in `function_names` or Marimo's `mo.sql()` calls stop being formatted.
 
 ## Examples
 
@@ -187,20 +206,20 @@ execute_sql("""SELECT a.col1, b.col2 FROM table_a a JOIN table_b b ON a.id = b.a
 
 After formatting:
 ```python
-execute_sql("""
-SELECT
-  a.col1,
-  b.col2
-FROM
-  table_a AS a
-JOIN
-  table_b AS b
-  ON a.id = b.a_id
-WHERE
-  a.status = 'active'
-ORDER BY
-  a.created_at DESC
-""")
+execute_sql(
+    """
+    SELECT
+      a.col1,
+      b.col2
+    FROM table_a AS a
+    JOIN table_b AS b
+      ON a.id = b.a_id
+    WHERE
+      a.status = 'active'
+    ORDER BY
+      a.created_at DESC
+    """
+)
 ```
 
 ### Marimo Notebook
@@ -218,17 +237,17 @@ After formatting:
 @app.cell
 def _(mo):
     _df = mo.sql(
-    f"""
-    SELECT
-      id,
-      name
-    FROM users
-    WHERE
-      active = 1
-    ORDER BY
-      name
-    """
-)
+        f"""
+        SELECT
+          id,
+          name
+        FROM users
+        WHERE
+          active = 1
+        ORDER BY
+          name
+        """
+    )
     return
 ```
 
@@ -236,7 +255,7 @@ def _(mo):
 
 **SQL not being formatted?**
 - Ensure the string contains at least 2 SQL keywords or a recognizable pattern like `SELECT...FROM`
-- Check that the function name is in the recognized list (use `--config` to add custom ones)
+- Check that the function name is in the recognized list (add custom ones via `function_names` in `[tool.sqlnbfmt]` or `--config`)
 
 **Comments being modified?**
 - Python comments (`#`) are preserved. SQL comments (`--`) inside strings are converted to `/* */` block comments by sqlglot.

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

@@ -76,7 +76,7 @@ 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`:
+The extension uses `[tool.sqlnbfmt]` (including `dialect`) from the nearest `pyproject.toml` of the directory you start Jupyter in. To set the dialect explicitly instead, add this to `~/.jupyter/jupyter_server_config.py`:
 ```python
 from sqlnbfmt.jupyterlab_integration import register
 register(dialect="postgres")
@@ -93,7 +93,7 @@ pip install pre-commit
 ```yaml
 repos:
   - repo: https://github.com/flyersworder/sqlnbfmt
-    rev: v0.4.0
+    rev: v0.5.0
     hooks:
       - id: sqlnbfmt
         types: [jupyter]
@@ -105,7 +105,7 @@ To also format Marimo notebooks (Python files), add the Python hook:
         files: '\.py$'  # optionally narrow with: files: 'marimo_.*\.py$'
 ```
 
-All arguments are optional. To specify a dialect or custom config:
+All arguments are optional. Settings in `[tool.sqlnbfmt]` in your `pyproject.toml` are picked up automatically (see [Configuration](#configuration)); alternatively pass them as arguments:
 ```yaml
         args: [--dialect, postgres, --config, config.yaml]
 ```
@@ -134,19 +134,38 @@ Use `--check` in GitHub Actions to enforce formatting:
 
 ## Configuration
 
-`sqlnbfmt` works without any configuration file. A `config.yaml` is only needed to override defaults.
+`sqlnbfmt` works without any configuration. To override defaults, use a `[tool.sqlnbfmt]` table in `pyproject.toml` or a separate YAML file.
 
-Create a `config.yaml` file to customize formatting behavior. [Here](https://github.com/flyersworder/sqlnbfmt/blob/main/config.yaml) is a template.
+### pyproject.toml
+
+```toml
+[tool.sqlnbfmt]
+dialect = "postgres"
+
+[tool.sqlnbfmt.formatting_options]
+indent_width = 2
+```
+
+`sqlnbfmt` searches the current directory and its parents for the nearest `pyproject.toml` with a `[tool.sqlnbfmt]` table, stopping at the repository root (the directory containing `.git`). A `pyproject.toml` without that table is skipped, so a sub-package's file doesn't hide the repository-level configuration. The JupyterLab integration does the same, starting from the Jupyter server's working directory.
+
+### YAML file
+
+Pass a YAML file with `--config config.yaml`. [Here](https://github.com/flyersworder/sqlnbfmt/blob/main/config.yaml) is a template. `--config` also accepts a `.toml` path, which is read from its `[tool.sqlnbfmt]` table.
+
+When `--config` is given, `pyproject.toml` discovery is skipped. Options you don't set keep their defaults, and unknown option names produce a warning.
 
 ### Configuration Options
 
 | Option | Description | Default |
 |--------|-------------|---------|
+| `dialect` | SQL dialect passed to sqlglot (e.g. `postgres`, `mysql`, `bigquery`); `--dialect` overrides it | none (generic SQL) |
 | `sql_keywords` | SQL keywords to recognize and format | Common SQL keywords |
-| `function_names` | Python functions containing SQL code | `read_sql`, `execute`, etc. |
+| `function_names` | Python functions containing SQL code | `read_sql`, `execute`, `sql` (Marimo's `mo.sql`), etc. |
 | `sql_decorators` | Decorators indicating SQL code | `query`, `sql_query`, etc. |
-| `single_line_threshold` | Maximum length before splitting SQL | 80 |
-| `indent_width` | Number of spaces for indentation | 4 |
+| `formatting_options.single_line_threshold` | Maximum length before splitting SQL | 80 |
+| `formatting_options.indent_width` | Number of spaces for indentation | 4 |
+
+`sql_keywords`, `function_names` and `sql_decorators` **replace** the built-in lists rather than extending them. Copy the defaults you still rely on from the [template](https://github.com/flyersworder/sqlnbfmt/blob/main/config.yaml); for example, keep `sql` in `function_names` or Marimo's `mo.sql()` calls stop being formatted.
 
 ## Examples
 
@@ -159,20 +178,20 @@ execute_sql("""SELECT a.col1, b.col2 FROM table_a a JOIN table_b b ON a.id = b.a
 
 After formatting:
 ```python
-execute_sql("""
-SELECT
-  a.col1,
-  b.col2
-FROM
-  table_a AS a
-JOIN
-  table_b AS b
-  ON a.id = b.a_id
-WHERE
-  a.status = 'active'
-ORDER BY
-  a.created_at DESC
-""")
+execute_sql(
+    """
+    SELECT
+      a.col1,
+      b.col2
+    FROM table_a AS a
+    JOIN table_b AS b
+      ON a.id = b.a_id
+    WHERE
+      a.status = 'active'
+    ORDER BY
+      a.created_at DESC
+    """
+)
 ```
 
 ### Marimo Notebook
@@ -190,17 +209,17 @@ After formatting:
 @app.cell
 def _(mo):
     _df = mo.sql(
-    f"""
-    SELECT
-      id,
-      name
-    FROM users
-    WHERE
-      active = 1
-    ORDER BY
-      name
-    """
-)
+        f"""
+        SELECT
+          id,
+          name
+        FROM users
+        WHERE
+          active = 1
+        ORDER BY
+          name
+        """
+    )
     return
 ```
 
@@ -208,7 +227,7 @@ def _(mo):
 
 **SQL not being formatted?**
 - Ensure the string contains at least 2 SQL keywords or a recognizable pattern like `SELECT...FROM`
-- Check that the function name is in the recognized list (use `--config` to add custom ones)
+- Check that the function name is in the recognized list (add custom ones via `function_names` in `[tool.sqlnbfmt]` or `--config`)
 
 **Comments being modified?**
 - Python comments (`#`) are preserved. SQL comments (`--`) inside strings are converted to `/* */` block comments by sqlglot.

sqlnbfmt-0.5.0/SECURITY.md

@@ -0,0 +1,13 @@
+# Security Policy
+
+## Supported Versions
+
+Only the latest release receives security fixes.
+
+## Reporting a Vulnerability
+
+Please **do not** open a public GitHub issue for security vulnerabilities.
+
+Report them privately via [GitHub Security Advisories](https://github.com/flyersworder/sqlnbfmt/security/advisories/new). Include a description of the issue, steps to reproduce, and the potential impact.
+
+You can expect an acknowledgement within 48 hours and a patch or mitigation plan within 14 days for confirmed issues.

{sqlnbfmt-0.4.2 → sqlnbfmt-0.5.0}/config.yaml

@@ -2,6 +2,9 @@
 # Use this file only to override specific settings.
 # config.yaml
 
+# SQL dialect for sqlglot (e.g. postgres, mysql, bigquery); --dialect overrides it
+# dialect: postgres
+
 sql_keywords:
   - SELECT
   - FROM
@@ -35,6 +38,7 @@ function_names:
   - fetchone
   - fetchmany
   - execute_query
+  - sql  # Marimo mo.sql()
 
 # Decorator names that contain SQL
 sql_decorators:

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

@@ -1,6 +1,6 @@
 [project]
 name = "sqlnbfmt"
-version = "0.4.2"
+version = "0.5.0"
 description = "A tool to format SQL code in Jupyter notebooks and Marimo notebooks."
 authors = [
   { name = "Qing", email = "qingye779@gmail.com" }
@@ -56,4 +56,9 @@ markers = [
 "jupyter-config/sqlnbfmt.json" = "etc/jupyter/jupyter_server_config.d/sqlnbfmt.json"
 
 [tool.ruff]
-extend-exclude = ["tests/eval/*/"]
+# Eval cases and test notebooks are fixtures: their exact formatting is the test input.
+extend-exclude = ["tests/eval/*/", "tests/*.ipynb"]
+
+[tool.ruff.format]
+# Code blocks in docs show sqlnbfmt's own output, not ruff's.
+exclude = ["*.md"]

sqlnbfmt-0.5.0/sqlnbfmt/__init__.py

@@ -0,0 +1,29 @@
+def _jupyter_server_extension_points():
+    return [{"module": "sqlnbfmt"}]
+
+
+def _load_jupyter_server_extension(server_app):
+    try:
+        from jupyterlab_code_formatter.formatters import SERVER_FORMATTERS
+    except ImportError:
+        server_app.log.debug(
+            "sqlnbfmt: jupyterlab-code-formatter not installed; skipping registration"
+        )
+        return
+
+    # jupyter_server_config.py runs before extensions load; keep a formatter the
+    # user registered there (e.g. register(dialect="postgres")).
+    if "sqlnbfmt" in SERVER_FORMATTERS:
+        server_app.log.info("sqlnbfmt: keeping the formatter registered in config")
+        return
+
+    try:
+        from sqlnbfmt.jupyterlab_integration import register
+
+        register()
+    except Exception as e:  # noqa: BLE001 - must never break Jupyter server startup
+        server_app.log.error(f"sqlnbfmt: SQL formatter not registered: {e}")
+        return
+    server_app.log.info(
+        "sqlnbfmt: registered SQL formatter with jupyterlab-code-formatter"
+    )