Merge pull request #3 from AzisK/Switch-Python-parsing-to-AST

Switch python parsing to ast

### Changed

- **Switched to AST-based Python parsing**: Replaced regex-based string extraction with Python's `ast` module.
  - **Improved Robustness**: Eliminated edge cases where comments or non-assignment strings were incorrectly formatted.
  - **Enhanced F-string support**: More reliable parsing of SQL within f-strings.
  - **False Positive Prevention**: Correctly ignores SQL-like text in docstrings and comments, which were previously matched by the regex.
  - **Strict Targeting**: Only formats strings that are actual variable assignments.
- **Modernized File Handling**: Adopted `pathlib` for all file system operations.
- **Type Safety**: Added comprehensive type hints to the codebase.

Author: AzisK

.github/workflows/ci.yml

@@ -47,7 +47,7 @@ jobs:
 
   lint:
     name: Lint
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-slim
 
     steps:
       - name: Checkout repository
@@ -65,3 +65,22 @@ jobs:
         run: |
           uv pip install pre-commit
           uv run pre-commit run --all-files --show-diff-on-failure
+
+  type-check:
+    name: Type Check
+    runs-on: ubuntu-slim
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v5
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v7
+        with:
+          enable-cache: true
+
+      - name: Install dependencies
+        run: uv sync --all-extras
+
+      - name: Run mypy
+        run: uv run mypy .

AGENTS.md

@@ -22,7 +22,10 @@ uv run readsql file1.sql file2.py folder/               # Process multiple files
 # Run tests
 uv run pytest -v
 
-# Pre-commit (uses black with -S flag, zimports)
+# Type Check (MyPy)
+uv run mypy .
+
+# Pre-commit (uses black with -S flag, ruff)
 pre-commit run --all-files
 ```
 
@@ -36,7 +39,7 @@ The CLI accepts one or multiple files/folders as input. When given a folder, it
 1. `parse_args()` - Handles CLI arguments (`-s` for string mode, `-n` for dry-run, `-py` for custom Python variable names)
 2. For strings: `read_replace()` applies regex substitutions directly
 3. For files: `read_file()` dispatches to `read_sql_file()` or `read_python_file()` based on extension
-4. `read_python_file()` extracts SQL from variable assignments (default: `query`) using regex, then applies `read_replace()`
+4. `read_python_file()` uses `ast` module to safely extract SQL from variable assignments (default: `query`) while preserving formatting, then applies `read_replace()`
 
 ### Regex Rules (`readsql/regexes.txt`)
 Format: `SUBSTITUTE__REGEX__GROUP` (double underscore delimited)

CHANGELOG.md

@@ -2,6 +2,18 @@
 
 All notable changes to this project will be documented in this file.
 
+## [1.1.0] - 2026-01-22
+
+### Changed
+
+- **Switched to AST-based Python parsing**: Replaced regex-based string extraction with Python's `ast` module.
+  - **Improved Robustness**: Eliminated edge cases where comments or non-assignment strings were incorrectly formatted.
+  - **Enhanced F-string support**: More reliable parsing of SQL within f-strings.
+  - **False Positive Prevention**: Correctly ignores SQL-like text in docstrings and comments, which were previously matched by the regex.
+  - **Strict Targeting**: Only formats strings that are actual variable assignments.
+- **Modernized File Handling**: Adopted `pathlib` for all file system operations.
+- **Type Safety**: Added comprehensive type hints to the codebase.
+
 ## [1.0.0] - 2026-01-21
 
 ### Changed

README.md

@@ -47,6 +47,12 @@ We can look for different strings in Python files with `-py` arguments
 readsql <FILE_OR_FOLDER_PATH> -py <PY_VAR1> <PY_VAR2>
 ```
 
+> **Note**: `readsql` uses Python's AST parser, so it supports:
+> - **Type Hints**: `query: str = "..."`
+> - **F-strings**: `f"SELECT * FROM {table}"`
+> - **Nested Scopes**: Robustly handles variables inside functions and classes.
+> - **Comments/Docstrings**: Correctly ignores SQL-like text in comments or docstrings.
+
 # Usage examples
 
 1. `readsql 'select sushi from tokyo' -s` command returns

pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "readsql"
-version = "1.0.0"
+version = "1.1.0"
 description = "Convert SQL to most human readable format"
 authors = [{ name = "Azis", email = "azuolas.krusna@yahoo.com" }]
 maintainers = [{ name = "Azis", email = "azuolas.krusna@yahoo.com" }]
@@ -50,4 +50,14 @@ exclude = ["tests/*_example*.py"]
 [dependency-groups]
 dev = [
     "ruff>=0.14.13",
+    "mypy>=1.0.0",
 ]
+
+[tool.mypy]
+python_version = "3.9"
+strict = true
+ignore_missing_imports = true
+
+[[tool.mypy.overrides]]
+module = "tests.*"
+ignore_errors = true