mirror of
https://github.com/DRYTRIX/TimeTracker.git
synced 2026-05-22 06:10:24 -05:00
Dries Peeters
1836cb3c2d
Drives ``mypy app/`` from 567 errors in 208 files to 0 errors across the
376 source files checked by ``./scripts/run-ci-local.sh code-quality``.
Configuration & dependencies
- pyproject.toml: enable implicit_optional (Flask-style ``x: str = None``
defaults), silence truthy-function/truthy-bool (legitimate import-guard
checks like ``KanbanColumn``), and disable warn_return_any (SQLAlchemy
1.x ``Query`` API returns Any pervasively). Add module overrides for
``app.models.*``, repositories, base CRUD service, and known
``joinedload`` / ``Query.paginate`` callers where mypy cannot model the
Flask-SQLAlchemy runtime API without a plugin.
- requirements-test.txt: pin ``types-requests``, ``types-bleach``,
``types-Markdown``, ``types-python-dateutil`` so mypy stops complaining
about missing stubs.
Latent bugs fixed while driving mypy to zero
- app/utils/logger.py, app/utils/datetime_utils.py: drop imports of
symbols that don't exist (``get_performance_metrics``,
``from_app_timezone``, ``to_app_timezone``) — these would have raised
at import time on first use.
- app/services/currency_service.py: ``from typing import Decimal`` was a
bug (typing has no Decimal); switch to ``decimal.Decimal`` and rename
the ``D`` alias.
- app/utils/env_validation.py, app/utils/role_migration.py: ``Dict[str,
any]`` → ``Dict[str, Any]`` (built-in ``any`` is not a type).
- app/utils/email.py: introduce ``send_template_email`` and update the
three callers (``client_approval_service``,
``client_notification_service``, ``workflow_engine``) that were
passing ``to=``/``template=``/etc. to ``send_email`` whose signature
doesn't accept them — calls would have raised TypeError at runtime.
- app/services/permission_service.py: rewrite ``grant_permission`` /
``revoke_permission`` to use the actual ``Role`` ↔ ``Permission``
many-to-many relationship; the old code referenced non-existent
``Permission.role_id`` / ``Permission.granted`` columns.
- app/services/gps_tracking_service.py: pass the required ``title`` and
``expense_date`` fields when creating mileage ``Expense`` rows.
- app/services/workflow_engine.py: ``_perform_action`` now forwards the
``rule`` argument to ``_action_log_time``, and ``_action_webhook``
short-circuits when ``url`` is missing.
- app/services/time_tracking_service.py: validate ``start_time`` /
``end_time`` before comparing them.
- app/services/export_service.py: build CSV in a ``StringIO`` then wrap
the bytes in ``BytesIO`` — ``csv.writer`` requires text I/O.
- app/integrations/peppol_smp.py: avoid attribute access on ``None`` in
the SMP ``href`` fallback.
- app/integrations/{github,gitlab,slack}.py: coerce query-string params
to strings so ``requests.get(params=...)`` matches the typed signature
(and is what the HTTP layer expects anyway).
- app/integrations/{xero,quickbooks}.py: guard ``get_access_token()``
returning ``None`` before calling private ``_api_request`` helpers.
Annotation-only changes
- Add ``Dict[str, Any]`` / ``list`` / ``Optional[...]`` annotations to
service dict-literals that mypy could not infer from heterogeneous
values (``ai_suggestion_service``, ``ai_categorization_service``,
``custom_report_service``, ``unpaid_hours_service``,
``integration_service``, ``invoice_service``, ``backup_service``,
``inventory_report_service``, ``analytics_service``, etc.).
- ``app/utils/event_bus.py``: ``emit_event`` accepts ``str |
WebhookEvent`` and normalizes to ``str`` so all call-sites type-check.
- ``app/utils/api_responses.py``: introduce ``ApiResponse`` alias for
``Response | tuple[Response, int] | tuple[str, int]``.
- ``app/utils/budget_forecasting.py``: forecasting helpers return
``Optional[Dict]`` (they already returned ``None`` when the project
was missing).
- ``app/utils/pdf_generator_reportlab.py``: ``_normalize_color`` is
``Optional[str]``.
- ``app/utils/pdfa3.py``: remove invalid ``force_version=None`` retry
call.
- Narrow ``type: ignore`` markers on optional-dependency fallbacks
(``redis``, ``bleach``, ``markdown``, ``babel``,
``powerpoint_export``) and on the documented ``requests.Session``
/ ``RotatingFileHandler`` typeshed limitations.
108 lines
2.7 KiB
Python
108 lines
2.7 KiB
Python
"""
|
|
Enhanced logging utilities.
|
|
"""
|
|
|
|
import logging
|
|
from typing import Any, Dict, Optional
|
|
|
|
from flask import g, request
|
|
|
|
|
|
def get_logger(name: str) -> logging.Logger:
|
|
"""
|
|
Get a logger instance.
|
|
|
|
Args:
|
|
name: Logger name (usually __name__)
|
|
|
|
Returns:
|
|
Logger instance
|
|
"""
|
|
return logging.getLogger(name)
|
|
|
|
|
|
def log_request(logger: logging.Logger, level: int = logging.INFO, extra: Optional[Dict[str, Any]] = None) -> None:
|
|
"""
|
|
Log request information.
|
|
|
|
Args:
|
|
logger: Logger instance
|
|
level: Log level
|
|
extra: Additional context
|
|
"""
|
|
if not request:
|
|
return
|
|
|
|
context = {
|
|
"method": request.method,
|
|
"path": request.path,
|
|
"remote_addr": request.remote_addr,
|
|
"user_agent": request.headers.get("User-Agent"),
|
|
"request_id": getattr(g, "request_id", None),
|
|
}
|
|
|
|
if extra:
|
|
context.update(extra)
|
|
|
|
logger.log(level, f"{request.method} {request.path}", extra=context)
|
|
|
|
|
|
def log_error(logger: logging.Logger, error: Exception, context: Optional[Dict[str, Any]] = None) -> None:
|
|
"""
|
|
Log an error with context.
|
|
|
|
Args:
|
|
logger: Logger instance
|
|
error: Exception to log
|
|
context: Additional context
|
|
"""
|
|
error_context = {
|
|
"error_type": type(error).__name__,
|
|
"error_message": str(error),
|
|
"request_id": getattr(g, "request_id", None),
|
|
"path": request.path if request else None,
|
|
"method": request.method if request else None,
|
|
}
|
|
|
|
if context:
|
|
error_context.update(context)
|
|
|
|
logger.error(f"Error: {error}", exc_info=True, extra=error_context)
|
|
|
|
|
|
def log_business_event(logger: logging.Logger, event: str, user_id: Optional[int] = None, **kwargs) -> None:
|
|
"""
|
|
Log a business event.
|
|
|
|
Args:
|
|
logger: Logger instance
|
|
event: Event name
|
|
user_id: User ID
|
|
**kwargs: Additional event data
|
|
"""
|
|
event_data = {
|
|
"event": event,
|
|
"user_id": user_id,
|
|
"request_id": getattr(g, "request_id", None),
|
|
"path": request.path if request else None,
|
|
}
|
|
event_data.update(kwargs)
|
|
|
|
logger.info(f"Business event: {event}", extra=event_data)
|
|
|
|
|
|
def log_performance(logger: logging.Logger, operation: str, duration: float, **kwargs) -> None:
|
|
"""
|
|
Log performance metrics.
|
|
|
|
Args:
|
|
logger: Logger instance
|
|
operation: Operation name
|
|
duration: Duration in seconds
|
|
**kwargs: Additional metrics
|
|
"""
|
|
metrics = {"operation": operation, "duration": duration, "request_id": getattr(g, "request_id", None)}
|
|
metrics.update(kwargs)
|
|
|
|
logger.info(f"Performance: {operation} took {duration:.4f}s", extra=metrics)
|