Merge pull request #9 from feteu/develop

Develop

asgi_request_duration/__init__.py

@@ -1,13 +1,19 @@
+"""
+ASGI Request Duration Package
+
+This package provides middleware and utilities to measure and log the duration of HTTP requests in ASGI applications.
+"""
+
 from asgi_request_duration.context import REQUEST_DURATION_CTX_KEY, request_duration_ctx_var
 from asgi_request_duration.exceptions import InvalidHeaderNameException, PrecisionValueOutOfRangeException
 from asgi_request_duration.filters import RequestDurationFilter
 from asgi_request_duration.middleware import RequestDurationMiddleware
 
-__all__ = [
+__all__ = (
     "InvalidHeaderNameException",
     "PrecisionValueOutOfRangeException",
     "REQUEST_DURATION_CTX_KEY",
     "request_duration_ctx_var",
     "RequestDurationFilter",
     "RequestDurationMiddleware",
-]
+)

asgi_request_duration/constants.py

@@ -1,10 +1,10 @@
 import re
 
-_DEFAULT_EXCLUDED_PATHS = []
-_DEFAULT_HEADER_NAME = "X-Request-Duration"
-_DEFAULT_PRECISION = 6
-_DEFAULT_SKIP_VALIDATE_HEADER_NAME = False
-_DEFAULT_SKIP_VALIDATE_PRECISION = False
-_HEADER_NAME_PATTERN = re.compile(r"^[a-zA-Z0-9][a-zA-Z0-9-_]*$")
-_PRECISION_MAX = 17
-_PRECISION_MIN = 0
+_DEFAULT_EXCLUDED_PATHS: list = []
+_DEFAULT_HEADER_NAME: str = "X-Request-Duration"
+_DEFAULT_PRECISION: int = 6
+_DEFAULT_SKIP_VALIDATE_HEADER_NAME: bool = False
+_DEFAULT_SKIP_VALIDATE_PRECISION: bool = False
+_HEADER_NAME_PATTERN: re.Pattern = re.compile(r"^[a-zA-Z0-9][a-zA-Z0-9-_]*$")
+_PRECISION_MAX: int = 17
+_PRECISION_MIN: int = 0

asgi_request_duration/decorators.py

@@ -9,7 +9,7 @@
     _PRECISION_MIN,
 )
 
-def validate_header_name(skip=_DEFAULT_SKIP_VALIDATE_HEADER_NAME) -> callable:
+def validate_header_name(skip: bool =_DEFAULT_SKIP_VALIDATE_HEADER_NAME) -> callable:
     """
     Decorator to validate the header name against a pattern.
     
@@ -23,7 +23,7 @@ def validate_header_name(skip=_DEFAULT_SKIP_VALIDATE_HEADER_NAME) -> callable:
     Raises:
         InvalidHeaderNameException: If the header name is invalid.
     """
-    def decorator(func)-> callable:
+    def decorator(func: callable)-> callable:
         def wrapper(*args, **kwargs) -> callable:
             if not skip:
                 header_name = kwargs.get('header_name', _DEFAULT_HEADER_NAME)
@@ -33,7 +33,7 @@ def wrapper(*args, **kwargs) -> callable:
         return wrapper
     return decorator
 
-def validate_precision(skip=_DEFAULT_SKIP_VALIDATE_PRECISION)-> callable:
+def validate_precision(skip: bool =_DEFAULT_SKIP_VALIDATE_PRECISION)-> callable:
     """
     Decorator to validate the precision value.
     
@@ -47,7 +47,7 @@ def validate_precision(skip=_DEFAULT_SKIP_VALIDATE_PRECISION)-> callable:
     Raises:
         PrecisionValueOutOfRangeException: If the precision value is out of range.
     """
-    def decorator(func) -> callable:
+    def decorator(func: callable) -> callable:
         def wrapper(*args, **kwargs) -> callable:
             if not skip:
                 precision = kwargs.get('precision', _DEFAULT_PRECISION)

asgi_request_duration/exceptions.py

@@ -4,7 +4,7 @@ class InvalidHeaderNameException(Exception):
     This class represents an error that occurs when an invalid header name is provided.
     It provides a custom description to inform the user about the invalid header name.
     """
-    description = (
+    description: str = (
         "Invalid header name provided. "
         "Please ensure that the header name is correct and try again."
     )
@@ -22,7 +22,7 @@ class PrecisionValueOutOfRangeException(ValueError):
     This class represents an error that occurs when a precision value is out of the allowed range.
     It provides a custom description to inform the user about the out-of-range precision value.
     """
-    description = (
+    description: str = (
         "Precision value is out of range. "
         "Please ensure that the precision value is within the allowed range."
     )

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "asgi-request-duration"
-version = "1.0.1"
+version = "1.0.2"
 description = "A asgi middleware to measure the request duration"
 authors = ["Fabio Greco <fabio.greco.github@gmail.com>"]
 maintainers = ["Fabio Greco <fabio.greco.github@gmail.com>"]