pandera-mypy 0.0.1__tar.gz

pandera_mypy-0.0.1/.github/workflows/ci.yml

@@ -0,0 +1,120 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+  workflow_dispatch:
+
+permissions:
+  contents: read
+
+jobs:
+  lint:
+    name: ruff
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@34e114876b0b11c390a56381ad16ebd13914f8d5 # v4.3.1
+
+      - name: Set up uv
+        uses: astral-sh/setup-uv@d0cc045d04ccac9d8b7881df0226f9e82c39688e # v6.8.0
+        with:
+          python-version: "3.12"
+          enable-cache: true
+          cache-dependency-glob: "uv.lock"
+
+      - name: Install dependencies
+        run: uv sync --group dev
+
+      - name: Check lockfile is up to date
+        run: uv lock --check
+
+      - name: Ruff format check
+        run: uv run ruff format --check .
+
+      - name: Ruff lint check
+        run: uv run ruff check .
+
+  build:
+    name: build wheel + sdist
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@34e114876b0b11c390a56381ad16ebd13914f8d5 # v4.3.1
+
+      - name: Set up uv
+        uses: astral-sh/setup-uv@d0cc045d04ccac9d8b7881df0226f9e82c39688e # v6.8.0
+        with:
+          python-version: "3.12"
+          enable-cache: true
+          cache-dependency-glob: "uv.lock"
+
+      - name: Build
+        run: uv build
+
+  typecheck:
+    name: mypy
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@34e114876b0b11c390a56381ad16ebd13914f8d5 # v4.3.1
+
+      - name: Set up uv
+        uses: astral-sh/setup-uv@d0cc045d04ccac9d8b7881df0226f9e82c39688e # v6.8.0
+        with:
+          python-version: "3.12"
+          enable-cache: true
+          cache-dependency-glob: "uv.lock"
+
+      - name: Install dependencies
+        run: uv sync --group dev
+
+      - name: Run mypy
+        run: uv run mypy src
+
+  pytest:
+    name: >-
+      pytest (pandera ${{ matrix.pandera-version }},
+      Python ${{ matrix.python-version }}, ${{ matrix.os-name }})
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        # latest patch of every minor release from the minimum supported
+        # version (0.21) through the current latest (0.31); note that there
+        # is no stable 0.24 release (only 0.24.0rc0 was published).
+        pandera-version:
+          - "0.21.1"
+          - "0.22.1"
+          - "0.23.1"
+          - "0.25.0"
+          - "0.26.1"
+          - "0.27.1"
+          - "0.28.1"
+          - "0.29.0"
+          - "0.30.1"
+          - "0.31.1"
+        python-version: ["3.10", "3.11", "3.12", "3.13", "3.14"]
+        os: [ubuntu-latest, windows-latest]
+        include:
+          - os: ubuntu-latest
+            os-name: Linux
+          - os: windows-latest
+            os-name: Windows
+    steps:
+      - uses: actions/checkout@34e114876b0b11c390a56381ad16ebd13914f8d5 # v4.3.1
+
+      - name: Set up uv
+        uses: astral-sh/setup-uv@d0cc045d04ccac9d8b7881df0226f9e82c39688e # v6.8.0
+        with:
+          python-version: ${{ matrix.python-version }}
+          enable-cache: true
+          cache-dependency-glob: "uv.lock"
+
+      - name: Install dependencies
+        run: uv sync --group dev
+
+      - name: Override pandera version
+        run: uv pip install "pandera[polars]==${{ matrix.pandera-version }}"
+
+      - name: Run pytest
+        run: uv run pytest

pandera_mypy-0.0.1/.github/workflows/publish.yml

@@ -0,0 +1,151 @@
+name: Publish to PyPI
+
+# Triggers on pushes to main that modify pyproject.toml, plus manual dispatch.
+# The workflow publishes only when project.version actually changed compared
+# with the previous state of main.
+#
+# Setup (one-time, before first publish):
+#   1. Create the GitHub Actions environment named "pypi" in this repo.
+#   2. On PyPI, add a pending Trusted Publisher for project "pandera-mypy":
+#      https://pypi.org/manage/account/publishing/
+#   3. Configure it with:
+#      - Owner:       TymoteuszChatys
+#      - Repo:        pandera-mypy
+#      - Workflow:    publish.yml
+#      - Environment: pypi
+#      - Project name: pandera-mypy
+#   4. Ensure the pypi environment has no required reviewers; otherwise
+#      publishing will pause for manual approval.
+on:
+  workflow_dispatch:
+  push:
+    branches: [main]
+    paths:
+      - pyproject.toml
+
+permissions:
+  contents: read
+
+jobs:
+  publish:
+    name: Build and publish to PyPI
+    if: github.ref == 'refs/heads/main'
+    runs-on: ubuntu-latest
+    environment: pypi
+    permissions:
+      contents: read
+      id-token: write  # required for OIDC Trusted Publishing
+
+    steps:
+      - uses: actions/checkout@34e114876b0b11c390a56381ad16ebd13914f8d5 # v4.3.1
+        with:
+          fetch-depth: 0
+
+      - name: Set up uv
+        uses: astral-sh/setup-uv@d0cc045d04ccac9d8b7881df0226f9e82c39688e # v6.8.0
+        with:
+          python-version: "3.12"
+          enable-cache: true
+          cache-dependency-glob: "uv.lock"
+
+      - name: Detect version bump
+        id: version_check
+        run: |
+          CURRENT_VERSION=$(python - <<'PY'
+          from pathlib import Path
+          import tomllib
+
+          print(tomllib.loads(Path("pyproject.toml").read_text())["project"]["version"])
+          PY
+          )
+
+          PREVIOUS_VERSION=$(python - <<'PY'
+          import os
+          import subprocess
+          import tomllib
+
+          before = os.environ.get("GITHUB_EVENT_BEFORE", "")
+          if not before or set(before) == {"0"}:
+              print("")
+          else:
+              result = subprocess.run(
+                  ["git", "show", f"{before}:pyproject.toml"],
+                  check=False,
+                  capture_output=True,
+                  text=True,
+              )
+              if result.returncode != 0:
+                  print("")
+              else:
+                  print(tomllib.loads(result.stdout)["project"]["version"])
+          PY
+          )
+
+          {
+            echo "current_version=$CURRENT_VERSION"
+            echo "previous_version=$PREVIOUS_VERSION"
+          } >> "$GITHUB_OUTPUT"
+
+          if [ -z "$PREVIOUS_VERSION" ]; then
+            echo "Previous version unavailable; publishing $CURRENT_VERSION."
+            echo "should_publish=true" >> "$GITHUB_OUTPUT"
+            exit 0
+          fi
+
+          if [ "$CURRENT_VERSION" = "$PREVIOUS_VERSION" ]; then
+            echo "Version unchanged ($CURRENT_VERSION); skipping publish."
+            echo "should_publish=false" >> "$GITHUB_OUTPUT"
+            exit 0
+          fi
+
+          echo "Version changed: $PREVIOUS_VERSION -> $CURRENT_VERSION"
+          echo "should_publish=true" >> "$GITHUB_OUTPUT"
+
+      - name: Check whether version already exists on PyPI
+        id: pypi_check
+        if: steps.version_check.outputs.should_publish == 'true'
+        env:
+          PACKAGE_VERSION: ${{ steps.version_check.outputs.current_version }}
+        run: |
+          python - <<'PY'
+          import json
+          import os
+          import urllib.error
+          import urllib.request
+
+          version = os.environ["PACKAGE_VERSION"]
+          url = "https://pypi.org/pypi/pandera-mypy/json"
+
+          try:
+              with urllib.request.urlopen(url, timeout=30) as response:
+                  releases = json.load(response)["releases"]
+          except urllib.error.HTTPError as error:
+              if error.code == 404:
+                  releases = {}
+              else:
+                  raise
+
+          already_published = version in releases and bool(releases[version])
+          if already_published:
+              print(f"Version {version} already exists on PyPI.")
+          else:
+              print(f"Version {version} is not on PyPI yet.")
+
+          with open(os.environ["GITHUB_OUTPUT"], "a", encoding="utf-8") as output:
+              output.write(
+                  "already_published="
+                  f"{str(already_published).lower()}\n"
+              )
+          PY
+
+      - name: Build wheel and sdist
+        if: |
+          steps.version_check.outputs.should_publish == 'true' &&
+          steps.pypi_check.outputs.already_published != 'true'
+        run: uv build
+
+      - name: Publish to PyPI
+        if: |
+          steps.version_check.outputs.should_publish == 'true' &&
+          steps.pypi_check.outputs.already_published != 'true'
+        uses: pypa/gh-action-pypi-publish@cef221092ed1bacb1cc03d23a2d87d1d172e277b # release/v1 (v1.14.0)

pandera_mypy-0.0.1/.gitignore

@@ -0,0 +1,216 @@
+# 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
+
+# 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__/
+
+# Sandbox-generated Excel files
+*.xlsx
+
+# Benchmark cache
+.benchmark_cache/
+
+# Benchmark results
+benchmark_results/

pandera_mypy-0.0.1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Tymoteusz Chatys
+
+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.

pandera_mypy-0.0.1/PKG-INFO

@@ -0,0 +1,177 @@
+Metadata-Version: 2.4
+Name: pandera-mypy
+Version: 0.0.1
+Summary: Mypy plugin that resolves Pandera DataFrameModel column attributes as str
+Project-URL: Homepage, https://github.com/TymoteuszChatys/pandera-mypy
+Project-URL: Repository, https://github.com/TymoteuszChatys/pandera-mypy
+Project-URL: Issues, https://github.com/TymoteuszChatys/pandera-mypy/issues
+Author-email: Tymoteusz Chatys <tymoteuszchatys@gmail.com>
+License: MIT
+License-File: LICENSE
+Keywords: mypy,pandera,plugin,polars,type-checking
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+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 :: Software Development :: Libraries
+Classifier: Topic :: Software Development :: Quality Assurance
+Classifier: Topic :: Software Development :: Testing
+Classifier: Typing :: Typed
+Requires-Python: <3.15,>=3.10
+Requires-Dist: mypy>=1.0.0
+Description-Content-Type: text/markdown
+
+# pandera-mypy
+
+> A mypy plugin that resolves [Pandera](https://pandera.readthedocs.io/) `DataFrameModel` column attributes as `str`, eliminating false type errors when passing column names to `polars.col()` or any other `str`-expecting API.
+
+## The Problem
+
+Pandera's `DataFrameModel` supports a convenient **bare-type** shorthand for
+column annotations, where a plain Python type is used instead of the full
+`Series[T]` form:
+
+```python
+import pandera.polars as pa
+
+class MySchema(pa.DataFrameModel):
+    quantity: int   # shorthand for Series[int]
+    label: str      # shorthand for Series[str]
+```
+
+At **runtime**, accessing a column attribute always returns its *name* as a
+plain `str`:
+
+```python
+>>> MySchema.quantity
+'quantity'
+>>> MySchema.label
+'label'
+```
+
+Without the plugin, mypy infers the **declared type** (`int`, `str`, …) rather
+than `str`, causing spurious errors when column names are passed to
+`polars.col()` or any other `str`-expecting API:
+
+```python
+import polars as pl
+
+pl.col(MySchema.quantity)
+# ^ error: Argument 1 to "col" has incompatible type "int"; expected "str"
+```
+
+> **`Series[T]` annotations**: Pandera's bundled stubs already type
+> class-level attribute access as `str` for `Series[T]`-annotated columns
+> across all supported versions (0.21.1-0.31.1). The plugin ensures uniform
+> `str` inference when schemas mix `Series[T]` and bare-type annotations.
+
+## The Solution
+
+This plugin overrides the inferred type of every column-annotated attribute on
+a `DataFrameModel` subclass to `str`, matching the actual runtime behaviour —
+no changes to your Pandera models required.
+
+```python
+# With the plugin enabled:
+pl.col(MySchema.quantity)         # ✅  no error
+col_name: str = MySchema.quantity # ✅  no error
+```
+
+## Installation
+
+```bash
+pip install pandera-mypy
+```
+
+```bash
+# or with uv:
+uv add pandera-mypy
+```
+
+## Configuration
+
+Add the plugin to your mypy configuration and that's it:
+
+**`mypy.ini`**
+```ini
+[mypy]
+plugins = pandera_mypy.plugin
+```
+
+**`pyproject.toml`**
+```toml
+[tool.mypy]
+plugins = ["pandera_mypy.plugin"]
+```
+
+**`setup.cfg`**
+```ini
+[mypy]
+plugins = pandera_mypy.plugin
+```
+
+## Compatibility
+
+| Python | Supported |
+|--------|-----------|
+| 3.10   | ✅        |
+| 3.11   | ✅        |
+| 3.12   | ✅        |
+| 3.13   | ✅        |
+| 3.14   | ✅        |
+
+Requires `mypy >= 1.0.0` and works with both the **Polars** and **Pandas** backends of Pandera.
+
+## How It Works
+
+The plugin implements mypy's `get_class_attribute_hook` (for `MySchema.price` style class-level access) and `get_attribute_hook` (for instance-level access).
+
+For every attribute access, it checks whether:
+
+1. The owning class inherits from a Pandera `DataFrameModel` (detected via the MRO, so indirect subclasses work too).
+2. The attribute is annotated with a Pandera column type — either `Series[T]` or a bare type such as `int`.
+
+When both conditions hold, the plugin replaces the inferred type with `builtins.str`.
+
+> **Why `get_class_attribute_hook`?**  
+> Mypy routes class-level attribute access (e.g. `MySchema.price`) through
+> `get_class_attribute_hook` in `mypy.checkmember`, **not** through
+> `get_attribute_hook`. Using only `get_attribute_hook` would leave the common
+> `pl.col(MySchema.price)` pattern uncorrected.
+
+## Development
+
+```bash
+# Install all dependencies including the dev group
+uv sync --group dev
+
+# Run the test suite with coverage
+uv run pytest
+
+# Type-check the plugin
+uv run mypy src
+
+# Lint (report only)
+uv run ruff check .
+
+# Lint and auto-fix
+uv run ruff check --fix .
+
+# Format
+uv run ruff format .
+
+# Check formatting without changing files
+uv run ruff format --check .
+
+# Verify the lockfile is up to date with pyproject.toml
+uv lock --check
+
+# Build the wheel and sdist
+uv build
+```