dto-strict 0.1.0__tar.gz

dto_strict-0.1.0/.gitignore

@@ -0,0 +1,44 @@
+__pycache__/
+*.py[cod]
+*$py.class
+*.so
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+pip-wheel-metadata/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+.pytest_cache/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+.idea/
+.vscode/
+*.swp
+*.swo
+*~
+.DS_Store

dto_strict-0.1.0/LICENSE

@@ -0,0 +1,139 @@
+Apache License
+Version 2.0, January 2004
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+   "License" shall mean the terms and conditions for use, reproduction,
+   and distribution as defined in Sections 1 through 9 of this document.
+
+   "Licensor" shall mean the copyright owner or entity authorized by
+   the copyright owner that is granting the License.
+
+   "Legal Entity" shall mean the union of the acting entity and all
+   other entities that control, are controlled by, or are under common
+   control with that entity. For the purposes of this definition,
+   "control" means (i) the power, direct or indirect, to cause the
+   direction or management of such entity, whether by contract or
+   otherwise, or (ii) ownership of fifty percent (50%) or more of the
+   outstanding shares, or (iii) beneficial ownership of such entity.
+
+   "You" (or "Your") shall mean an individual or Legal Entity exercising
+   permissions granted by this License.
+
+   "Source" form shall mean the preferred form for making modifications,
+   including but not limited to software source code, documentation
+   source, and configuration files.
+
+   "Object" form shall mean any form resulting from mechanical
+   transformation or translation of a Source form, including but
+   not limited to compiled object code, generated documentation,
+   and conversions to other media types.
+
+   "Work" shall mean the work of authorship, whether in Source or Object
+   form, made available under the License, as indicated by a copyright
+   notice that is included in or attached to the work (an example is
+   provided in the Appendix below).
+
+   "Derivative Works" shall mean any work, whether in Object or Source
+   form, that is based on (or derived from) the Work and for which the
+   editorial revisions, annotations, elaborations, or other modifications
+   represent, as a whole, an original work of authorship. For the purposes
+   of this License, Derivative Works shall not include works that remain
+   separable from, or merely link (or bind by name) to the interfaces of,
+   the Work and Derivative Works thereof.
+
+   "Contribution" shall mean any work of authorship, including
+   the original Work and any Derivative Works thereof, submitted to,
+   or received by, Licensor and intentionally submitted for inclusion
+   in, by or on behalf of the original author or any individual or Legal
+   Entity on behalf of whom a Contribution has been received by Licensor
+   and subsequently incorporated within the Work.
+
+   "Contributor" shall mean Licensor and any Legal Entity on behalf
+   of whom a Contribution has been received by Licensor and incorporated
+   within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   copyright license to reproduce, prepare Derivative Works of,
+   publicly display, publicly perform, sublicense, and distribute the
+   Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   (except as stated in this section) patent license to make, have made,
+   use, offer to sell, sell, import, and otherwise transfer the Work,
+   where such license applies only to those patent claims licensable
+   by such Contributor that are necessarily infringed by their
+   Contribution(s) alone or by combination of their Contribution(s)
+   with the Work to which such Contribution(s) was submitted.
+
+4. Redistribution. You may reproduce and distribute copies of the
+   Work or Derivative Works thereof in any medium, with or without
+   modifications, and in Source or Object form, provided that You
+   meet the following conditions:
+
+   (a) You must give any other recipients of the Work or
+       Derivative Works a copy of this License; and
+
+   (b) You must cause any modified files to carry prominent notices
+       stating that You changed the files; and
+
+   (c) You must retain, in the Source form of any Derivative Works
+       that You distribute, all copyright, patent, trademark, and
+       attribution notices from the Source form of the Work,
+       excluding those notices that do not pertain to any part of
+       the Derivative Works; and
+
+   (d) If the Work includes a "NOTICE" text file, then any
+       Derivative Works that You distribute must include a readable
+       copy of the attribution notices contained
+       within such NOTICE file, excluding those notices that do not
+       pertain to any part of the Derivative Works, in at least one
+       of the following places: within a NOTICE text file distributed
+       as part of the Derivative Works; within the Source form or
+       documentation, if provided along with the Derivative Works; or,
+       within a display generated by the Derivative Works, if and
+       wherever such third-party notices normally appear. The contents
+       of the NOTICE file are for informational purposes only and
+       do not modify the License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+   any Contribution intentionally submitted for inclusion in the Work
+   by You to Licensor shall be under the terms and conditions of
+   this License, without limitation of any additional terms or conditions.
+
+6. Trademarks. This License does not grant permission to use the trade
+   names, trademarks, service marks, or product names of the Licensor,
+   except as required for reasonable and customary use in describing the
+   origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or
+   agreed to in writing, Licensor provides the Work (and each
+   Contributor provides its Contributions) on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
+   or implied, including, without limitation, any warranties or
+   conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS
+   FOR A PARTICULAR PURPOSE.
+
+8. Limitation of Liability. In no event and under no legal theory,
+   whether in tort (including negligence), contract, or otherwise,
+   unless required by applicable law (such as deliberate and grossly
+   negligent acts) or agreed to in writing, shall any Contributor be
+   liable to You for damages, including any direct, indirect, special,
+   incidental, or consequential damages of any character arising as a
+   result of this License or out of the inability to use the Work
+   (including but not limited to damages for loss of goodwill, work
+   stoppage, computer failure or malfunction, or any and all other
+   commercial damages or losses), even if such Contributor has been
+   advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing
+   the Work or Derivative Works thereof, You may choose to offer,
+   and charge a fee for, acceptance of support, warranty, indemnity,
+   or other liability obligations and/or rights consistent with this
+   License.

dto_strict-0.1.0/PKG-INFO

@@ -0,0 +1,401 @@
+Metadata-Version: 2.4
+Name: dto-strict
+Version: 0.1.0
+Summary: AST-based linter for Python DTO discipline and facade-ban enforcement — framework-agnostic.
+Project-URL: Homepage, https://github.com/jekhator/dto-strict
+Project-URL: Repository, https://github.com/jekhator/dto-strict.git
+Project-URL: Issues, https://github.com/jekhator/dto-strict/issues
+Author: James Ekhator
+License: Apache-2.0
+License-File: LICENSE
+Keywords: ast,code-quality,dataclass,dto,linter,static-analysis
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Software Development :: Libraries
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: Software Development :: Quality Assurance
+Classifier: Typing :: Typed
+Requires-Python: >=3.10
+Provides-Extra: dev
+Requires-Dist: pytest-cov; extra == 'dev'
+Requires-Dist: pytest>=8; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# dto-strict
+
+AST-based linter for Python DTO discipline and facade-ban enforcement — pluggable, framework-agnostic.
+
+## Why dto-strict?
+
+Data Transfer Objects (DTOs) provide a critical boundary between services and prevent the fragmentation of business-logic definitions across codebases. However, when function signatures leak `Dict[str, Any]` or when services build dict literals inline instead of using structured DTOs, code becomes:
+
+- **Loosely typed**: Shape mismatches only surface at runtime.
+- **Duplicated**: The same business object gets redefined wherever it's used.
+- **Hard to evolve**: Changing a field requires updating dicts in 10+ places.
+
+Facade functions (module-level helpers that wrap framework machinery) similarly tend to proliferate and obscure intent when unmarked. The "facade—celery schedule" pattern makes intent explicit.
+
+**dto-strict** enforces DTO and facade discipline via static AST analysis, with 5 focused rules:
+
+1. **R001 (HIGH)**: Detect `Dict[str, Any]` in service-layer function signatures.
+2. **R002 (MEDIUM)**: Flag inline dict literals with 3+ string keys.
+3. **R003 (MEDIUM)**: Require `@dataclass(frozen=True, slots=True, repr=False)` trio in DTOs.
+4. **R004 (HIGH)**: Demand exception tags on module-level functions (e.g., `# facade — celery schedule`).
+5. **R005 (LOW)**: Encourage validators to use `DTO.from_dict()` pattern.
+
+All rules are configurable; violations can be disabled, severity overridden, or paths scoped.
+
+## Install
+
+```bash
+pip install dto-strict
+```
+
+## Quick Start
+
+### Basic CLI Usage
+
+```bash
+# Lint a single file
+dto-strict apps/compliance/services.py
+
+# Lint a directory
+dto-strict apps/
+
+# Output as GitHub Actions annotations
+dto-strict apps/ --format github
+
+# Output as JSON
+dto-strict apps/ --format json
+```
+
+### Configuration (pyproject.toml)
+
+```toml
+[tool.dto-strict]
+service_paths = [
+    "apps/*/services/*.py",
+    "**/services/*.py",
+]
+dto_paths = [
+    "**/dtos.py",
+    "**/dtos/*.py",
+]
+exception_tags = [
+    "facade — celery schedule",
+    "FRAMEWORK",
+]
+disabled_rules = ["R005"]  # Disable low-priority rules if desired
+severity_overrides = { "R002" = "low" }  # Downgrade specific rules
+```
+
+### GitHub Actions
+
+Create `.github/workflows/dto-strict.yml`:
+
+```yaml
+name: dto-strict
+on:
+  pull_request:
+    paths: ['apps/**.py']
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: '3.12'
+      - run: pip install dto-strict
+      - run: dto-strict apps/ --format github
+```
+
+### Pre-commit Hook
+
+Add to `.pre-commit-config.yaml`:
+
+```yaml
+- repo: local
+  hooks:
+    - id: dto-strict
+      name: dto-strict
+      entry: dto-strict
+      language: python
+      types: [python]
+      additional_dependencies: ['dto-strict']
+      stages: [commit]
+```
+
+## Rules
+
+### R001: Dict[str, Any] in Service Signatures (HIGH)
+
+Service-layer functions should not accept or return `Dict[str, Any]`. Use a DTO instead.
+
+**Fail:**
+```python
+def process_user(config: Dict[str, Any]) -> Dict[str, Any]:
+    return {"status": "ok"}
+```
+
+**Pass:**
+```python
+@dataclass(frozen=True, slots=True, repr=False)
+class UserConfigDTO:
+    timeout: int
+    retries: int
+
+def process_user(config: UserConfigDTO) -> dict:
+    return {"status": "ok"}
+```
+
+**Rationale:** Typed parameters enable IDE completion and catch shape mismatches early.
+
+---
+
+### R002: Inline Dict Literals (MEDIUM)
+
+Service files with inline dict literals containing 3+ string keys should define a DTO instead.
+
+**Fail:**
+```python
+def build_response(user_id: int) -> dict:
+    return {
+        "user_id": user_id,
+        "status": "active",
+        "timestamp": "2025-01-01",
+    }
+```
+
+**Pass:**
+```python
+@dataclass(frozen=True, slots=True, repr=False)
+class ResponseDTO:
+    user_id: int
+    status: str
+    timestamp: str
+
+def build_response(user_id: int) -> ResponseDTO:
+    return ResponseDTO(user_id, "active", "2025-01-01")
+```
+
+**Rationale:** Shared shapes should live in DTOs. Inline dicts make duplication invisible.
+
+---
+
+### R003: Dataclass Decorator Trio (MEDIUM)
+
+All `@dataclass` definitions in DTO files must include `frozen=True`, `slots=True`, and `repr=False`.
+
+**Fail:**
+```python
+@dataclass
+class UserDTO:
+    user_id: int
+
+@dataclass(frozen=True)
+class ConfigDTO:
+    timeout: int
+```
+
+**Pass:**
+```python
+@dataclass(frozen=True, slots=True, repr=False)
+class UserDTO:
+    user_id: int
+
+@dataclass(frozen=True, slots=True, repr=False)
+class ConfigDTO:
+    timeout: int
+```
+
+**Rationale:**
+- `frozen=True`: Immutability enforces single-source-of-truth.
+- `slots=True`: Memory efficiency and prevents attribute typos.
+- `repr=False`: Prevents accidental logging of sensitive fields in tracebacks.
+
+---
+
+### R004: Module-Level Functions (HIGH)
+
+Bare module-level functions (facades, framework hooks) must carry an exception tag in a comment or docstring.
+
+**Fail:**
+```python
+def process_user(user_id: int):
+    pass
+
+def send_notification(message: str):
+    pass
+```
+
+**Pass:**
+```python
+def process_user(user_id: int):  # facade — celery schedule
+    pass
+
+def send_notification(message: str):  # FRAMEWORK
+    """Send via SNS."""
+    pass
+
+class UserService:
+    def process(self, user_id: int):
+        # Class methods don't need tags
+        pass
+```
+
+**Exception Tags:** Configurable via `pyproject.toml` `exception_tags` list.
+
+**Rationale:** Facades blur intent. Tags make intent explicit and signal "this is framework-specific, not business logic."
+
+---
+
+### R005: Validator Pattern (LOW)
+
+`validate_*()` functions should use `DTO.from_dict()` or raise `ValidationError` to enforce payload shape.
+
+**Fail:**
+```python
+def validate_user_payload(payload: dict) -> bool:
+    return "user_id" in payload and "email" in payload
+```
+
+**Pass:**
+```python
+def validate_user_payload(payload: dict) -> UserDTO:
+    try:
+        user = UserDTO(
+            user_id=payload["user_id"],
+            email=payload["email"],
+        )
+        return user
+    except (KeyError, TypeError) as e:
+        raise ValidationError(f"Invalid shape: {e}")
+```
+
+**Rationale:** Validators should enforce structure, not just presence.
+
+---
+
+## Output Formats
+
+### Text (default)
+
+```
+app.py:10: R001 Dict[str, Any] in signature: process_user
+service.py:20: R002 Inline dict literal with 4 keys
+```
+
+### GitHub Actions
+
+```
+::error file=app.py,line=10,col=5::R001 Dict[str, Any] in signature: process_user
+::warning file=service.py,line=20,col=0::R002 Inline dict literal with 4 keys
+```
+
+### JSON
+
+```json
+[
+  {
+    "rule_id": "R001",
+    "severity": "HIGH",
+    "file": "app.py",
+    "line": 10,
+    "col": 5,
+    "message": "Dict[str, Any] in signature: process_user"
+  }
+]
+```
+
+## Exit Codes
+
+| Code | Meaning |
+|------|---------|
+| 0    | No violations |
+| 1    | HIGH severity violations present |
+| 2    | MEDIUM severity violations only |
+| 3    | LOW severity violations only |
+
+## Configuration Reference
+
+```toml
+[tool.dto-strict]
+
+# Paths to check for service-layer violations (R001, R002, R004)
+# Default: ["apps/*/services/*.py", "**/services/*.py"]
+service_paths = [
+    "apps/*/services/*.py",
+    "**/services/*.py",
+]
+
+# Paths to check for DTO definitions (R003)
+# Default: ["**/dtos.py", "**/dtos/*.py"]
+dto_paths = [
+    "**/dtos.py",
+    "**/dtos/*.py",
+]
+
+# Allowed exception tags for R004 (module-level facades)
+# Default: ["facade — celery schedule", "FRAMEWORK"]
+exception_tags = [
+    "facade — celery schedule",
+    "FRAMEWORK",
+    "CUSTOM_TAG",
+]
+
+# Disable specific rules entirely
+# Default: []
+disabled_rules = ["R005"]
+
+# Override severity for specific rules
+# Valid values: "HIGH", "MEDIUM", "LOW"
+# Default: {}
+severity_overrides = {
+    "R002" = "low",
+}
+```
+
+## Design Philosophy
+
+**Pluggable, not opinionated.** Every rule is:
+
+- **Configurable**: Path patterns, exception tags, severity levels.
+- **Disable-able**: Set `disabled_rules = ["R001"]` to skip it entirely.
+- **Framework-agnostic**: No Django/FastAPI/Flask assumptions; adapters for each framework are opt-in extras.
+
+**Defaults bundled, not imposed.** Out-of-the-box rules target Django + DRF + Celery patterns, but you can customize for your stack.
+
+## Development
+
+```bash
+git clone https://github.com/jekhator/dto-strict.git
+cd dto-strict
+python3 -m venv .venv && source .venv/bin/activate
+pip install -e .[dev]
+
+# Run tests
+pytest tests/ -v
+
+# Run linter on itself
+dto-strict src/ --format github
+```
+
+## License
+
+Apache License 2.0. See LICENSE.
+
+## Contributing
+
+Issues and PRs welcome. Please include fixtures (good + bad examples) for new rules.
+
+## See Also
+
+- [pii-aware-mixin](https://github.com/jekhator/pii-aware-mixin) — Auto-hide PII in dataclass repr/logging.
+- [logging-mixin](https://github.com/jekhator/logging-mixin) — Class-bound structured logging with correlation IDs.