c2cwsgiutils 6.1.7.dev4__tar.gz → 6.2.0.dev54__tar.gz

{c2cwsgiutils-6.1.7.dev4 → c2cwsgiutils-6.2.0.dev54}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: c2cwsgiutils
-Version: 6.1.7.dev4
+Version: 6.2.0.dev54
 Summary: Common utilities for Camptocamp WSGI applications
 Home-page: https://github.com/camptocamp/c2cwsgiutils
 License: BSD-2-Clause
@@ -33,22 +33,26 @@ 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: Paste ; extra == "standard" or extra == "waitress" or extra == "all"
+Requires-Dist: SQLAlchemy ; extra == "standard" or extra == "webserver" or extra == "waitress" or extra == "all"
+Requires-Dist: SQLAlchemy-Utils ; extra == "standard" or extra == "webserver" or extra == "waitress" or extra == "all"
 Requires-Dist: alembic ; extra == "standard" or extra == "alembic" or extra == "all"
 Requires-Dist: boltons ; extra == "tests" or extra == "all"
 Requires-Dist: cee_syslog_handler
-Requires-Dist: cornice ; extra == "standard" or extra == "webserver" or extra == "all"
+Requires-Dist: cornice ; extra == "standard" or extra == "webserver" or extra == "waitress" or extra == "all"
+Requires-Dist: coverage ; extra == "debug" 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: prometheus-client ; extra == "standard" or extra == "webserver" or extra == "waitress" or extra == "all"
+Requires-Dist: psutil ; extra == "debug" or extra == "all"
+Requires-Dist: psycopg2 ; extra == "standard" or extra == "webserver" or extra == "waitress" 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: pyramid ; extra == "standard" or extra == "webserver" or extra == "waitress" or extra == "all"
+Requires-Dist: pyramid-tm ; extra == "standard" or extra == "webserver" or extra == "waitress" or extra == "all"
+Requires-Dist: pyramid_mako ; extra == "standard" or extra == "webserver" or extra == "waitress" or extra == "all"
 Requires-Dist: pyyaml
 Requires-Dist: redis ; extra == "standard" or extra == "broadcast" or extra == "all"
 Requires-Dist: requests
@@ -56,9 +60,9 @@ Requires-Dist: requests-oauthlib ; extra == "standard" or extra == "oauth2" or e
 Requires-Dist: scikit-image ; extra == "test-images"
 Requires-Dist: sentry-sdk ; extra == "standard" or extra == "sentry" or extra == "all"
 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 == "standard" or extra == "dev" or extra == "waitress" or extra == "all"
+Requires-Dist: zope.interface ; extra == "standard" or extra == "webserver" or extra == "waitress" or extra == "all"
+Requires-Dist: zope.sqlalchemy ; extra == "standard" or extra == "webserver" or extra == "waitress" or extra == "all"
 Project-URL: Repository, https://github.com/camptocamp/c2cwsgiutils
 Description-Content-Type: text/markdown
 
@@ -672,6 +676,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.1.7.dev4 → c2cwsgiutils-6.2.0.dev54}/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.1.7.dev4 → c2cwsgiutils-6.2.0.dev54}/c2cwsgiutils/acceptance/__init__.py

@@ -20,6 +20,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.1.7.dev4 → c2cwsgiutils-6.2.0.dev54}/c2cwsgiutils/acceptance/connection.py

@@ -20,6 +20,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 += "/"
@@ -93,10 +94,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
             if schema is not None:
                 with open(schema, encoding="utf-8") as schema_file:
-                    xml_schema = etree.XMLSchema(etree.parse(schema_file))  # nosec
+                    xml_schema = etree.XMLSchema(etree.parse(schema_file))  # noqa: S320
                 xml_schema.assertValid(doc)
             return doc
 

{c2cwsgiutils-6.1.7.dev4 → c2cwsgiutils-6.2.0.dev54}/c2cwsgiutils/acceptance/image.py

@@ -10,7 +10,7 @@ import skimage.metrics  # pylint: disable=import-error
 import skimage.transform  # pylint: disable=import-error
 
 if TYPE_CHECKING:
-    from typing import TypeAlias
+    from typing_extensions import TypeAlias
 
     NpNdarrayInt: TypeAlias = np.ndarray[np.uint8, Any]
 else:
@@ -89,6 +89,7 @@ def check_image(  # pylint: disable=too-many-locals,too-many-statements
       level: The minimum similarity level (between 0.0 and 1.0), default to 1.0
       generate_expected_image: If `True` generate the expected image instead of checking it
       use_mask: If `False` don't use the mask event if the file exists
+
     """
     assert image_to_check is not None, "Image required"
     image_file_basename = os.path.splitext(os.path.basename(expected_filename))[0]
@@ -129,7 +130,7 @@ def check_image(  # pylint: disable=too-many-locals,too-many-statements
         if np.issubdtype(mask.dtype, np.floating):
             mask = (mask * 255).astype("uint8")
 
-        assert ((0 < mask) & (mask < 255)).sum() == 0, "Mask should be only black and white image"
+        assert ((mask > 0) & (mask < 255)).sum() == 0, "Mask should be only black and white image"
 
         # Convert to boolean
         mask = mask == 0
@@ -146,7 +147,7 @@ def check_image(  # pylint: disable=too-many-locals,too-many-statements
         return
     if not os.path.isfile(expected_filename):
         skimage.io.imsave(expected_filename, image_to_check)
-        assert False, "Expected image not found: " + expected_filename
+        raise AssertionError("Expected image not found: " + expected_filename)
     expected = skimage.io.imread(expected_filename)
     assert expected is not None, "Wrong image: " + expected_filename
     expected = normalize_image(expected)
@@ -208,6 +209,7 @@ def check_screenshot(
       level: See `check_image`
       generate_expected_image: See `check_image`
       use_mask: See `check_image`
+
     """
     if headers is None:
         headers = {}