c2cwsgiutils 6.2.0.dev20__tar.gz → 6.2.0.dev207__tar.gz

{c2cwsgiutils-6.2.0.dev20 → c2cwsgiutils-6.2.0.dev207}/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2015-2024, Camptocamp SA
+Copyright (c) 2015-2026, Camptocamp SA
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without

{c2cwsgiutils-6.2.0.dev20 → c2cwsgiutils-6.2.0.dev207}/PKG-INFO

@@ -1,9 +1,9 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: c2cwsgiutils
-Version: 6.2.0.dev20
+Version: 6.2.0.dev207
 Summary: Common utilities for Camptocamp WSGI applications
-Home-page: https://github.com/camptocamp/c2cwsgiutils
-License: BSD-2-Clause
+License-Expression: BSD-2-Clause
+License-File: LICENSE
 Keywords: geo,gis,sqlalchemy,orm,wsgi
 Author: Camptocamp
 Author-email: info@camptocamp.com
@@ -33,32 +33,86 @@ Provides-Extra: sentry
 Provides-Extra: standard
 Provides-Extra: test-images
 Provides-Extra: tests
+Provides-Extra: waitress
 Provides-Extra: webserver
-Requires-Dist: SQLAlchemy ; extra == "standard" or extra == "webserver" or extra == "all"
-Requires-Dist: SQLAlchemy-Utils ; extra == "standard" or extra == "webserver" or extra == "all"
-Requires-Dist: alembic ; extra == "standard" or extra == "alembic" or extra == "all"
-Requires-Dist: boltons ; extra == "tests" or extra == "all"
+Requires-Dist: Paste ; extra == "all"
+Requires-Dist: Paste ; extra == "standard"
+Requires-Dist: Paste ; extra == "waitress"
+Requires-Dist: SQLAlchemy (>=1.4.0,<3.0.0) ; extra == "all"
+Requires-Dist: SQLAlchemy (>=1.4.0,<3.0.0) ; extra == "standard"
+Requires-Dist: SQLAlchemy (>=1.4.0,<3.0.0) ; extra == "waitress"
+Requires-Dist: SQLAlchemy (>=1.4.0,<3.0.0) ; extra == "webserver"
+Requires-Dist: SQLAlchemy-Utils ; extra == "all"
+Requires-Dist: SQLAlchemy-Utils ; extra == "standard"
+Requires-Dist: SQLAlchemy-Utils ; extra == "waitress"
+Requires-Dist: SQLAlchemy-Utils ; extra == "webserver"
+Requires-Dist: alembic ; extra == "alembic"
+Requires-Dist: alembic ; extra == "all"
+Requires-Dist: alembic ; extra == "standard"
+Requires-Dist: boltons ; extra == "all"
+Requires-Dist: boltons ; extra == "tests"
 Requires-Dist: cee_syslog_handler
-Requires-Dist: cornice ; extra == "standard" or extra == "webserver" or extra == "all"
-Requires-Dist: gunicorn ; extra == "standard" or extra == "webserver" or extra == "all"
-Requires-Dist: lxml ; extra == "tests" or extra == "all"
-Requires-Dist: objgraph ; extra == "debug" or extra == "all"
-Requires-Dist: prometheus-client ; extra == "standard" or extra == "webserver" or extra == "all"
-Requires-Dist: psycopg2 ; extra == "standard" or extra == "webserver" or extra == "all"
-Requires-Dist: pyjwt ; extra == "standard" or extra == "oauth2" or extra == "all"
-Requires-Dist: pyramid ; extra == "standard" or extra == "webserver" or extra == "all"
-Requires-Dist: pyramid-tm ; extra == "standard" or extra == "webserver" or extra == "all"
-Requires-Dist: pyramid_mako ; extra == "standard" or extra == "webserver" or extra == "all"
+Requires-Dist: cornice ; extra == "all"
+Requires-Dist: cornice ; extra == "standard"
+Requires-Dist: cornice ; extra == "waitress"
+Requires-Dist: cornice ; extra == "webserver"
+Requires-Dist: coverage ; extra == "all"
+Requires-Dist: coverage ; extra == "debug"
+Requires-Dist: gunicorn ; extra == "all"
+Requires-Dist: gunicorn ; extra == "standard"
+Requires-Dist: gunicorn ; extra == "webserver"
+Requires-Dist: lxml ; extra == "all"
+Requires-Dist: lxml ; extra == "tests"
+Requires-Dist: objgraph ; extra == "all"
+Requires-Dist: objgraph ; extra == "debug"
+Requires-Dist: prometheus-client
+Requires-Dist: psutil ; extra == "all"
+Requires-Dist: psutil ; extra == "debug"
+Requires-Dist: psycopg2 ; extra == "all"
+Requires-Dist: psycopg2 ; extra == "standard"
+Requires-Dist: psycopg2 ; extra == "waitress"
+Requires-Dist: psycopg2 ; extra == "webserver"
+Requires-Dist: pyjwt ; extra == "all"
+Requires-Dist: pyjwt ; extra == "oauth2"
+Requires-Dist: pyjwt ; extra == "standard"
+Requires-Dist: pyramid ; extra == "all"
+Requires-Dist: pyramid ; extra == "standard"
+Requires-Dist: pyramid ; extra == "waitress"
+Requires-Dist: pyramid ; extra == "webserver"
+Requires-Dist: pyramid-tm ; extra == "all"
+Requires-Dist: pyramid-tm ; extra == "standard"
+Requires-Dist: pyramid-tm ; extra == "waitress"
+Requires-Dist: pyramid-tm ; extra == "webserver"
+Requires-Dist: pyramid_mako ; extra == "all"
+Requires-Dist: pyramid_mako ; extra == "standard"
+Requires-Dist: pyramid_mako ; extra == "waitress"
+Requires-Dist: pyramid_mako ; extra == "webserver"
 Requires-Dist: pyyaml
-Requires-Dist: redis ; extra == "standard" or extra == "broadcast" or extra == "all"
+Requires-Dist: redis ; extra == "all"
+Requires-Dist: redis ; extra == "broadcast"
+Requires-Dist: redis ; extra == "standard"
 Requires-Dist: requests
-Requires-Dist: requests-oauthlib ; extra == "standard" or extra == "oauth2" or extra == "all"
+Requires-Dist: requests-oauthlib ; extra == "all"
+Requires-Dist: requests-oauthlib ; extra == "oauth2"
+Requires-Dist: requests-oauthlib ; extra == "standard"
 Requires-Dist: scikit-image ; extra == "test-images"
-Requires-Dist: sentry-sdk ; extra == "standard" or extra == "sentry" or extra == "all"
+Requires-Dist: sentry-sdk ; extra == "all"
+Requires-Dist: sentry-sdk ; extra == "sentry"
+Requires-Dist: sentry-sdk ; extra == "standard"
 Requires-Dist: ujson
-Requires-Dist: waitress ; extra == "dev" or extra == "all"
-Requires-Dist: zope.interface ; extra == "standard" or extra == "webserver" or extra == "all"
-Requires-Dist: zope.sqlalchemy ; extra == "standard" or extra == "webserver" or extra == "all"
+Requires-Dist: waitress ; extra == "all"
+Requires-Dist: waitress ; extra == "dev"
+Requires-Dist: waitress ; extra == "standard"
+Requires-Dist: waitress ; extra == "waitress"
+Requires-Dist: zope.interface ; extra == "all"
+Requires-Dist: zope.interface ; extra == "standard"
+Requires-Dist: zope.interface ; extra == "waitress"
+Requires-Dist: zope.interface ; extra == "webserver"
+Requires-Dist: zope.sqlalchemy ; extra == "all"
+Requires-Dist: zope.sqlalchemy ; extra == "standard"
+Requires-Dist: zope.sqlalchemy ; extra == "waitress"
+Requires-Dist: zope.sqlalchemy ; extra == "webserver"
+Project-URL: Bug Tracker, https://github.com/camptocamp/c2cwsgiutils/issues
 Project-URL: Repository, https://github.com/camptocamp/c2cwsgiutils
 Description-Content-Type: text/markdown
 
@@ -672,6 +726,64 @@ def hello_get(request):
     return {'hello': True}
 ```
 
+## Waitress
+
+In production mode we usually use Gunicorn but we can also use Waitress.
+
+The advantage to use Waitress is that it creates only one process, that makes it easier to manage especially on Kubernetes:
+
+- The memory is more stable.
+- The OOM killer will restart the container.
+- Prometheus didn't request trick to aggregate the metrics.
+
+Then to migrate from Gunicorn to Waitress you should do:
+
+Add call to `c2cwsgiutils.prometheus.start_single_process()` on your application main function.
+
+Changes to do in your docker file:
+
+```diff
+
+ ENV \
+-   GUNICORN_LOG_LEVEL=WARNING \
++   WAITRESS_LOG_LEVEL=WARNING \
++   WAITRESS_THREADS=10 \
+
+-RUN mkdir -p /prometheus-metrics \
+-  && chmod a+rwx /prometheus-metrics
+-ENV PROMETHEUS_MULTIPROC_DIR=/prometheus-metrics
+
+
+-CMD ["/venv/bin/gunicorn", "--paste=/app/production.ini"]
++CMD ["/venv/bin/pserve", "c2c:///app/production.ini"]
+```
+
+Remove the no more needed file `gunicorn.conf.py`.
+
+Update the `production.ini` file:
+
+```diff
+
+-# this file should be used by gunicorn.
+
+ [server:main]
++threads = %(WAITRESS_THREADS)s
++trusted_proxy = True
++clear_untrusted_proxy_headers = False
+
+ [loggers]
+-keys = root, gunicorn, sqlalchemy, c2cwsgiutils, c2cwsgiutils_app
++keys = root, waitress, sqlalchemy, c2cwsgiutils, c2cwsgiutils_app
+
+-[logger_gunicorn]
+-level = %(GUNICORN_LOG_LEVEL)s
++[logger_waitress]
++level = %(WAITRESS_LOG_LEVEL)s
+ handlers =
+-qualname = gunicorn.error
++qualname = waitress
+```
+
 # Exception handling
 
 c2cwsgiutils can install exception handling views that will catch any exception raised by the

{c2cwsgiutils-6.2.0.dev20 → c2cwsgiutils-6.2.0.dev207}/README.md

@@ -608,6 +608,64 @@ def hello_get(request):
     return {'hello': True}
 ```
 
+## Waitress
+
+In production mode we usually use Gunicorn but we can also use Waitress.
+
+The advantage to use Waitress is that it creates only one process, that makes it easier to manage especially on Kubernetes:
+
+- The memory is more stable.
+- The OOM killer will restart the container.
+- Prometheus didn't request trick to aggregate the metrics.
+
+Then to migrate from Gunicorn to Waitress you should do:
+
+Add call to `c2cwsgiutils.prometheus.start_single_process()` on your application main function.
+
+Changes to do in your docker file:
+
+```diff
+
+ ENV \
+-   GUNICORN_LOG_LEVEL=WARNING \
++   WAITRESS_LOG_LEVEL=WARNING \
++   WAITRESS_THREADS=10 \
+
+-RUN mkdir -p /prometheus-metrics \
+-  && chmod a+rwx /prometheus-metrics
+-ENV PROMETHEUS_MULTIPROC_DIR=/prometheus-metrics
+
+
+-CMD ["/venv/bin/gunicorn", "--paste=/app/production.ini"]
++CMD ["/venv/bin/pserve", "c2c:///app/production.ini"]
+```
+
+Remove the no more needed file `gunicorn.conf.py`.
+
+Update the `production.ini` file:
+
+```diff
+
+-# this file should be used by gunicorn.
+
+ [server:main]
++threads = %(WAITRESS_THREADS)s
++trusted_proxy = True
++clear_untrusted_proxy_headers = False
+
+ [loggers]
+-keys = root, gunicorn, sqlalchemy, c2cwsgiutils, c2cwsgiutils_app
++keys = root, waitress, sqlalchemy, c2cwsgiutils, c2cwsgiutils_app
+
+-[logger_gunicorn]
+-level = %(GUNICORN_LOG_LEVEL)s
++[logger_waitress]
++level = %(WAITRESS_LOG_LEVEL)s
+ handlers =
+-qualname = gunicorn.error
++qualname = waitress
+```
+
 # Exception handling
 
 c2cwsgiutils can install exception handling views that will catch any exception raised by the

{c2cwsgiutils-6.2.0.dev20 → c2cwsgiutils-6.2.0.dev207}/c2cwsgiutils/__init__.py

@@ -35,7 +35,8 @@ def _create_handlers(config: configparser.ConfigParser) -> dict[str, Any]:
     for hh in handlers:
         block = config[f"handler_{hh}"]
         if "args" in block:
-            raise ValueError(f"Can not parse args of handlers {hh}, use kwargs instead.")
+            message = f"Can not parse args of handlers {hh}, use kwargs instead."
+            raise ValueError(message)
         c = block["class"]
         if "." not in c:
             # classes like StreamHandler does not need the prefix in the ini so we add it here
@@ -116,10 +117,9 @@ def get_paste_config() -> str:
     for val in sys.argv:
         if next_one:
             return val
-        if val.startswith("--paste=") or val.startswith("--paster="):
+        if val.startswith(("--paste=", "--paster=")):
             return val.split("=")[1]
         if val in ["--paste", "--paster"]:
             next_one = True
 
-    fallback = os.environ.get("C2CWSGIUTILS_CONFIG", "production.ini")
-    return fallback
+    return os.environ.get("C2CWSGIUTILS_CONFIG", "production.ini")

{c2cwsgiutils-6.2.0.dev20 → c2cwsgiutils-6.2.0.dev207}/c2cwsgiutils/acceptance/__init__.py

@@ -7,7 +7,10 @@ _LOG = logging.getLogger(__name__)
 
 
 def retry(
-    exception_to_check: typing.Any, tries: float = 3, delay: float = 0.5, backoff: float = 2
+    exception_to_check: typing.Any,
+    tries: float = 3,
+    delay: float = 0.5,
+    backoff: float = 2,
 ) -> typing.Callable[..., typing.Any]:
     """
     Retry calling the decorated function using an exponential backoff.
@@ -20,6 +23,7 @@ def retry(
         tries: number of times to try (not retry) before giving up
         delay: initial delay between retries in seconds
         backoff: backoff multiplier e.g. value of 2 will double the delay each retry
+
     """
 
     def deco_retry(f: typing.Callable[..., typing.Any]) -> typing.Callable[..., typing.Any]:

{c2cwsgiutils-6.2.0.dev20 → c2cwsgiutils-6.2.0.dev207}/c2cwsgiutils/acceptance/connection.py

@@ -1,7 +1,8 @@
 import re
 from collections.abc import Mapping, MutableMapping
 from enum import Enum
-from typing import Any, Optional, Union
+from pathlib import Path
+from typing import Any
 
 import requests
 
@@ -20,6 +21,7 @@ class Connection:
     """The connection."""
 
     def __init__(self, base_url: str, origin: str) -> None:
+        """Initialize the connection."""
         self.base_url = base_url
         if not self.base_url.endswith("/"):
             self.base_url += "/"
@@ -31,10 +33,10 @@ class Connection:
         url: str,
         expected_status: int = 200,
         cors: bool = True,
-        headers: Optional[Mapping[str, str]] = None,
+        headers: Mapping[str, str] | None = None,
         cache_expected: CacheExpected = CacheExpected.NO,
         **kwargs: Any,
-    ) -> Optional[str]:
+    ) -> str | None:
         """Get the given URL (relative to the root of API)."""
         with self.session.get(self.base_url + url, headers=self._merge_headers(headers, cors), **kwargs) as r:
             check_response(r, expected_status, cache_expected=cache_expected)
@@ -45,7 +47,7 @@ class Connection:
         self,
         url: str,
         expected_status: int = 200,
-        headers: Optional[Mapping[str, str]] = None,
+        headers: Mapping[str, str] | None = None,
         cors: bool = True,
         cache_expected: CacheExpected = CacheExpected.NO,
         **kwargs: Any,
@@ -60,7 +62,7 @@ class Connection:
         self,
         url: str,
         expected_status: int = 200,
-        headers: Optional[Mapping[str, str]] = None,
+        headers: Mapping[str, str] | None = None,
         cors: bool = True,
         cache_expected: CacheExpected = CacheExpected.NO,
         **kwargs: Any,
@@ -74,9 +76,9 @@ class Connection:
     def get_xml(
         self,
         url: str,
-        schema: Optional[str] = None,
+        schema: Path | None = None,
         expected_status: int = 200,
-        headers: Optional[Mapping[str, str]] = None,
+        headers: Mapping[str, str] | None = None,
         cors: bool = True,
         cache_expected: CacheExpected = CacheExpected.NO,
         **kwargs: Any,
@@ -93,10 +95,10 @@ class Connection:
             check_response(r, expected_status, cache_expected=cache_expected)
             self._check_cors(cors, r)
             r.raw.decode_content = True
-            doc = etree.parse(r.raw)  # nosec
+            doc = etree.parse(r.raw)  # noqa: S320, RUF100
             if schema is not None:
-                with open(schema, encoding="utf-8") as schema_file:
-                    xml_schema = etree.XMLSchema(etree.parse(schema_file))  # nosec
+                with schema.open(encoding="utf-8") as schema_file:
+                    xml_schema = etree.XMLSchema(etree.parse(schema_file))  # noqa: S320, RUF100
                 xml_schema.assertValid(doc)
             return doc
 
@@ -104,14 +106,16 @@ class Connection:
         self,
         url: str,
         expected_status: int = 200,
-        headers: Optional[Mapping[str, str]] = None,
+        headers: Mapping[str, str] | None = None,
         cors: bool = True,
         cache_expected: CacheExpected = CacheExpected.NO,
         **kwargs: Any,
     ) -> Any:
         """POST the given URL (relative to the root of API)."""
         with self.session.post(
-            self.base_url + url, headers=self._merge_headers(headers, cors), **kwargs
+            self.base_url + url,
+            headers=self._merge_headers(headers, cors),
+            **kwargs,
         ) as r:
             check_response(r, expected_status, cache_expected=cache_expected)
             self._check_cors(cors, r)
@@ -121,14 +125,16 @@ class Connection:
         self,
         url: str,
         expected_status: int = 200,
-        headers: Optional[Mapping[str, str]] = None,
+        headers: Mapping[str, str] | None = None,
         cors: bool = True,
         cache_expected: CacheExpected = CacheExpected.NO,
         **kwargs: Any,
     ) -> Any:
         """POST files to the the given URL (relative to the root of API)."""
         with self.session.post(
-            self.base_url + url, headers=self._merge_headers(headers, cors), **kwargs
+            self.base_url + url,
+            headers=self._merge_headers(headers, cors),
+            **kwargs,
         ) as r:
             check_response(r, expected_status, cache_expected)
             self._check_cors(cors, r)
@@ -138,14 +144,16 @@ class Connection:
         self,
         url: str,
         expected_status: int = 200,
-        headers: Optional[Mapping[str, str]] = None,
+        headers: Mapping[str, str] | None = None,
         cors: bool = True,
         cache_expected: CacheExpected = CacheExpected.NO,
         **kwargs: Any,
-    ) -> Optional[str]:
+    ) -> str | None:
         """POST the given URL (relative to the root of API)."""
         with self.session.post(
-            self.base_url + url, headers=self._merge_headers(headers, cors), **kwargs
+            self.base_url + url,
+            headers=self._merge_headers(headers, cors),
+            **kwargs,
         ) as r:
             check_response(r, expected_status, cache_expected)
             self._check_cors(cors, r)
@@ -155,7 +163,7 @@ class Connection:
         self,
         url: str,
         expected_status: int = 200,
-        headers: Optional[Mapping[str, str]] = None,
+        headers: Mapping[str, str] | None = None,
         cors: bool = True,
         cache_expected: CacheExpected = CacheExpected.NO,
         **kwargs: Any,
@@ -170,14 +178,16 @@ class Connection:
         self,
         url: str,
         expected_status: int = 200,
-        headers: Optional[Mapping[str, str]] = None,
+        headers: Mapping[str, str] | None = None,
         cors: bool = True,
         cache_expected: CacheExpected = CacheExpected.NO,
         **kwargs: Any,
     ) -> Any:
         """PATCH the given URL (relative to the root of API)."""
         with self.session.patch(
-            self.base_url + url, headers=self._merge_headers(headers, cors), **kwargs
+            self.base_url + url,
+            headers=self._merge_headers(headers, cors),
+            **kwargs,
         ) as r:
             check_response(r, expected_status, cache_expected)
             self._check_cors(cors, r)
@@ -187,14 +197,16 @@ class Connection:
         self,
         url: str,
         expected_status: int = 204,
-        headers: Optional[Mapping[str, str]] = None,
+        headers: Mapping[str, str] | None = None,
         cors: bool = True,
         cache_expected: CacheExpected = CacheExpected.NO,
         **kwargs: Any,
     ) -> requests.Response:
         """DELETE the given URL (relative to the root of API)."""
         with self.session.delete(
-            self.base_url + url, headers=self._merge_headers(headers, cors), **kwargs
+            self.base_url + url,
+            headers=self._merge_headers(headers, cors),
+            **kwargs,
         ) as r:
             check_response(r, expected_status, cache_expected)
             self._check_cors(cors, r)
@@ -204,13 +216,15 @@ class Connection:
         self,
         url: str,
         expected_status: int = 200,
-        headers: Optional[Mapping[str, str]] = None,
+        headers: Mapping[str, str] | None = None,
         cache_expected: CacheExpected = CacheExpected.NO,
         **kwargs: Any,
     ) -> requests.Response:
         """Get the given URL (relative to the root of API)."""
         with self.session.options(
-            self.base_url + url, headers=self._merge_headers(headers, False), **kwargs
+            self.base_url + url,
+            headers=self._merge_headers(headers, cors=False),
+            **kwargs,
         ) as r:
             check_response(r, expected_status, cache_expected=cache_expected)
             return r
@@ -218,8 +232,7 @@ class Connection:
     def _cors_headers(self, cors: bool) -> Mapping[str, str]:
         if cors:
             return {"Origin": self.origin}
-        else:
-            return {}
+        return {}
 
     def _check_cors(self, cors: bool, r: requests.Response) -> None:
         if cors:
@@ -229,8 +242,10 @@ class Connection:
                 assert r.headers["Access-Control-Allow-Origin"] == "*"
 
     def _merge_headers(
-        self, headers: Optional[Mapping[str, Union[str, bytes]]], cors: bool
-    ) -> MutableMapping[str, Union[str, bytes]]:
+        self,
+        headers: Mapping[str, str | bytes] | None,
+        cors: bool,
+    ) -> MutableMapping[str, str | bytes]:
         merged = dict(headers) if headers is not None else {}
         if self.session.headers is not None:
             merged.update(self.session.headers)
@@ -264,9 +279,8 @@ def check_response(
 def _get_json(r: requests.Response) -> Any:
     if r.status_code == 204:
         return None
-    else:
-        content_type = r.headers["Content-Type"].split(";")[0]
-        assert content_type == "application/json" or content_type.endswith(
-            "+json"
-        ), f"{r.status_code}, {content_type}, {r.text}"
-        return r.json()
+    content_type = r.headers["Content-Type"].split(";")[0]
+    assert content_type == "application/json" or content_type.endswith("+json"), (
+        f"{r.status_code}, {content_type}, {r.text}"
+    )
+    return r.json()