open-api-framework 0.13.1__tar.gz → 0.13.3__tar.gz

{open_api_framework-0.13.1 → open_api_framework-0.13.3}/CHANGELOG.rst

@@ -1,6 +1,25 @@
 Changelog
 =========
 
+0.13.3 (2026-01-28)
+-------------------
+
+**Bugfixes**
+
+* [#196] Fix errors raised when using ``open-api-framework`` without optional dependencies
+
+**Project maintenance**
+
+* Remove Django 4.2 from CI (pyproject.toml enforces >=5.2)
+
+0.13.2 (2025-11-13)
+-------------------
+
+**Documentation**
+
+* Updated the help text of ``DB_POOL_ENABLED`` to indicate that connection pooling is experimental and not recommended for production use.
+* Added a reference to the connection pooling documentation.
+
 0.13.1 (2025-10-03)
 -------------------
 

{open_api_framework-0.13.1/open_api_framework.egg-info → open_api_framework-0.13.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: open-api-framework
-Version: 0.13.1
+Version: 0.13.3
 Summary: A metapackage for registration components, that bundles the dependencies shared between these components and provides generic settings
 Author-email: Maykin Media <support@maykinmedia.nl>
 License: Copyright © Maykin 2024
@@ -96,7 +96,7 @@ Dynamic: license-file
 Open API Framework
 ==================
 
-:Version: 0.13.1
+:Version: 0.13.3
 :Source: https://github.com/maykinmedia/open-api-framework
 :Keywords: metapackage, dependencies
 

{open_api_framework-0.13.1 → open_api_framework-0.13.3}/README.rst

@@ -1,7 +1,7 @@
 Open API Framework
 ==================
 
-:Version: 0.13.1
+:Version: 0.13.3
 :Source: https://github.com/maykinmedia/open-api-framework
 :Keywords: metapackage, dependencies
 

{open_api_framework-0.13.1 → open_api_framework-0.13.3}/open_api_framework/conf/base.py

@@ -1,30 +1,40 @@
 import datetime
 import os
 import warnings
-from pathlib import Path
+from contextlib import suppress
+from importlib.util import find_spec
 
 from django.urls import reverse_lazy
 
 import sentry_sdk
-from corsheaders.defaults import default_headers as default_cors_headers
-from csp.constants import NONCE, NONE, SELF
 from log_outgoing_requests.formatters import HttpFormatter
-from notifications_api_common.settings import *  # noqa
 
 from .utils import (
     config,
     get_django_project_dir,
     get_project_dirname,
     get_sentry_integrations,
+    importable,
     strip_protocol_from_origin,
 )
 
+# optional requirements
+default_cors_headers = []
+with suppress(ImportError):
+    from corsheaders.defaults import default_headers as default_cors_headers
+
+csp_installed = False
+with suppress(ImportError):
+    from csp.constants import NONCE, NONE, SELF
+
+    csp_installed = True
+
 PROJECT_DIRNAME = get_project_dirname()
 
 # Build paths inside the project, so further paths can be defined relative to
 # the code root.
 DJANGO_PROJECT_DIR = get_django_project_dir()
-BASE_DIR = Path(DJANGO_PROJECT_DIR).resolve().parents[1]
+BASE_DIR = DJANGO_PROJECT_DIR.resolve().parents[1]
 
 
 #
@@ -164,7 +174,12 @@ DATABASES["default"]["CONN_MAX_AGE"] = config(
 DB_POOL_ENABLED = config(
     "DB_POOL_ENABLED",
     default=False,
-    help_text=("Whether to use connection pooling."),
+    help_text=(
+        "**Experimental:** Whether to use connection pooling. "
+        "This feature is not yet recommended for production use. "
+        "See the documentation for details: "
+        "https://open-api-framework.readthedocs.io/en/latest/connection_pooling.html"
+    ),
     group="Database",
 )
 
@@ -302,53 +317,55 @@ if DB_POOL_ENABLED:
 # https://docs.djangoproject.com/en/4.0/ref/settings/#std:setting-DEFAULT_AUTO_FIELD
 DEFAULT_AUTO_FIELD = "django.db.models.AutoField"
 
-CACHE_DEFAULT = config(
-    "CACHE_DEFAULT",
-    "localhost:6379/0",
-    help_text="redis cache address for the default cache (this **MUST** be set when using Docker)",
-    group="Required",
-)
-CACHE_AXES = config(
-    "CACHE_AXES",
-    "localhost:6379/0",
-    help_text=(
-        "redis cache address for the brute force login protection cache "
-        "(this **MUST** be set when using Docker)"
-    ),
-    group="Required",
-)
+if find_spec("django_redis"):
+    CACHE_DEFAULT = config(
+        "CACHE_DEFAULT",
+        "localhost:6379/0",
+        help_text="redis cache address for the default cache (this **MUST** be set when using Docker)",
+        group="Required",
+    )
+    CACHE_AXES = config(
+        "CACHE_AXES",
+        "localhost:6379/0",
+        help_text=(
+            "redis cache address for the brute force login protection cache "
+            "(this **MUST** be set when using Docker)"
+        ),
+        group="Required",
+    )
 
-CACHES = {
-    "default": {
-        "BACKEND": "django_redis.cache.RedisCache",
-        "LOCATION": f"redis://{CACHE_DEFAULT}",
-        "OPTIONS": {
-            "CLIENT_CLASS": "django_redis.client.DefaultClient",
-            "IGNORE_EXCEPTIONS": True,
+    CACHES = {
+        "default": {
+            "BACKEND": "django_redis.cache.RedisCache",
+            "LOCATION": f"redis://{CACHE_DEFAULT}",
+            "OPTIONS": {
+                "CLIENT_CLASS": "django_redis.client.DefaultClient",
+                "IGNORE_EXCEPTIONS": True,
+            },
         },
-    },
-    "axes": {
-        "BACKEND": "django_redis.cache.RedisCache",
-        "LOCATION": f"redis://{CACHE_AXES}",
-        "OPTIONS": {
-            "CLIENT_CLASS": "django_redis.client.DefaultClient",
-            "IGNORE_EXCEPTIONS": True,
+        "axes": {
+            "BACKEND": "django_redis.cache.RedisCache",
+            "LOCATION": f"redis://{CACHE_AXES}",
+            "OPTIONS": {
+                "CLIENT_CLASS": "django_redis.client.DefaultClient",
+                "IGNORE_EXCEPTIONS": True,
+            },
         },
-    },
-    "oidc": {
-        "BACKEND": "django_redis.cache.RedisCache",
-        "LOCATION": f"redis://{CACHE_DEFAULT}",
-        "OPTIONS": {
-            "CLIENT_CLASS": "django_redis.client.DefaultClient",
-            "IGNORE_EXCEPTIONS": True,
+        "oidc": {
+            "BACKEND": "django_redis.cache.RedisCache",
+            "LOCATION": f"redis://{CACHE_DEFAULT}",
+            "OPTIONS": {
+                "CLIENT_CLASS": "django_redis.client.DefaultClient",
+                "IGNORE_EXCEPTIONS": True,
+            },
         },
-    },
-}
+    }
+
 
 #
 # APPLICATIONS enabled for this project
 #
-INSTALLED_APPS = [
+INSTALLED_APPS = importable(
     # Note: contenttypes should be first, see Django ticket #10827
     "django.contrib.contenttypes",
     "django.contrib.auth",
@@ -391,9 +408,9 @@ INSTALLED_APPS = [
     PROJECT_DIRNAME,
     # Django libraries
     "upgrade_check",
-]
+)
 
-MIDDLEWARE = [
+MIDDLEWARE = importable(
     "django.middleware.security.SecurityMiddleware",
     "sessionprofile.middleware.SessionProfileMiddleware",
     "django.contrib.sessions.middleware.SessionMiddleware",
@@ -406,7 +423,7 @@ MIDDLEWARE = [
     "django.middleware.clickjacking.XFrameOptionsMiddleware",
     "axes.middleware.AxesMiddleware",
     "csp.contrib.rate_limiting.RateLimitedCSPMiddleware",
-]
+)
 
 ROOT_URLCONF = f"{PROJECT_DIRNAME}.urls"
 
@@ -419,7 +436,7 @@ TEMPLATE_LOADERS = (
 TEMPLATES = [
     {
         "BACKEND": "django.template.backends.django.DjangoTemplates",
-        "DIRS": [Path(DJANGO_PROJECT_DIR) / "templates"],
+        "DIRS": [DJANGO_PROJECT_DIR / "templates"],
         "APP_DIRS": False,  # conflicts with explicity specifying the loaders
         "OPTIONS": {
             "context_processors": [
@@ -438,7 +455,7 @@ TEMPLATES = [
 WSGI_APPLICATION = f"{PROJECT_DIRNAME}.wsgi.application"
 
 # Translations
-LOCALE_PATHS = (Path(DJANGO_PROJECT_DIR) / "conf" / "locale",)
+LOCALE_PATHS = (DJANGO_PROJECT_DIR / "conf" / "locale",)
 
 #
 # SERVING of static and media files
@@ -446,10 +463,10 @@ LOCALE_PATHS = (Path(DJANGO_PROJECT_DIR) / "conf" / "locale",)
 
 STATIC_URL = "/static/"
 
-STATIC_ROOT = Path(BASE_DIR) / "static"
+STATIC_ROOT = BASE_DIR / "static"
 
 # Additional locations of static files
-STATICFILES_DIRS = [Path(DJANGO_PROJECT_DIR) / "static"]
+STATICFILES_DIRS = [DJANGO_PROJECT_DIR / "static"]
 
 # List of finder classes that know how to find static files in
 # various locations.
@@ -458,7 +475,7 @@ STATICFILES_FINDERS = [
     "django.contrib.staticfiles.finders.AppDirectoriesFinder",
 ]
 
-MEDIA_ROOT = Path(BASE_DIR) / "media"
+MEDIA_ROOT = BASE_DIR / "media"
 
 MEDIA_URL = "/media/"
 
@@ -563,6 +580,7 @@ CELERY_LOGLEVEL = config(
     help_text="control the verbosity of logging output for celery, independent of ``LOG_LEVEL``."
     " Available values are ``CRITICAL``, ``ERROR``, ``WARNING``, ``INFO`` and ``DEBUG``",
     group="Celery",
+    add_to_docs="celery",
 )
 
 _USE_STRUCTLOG = config("_USE_STRUCTLOG", default=False, add_to_docs=False)
@@ -573,10 +591,11 @@ ENABLE_STRUCTLOG_REQUESTS = config(
     default=True,
     help_text=("enable structured logging of requests"),
     group="Logging",
+    add_to_docs="django_structlog",
 )
 
 
-LOGGING_DIR = Path(BASE_DIR) / "log"
+LOGGING_DIR = BASE_DIR / "log"
 
 if _USE_STRUCTLOG:
     import structlog
@@ -663,7 +682,7 @@ if _USE_STRUCTLOG:
             "json_file": {
                 "level": LOG_LEVEL,  # always debug might be better?
                 "class": "logging.handlers.RotatingFileHandler",
-                "filename": Path(LOGGING_DIR) / "application.jsonl",
+                "filename": LOGGING_DIR / "application.jsonl",
                 "formatter": "json",
                 "maxBytes": 1024 * 1024 * 10,  # 10 MB
                 "backupCount": 10,
@@ -671,7 +690,7 @@ if _USE_STRUCTLOG:
             "performance": {
                 "level": "INFO",
                 "class": "logging.handlers.RotatingFileHandler",
-                "filename": Path(LOGGING_DIR) / "performance.log",
+                "filename": LOGGING_DIR / "performance.log",
                 "formatter": "performance",
                 "maxBytes": 1024 * 1024 * 10,  # 10 MB
                 "backupCount": 10,
@@ -679,7 +698,7 @@ if _USE_STRUCTLOG:
             "requests": {
                 "level": "DEBUG",
                 "class": "logging.handlers.RotatingFileHandler",
-                "filename": Path(LOGGING_DIR) / "requests.log",
+                "filename": LOGGING_DIR / "requests.log",
                 "formatter": "timestamped",
                 "maxBytes": 1024 * 1024 * 10,  # 10 MB
                 "backupCount": 10,
@@ -820,23 +839,10 @@ else:
                 "class": "logging.StreamHandler",
                 "formatter": "db",
             },
-            "celery_console": {
-                "level": CELERY_LOGLEVEL,
-                "class": "logging.StreamHandler",
-                "formatter": "timestamped",
-            },
-            "celery_file": {
-                "level": CELERY_LOGLEVEL,
-                "class": "logging.handlers.RotatingFileHandler",
-                "filename": Path(LOGGING_DIR) / "celery.log",
-                "formatter": "verbose",
-                "maxBytes": 1024 * 1024 * 10,  # 10 MB
-                "backupCount": 10,
-            },
             "django": {
                 "level": LOG_LEVEL,
                 "class": "logging.handlers.RotatingFileHandler",
-                "filename": Path(LOGGING_DIR) / "django.log",
+                "filename": LOGGING_DIR / "django.log",
                 "formatter": "verbose",
                 "maxBytes": 1024 * 1024 * 10,  # 10 MB
                 "backupCount": 10,
@@ -844,7 +850,7 @@ else:
             "project": {
                 "level": LOG_LEVEL,
                 "class": "logging.handlers.RotatingFileHandler",
-                "filename": Path(LOGGING_DIR) / f"{PROJECT_DIRNAME}.log",
+                "filename": LOGGING_DIR / f"{PROJECT_DIRNAME}.log",
                 "formatter": "verbose",
                 "maxBytes": 1024 * 1024 * 10,  # 10 MB
                 "backupCount": 10,
@@ -852,7 +858,7 @@ else:
             "performance": {
                 "level": "INFO",
                 "class": "logging.handlers.RotatingFileHandler",
-                "filename": Path(LOGGING_DIR) / "performance.log",
+                "filename": LOGGING_DIR / "performance.log",
                 "formatter": "performance",
                 "maxBytes": 1024 * 1024 * 10,  # 10 MB
                 "backupCount": 10,
@@ -860,7 +866,7 @@ else:
             "requests": {
                 "level": "DEBUG",
                 "class": "logging.handlers.RotatingFileHandler",
-                "filename": Path(LOGGING_DIR) / "requests.log",
+                "filename": LOGGING_DIR / "requests.log",
                 "formatter": "timestamped",
                 "maxBytes": 1024 * 1024 * 10,  # 10 MB
                 "backupCount": 10,
@@ -875,7 +881,26 @@ else:
                 # enabling saving to database
                 "class": "log_outgoing_requests.handlers.DatabaseOutgoingRequestsHandler",
             },
-        },
+        }
+        | (  # celery dependant handlers
+            {
+                "celery_console": {
+                    "level": CELERY_LOGLEVEL,
+                    "class": "logging.StreamHandler",
+                    "formatter": "timestamped",
+                },
+                "celery_file": {
+                    "level": CELERY_LOGLEVEL,
+                    "class": "logging.handlers.RotatingFileHandler",
+                    "filename": LOGGING_DIR / "celery.log",
+                    "formatter": "verbose",
+                    "maxBytes": 1024 * 1024 * 10,  # 10 MB
+                    "backupCount": 10,
+                },
+            }
+            if find_spec("celery")
+            else {}
+        ),
         "loggers": {
             "": {
                 "handlers": logging_root_handlers,
@@ -925,18 +950,25 @@ else:
                 "level": "DEBUG",
                 "propagate": True,
             },
-            "celery": {
-                "handlers": ["celery_console"] if LOG_STDOUT else ["celery_file"],
-                "level": CELERY_LOGLEVEL,
-                "propagate": True,
-            },
-        },
+        }
+        | (
+            {
+                "celery": {
+                    "handlers": ["celery_console"] if LOG_STDOUT else ["celery_file"],
+                    "level": CELERY_LOGLEVEL,
+                    "propagate": True,
+                },
+            }
+            if find_spec("celery")
+            else {}
+        ),
     }
 
 #
 # AUTH settings - user accounts, passwords, backends...
 #
-AUTH_USER_MODEL = "accounts.User"
+if find_spec(f"{PROJECT_DIRNAME}.accounts"):
+    AUTH_USER_MODEL = "accounts.User"
 
 # Password validation
 # https://docs.djangoproject.com/en/3.0/ref/settings/#auth-password-validators
@@ -1048,7 +1080,7 @@ if subpath:
 if "GIT_SHA" in os.environ:
     GIT_SHA = config("GIT_SHA", "", add_to_docs=False)
 # in docker (build) context, there is no .git directory
-elif (Path(BASE_DIR) / ".git").exists():
+elif (BASE_DIR / ".git").exists():
     try:
         import git
     except ImportError:
@@ -1128,6 +1160,7 @@ CORS_ALLOW_ALL_ORIGINS = config(
     default=False,
     group="Cross-Origin-Resource-Sharing",
     help_text="allow cross-domain access from any client",
+    add_to_docs="corsheaders",
 )
 CORS_ALLOWED_ORIGINS = config(
     "CORS_ALLOWED_ORIGINS",
@@ -1138,6 +1171,7 @@ CORS_ALLOWED_ORIGINS = config(
         "explicitly list the allowed origins for cross-domain requests. "
         "Example: http://localhost:3000,https://some-app.gemeente.nl"
     ),
+    add_to_docs="corsheaders",
 )
 CORS_ALLOWED_ORIGIN_REGEXES = config(
     "CORS_ALLOWED_ORIGIN_REGEXES",
@@ -1145,7 +1179,9 @@ CORS_ALLOWED_ORIGIN_REGEXES = config(
     default=[],
     group="Cross-Origin-Resource-Sharing",
     help_text="same as ``CORS_ALLOWED_ORIGINS``, but supports regular expressions",
+    add_to_docs="corsheaders",
 )
+
 # Authorization is included in default_cors_headers
 CORS_ALLOW_HEADERS = (
     list(default_cors_headers)
@@ -1163,8 +1199,10 @@ CORS_ALLOW_HEADERS = (
             "By default, Authorization, Accept-Crs and Content-Crs are already included. "
             "The value of this variable is added to these already included headers."
         ),
+        add_to_docs="corsheaders",
     )
 )
+
 CORS_EXPOSE_HEADERS = [
     "content-crs",
 ]
@@ -1185,7 +1223,7 @@ CSRF_TRUSTED_ORIGINS = config(
 #
 # DJANGO-PRIVATES -- safely serve files after authorization
 #
-PRIVATE_MEDIA_ROOT = Path(BASE_DIR) / "private-media"
+PRIVATE_MEDIA_ROOT = BASE_DIR / "private-media"
 PRIVATE_MEDIA_URL = "/private-media/"
 
 
@@ -1387,54 +1425,72 @@ LOG_OUTGOING_REQUESTS_MAX_AGE = config(
 
 def get_content_security_policy():
     # ideally we'd use BASE_URI but it'd have to be lazy or cause issues
-    csp_default_src = [SELF] + config(
+    extra_default_src = config(
         "CSP_EXTRA_DEFAULT_SRC",
         default=[],
         split=True,
         group="Content Security Policy",
         help_text="Extra default source URLs for CSP other than ``self``. Used for ``img-src``, ``style-src`` and ``script-src``.",
+        add_to_docs="csp",
+    )
+    extra_form_action = config(
+        "CSP_EXTRA_FORM_ACTION",
+        default=[],
+        split=True,
+        group="Content Security Policy",
+        help_text="Additional `form-action` sources.",
+        add_to_docs="csp",
+    )
+    form_action = config(
+        "CSP_FORM_ACTION",
+        default=["\"'self'\""] + extra_form_action,
+        split=True,
+        group="Content Security Policy",
+        help_text="Override the default `form-action` sources.",
+        add_to_docs="csp",
     )
+    extra_img_src = config(
+        "CSP_EXTRA_IMG_SRC",
+        default=[],
+        split=True,
+        group="Content Security Policy",
+        help_text="Extra `img-src` sources.",
+        add_to_docs="csp",
+    )
+    object_src = config(
+        "CSP_OBJECT_SRC",
+        default=["\"'none'\""],
+        split=True,
+        group="Content Security Policy",
+        help_text="`object-src` sources.",
+        add_to_docs="csp",
+    )
+    report_uri = config(
+        "CSP_REPORT_URI",
+        None,
+        group="Content Security Policy",
+        help_text="URI for CSP report-uri directive.",
+        add_to_docs="csp",
+    )
+    report_percentage = config(
+        "CSP_REPORT_PERCENTAGE",
+        0.0,
+        group="Content Security Policy",
+        help_text="Fraction (between 0 and 1) of requests to include report-uri directive.",
+        add_to_docs="csp",
+    )
+
+    if not csp_installed:
+        return {}
+
+    csp_default_src = [SELF] + extra_default_src
     return {
         "DIRECTIVES": {
-            "default-src": [SELF]
-            + config(
-                "CSP_EXTRA_DEFAULT_SRC",
-                default=[],
-                split=True,
-                group="Content Security Policy",
-                help_text="Extra default source URLs for CSP other than ``self``. Used for ``img-src``, ``style-src`` and ``script-src``.",
-            ),
-            "form-action": config(
-                "CSP_FORM_ACTION",
-                default=["\"'self'\""]
-                + config(
-                    "CSP_EXTRA_FORM_ACTION",
-                    default=[],
-                    split=True,
-                    group="Content Security Policy",
-                    help_text="Additional `form-action` sources.",
-                ),
-                split=True,
-                group="Content Security Policy",
-                help_text="Override the default `form-action` sources.",
-            )
-            + CORS_ALLOWED_ORIGINS,
-            "img-src": csp_default_src
-            + ["data:", "cdn.redoc.ly"]
-            + config(
-                "CSP_EXTRA_IMG_SRC",
-                default=[],
-                split=True,
-                group="Content Security Policy",
-                help_text="Extra `img-src` sources.",
-            ),
-            "object-src": config(
-                "CSP_OBJECT_SRC",
-                default=["\"'none'\""],
-                split=True,
-                group="Content Security Policy",
-                help_text="`object-src` sources.",
-            ),
+            "default-src": csp_default_src,
+            "form-action": form_action
+            + CORS_ALLOWED_ORIGINS,  # XXX: not passed as default to prevent misconfig??
+            "img-src": csp_default_src + ["data:", "cdn.redoc.ly"] + extra_img_src,
+            "object-src": object_src,
             "style-src": csp_default_src
             + [NONCE, "'unsafe-inline'", "fonts.googleapis.com"],
             "script-src": csp_default_src + [NONCE, "'unsafe-inline'"],
@@ -1444,22 +1500,11 @@ def get_content_security_policy():
             "frame-ancestors": [NONE],
             "frame-src": [SELF],
             "upgrade-insecure-requests": False,  # Enable only in production
-            "report-uri": config(
-                "CSP_REPORT_URI",
-                None,
-                group="Content Security Policy",
-                help_text="URI for CSP report-uri directive.",
-            ),
+            "report-uri": report_uri,
         },
         # Envvar used for django-csp==3.8 was a float between 0 and 1, while django-csp==4.0
         # expects a percentage (between 0 and 100)
-        "REPORT_PERCENTAGE": config(
-            "CSP_REPORT_PERCENTAGE",
-            0.0,
-            group="Content Security Policy",
-            help_text="Fraction (between 0 and 1) of requests to include report-uri directive.",
-        )
-        * 100,
+        "REPORT_PERCENTAGE": report_percentage * 100,
     }
 
 

{open_api_framework-0.13.1 → open_api_framework-0.13.3}/open_api_framework/conf/utils.py

@@ -1,12 +1,14 @@
 import logging  # noqa: TID251
 import sys
 from dataclasses import dataclass
+from importlib.util import find_spec
 from pathlib import Path
-from typing import Any, Optional
+from typing import Any, Optional, TypeVar, assert_never
 from urllib.parse import urlparse
+from warnings import warn
 
 from decouple import Csv, Undefined, config as _config, undefined
-from sentry_sdk.integrations import DidNotEnable, django, redis
+from sentry_sdk.integrations import DidNotEnable, Integration, django, redis
 from sentry_sdk.integrations.logging import LoggingIntegration
 
 
@@ -30,17 +32,19 @@ class EnvironmentVariable:
 
 ENVVAR_REGISTRY = []
 
+_T = TypeVar("_T")
+
 
 def config(
     option: str,
-    default: Any = undefined,
+    default: _T = undefined,
     help_text="",
     group=None,
-    add_to_docs=True,
+    add_to_docs: str | bool = True,
     auto_display_default=True,
     *args,
     **kwargs,
-):
+) -> _T:
     """
     An override of ``decouple.config``, with custom options to construct documentation
     for environment variables.
@@ -59,18 +63,21 @@ def config(
     :param help_text: The help text to be displayed for this variable in the documentation. Default `""`
     :param group: The name of the section under which this variable will be grouped. Default ``None``
     :param add_to_docs: Whether or not this variable will be displayed in the documentation. Default ``True``
+                        If a string is passed, it will only be displayed if it is importable as a module,
+                        and will raise a Warning when it is still passed in from the environment.
     :param auto_display_default: Whether or not the passed ``default`` value is displayed in the docs, this can be
         set to ``False`` in case a default needs more explanation that can be added to the ``help_text``
         (e.g. if it is computed or based on another variable). Default ``True``
     """
-    if add_to_docs:
-        variable = EnvironmentVariable(
-            name=option,
-            default=default,
-            help_text=help_text,
-            group=group,
-            auto_display_default=auto_display_default,
-        )
+    variable = EnvironmentVariable(
+        name=option,
+        default=default,
+        help_text=help_text,
+        group=group,
+        auto_display_default=auto_display_default,
+    )
+
+    def document():
         if variable not in ENVVAR_REGISTRY:
             ENVVAR_REGISTRY.append(variable)
         else:
@@ -85,19 +92,44 @@ def config(
 
     if default is not undefined and default is not None:
         kwargs.setdefault("cast", type(default))
-    return _config(option, default=default, *args, **kwargs)
+
+    value = _config(option, default=default, *args, **kwargs)
+
+    match add_to_docs:
+        case str(module) if find_spec(module):
+            document()
+        case str(module):
+            if value is not default:
+                warn(
+                    f"{variable.name} found, but required {add_to_docs} is not installed",
+                    RuntimeWarning,
+                )
+        case True:
+            document()
+        case False:
+            pass
+        case _:
+            assert_never(add_to_docs)
+
+    return value  # type: ignore
 
 
-def get_sentry_integrations() -> list:
+def importable(*items: str) -> list[str]:
+    "Return the dotted paths that start from an installed package"
+
+    split_items = (item.split(".") for item in items)
+    return [".".join(item) for item in split_items if find_spec(item[0])]
+
+
+def get_sentry_integrations() -> list[Integration]:
     """
     Determine which Sentry SDK integrations to enable.
     """
-    default = [
-        django.DjangoIntegration(),
-        redis.RedisIntegration(),
-    ]
     extra = []
 
+    if find_spec("redis"):  # does not raise DidNotEnable if redis is not installed
+        extra.append(redis.RedisIntegration())
+
     try:
         from sentry_sdk.integrations import celery
     except DidNotEnable:  # happens if the celery import fails by the integration
@@ -105,11 +137,7 @@ def get_sentry_integrations() -> list:
     else:
         extra.append(celery.CeleryIntegration())
 
-    try:
-        import structlog  # type: ignore  # noqa
-    except ImportError:
-        pass
-    else:
+    if find_spec("structlog"):
         extra.append(
             LoggingIntegration(
                 level=logging.INFO,  # breadcrumbs
@@ -119,7 +147,7 @@ def get_sentry_integrations() -> list:
             ),
         )
 
-    return [*default, *extra]
+    return [django.DjangoIntegration(), *extra]
 
 
 def strip_protocol_from_origin(origin: str) -> str:
@@ -131,10 +159,10 @@ def get_project_dirname() -> str:
     return config("DJANGO_SETTINGS_MODULE", add_to_docs=False).split(".")[0]
 
 
-def get_django_project_dir() -> str:
+def get_django_project_dir() -> Path:
     # Get the path of the importing module
     base_dirname = get_project_dirname()
-    return Path(sys.modules[base_dirname].__file__).parent
+    return Path(sys.modules[base_dirname].__file__).parent  # pyright: ignore[reportArgumentType]
 
 
 def mute_logging(config: dict) -> None:  # pragma: no cover

{open_api_framework-0.13.1 → open_api_framework-0.13.3/open_api_framework.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: open-api-framework
-Version: 0.13.1
+Version: 0.13.3
 Summary: A metapackage for registration components, that bundles the dependencies shared between these components and provides generic settings
 Author-email: Maykin Media <support@maykinmedia.nl>
 License: Copyright © Maykin 2024
@@ -96,7 +96,7 @@ Dynamic: license-file
 Open API Framework
 ==================
 
-:Version: 0.13.1
+:Version: 0.13.3
 :Source: https://github.com/maykinmedia/open-api-framework
 :Keywords: metapackage, dependencies
 

{open_api_framework-0.13.1 → open_api_framework-0.13.3}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "open-api-framework"
-version = "0.13.1"
+version = "0.13.3"
 description = "A metapackage for registration components, that bundles the dependencies shared between these components and provides generic settings"
 authors = [
     {name = "Maykin Media", email = "support@maykinmedia.nl"}
@@ -129,7 +129,7 @@ env = [
 ]
 
 [tool.bumpversion]
-current_version = "0.13.1"
+current_version = "0.13.3"
 files = [
     {filename = "pyproject.toml"},
     {filename = "README.rst"},

open_api_framework-0.13.3/tests/test_config_helpers.py

@@ -0,0 +1,50 @@
+import os
+
+import pytest
+
+from open_api_framework.conf.utils import (
+    ENVVAR_REGISTRY,
+    config,
+    get_django_project_dir,
+)
+
+
+def test_empty_list_as_default():
+    value = config("SOME_TEST_ENVVAR", split=True, default=[], add_to_docs=False)
+
+    assert value == []
+
+
+def test_non_empty_list_as_default():
+    value = config("SOME_TEST_ENVVAR", split=True, default=["foo"], add_to_docs=False)
+
+    assert value == ["foo"]
+
+
+def test_string_list_from_env(monkeypatch):
+    monkeypatch.setenv("SOME_TEST_ENVVAR", "foo,bar")
+
+    value = config("SOME_TEST_ENVVAR", split=True, default=["foo"], add_to_docs=False)
+
+    assert value == ["foo", "bar"]
+
+
+def test_it_raises_warning_if_add_to_docs_module_is_not_present(monkeypatch):
+    monkeypatch.setenv("FOO_TEST_ENVVAR", "value")
+    with pytest.warns() as warnings:
+        value = config("FOO_TEST_ENVVAR", default="value", add_to_docs="foo_module")
+        assert value == "value"
+        assert not any(var.name == "FOO_TEST_VAR" for var in ENVVAR_REGISTRY)
+
+    # warning mentions key actionable info
+    assert "FOO_TEST_ENVVAR" in str(warnings[0])
+    assert "foo_module" in str(warnings[0])
+
+
+def test_get_django_project_dir():
+    project_path = get_django_project_dir()
+    assert project_path.parts[-1] == "testapp"
+
+    # still compatible with os.path.join
+    settings = os.path.join(project_path, "settings.py")
+    assert os.path.exists(settings)

{open_api_framework-0.13.1 → open_api_framework-0.13.3}/tests/test_csp.py

@@ -1,5 +1,12 @@
+from importlib.util import find_spec
+
+import pytest
+
 import testapp.settings
 
+if not find_spec("csp"):
+    pytest.skip("no csp installed", allow_module_level=True)
+
 
 def test_csp_default(client):
     response = client.get("/dummy/")

{open_api_framework-0.13.1 → open_api_framework-0.13.3}/tests/test_generate_envvar_docs.py

@@ -1,3 +1,4 @@
+from importlib.util import find_spec
 from unittest.mock import mock_open, patch
 
 from django.core.management import call_command
@@ -34,7 +35,7 @@ Database
 * ``DB_HOST``: hostname of the PostgreSQL database. Defaults to ``db`` for the docker environment, otherwise defaults to ``localhost``.
 * ``DB_PORT``: port number of the database. Defaults to: ``5432``.
 * ``DB_CONN_MAX_AGE``: The lifetime of a database connection, as an integer of seconds. Use 0 to close database connections at the end of each request — Django’s historical behavior. This setting is ignored if connection pooling is used. Defaults to: ``60``.
-* ``DB_POOL_ENABLED``: Whether to use connection pooling. Defaults to: ``False``.
+* ``DB_POOL_ENABLED``: **Experimental:** Whether to use connection pooling. This feature is not yet recommended for production use. See the documentation for details: https://open-api-framework.readthedocs.io/en/latest/connection_pooling.html. Defaults to: ``False``.
 * ``DB_POOL_MIN_SIZE``: The minimum number of connection the pool will hold. The pool will actively try to create new connections if some are lost (closed, broken) and will try to never go below min_size. Defaults to: ``4``.
 * ``DB_POOL_MAX_SIZE``: The maximum number of connections the pool will hold. If None, or equal to min_size, the pool will not grow or shrink. If larger than min_size, the pool can grow if more than min_size connections are requested at the same time and will shrink back after the extra connections have been unused for more than max_idle seconds. Defaults to: ``None``.
 * ``DB_POOL_TIMEOUT``: The default maximum time in seconds that a client can wait to receive a connection from the pool (using connection() or getconn()). Note that these methods allow to override the timeout default. Defaults to: ``30``.
@@ -160,6 +161,8 @@ to define the envvars. The component will pick them up out of the box.
 
 def test_generate_envvar_docs():
     mock_file = mock_open()
+    extras_installed = bool(find_spec("csp"))
+
     with patch(
         "open_api_framework.management.commands.generate_envvar_docs.open", mock_file
     ):
@@ -174,4 +177,8 @@ def test_generate_envvar_docs():
         # Check the entire content written to the mock file
         written_content = "".join(call.args[0] for call in handle.write.call_args_list)
 
-        assert written_content == EXPECTED_OUTPUT
+        if extras_installed:
+            assert written_content == EXPECTED_OUTPUT
+        else:
+            assert "Cross-Origin-Resource-Sharing" not in written_content
+            assert "Content Security Policy" not in written_content

{open_api_framework-0.13.1 → open_api_framework-0.13.3}/tests/test_settings.py

@@ -1,9 +1,13 @@
+from importlib.util import find_spec
+
 from django.conf import settings
 from django.urls import reverse
 
+import pytest
 from django_webtest import WebTest
 
 
+@pytest.mark.skipif(not find_spec("sentry_sdk"), reason="No sentry installed")
 def test_sentry_settings():
     """
     test that sentry settings are initialized

open_api_framework-0.13.1/tests/test_config_helpers.py

@@ -1,13 +0,0 @@
-from open_api_framework.conf.utils import config
-
-
-def test_empty_list_as_default():
-    value = config("SOME_TEST_ENVVAR", split=True, default=[], add_to_docs=False)
-
-    assert value == []
-
-
-def test_non_empty_list_as_default():
-    value = config("SOME_TEST_ENVVAR", split=True, default=["foo"], add_to_docs=False)
-
-    assert value == ["foo"]