xocto 4.9.0__py3-none-any.whl

xocto/__init__.py

@@ -0,0 +1,4 @@
+import importlib.metadata
+
+
+__version__ = importlib.metadata.version("xocto")

xocto/events/__init__.py

@@ -0,0 +1,2 @@
+from .core import *  # noqa
+from .utils import *  # noqa

xocto/events/core.py

@@ -0,0 +1,88 @@
+from __future__ import annotations
+
+from typing import Any, Protocol
+
+import structlog
+from django import http
+from django.conf import settings
+
+
+logger = structlog.get_logger("events")
+
+__all__ = ["publish"]
+
+METADATA = {
+    "release": "GIT_SHA",
+    "aws_private_ip": "AWS_LOCAL_IP",
+    "aws_instance_id": "AWS_INSTANCE_ID",
+    "aws_availability_zone": "AWS_AVAILABILITY_ZONE",
+    "aws_auto_scaling_group": "AWS_AUTO_SCALING_GROUP",
+}
+
+
+class Account(Protocol):
+    number: str
+
+
+def publish(
+    event: str,
+    params: dict[str, Any] | None = None,
+    meta: dict[str, Any] | None = None,
+    account: Account | None = None,
+    request: http.HttpRequest | None = None,
+) -> None:
+    """
+    Publish an event.
+
+    - `params` are values that were used to create the event (eg the path of a
+      request)
+    - `meta` are contextual values around the event (eg the IP address of the
+      person making the request)
+
+    Note, structlog will add a timestamp.
+    """
+    payload: dict[str, Any] = {"event": event}
+    if params is not None:
+        payload["params"] = params
+    if meta is None:
+        meta = {}
+
+    # If the event relates to a single account, we include its number so it's easy to filter down
+    # to events that affect one account in Loggly.
+    if account is not None:
+        payload["account"] = account.number
+
+    # Add static metadata from settings.
+    for key, setting in METADATA.items():
+        value = getattr(settings, setting, "")
+        if value:
+            meta[key] = value
+
+    # Add metadata from request
+    if request is not None:
+        meta.update(_request_meta(request))
+
+    payload["meta"] = meta
+
+    _log(payload)
+
+
+def _log(event: dict[str, Any]) -> None:
+    """
+    Log the event.
+    """
+    event_ = event.copy()
+    name = event_.pop("event")
+    logger.info(name, **event_)
+
+
+def _request_meta(request: http.HttpRequest) -> dict[str, Any]:
+    """
+    Extract relevant meta information from a request instance.
+    """
+    meta = {"ip_address": request.META["REMOTE_ADDR"]}
+    if "HTTP_USER_AGENT" in request.META:
+        meta["user_agent"] = request.META["HTTP_USER_AGENT"]
+    if hasattr(request, "session") and request.session.session_key:
+        meta["session"] = request.session.session_key
+    return meta

xocto/events/utils.py

@@ -0,0 +1,19 @@
+import time
+from typing import Any
+
+
+__all__ = ["Timer"]
+
+
+class Timer(object):
+    """
+    Context manager to allow easy timing of events.
+    """
+
+    def __enter__(self) -> "Timer":
+        self.start = time.time()
+        return self
+
+    def __exit__(self, *args: Any) -> None:
+        self.end = time.time()
+        self.duration_in_ms = (self.end - self.start) * 1000

xocto/exceptions.py

@@ -0,0 +1,4 @@
+class SettlementPeriodError(Exception):
+    """
+    Basic exception raised while converting tz-aware datetime.
+    """

xocto/health.py

@@ -0,0 +1,28 @@
+from django.db import DEFAULT_DB_ALIAS, connections
+from django.db.migrations.loader import MigrationLoader
+
+
+def check_migrations() -> bool:
+    """
+    Check if there are any migrations that haven't been applied yet.
+    """
+    return _num_unapplied_migrations() == 0
+
+
+def _num_unapplied_migrations() -> int:
+    """
+    Return the number of unapplied migrations.
+    """
+    connection = connections[DEFAULT_DB_ALIAS]
+    loader = MigrationLoader(connection)
+    graph = loader.graph
+
+    # Count unapplied migrations
+    num_unapplied_migrations = 0
+    for app_name in loader.migrated_apps:
+        for node in graph.leaf_nodes(app_name):
+            for plan_node in graph.forwards_plan(node):
+                if plan_node not in loader.applied_migrations:
+                    num_unapplied_migrations += 1
+
+    return num_unapplied_migrations