rusty-validator 0.1.1__tar.gz

rusty_validator-0.1.1/.github/workflows/CI.yml

@@ -0,0 +1,184 @@
+# This file is autogenerated by maturin v1.6.0
+# To update, run
+#
+#    maturin generate-ci github
+#
+name: CI
+
+on:
+  push:
+    branches:
+      - main
+      - master
+    tags:
+      - '*'
+  pull_request:
+  workflow_dispatch:
+
+permissions:
+  contents: read
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: astral-sh/setup-uv@v5
+        with:
+          enable-cache: true
+      - uses: dtolnay/rust-toolchain@stable
+      - name: Sync deps and build extension
+        run: uv sync
+      - name: Test
+        run: uv run pytest
+      - name: Type-check
+        run: uv run mypy python
+
+  linux:
+    runs-on: ${{ matrix.platform.runner }}
+    strategy:
+      matrix:
+        platform:
+          - runner: ubuntu-latest
+            target: x86_64
+          - runner: ubuntu-latest
+            target: x86
+          - runner: ubuntu-latest
+            target: aarch64
+          - runner: ubuntu-latest
+            target: armv7
+          - runner: ubuntu-latest
+            target: s390x
+          - runner: ubuntu-latest
+            target: ppc64le
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: '3.13'
+      - name: Build wheels
+        uses: PyO3/maturin-action@v1
+        with:
+          target: ${{ matrix.platform.target }}
+          # abi3-py313: one cp313-abi3 wheel per platform, runs on all CPython >=3.13.
+          args: --release --out dist -i 3.13
+          sccache: 'true'
+          manylinux: auto
+      - name: Upload wheels
+        uses: actions/upload-artifact@v4
+        with:
+          name: wheels-linux-${{ matrix.platform.target }}
+          path: dist
+
+  musllinux:
+    runs-on: ${{ matrix.platform.runner }}
+    strategy:
+      matrix:
+        platform:
+          - runner: ubuntu-latest
+            target: x86_64
+          - runner: ubuntu-latest
+            target: x86
+          - runner: ubuntu-latest
+            target: aarch64
+          - runner: ubuntu-latest
+            target: armv7
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: '3.13'
+      - name: Build wheels
+        uses: PyO3/maturin-action@v1
+        with:
+          target: ${{ matrix.platform.target }}
+          # abi3-py313: one cp313-abi3 wheel per platform, runs on all CPython >=3.13.
+          args: --release --out dist -i 3.13
+          sccache: 'true'
+          manylinux: musllinux_1_2
+      - name: Upload wheels
+        uses: actions/upload-artifact@v4
+        with:
+          name: wheels-musllinux-${{ matrix.platform.target }}
+          path: dist
+
+  windows:
+    runs-on: ${{ matrix.platform.runner }}
+    strategy:
+      matrix:
+        platform:
+          - runner: windows-latest
+            target: x64
+          - runner: windows-latest
+            target: x86
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: '3.13'
+          architecture: ${{ matrix.platform.target }}
+      - name: Build wheels
+        uses: PyO3/maturin-action@v1
+        with:
+          target: ${{ matrix.platform.target }}
+          # abi3-py313: one cp313-abi3 wheel per platform, runs on all CPython >=3.13.
+          args: --release --out dist -i 3.13
+          sccache: 'true'
+      - name: Upload wheels
+        uses: actions/upload-artifact@v4
+        with:
+          name: wheels-windows-${{ matrix.platform.target }}
+          path: dist
+
+  macos:
+    # Single universal2 build on Apple Silicon: Intel macOS runners (macos-13) queue for
+    # hours / don't schedule on public repos, while one ARM runner emits a fat x86_64+arm64
+    # wheel. abi3 cross-compiles cleanly, so this keeps Intel coverage without an Intel runner.
+    runs-on: macos-14
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: '3.13'
+      - name: Build wheels
+        uses: PyO3/maturin-action@v1
+        with:
+          target: universal2-apple-darwin
+          # abi3-py313: one cp313-abi3 wheel, runs on all CPython >=3.13.
+          args: --release --out dist -i 3.13
+          sccache: 'true'
+      - name: Upload wheels
+        uses: actions/upload-artifact@v4
+        with:
+          name: wheels-macos-universal2
+          path: dist
+
+  sdist:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Build sdist
+        uses: PyO3/maturin-action@v1
+        with:
+          command: sdist
+          args: --out dist
+      - name: Upload sdist
+        uses: actions/upload-artifact@v4
+        with:
+          name: wheels-sdist
+          path: dist
+
+  release:
+    name: Release
+    runs-on: ubuntu-latest
+    if: "startsWith(github.ref, 'refs/tags/')"
+    needs: [test, linux, musllinux, windows, macos, sdist]
+    steps:
+      - uses: actions/download-artifact@v4
+      - name: Publish to PyPI
+        uses: PyO3/maturin-action@v1
+        env:
+          MATURIN_PYPI_TOKEN: ${{ secrets.PYPI_API_TOKEN }}
+        with:
+          command: upload
+          args: --non-interactive --skip-existing wheels-*/*

rusty_validator-0.1.1/.gitignore

@@ -0,0 +1,73 @@
+/target
+.claude
+graphify-out/
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+.pytest_cache/
+*.py[cod]
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+.venv/
+env/
+bin/
+build/
+develop-eggs/
+dist/
+eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+include/
+man/
+venv/
+*.egg-info/
+.installed.cfg
+*.egg
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+pip-selfcheck.json
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.coverage
+.cache
+nosetests.xml
+coverage.xml
+
+# Translations
+*.mo
+
+# Mr Developer
+.mr.developer.cfg
+.project
+.pydevproject
+
+# Rope
+.ropeproject
+
+# Django stuff:
+*.log
+*.pot
+
+.DS_Store
+
+# Sphinx documentation
+docs/_build/
+
+# PyCharm
+.idea/
+
+# VSCode
+.vscode/
+
+# Pyenv / uv: .python-version is committed (pins the dev interpreter)

rusty_validator-0.1.1/.python-version

@@ -0,0 +1 @@
+3.13

rusty_validator-0.1.1/CLAUDE.md

@@ -0,0 +1,170 @@
+# CLAUDE.md
+
+Dieser Leitfaden hilft Claude Code (claude.ai/code) bei der Arbeit in diesem Repository.
+
+## Projektüberblick
+
+**rusty-validator** ist ein schmales **Python-Binding** der Rust-Crate
+[`validator`](https://github.com/Keats/validator), gebaut mit **PyO3** und
+**maturin**. Es stellt Validierungs-**Prädikate** bereit: Funktionen, die prüfen, ob
+eine Zeichenkette wohlgeformt ist (E-Mail-Adresse, URL, IP-Adresse) und `True`/`False`
+zurückgeben. Die eigentliche Prüf-Logik liefert die Crate — dieses Projekt reicht sie
+nur treu nach Python durch.
+
+**Vor Änderungen lesen** — die Domänensprache und die tragenden Entscheidungen sind
+hier festgehalten:
+
+- [CONTEXT.md](CONTEXT.md) — Glossar (Validieren, Format-/Constraint-Validator,
+  E-Mail-Adresse, URL, IP-Adresse) + Beispieldialog. Reines Glossar, keine
+  Implementierungsdetails.
+- [docs/adr/](docs/adr/) — Architektur-Entscheidungen:
+  - [0001](docs/adr/0001-treues-binding-der-validator-crate.md) — Treues Binding der
+    `validator`-Crate (Crate = Vorgabe, mit dokumentierten Ausnahmen)
+  - [0002](docs/adr/0002-reines-praedikat-binding-ergonomie-separat.md) — Reines
+    Prädikat-Binding; Ergonomie (Guards/Decorators/Constraint-Objekte) in separatem Paket
+  - [0003](docs/adr/0003-pythonische-parameternamen.md) — Pythonische Parameternamen
+  - [0004](docs/adr/0004-strikter-typ-vertrag.md) — Strikter Typ-Vertrag: `TypeError`
+    bei Typfehler, sonst Prädikat
+
+## Architektur
+
+Drei Schichten, von Rust nach Python:
+
+1. **Rust** ([src/lib.rs](src/lib.rs)): Jede Validierung ist eine `#[pyfunction]`
+   (`validate_email`/`validate_url`/`validate_ip`), die an die `validator`-Crate
+   delegiert. Registriert werden sie im `#[pymodule] _validator`.
+2. **maturin** baut die Rust-`cdylib` zur nativen Erweiterung `rusty_validator._validator`
+   (siehe `[tool.maturin]` in [pyproject.toml](pyproject.toml): `python-source = "python"`,
+   `module-name = "rusty_validator._validator"`).
+3. **Python** ([`python/rusty_validator/__init__.py`](python/rusty_validator/__init__.py))
+   re-exportiert die Funktionen aus `._validator`; die Typen stehen im Stub
+   [`__init__.pyi`](python/rusty_validator/__init__.pyi).
+
+**Leitprinzipien** (Details in den ADRs):
+
+- **Treues Binding**: Verhalten = `validator`-Crate. Überraschende Crate-Ergebnisse
+  (z. B. `validate_url("ftp://x")` ist `True`, `validate_ip("::1")` ist `True`) sind
+  beabsichtigt geerbt — **nicht** „reparieren". Abweichungen sind dokumentierte
+  Ausnahmen (ADR 0001).
+- **Reines Prädikat**: Jede Funktion gibt `bool` zurück. Kein „wirf-bei-ungültig"-Stil
+  (Guard), keine Constraint-Objekte, keine Decorators — die gehören in ein **separates**
+  Ergonomie-Paket (ADR 0002).
+- **Pythonische Parameternamen**: Parametrisierte Validatoren bekommen lesbare Namen
+  (z. B. `min_length` statt Crate-`min`) — bewusste Ausnahme zu ADR 0001 (ADR 0003).
+- **Strikter Typ-Vertrag**: Korrekt typisierte, aber ungültige Eingabe → `False`;
+  **typ-falsche** Eingabe (z. B. `None`) → `TypeError`, kein stilles `False` (ADR 0004).
+
+## Repository-Struktur
+
+```text
+rusty-validator/
+├── CLAUDE.md                     # Diese Datei
+├── CONTEXT.md                    # Domänen-Glossar
+├── README.md                     # Nutzer-Doku
+├── Cargo.toml / Cargo.lock       # Rust-Crate (Name, Version, Dependencies)
+├── pyproject.toml                # maturin-Build + mypy-Konfiguration
+├── docs/adr/                     # Architektur-Entscheidungen (ADRs)
+├── src/lib.rs                    # Rust: #[pyfunction]s + #[pymodule]
+├── python/rusty_validator/
+│   ├── __init__.py               # Re-Export der nativen Funktionen
+│   ├── __init__.pyi              # Typ-Stubs der öffentlichen API
+│   └── py.typed                  # Markiert das Paket als typisiert (PEP 561)
+├── tests/                        # pytest-Suite (parametrisiert)
+└── .github/workflows/CI.yml      # Wheels bauen (Multi-Target) + PyPI-Release bei Tags
+```
+
+## Entwicklungsbefehle
+
+[uv](https://docs.astral.sh/uv/) verwaltet venv, Dev-Dependencies (`[dependency-groups]`
+in [pyproject.toml](pyproject.toml)) und die Python-Version ([.python-version](.python-version));
+**maturin bleibt das Build-Backend** (`[build-system]`). Einmal `uv sync` holt die Tools
+ins `.venv`; danach laufen alle Befehle ohne globale Installation via `uv run`. (Ohne uv
+funktionieren die blanken Befehle im aktiven venv weiterhin.)
+
+```bash
+uv sync                    # .venv + Dev-Tools (pytest, mypy, maturin) aus uv.lock
+```
+
+### Bauen & in das venv installieren (Entwicklung)
+
+```bash
+uv run maturin develop            # kompiliert die Rust-Erweiterung in das venv
+uv run maturin develop --release  # optimierter Build (langsamer zu bauen, schneller zur Laufzeit)
+```
+
+Nach jeder Änderung an [src/lib.rs](src/lib.rs) muss `maturin develop` neu laufen, bevor
+die Python-Tests die Änderung sehen — **uv recompiliert kompilierte Projekte nicht
+automatisch**.
+
+### Tests
+
+```bash
+uv run pytest              # Python-Tests (benötigt vorher: maturin develop)
+uv run pytest --cov        # mit Coverage
+```
+
+Es gibt bewusst **keine** Rust-`#[cfg(test)]`-Tests: das Binding wird über die
+pytest-Suite gegen die echte Extension geprüft (treuer als ein In-Process-Embedded-Test),
+und die `validator`-Crate testen wir nicht nach (ADR 0001).
+
+### Typprüfung (mypy-Config in pyproject.toml)
+
+```bash
+uv run mypy python         # prüft Stubs/Python-Quelle (disallow_untyped_defs aktiv)
+```
+
+### Rust-Standardwerkzeuge
+
+```bash
+cargo fmt                  # formatieren
+cargo clippy               # Lints
+```
+
+### Wheels bauen
+
+```bash
+uv run maturin build --release    # baut ein Wheel nach target/wheels/
+```
+
+## Einen neuen Validator hinzufügen
+
+Ziel des Projekts ist breite Abdeckung der `validator`-Crate (siehe CONTEXT.md). Beim
+Hinzufügen eines Validators die ADR-Prinzipien einhalten:
+
+1. **Rust** ([src/lib.rs](src/lib.rs)): `#[pyfunction] fn validate_x(...) -> PyResult<bool>`
+   anlegen, an die passende `validator`-Trait-Methode delegieren, und im
+   `#[pymodule] _validator` per `wrap_pyfunction!` registrieren.
+   - **Format-Validator** (argumentlos): Signatur `f(value: String) -> PyResult<bool>`.
+   - **Constraint-Validator** (parametrisiert): pythonische Keyword-Parameter (ADR 0003);
+     Ergebnis bleibt `bool` (ADR 0002).
+2. **Python-Oberfläche**: Funktion in [`__init__.py`](python/rusty_validator/__init__.py)
+   (`__all__`) und im Stub [`__init__.pyi`](python/rusty_validator/__init__.pyi) ergänzen.
+3. **Tests** ([tests/](tests/)): parametrisierte `pytest`-Fälle (gültig **und** ungültig);
+   für den Typ-Vertrag auch einen `TypeError`-Fall (ADR 0004).
+4. `maturin develop` ausführen, dann `pytest`.
+5. **`graphify update .`** ausführen, um den Wissensgraphen aktuell zu halten.
+
+## Release
+
+- Die veröffentlichte Version steht in [Cargo.toml](Cargo.toml) (`[package].version`);
+  Python bezieht sie dynamisch daraus.
+- Ein **Git-Tag** auslösen → [CI.yml](.github/workflows/CI.yml) baut Wheels für alle
+  Targets und published zu PyPI (`MATURIN_PYPI_TOKEN`).
+
+## Codebase-Navigation (graphify)
+
+Dieses Projekt hat einen Wissensgraphen unter `graphify-out/` (god nodes, Community-
+Struktur, dateiübergreifende Beziehungen).
+
+Regeln:
+
+- Für Fragen zur Codebasis zuerst `graphify query "<frage>"` ausführen, wenn
+  `graphify-out/graph.json` existiert. `graphify path "<A>" "<B>"` für Beziehungen,
+  `graphify explain "<konzept>"` für fokussierte Konzepte. Diese liefern einen
+  begrenzten Subgraphen, meist deutlich kleiner als `GRAPH_REPORT.md` oder rohe
+  grep-Ausgabe.
+- Existiert `graphify-out/wiki/index.md`, dieses zur groben Navigation nutzen statt
+  rohem Quelltext-Browsing.
+- `graphify-out/GRAPH_REPORT.md` nur für breite Architektur-Reviews lesen oder wenn
+  query/path/explain nicht genug Kontext liefern.
+- Nach Code-Änderungen `graphify update .` ausführen (nur AST, keine API-Kosten).

rusty_validator-0.1.1/CONTEXT.md

@@ -0,0 +1,83 @@
+# Rusty Validator
+
+Ein schmales Python-Binding der Rust-Crate `validator` (über PyO3). Es prüft, ob
+ein Wert eine bestimmte Regel erfüllt — die Form einer E-Mail/URL/IP oder eine
+Bedingung wie Länge oder Wertebereich — und gibt das Ergebnis als `bool` zurück.
+Eigene Ergonomie (Decorators, Guards, Constraint-Objekte) gehört bewusst in ein
+separates Paket, nicht hierher.
+
+## Language
+
+**Validieren / Validierung**:
+Die Prüfung, ob ein Wert eine **definierte Regel** erfüllt. Das Ergebnis ist ein
+**Prädikat**: für korrekt typisierte Eingaben immer ein `bool`, nie ein
+Validierungs-*Fehler* — der „wirf bei ungültig"-Stil (Guard) lebt im separaten
+Ergonomie-Paket, nicht hier. **Typ-falsche** Eingaben (z. B. `None`) sind ein
+Programmierfehler und lösen wie üblich einen `TypeError` aus, kein stilles `False`.
+Invariante: rein lokal — es wird nie geprüft, ob etwas real existiert oder
+erreichbar ist (kein DNS, kein Netzwerk, keine IO).
+*Avoid*: Prüfen auf Existenz, Verifizieren, Zustellbarkeit; Guard/Erzwingen (andere Operation)
+
+**Format-Validator**:
+Ein **argumentloser** Validator, der die **Form** einer Zeichenkette prüft:
+`email`, `url`, `ip` (perspektivisch auch `credit_card`, `phone`,
+`non_control_character`). Signatur stets `f(str) -> bool`.
+
+**Constraint-Validator**:
+Ein **parametrisierter** Validator, der eine **Bedingung** an einem Wert prüft:
+`length`, `range`, `contains`, `must_match`. Braucht Argumente (z. B. Grenzen) und
+arbeitet nicht zwingend auf Zeichenketten (`range` prüft Zahlen).
+*Avoid*: Format-Validator (die andere Unterart)
+
+**E-Mail-Adresse**:
+Eine **einzelne**, wohlgeformte Adresse `lokalteil@domain` im Sinne von
+`validator::ValidateEmail`. Rein syntaktisch — keine Existenz-/MX-Prüfung. **Keine**
+Anzeigenamen-Form (`Max <max@x.de>`) und **keine** Liste mehrerer Adressen.
+*Avoid*: E-Mail (zu unscharf, wenn die Adresse gemeint ist), Mail-Konto
+
+**URL**:
+Eine wohlgeformte **absolute** URL im Sinne von `validator::ValidateUrl` (RFC 3986),
+also *mit* Schema und Host. Das Schema ist **nicht** auf Web beschränkt: `http`,
+`https`, `ftp`, `mailto`, `file` und sogar erfundene Schemata gelten als gültig.
+„example.com" (ohne Schema) ist hingegen keine gültige URL. Die Grenze definiert
+allein die Crate — wir engen sie nicht auf http/https ein.
+*Avoid*: URI, Link, Web-Adresse (suggeriert fälschlich „nur http/https")
+
+**IP-Adresse**:
+Eine wohlgeformte IP-Adresse im Sinne von `validator::ValidateIp` — **IPv4 oder
+IPv6** sind beide eine IP-Adresse (`127.0.0.1` ebenso wie `::1`). Rein syntaktisch,
+keine Erreichbarkeitsprüfung. **IPv4** und **IPv6** sind unterscheidbare Unterarten,
+die getrennt prüfbar gemacht werden.
+*Avoid*: Host, Hostname (das ist ein Name, keine Adresse)
+
+## Beispieldialog
+
+**Entwickler:** `validate_url("ftp://files.example.com")` gibt `True` — ist das ein Bug?
+
+**Expertin:** Nein. Eine **URL** ist bei uns jede wohlgeformte absolute URL, egal
+welches Schema. Wir reichen die `validator`-Crate treu durch und engen sie nicht auf
+http/https ein.
+
+**Entwickler:** Ich *will* aber nur Web-Adressen zulassen.
+
+**Expertin:** Das ist eine eigene **Regel** über der Validierung — die gehört ins
+Ergonomie-Paket, nicht ins Binding. Das Binding sagt nur „wohlgeformt: ja/nein".
+
+**Entwickler:** Und `validate_length`? Das ist doch keine Form.
+
+**Expertin:** Genau. `email`/`url`/`ip` sind **Format-Validatoren** (argumentlos,
+prüfen die Form). `length`/`range`/`contains` sind **Constraint-Validatoren**
+(parametrisiert, prüfen eine Bedingung). Beides ist **Validierung**, beides liefert
+ein **Prädikat**.
+
+**Entwickler:** Und wenn ich `validate_ip(None)` übergebe?
+
+**Expertin:** `TypeError` — ein Programmierfehler, kein „ungültig". Ein kaputter
+*String* gibt `False`; ein **falscher Typ** wirft. Und wenn bei Ungültigkeit ein
+Fehler fliegen soll, brauchst du einen **Guard** — den gibt es hier nicht, er lebt
+im Ergonomie-Paket.
+
+**Entwickler:** `validate_ip("::1")`?
+
+**Expertin:** `True` — eine **IP-Adresse** ist v4 *oder* v6. Willst du gezielt nur
+v6, nimm `validate_ipv6`.