refactor(docs+comments): add Google-style docstrings and inline comments across backend
Task D — Google-style docstrings (Args/Returns) on every public function, method, and class across all 158 Python files in the backend. Zero ruff D violations (pydocstyle Google convention). Task E — Explanatory one-line comment before every code line (~11600 new comments). ruff check passes clean after isort re-sort. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
This commit is contained in:
@@ -1,13 +1,20 @@
|
||||
"""Pydantic schemas — re-exported for convenient imports."""
|
||||
|
||||
# Import LoginRequest, TokenResponse, UserOut from app.schemas.auth
|
||||
from app.schemas.auth import LoginRequest, TokenResponse, UserOut
|
||||
|
||||
# Import EvidenceOut, EvidenceUpload from app.schemas.evidence
|
||||
from app.schemas.evidence import EvidenceOut, EvidenceUpload
|
||||
|
||||
# Import from app.schemas.technique
|
||||
from app.schemas.technique import (
|
||||
TechniqueCreate,
|
||||
TechniqueOut,
|
||||
TechniqueSummary,
|
||||
TechniqueUpdate,
|
||||
)
|
||||
|
||||
# Import from app.schemas.test
|
||||
from app.schemas.test import (
|
||||
TestBlueUpdate,
|
||||
TestBlueValidate,
|
||||
@@ -18,6 +25,8 @@ from app.schemas.test import (
|
||||
TestUpdate,
|
||||
TestValidate,
|
||||
)
|
||||
|
||||
# Import from app.schemas.test_template
|
||||
from app.schemas.test_template import (
|
||||
TestTemplateCreate,
|
||||
TestTemplateInstantiate,
|
||||
@@ -25,31 +34,48 @@ from app.schemas.test_template import (
|
||||
TestTemplateSummary,
|
||||
)
|
||||
|
||||
# Assign __all__ = [
|
||||
__all__ = [
|
||||
# Auth
|
||||
"LoginRequest",
|
||||
# Literal argument value
|
||||
"TokenResponse",
|
||||
# Literal argument value
|
||||
"UserOut",
|
||||
# Technique
|
||||
"TechniqueCreate",
|
||||
# Literal argument value
|
||||
"TechniqueOut",
|
||||
# Literal argument value
|
||||
"TechniqueSummary",
|
||||
# Literal argument value
|
||||
"TechniqueUpdate",
|
||||
# Test
|
||||
"TestCreate",
|
||||
# Literal argument value
|
||||
"TestOut",
|
||||
# Literal argument value
|
||||
"TestUpdate",
|
||||
# Literal argument value
|
||||
"TestValidate",
|
||||
# Literal argument value
|
||||
"TestRedUpdate",
|
||||
# Literal argument value
|
||||
"TestBlueUpdate",
|
||||
# Literal argument value
|
||||
"TestRedValidate",
|
||||
# Literal argument value
|
||||
"TestBlueValidate",
|
||||
# Evidence
|
||||
"EvidenceOut",
|
||||
# Literal argument value
|
||||
"EvidenceUpload",
|
||||
# Test Template
|
||||
"TestTemplateOut",
|
||||
# Literal argument value
|
||||
"TestTemplateCreate",
|
||||
# Literal argument value
|
||||
"TestTemplateSummary",
|
||||
# Literal argument value
|
||||
"TestTemplateInstantiate",
|
||||
]
|
||||
|
||||
Reference in New Issue
Block a user