refactor(types): add comprehensive type annotations across backend Python codebase
Enable ANN rules in ruff.toml (flake8-annotations) and resolve all 221 violations: ANN201/ANN202 — return types on 168 public/private functions: - All 28 FastAPI routers: endpoints annotated with dict/list/specific schema/ StreamingResponse/FileResponse/JSONResponse as appropriate - main.py: lifespan→AsyncGenerator[None,None], exception handlers→JSONResponse - database.py: get_db→Generator[Session,None,None], proxy methods→correct types - middleware/request_context.py: dispatch→Response with Callable call_next type ANN001/ANN002/ANN003 — 32 missing argument types: - seed_demo.py: all db parameters typed as Session - domain/unit_of_work.py: __aexit__ exc_type/exc_val/exc_tb typed with TracebackType - services: audit_service user_id→UUID|None, heatmap_service query/model/builder, notification_service test→Test, tempo_service test→Test/user→User, test_workflow_service test_id→UUID, campaign_crud **fields→object, test_crud **fields→object (4 sites) ANN401 — 16 Any usages resolved: - Domain entities (campaign/technique/threat_actor/test_entity): replaced Any with actual ORM types via TYPE_CHECKING guards to avoid circular imports - detection_rule_service: test_id/detection_rule_id/evaluator_id→UUID - score_cache: kept Any with # noqa: ANN401 (genuinely generic cache) - jira_service/tempo_service: kept Any with # noqa: ANN401 (lazy optional deps) - d3fend_import_service: _to_str(v: Any) kept with # noqa: ANN401 ANN204/ANN205/ANN206 — special/static/class methods: - database.py proxy __call__/__getattr__: *args: object/**kwargs: object - schemas/test.py model_validate: obj→object, **kwargs→object - sa_technique_repository._int_type→type All 439 unit tests pass. ruff check app/ → All checks passed!
This commit is contained in:
@@ -34,7 +34,7 @@ router = APIRouter(prefix="/compliance", tags=["compliance"])
|
||||
def list_frameworks_endpoint(
|
||||
db: Session = Depends(get_db),
|
||||
current_user: User = Depends(get_current_user),
|
||||
):
|
||||
) -> list:
|
||||
"""List all available compliance frameworks."""
|
||||
return list_frameworks(db)
|
||||
|
||||
@@ -47,7 +47,7 @@ def framework_status(
|
||||
framework_id: str,
|
||||
db: Session = Depends(get_db),
|
||||
current_user: User = Depends(get_current_user),
|
||||
):
|
||||
) -> dict:
|
||||
"""Get compliance status for each control in a framework."""
|
||||
return get_framework_status(db, framework_id)
|
||||
|
||||
@@ -60,7 +60,7 @@ def framework_report(
|
||||
framework_id: str,
|
||||
db: Session = Depends(get_db),
|
||||
current_user: User = Depends(get_current_user),
|
||||
):
|
||||
) -> dict:
|
||||
"""Get the full compliance report (same as status but marked as report)."""
|
||||
return get_framework_status(db, framework_id)
|
||||
|
||||
@@ -73,7 +73,7 @@ def framework_report_csv(
|
||||
framework_id: str,
|
||||
db: Session = Depends(get_db),
|
||||
current_user: User = Depends(get_current_user),
|
||||
):
|
||||
) -> StreamingResponse:
|
||||
"""Export compliance report as CSV."""
|
||||
csv_bytes, filename = build_framework_report_csv(db, framework_id)
|
||||
return StreamingResponse(
|
||||
@@ -93,7 +93,7 @@ def framework_gaps(
|
||||
framework_id: str,
|
||||
db: Session = Depends(get_db),
|
||||
current_user: User = Depends(get_current_user),
|
||||
):
|
||||
) -> dict:
|
||||
"""Get controls with techniques that are not adequately covered."""
|
||||
return get_framework_gaps(db, framework_id)
|
||||
|
||||
@@ -105,7 +105,7 @@ def framework_gaps(
|
||||
def import_nist(
|
||||
db: Session = Depends(get_db),
|
||||
current_user: User = Depends(require_role("admin")),
|
||||
):
|
||||
) -> dict:
|
||||
"""Import NIST 800-53 Rev 5 mappings (admin only)."""
|
||||
result = import_nist_800_53_mappings(db)
|
||||
return result
|
||||
@@ -115,7 +115,7 @@ def import_nist(
|
||||
def import_cis(
|
||||
db: Session = Depends(get_db),
|
||||
current_user: User = Depends(require_role("admin")),
|
||||
):
|
||||
) -> dict:
|
||||
"""Import CIS Controls v8 mappings (admin only)."""
|
||||
result = import_cis_controls_v8_mappings(db)
|
||||
return result
|
||||
|
||||
Reference in New Issue
Block a user