Samir Boulahtit
7c43d6f4a2
Eliminate all 103 errors and 96 warnings from the architecture validator: Phase 1 - Validator rules & YAML: - Add NAM-001/NAM-002 exceptions for module-scoped router/service files - Fix API-004 to detect # public comments on decorator lines - Add module-specific exception bases to EXC-004 valid_bases - Exclude storefront files from AUTH-004 store context check - Add SVC-006 exceptions for loyalty service atomic commits - Fix _get_rule() to search naming_rules and auth_rules categories - Use plain # CODE comments instead of # noqa: CODE for custom rules Phase 2 - Billing module (5 route files): - Move _resolve_store_to_merchant to subscription_service - Move tier/feature queries to feature_service, admin_subscription_service - Extract 22 inline Pydantic schemas to billing/schemas/billing.py - Replace all HTTPException with domain exceptions Phase 3 - Loyalty module (4 routes + points_service): - Add 7 domain exceptions (Apple auth, enrollment, device registration) - Add service methods to card_service, program_service, apple_wallet_service - Move all db.query() from routes to service layer - Fix SVC-001: replace HTTPException in points_service with domain exception Phase 4 - Remaining modules: - tenancy: move store stats queries to admin_service - cms: move platform resolution to content_page_service, add NoPlatformSubscriptionException - messaging: move user/customer lookups to messaging_service - Add ConfigDict(from_attributes=True) to ContentPageResponse Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
73 lines
2.3 KiB
YAML
73 lines
2.3 KiB
YAML
# Architecture Rules - Exception Handling Rules
|
|
# Rules for exception handling across the application
|
|
|
|
exception_rules:
|
|
|
|
- id: "EXC-001"
|
|
name: "Define custom exceptions in exceptions module"
|
|
severity: "warning"
|
|
description: |
|
|
Create domain-specific exceptions in app/exceptions/ for better
|
|
error handling and clarity.
|
|
pattern:
|
|
file_pattern:
|
|
- "app/exceptions/**/*.py"
|
|
- "app/modules/*/exceptions.py"
|
|
encouraged_structure: |
|
|
class VendorError(Exception):
|
|
"""Base exception for vendor-related errors"""
|
|
pass
|
|
|
|
- id: "EXC-002"
|
|
name: "Never use bare except"
|
|
severity: "error"
|
|
description: |
|
|
Always specify exception types. Bare except catches everything including
|
|
KeyboardInterrupt and SystemExit.
|
|
pattern:
|
|
file_pattern: "**/*.py"
|
|
anti_patterns:
|
|
- "except:"
|
|
- "except\\s*:"
|
|
|
|
- id: "EXC-003"
|
|
name: "Log all exceptions with context"
|
|
severity: "warning"
|
|
description: |
|
|
When catching exceptions, log them with context and stack trace.
|
|
pattern:
|
|
file_pattern:
|
|
- "app/services/**/*.py"
|
|
- "app/modules/*/services/**/*.py"
|
|
encouraged_patterns:
|
|
- "logger.error"
|
|
- "exc_info=True"
|
|
|
|
- id: "EXC-004"
|
|
name: "Domain exceptions must inherit from WizamartException"
|
|
severity: "error"
|
|
description: |
|
|
All custom domain exceptions must inherit from WizamartException (or its
|
|
subclasses like ResourceNotFoundException, ValidationException, etc.).
|
|
This ensures the global exception handler catches and converts them properly.
|
|
pattern:
|
|
file_pattern:
|
|
- "app/exceptions/**/*.py"
|
|
- "app/modules/*/exceptions.py"
|
|
required_base_class: "WizamartException"
|
|
example_good: |
|
|
class VendorNotFoundException(ResourceNotFoundException):
|
|
def __init__(self, vendor_code: str):
|
|
super().__init__(resource_type="Vendor", identifier=vendor_code)
|
|
|
|
- id: "EXC-005"
|
|
name: "Exception handler must be registered"
|
|
severity: "error"
|
|
description: |
|
|
The global exception handler must be set up in app initialization to
|
|
catch WizamartException and convert to HTTP responses.
|
|
pattern:
|
|
file_pattern: "app/main.py"
|
|
required_patterns:
|
|
- "setup_exception_handlers"
|