apitally 0.16.2__py3-none-any.whl → 0.17.0__py3-none-any.whl

apitally/django.py

@@ -10,8 +10,10 @@ from typing import TYPE_CHECKING, Any, Callable, Dict, List, Optional, Set, Unio
 from warnings import warn
 
 from django.conf import settings
+from django.contrib.admindocs.views import extract_views_from_urlpatterns, simplify_regex
 from django.urls import URLPattern, URLResolver, get_resolver
 from django.utils.module_loading import import_string
+from django.views.generic.base import View
 
 from apitally.client.client_threading import ApitallyClient
 from apitally.client.consumers import Consumer as ApitallyConsumer
@@ -41,6 +43,7 @@ class ApitallyMiddlewareConfig:
     request_logging_config: Optional[RequestLoggingConfig]
     app_version: Optional[str]
     identify_consumer_callback: Optional[Callable[[HttpRequest], Union[str, ApitallyConsumer, None]]]
+    include_django_views: bool
     urlconfs: List[Optional[str]]
     proxy: Optional[str]
 
@@ -53,6 +56,7 @@ class ApitallyMiddleware:
         self.drf_available = _check_import("rest_framework")
         self.drf_endpoint_enumerator = None
         self.ninja_available = _check_import("ninja")
+        self.include_django_views = False
         self.callbacks = set()
 
         if self.config is None:
@@ -68,6 +72,9 @@ class ApitallyMiddleware:
                 self.callbacks.update(_get_drf_callbacks(self.config.urlconfs))
         if self.ninja_available and None not in self.config.urlconfs:
             self.callbacks.update(_get_ninja_callbacks(self.config.urlconfs))
+        if self.config.include_django_views:
+            self.callbacks.update(_get_django_callbacks(self.config.urlconfs))
+            self.include_django_views = True
 
         self.client = ApitallyClient(
             client_id=self.config.client_id,
@@ -98,6 +105,7 @@ class ApitallyMiddleware:
         request_logging_config: Optional[RequestLoggingConfig] = None,
         app_version: Optional[str] = None,
         identify_consumer_callback: Optional[str] = None,
+        include_django_views: bool = False,
         urlconf: Optional[Union[List[Optional[str]], str]] = None,
         proxy: Optional[str] = None,
     ) -> None:
@@ -109,6 +117,7 @@ class ApitallyMiddleware:
             identify_consumer_callback=import_string(identify_consumer_callback)
             if identify_consumer_callback
             else None,
+            include_django_views=include_django_views,
             urlconfs=[urlconf] if urlconf is None or isinstance(urlconf, str) else urlconf,
             proxy=proxy,
         )
@@ -116,6 +125,7 @@ class ApitallyMiddleware:
     def __call__(self, request: HttpRequest) -> HttpResponse:
         if self.client.enabled and request.method is not None and request.method != "OPTIONS":
             timestamp = time.time()
+
             request_size = parse_int(request.headers.get("Content-Length"))
             request_body = b""
             if self.capture_request_body:
@@ -128,32 +138,35 @@ class ApitallyMiddleware:
             start_time = time.perf_counter()
             response = self.get_response(request)
             response_time = time.perf_counter() - start_time
-            response_size = (
-                parse_int(response["Content-Length"])
-                if response.has_header("Content-Length")
-                else (len(response.content) if not response.streaming else None)
-            )
-            response_body = b""
-            response_content_type = response.get("Content-Type")
-            if (
-                self.capture_response_body
-                and not response.streaming
-                and RequestLogger.is_supported_content_type(response_content_type)
-            ):
-                response_body = (
-                    response.content if response_size is not None and response_size <= MAX_BODY_SIZE else BODY_TOO_LARGE
-                )
-
-            try:
-                consumer = self.get_consumer(request)
-                consumer_identifier = consumer.identifier if consumer else None
-                self.client.consumer_registry.add_or_update_consumer(consumer)
-            except Exception:  # pragma: no cover
-                logger.exception("Failed to get consumer for request")
-                consumer_identifier = None
-
             path = self.get_path(request)
+
             if path is not None:
+                try:
+                    consumer = self.get_consumer(request)
+                    consumer_identifier = consumer.identifier if consumer else None
+                    self.client.consumer_registry.add_or_update_consumer(consumer)
+                except Exception:  # pragma: no cover
+                    logger.exception("Failed to get consumer for request")
+                    consumer_identifier = None
+
+                response_size = (
+                    parse_int(response["Content-Length"])
+                    if response.has_header("Content-Length")
+                    else (len(response.content) if not response.streaming else None)
+                )
+                response_body = b""
+                response_content_type = response.get("Content-Type")
+                if (
+                    self.capture_response_body
+                    and not response.streaming
+                    and RequestLogger.is_supported_content_type(response_content_type)
+                ):
+                    response_body = (
+                        response.content
+                        if response_size is not None and response_size <= MAX_BODY_SIZE
+                        else BODY_TOO_LARGE
+                    )
+
                 try:
                     self.client.request_counter.add_request(
                         consumer=consumer_identifier,
@@ -196,27 +209,27 @@ class ApitallyMiddleware:
                     except Exception:  # pragma: no cover
                         logger.exception("Failed to log server error")
 
-            if self.client.request_logger.enabled:
-                self.client.request_logger.log_request(
-                    request={
-                        "timestamp": timestamp,
-                        "method": request.method,
-                        "path": path,
-                        "url": request.build_absolute_uri(),
-                        "headers": list(request.headers.items()),
-                        "size": request_size,
-                        "consumer": consumer_identifier,
-                        "body": request_body,
-                    },
-                    response={
-                        "status_code": response.status_code,
-                        "response_time": response_time,
-                        "headers": list(response.items()),
-                        "size": response_size,
-                        "body": response_body,
-                    },
-                    exception=getattr(request, "unhandled_exception", None),
-                )
+                if self.client.request_logger.enabled:
+                    self.client.request_logger.log_request(
+                        request={
+                            "timestamp": timestamp,
+                            "method": request.method,
+                            "path": path,
+                            "url": request.build_absolute_uri(),
+                            "headers": list(request.headers.items()),
+                            "size": request_size,
+                            "consumer": consumer_identifier,
+                            "body": request_body,
+                        },
+                        response={
+                            "status_code": response.status_code,
+                            "response_time": response_time,
+                            "headers": list(response.items()),
+                            "size": response_size,
+                            "body": response_body,
+                        },
+                        exception=getattr(request, "unhandled_exception", None),
+                    )
         else:
             response = self.get_response(request)
 
@@ -240,8 +253,9 @@ class ApitallyMiddleware:
                     from ninja.operation import PathView
 
                     if hasattr(match.func, "__self__") and isinstance(match.func.__self__, PathView):
-                        path = "/" + match.route.lstrip("/")
-                        return re.sub(r"<(?:[^:]+:)?([^>:]+)>", r"{\1}", path)
+                        return _transform_path(match.route)
+                if self.include_django_views:
+                    return _transform_path(match.route)
             except Exception:  # pragma: no cover
                 logger.exception("Failed to get path for request")
         return None
@@ -263,10 +277,12 @@ class ApitallyMiddleware:
         return None
 
 
-def _get_startup_data(app_version: Optional[str], urlconfs: List[Optional[str]]) -> Dict[str, Any]:
+def _get_startup_data(
+    app_version: Optional[str], urlconfs: List[Optional[str]], include_django_views: bool = False
+) -> Dict[str, Any]:
     data: Dict[str, Any] = {}
     try:
-        data["paths"] = _get_paths(urlconfs)
+        data["paths"] = _get_paths(urlconfs, include_django_views=include_django_views)
     except Exception:  # pragma: no cover
         data["paths"] = []
         logger.exception("Failed to get paths")
@@ -293,13 +309,26 @@ def _get_openapi(urlconfs: List[Optional[str]]) -> Optional[str]:
     return None  # pragma: no cover
 
 
-def _get_paths(urlconfs: List[Optional[str]]) -> List[Dict[str, str]]:
+def _get_paths(urlconfs: List[Optional[str]], include_django_views: bool = False) -> List[Dict[str, str]]:
     paths = []
     with contextlib.suppress(ImportError):
         paths.extend(_get_drf_paths(urlconfs))
     with contextlib.suppress(ImportError):
         paths.extend(_get_ninja_paths(urlconfs))
-    return paths
+    if include_django_views:
+        paths.extend(_get_django_paths(urlconfs))
+    return _deduplicate_paths(paths)
+
+
+def _deduplicate_paths(paths: List[Dict[str, str]]) -> List[Dict[str, str]]:
+    seen = set()
+    deduplicated_paths = []
+    for path in paths:
+        key = (path["method"], path["path"])
+        if key not in seen:
+            seen.add(key)
+            deduplicated_paths.append(path)
+    return deduplicated_paths
 
 
 def _get_drf_paths(urlconfs: List[Optional[str]]) -> List[Dict[str, str]]:
@@ -405,6 +434,37 @@ def _get_ninja_api_instances(
     return apis
 
 
+def _get_django_paths(urlconfs: Optional[List[Optional[str]]] = None) -> List[Dict[str, str]]:
+    if urlconfs is None:
+        urlconfs = [None]
+    return [
+        {
+            "method": method.upper(),
+            "path": _transform_path(regex),
+        }
+        for urlconf in urlconfs
+        for callback, regex, _, _ in extract_views_from_urlpatterns(get_resolver(urlconf).url_patterns)
+        if hasattr(callback, "view_class") and issubclass(callback.view_class, View)
+        for method in callback.view_class.http_method_names
+        if method != "options" and hasattr(callback.view_class, method)
+    ]
+
+
+def _get_django_callbacks(urlconfs: Optional[List[Optional[str]]] = None) -> Set[Callable]:
+    if urlconfs is None:
+        urlconfs = [None]
+    return {
+        callback
+        for urlconf in urlconfs
+        for callback, _, _, _ in extract_views_from_urlpatterns(get_resolver(urlconf).url_patterns)
+    }
+
+
+def _transform_path(path: str) -> str:
+    path = simplify_regex(path)
+    return re.sub(r"<(?:(?P<converter>[^>:]+):)?(?P<parameter>\w+)>", r"{\g<parameter>}", path)
+
+
 def _check_import(name: str) -> bool:
     try:
         import_module(name)

apitally/starlette.py

@@ -1,16 +1,18 @@
 from __future__ import annotations
 
 import time
-from typing import Any, Callable, Dict, List, Optional, Union
+from contextlib import asynccontextmanager
+from typing import Any, Awaitable, Callable, Dict, List, Optional, Union
 from warnings import warn
 
 from httpx import HTTPStatusError, Proxy
+from starlette.applications import Starlette
 from starlette.datastructures import Headers
 from starlette.requests import Request
 from starlette.routing import BaseRoute, Match, Router
 from starlette.schemas import EndpointInfo, SchemaGenerator
 from starlette.testclient import TestClient
-from starlette.types import ASGIApp, Message, Receive, Scope, Send
+from starlette.types import ASGIApp, Lifespan, Message, Receive, Scope, Send
 
 from apitally.client.client_asyncio import ApitallyClient
 from apitally.client.consumers import Consumer as ApitallyConsumer
@@ -56,10 +58,13 @@ class ApitallyMiddleware:
             self.client.request_logger.config.enabled and self.client.request_logger.config.log_response_body
         )
 
-        _register_event_handler(app, "startup", self.on_startup)
-        _register_event_handler(app, "shutdown", self.client.handle_shutdown)
+        _inject_lifespan_handlers(
+            app,
+            on_startup=self.on_startup,
+            on_shutdown=self.client.handle_shutdown,
+        )
 
-    def on_startup(self) -> None:
+    async def on_startup(self) -> None:
         data = _get_startup_data(self.app, app_version=self.app_version, openapi_url=self.openapi_url)
         self.client.set_startup_data(data)
         self.client.start_sync_loop()
@@ -289,8 +294,30 @@ def _get_routes(app: Union[ASGIApp, Router]) -> List[BaseRoute]:
     return []  # pragma: no cover
 
 
-def _register_event_handler(app: Union[ASGIApp, Router], event: str, handler: Callable[[], Any]) -> None:
-    if isinstance(app, Router):
-        app.add_event_handler(event, handler)
-    elif hasattr(app, "app"):
-        _register_event_handler(app.app, event, handler)
+def _inject_lifespan_handlers(
+    app: Union[ASGIApp, Router],
+    on_startup: Callable[[], Awaitable[Any]],
+    on_shutdown: Callable[[], Awaitable[Any]],
+) -> None:
+    """
+    Ensures the given startup and shutdown functions are called as part of the app's lifespan context manager.
+    """
+    router = app
+    while not isinstance(router, Router) and hasattr(router, "app"):
+        router = router.app
+    if not isinstance(router, Router):
+        raise TypeError("app must be a Starlette or Router instance")
+
+    lifespan: Optional[Lifespan] = getattr(router, "lifespan_context", None)
+
+    @asynccontextmanager
+    async def wrapped_lifespan(app: Starlette):
+        await on_startup()
+        if lifespan is not None:
+            async with lifespan(app):
+                yield
+        else:
+            yield
+        await on_shutdown()
+
+    router.lifespan_context = wrapped_lifespan

{apitally-0.16.2.dist-info → apitally-0.17.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: apitally
-Version: 0.16.2
+Version: 0.17.0
 Summary: Simple API monitoring & analytics for REST APIs built with FastAPI, Flask, Django, Starlette, Litestar and BlackSheep.
 Project-URL: Homepage, https://apitally.io
 Project-URL: Documentation, https://docs.apitally.io
@@ -49,9 +49,9 @@ Requires-Dist: inflection>=0.5.1; extra == 'django-rest-framework'
 Requires-Dist: requests>=2.26.0; extra == 'django-rest-framework'
 Requires-Dist: uritemplate>=3.0.0; extra == 'django-rest-framework'
 Provides-Extra: fastapi
-Requires-Dist: fastapi>=0.88.0; extra == 'fastapi'
+Requires-Dist: fastapi>=0.94.1; extra == 'fastapi'
 Requires-Dist: httpx>=0.22.0; extra == 'fastapi'
-Requires-Dist: starlette<1.0.0,>=0.22.0; extra == 'fastapi'
+Requires-Dist: starlette<1.0.0,>=0.26.1; extra == 'fastapi'
 Provides-Extra: flask
 Requires-Dist: flask>=2.0.0; extra == 'flask'
 Requires-Dist: requests>=2.26.0; extra == 'flask'
@@ -62,7 +62,7 @@ Provides-Extra: sentry
 Requires-Dist: sentry-sdk>=2.2.0; extra == 'sentry'
 Provides-Extra: starlette
 Requires-Dist: httpx>=0.22.0; extra == 'starlette'
-Requires-Dist: starlette<1.0.0,>=0.21.0; extra == 'starlette'
+Requires-Dist: starlette<1.0.0,>=0.26.1; extra == 'starlette'
 Description-Content-Type: text/markdown
 
 <p align="center">

{apitally-0.16.2.dist-info → apitally-0.17.0.dist-info}/RECORD

@@ -1,14 +1,14 @@
 apitally/__init__.py,sha256=ShXQBVjyiSOHxoQJS2BvNG395W4KZfqMxZWBAR0MZrE,22
 apitally/blacksheep.py,sha256=KvcPFeiwQgWZmRglbm8SLaN6_WRs5kZ3SymB1IuLR-A,9616
 apitally/common.py,sha256=azDxepViH0QW0MuufTHxeSQyLGzCkocAX_KPziWTx8A,1605
-apitally/django.py,sha256=f_k7yYlvvvhJMR53NcXCfmlLxLX3CeLO9ephF4bzKbo,16892
+apitally/django.py,sha256=MnyL6ntMYj1WndjLqpDZ-8BrbDWCeVV2dpZbe8Fnm-Y,19254
 apitally/django_ninja.py,sha256=-CmrwFFRv7thFOUK_OrOSouhHL9bm5sIBNIQlpyE_2c,166
 apitally/django_rest_framework.py,sha256=-CmrwFFRv7thFOUK_OrOSouhHL9bm5sIBNIQlpyE_2c,166
 apitally/fastapi.py,sha256=IfKfgsmIY8_AtnuMTW2sW4qnkya61CAE2vBoIpcc9tk,169
 apitally/flask.py,sha256=OoCEnjtnD51GUGq-adK80ebuiLj-5HXubxffCv5XTCM,9622
 apitally/litestar.py,sha256=mHoMqBO_gyoopeHljY8e8GTcV29UDf3uhQMxY3GeNpA,13451
 apitally/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-apitally/starlette.py,sha256=g6YmC186uG6Lc9-Gx3Pp4ke-jn8IeKK0nFLBGDnWYv0,12771
+apitally/starlette.py,sha256=081vXTNOy6-zZ8ugXknRtQZnFFqG7XKLW4Ho6oaHEUY,13525
 apitally/client/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 apitally/client/client_asyncio.py,sha256=rTsH5wlLHK3RmyIuEiT6vzjquU-l2OPC34JnC2U6uYw,6658
 apitally/client/client_base.py,sha256=DvivGeHd3dyOASRvkIo44Zh8RzdBMfH8_rROa2lFbgw,3799
@@ -20,7 +20,7 @@ apitally/client/requests.py,sha256=SDptGOg9XvaEKFj2o3oxJz-JAuZzUrqpHnbOQixf99o,3
 apitally/client/sentry.py,sha256=qMjHdI0V7c50ruo1WjmjWc8g6oGDv724vSCvcuZ8G9k,1188
 apitally/client/server_errors.py,sha256=4B2BKDFoIpoWc55UVH6AIdYSgzj6zxCdMNUW77JjhZw,3423
 apitally/client/validation_errors.py,sha256=6G8WYWFgJs9VH9swvkPXJGuOJgymj5ooWA9OwjUTbuM,1964
-apitally-0.16.2.dist-info/METADATA,sha256=Lycf-s6pDP5lO9B8-pRqcDfHZcJTFZQ--wSuquoDZn0,9321
-apitally-0.16.2.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-apitally-0.16.2.dist-info/licenses/LICENSE,sha256=vbLzC-4TddtXX-_AFEBKMYWRlxC_MN0g66QhPxo8PgY,1065
-apitally-0.16.2.dist-info/RECORD,,
+apitally-0.17.0.dist-info/METADATA,sha256=ERuU63GwG_N8quZ137RNkkTjfF0r3hAzoM514YjKfvs,9321
+apitally-0.17.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+apitally-0.17.0.dist-info/licenses/LICENSE,sha256=vbLzC-4TddtXX-_AFEBKMYWRlxC_MN0g66QhPxo8PgY,1065
+apitally-0.17.0.dist-info/RECORD,,