c2cwsgiutils 6.1.0.dev105__tar.gz → 6.1.7.dev4__tar.gz

{c2cwsgiutils-6.1.0.dev105 → c2cwsgiutils-6.1.7.dev4}/LICENSE

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

{c2cwsgiutils-6.1.0.dev105 → c2cwsgiutils-6.1.7.dev4}/PKG-INFO

@@ -1,13 +1,13 @@
 Metadata-Version: 2.1
 Name: c2cwsgiutils
-Version: 6.1.0.dev105
+Version: 6.1.7.dev4
 Summary: Common utilities for Camptocamp WSGI applications
 Home-page: https://github.com/camptocamp/c2cwsgiutils
 License: BSD-2-Clause
 Keywords: geo,gis,sqlalchemy,orm,wsgi
 Author: Camptocamp
 Author-email: info@camptocamp.com
-Requires-Python: >=3.9
+Requires-Python: >=3.10
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: Environment :: Plugins
 Classifier: Framework :: Pyramid
@@ -17,10 +17,10 @@ Classifier: License :: OSI Approved :: BSD License
 Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python
 Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
 Classifier: Topic :: Internet :: WWW/HTTP :: WSGI :: Application
 Classifier: Typing :: Typed
 Provides-Extra: alembic
@@ -64,7 +64,7 @@ Description-Content-Type: text/markdown
 
 # Camptocamp WSGI utilities
 
-This is a Python 3 library (>=3.5) providing common tools for Camptocamp WSGI
+This is a Python 3 library providing common tools for Camptocamp WSGI
 applications:
 
 - Provide prometheus metrics
@@ -725,11 +725,16 @@ A few other environment variables can be used to tune the info sent with each re
 - `SENTRY_CLIENT_IGNORE_EXCEPTIONS`: list (coma separated) of exceptions to ignore (defaults to SystemExit)
 - `SENTRY_TAG_...`: to add other custom tags
 - `SENTRY_LEVEL`: starting from what logging level to send events to Sentry (defaults to ERROR)
-- `SENTRY_TRACES_SAMPLE_RATE`: The percentage of events to send to sentry in order to compute the performance. Value between 0 and 1, default is 0.
+- `SENTRY_TRACES_SAMPLE_RATE`: The percentage of events to send to sentry in order to compute the performance. Value between 0 and 1 (default is 0)
+- `SENTRY_INTEGRATION_LOGGING`: If set to 0, the Sentry integration will not log anything (default is 1)
+- `SENTRY_INTEGRATION_PYRAMID`: If set to 0, the Sentry integration with Pyramid will not be enabled (default is 1)
+- `SENTRY_INTEGRATION_SQLALCHEMY`: If set to 0, the Sentry integration with SQLAlchemy will not be enabled (default is 1)
+- `SENTRY_INTEGRATION_REDIS`: If set to 0, the Sentry integration with Redis will not be enabled (default is 1)
+- `SENTRY_INTEGRATION_ASYNCIO`: If set to 0, the Sentry integration with asyncio will not be enabled (default is 1)
 
 # Developer info
 
-You will need `docker` (>=1.12.0), `docker-compose` (>=1.10.0) and
+You will need `docker` (>=1.12.0), `docker compose` and
 `make` installed on the machine to play with this project.
 Check available versions of `docker-engine` with
 `apt-get policy docker-engine` and eventually force install the
@@ -758,6 +763,13 @@ To make a release:
 - Add the new branch name in the `.github/workflows/rebuild.yaml` and
   `.github/workflows/audit.yaml` files.
 
+## Pserve
+
+Pserve will not set the headers in the environment then if you are behind a reverse proxy, you will have
+wrong values in client information, you can force them by using the environment variables:
+`C2CWSGIUTILS_FORCE_PROTO`, `C2CWSGIUTILS_FORCE_HOST` `C2CWSGIUTILS_FORCE_SERVER_NAME` and
+`C2CWSGIUTILS_FORCE_REMOTE_ADDR`.
+
 ## Testing
 
 ### Screenshots

{c2cwsgiutils-6.1.0.dev105 → c2cwsgiutils-6.1.7.dev4}/README.md

@@ -1,6 +1,6 @@
 # Camptocamp WSGI utilities
 
-This is a Python 3 library (>=3.5) providing common tools for Camptocamp WSGI
+This is a Python 3 library providing common tools for Camptocamp WSGI
 applications:
 
 - Provide prometheus metrics
@@ -661,11 +661,16 @@ A few other environment variables can be used to tune the info sent with each re
 - `SENTRY_CLIENT_IGNORE_EXCEPTIONS`: list (coma separated) of exceptions to ignore (defaults to SystemExit)
 - `SENTRY_TAG_...`: to add other custom tags
 - `SENTRY_LEVEL`: starting from what logging level to send events to Sentry (defaults to ERROR)
-- `SENTRY_TRACES_SAMPLE_RATE`: The percentage of events to send to sentry in order to compute the performance. Value between 0 and 1, default is 0.
+- `SENTRY_TRACES_SAMPLE_RATE`: The percentage of events to send to sentry in order to compute the performance. Value between 0 and 1 (default is 0)
+- `SENTRY_INTEGRATION_LOGGING`: If set to 0, the Sentry integration will not log anything (default is 1)
+- `SENTRY_INTEGRATION_PYRAMID`: If set to 0, the Sentry integration with Pyramid will not be enabled (default is 1)
+- `SENTRY_INTEGRATION_SQLALCHEMY`: If set to 0, the Sentry integration with SQLAlchemy will not be enabled (default is 1)
+- `SENTRY_INTEGRATION_REDIS`: If set to 0, the Sentry integration with Redis will not be enabled (default is 1)
+- `SENTRY_INTEGRATION_ASYNCIO`: If set to 0, the Sentry integration with asyncio will not be enabled (default is 1)
 
 # Developer info
 
-You will need `docker` (>=1.12.0), `docker-compose` (>=1.10.0) and
+You will need `docker` (>=1.12.0), `docker compose` and
 `make` installed on the machine to play with this project.
 Check available versions of `docker-engine` with
 `apt-get policy docker-engine` and eventually force install the
@@ -694,6 +699,13 @@ To make a release:
 - Add the new branch name in the `.github/workflows/rebuild.yaml` and
   `.github/workflows/audit.yaml` files.
 
+## Pserve
+
+Pserve will not set the headers in the environment then if you are behind a reverse proxy, you will have
+wrong values in client information, you can force them by using the environment variables:
+`C2CWSGIUTILS_FORCE_PROTO`, `C2CWSGIUTILS_FORCE_HOST` `C2CWSGIUTILS_FORCE_SERVER_NAME` and
+`C2CWSGIUTILS_FORCE_REMOTE_ADDR`.
+
 ## Testing
 
 ### Screenshots

{c2cwsgiutils-6.1.0.dev105 → c2cwsgiutils-6.1.7.dev4}/c2cwsgiutils/__init__.py

@@ -1,12 +1,12 @@
+import ast
 import configparser
 import logging
 import os
-import re
 import sys
 from configparser import SectionProxy
 from typing import Any
 
-LOG = logging.getLogger(__name__)
+_LOG = logging.getLogger(__name__)
 
 
 def get_config_defaults() -> dict[str, str]:
@@ -16,13 +16,13 @@ def get_config_defaults() -> dict[str, str]:
     configparser does not support duplicated defaults with different cases, this function filter
     the second one to avoid the issue.
 
-    configparser interpretate the % then we need to escape them
+    configparser interpret the % then we need to escape them
     """
     result: dict[str, str] = {}
     lowercase_keys: set[str] = set()
     for key, value in os.environ.items():
         if key.lower() in lowercase_keys:
-            LOG.warning("The environment variable '%s' is duplicated with different case, ignoring", key)
+            _LOG.warning("The environment variable '%s' is duplicated with different case, ignoring", key)
             continue
         lowercase_keys.add(key.lower())
         result[key] = value.replace("%", "%%")
@@ -32,23 +32,26 @@ def get_config_defaults() -> dict[str, str]:
 def _create_handlers(config: configparser.ConfigParser) -> dict[str, Any]:
     handlers = [k.strip() for k in config["handlers"]["keys"].split(",")]
     d_handlers: dict[str, Any] = {}
-    stream_re = re.compile(r"\((.*?),\)")
     for hh in handlers:
         block = config[f"handler_{hh}"]
-        stream_match = stream_re.match(block["args"])
-        if stream_match is None:
-            raise Exception(f"Could not parse args of handler {hh}")  # pylint: disable=broad-exception-raised
-        args = stream_match.groups()[0]
+        if "args" in block:
+            raise ValueError(f"Can not parse args of handlers {hh}, use kwargs instead.")
         c = block["class"]
         if "." not in c:
             # classes like StreamHandler does not need the prefix in the ini so we add it here
             c = f"logging.{c}"
         conf = {
             "class": c,
-            "stream": f"ext://{args}",  # like ext://sys.stdout
         }
+        if "level" in block:
+            conf["level"] = block["level"]
         if "formatter" in block:
             conf["formatter"] = block["formatter"]
+        if "filters" in block:
+            conf["filters"] = block["filters"]
+        if "kwargs" in block:
+            kwargs = ast.literal_eval(block["kwargs"])
+            conf.update(kwargs)
         d_handlers[hh] = conf
     return d_handlers
 
@@ -57,7 +60,7 @@ def _filter_logger(block: SectionProxy) -> dict[str, Any]:
     out: dict[str, Any] = {"level": block["level"]}
     handlers = block.get("handlers", "")
     if handlers != "":
-        out["handlers"] = [block["handlers"]]
+        out["handlers"] = [k.strip() for k in block["handlers"].split(",")]
     return out
 
 

{c2cwsgiutils-6.1.0.dev105 → c2cwsgiutils-6.1.7.dev4}/c2cwsgiutils/acceptance/__init__.py

@@ -3,7 +3,7 @@ import time
 import typing
 from functools import wraps
 
-LOG = logging.getLogger(__name__)
+_LOG = logging.getLogger(__name__)
 
 
 def retry(
@@ -16,7 +16,6 @@ def retry(
     original from: http://wiki.python.org/moin/PythonDecoratorLibrary#Retry
 
     Arguments:
-
         exception_to_check: the exception to check. may be a tuple of exceptions to check
         tries: number of times to try (not retry) before giving up
         delay: initial delay between retries in seconds
@@ -32,7 +31,7 @@ def retry(
                     return f(*args, **kwargs)
                 except exception_to_check as e:
                     msg = f"{e:s}, Retrying in {mdelay:d} seconds..."
-                    LOG.warning(msg)
+                    _LOG.warning(msg)
                     time.sleep(mdelay)
                     mtries -= 1
                     mdelay *= backoff

{c2cwsgiutils-6.1.0.dev105 → c2cwsgiutils-6.1.7.dev4}/c2cwsgiutils/acceptance/connection.py

@@ -82,8 +82,7 @@ class Connection:
         **kwargs: Any,
     ) -> Any:
         """Get the given URL (relative to the root of API)."""
-
-        from lxml import etree  # nosec
+        from lxml import etree  # nosec # pylint: disable=import-outside-toplevel
 
         with self.session.get(
             self.base_url + url,

{c2cwsgiutils-6.1.0.dev105 → c2cwsgiutils-6.1.7.dev4}/c2cwsgiutils/acceptance/image.py

@@ -3,11 +3,11 @@ import os
 import subprocess  # nosec
 from typing import TYPE_CHECKING, Any, Optional
 
-import numpy as np
-import skimage.color
-import skimage.io
-import skimage.metrics
-import skimage.transform
+import numpy as np  # pylint: disable=import-error
+import skimage.color  # pylint: disable=import-error
+import skimage.io  # pylint: disable=import-error
+import skimage.metrics  # pylint: disable=import-error
+import skimage.transform  # pylint: disable=import-error
 
 if TYPE_CHECKING:
     from typing import TypeAlias
@@ -58,7 +58,7 @@ def normalize_image(image: NpNdarrayInt) -> NpNdarrayInt:
     return image
 
 
-def check_image(
+def check_image(  # pylint: disable=too-many-locals,too-many-statements
     result_folder: str,
     image_to_check: NpNdarrayInt,
     expected_filename: str,
@@ -108,6 +108,13 @@ def check_image(
 
     mask = None
     if mask_filename is not None:
+        background_color = [255, 255, 255]
+        for color in range(3):
+            img_hist, _ = skimage.exposure.histogram(
+                image_to_check[..., color], nbins=256, source_range="dtype"
+            )
+            background_color[color] = np.argmax(img_hist)
+
         mask = skimage.io.imread(mask_filename)
 
         assert mask is not None, "Wrong mask: " + mask_filename
@@ -130,7 +137,7 @@ def check_image(
         assert (
             mask.shape[0] == image_to_check.shape[0] and mask.shape[1] == image_to_check.shape[1]
         ), f"Mask and image should have the same shape ({mask.shape} != {image_to_check.shape})"
-        image_to_check[mask] = [255, 255, 255]
+        image_to_check[mask] = background_color
 
     if not os.path.exists(result_folder):
         os.makedirs(result_folder)
@@ -148,7 +155,7 @@ def check_image(
         assert (
             expected.shape[0] == mask.shape[0] and expected.shape[1] == mask.shape[1]
         ), f"Mask and expected image should have the same shape ({mask.shape} != {expected.shape})"
-        expected[mask] = [255, 255, 255]
+        expected[mask] = background_color
 
     assert (
         expected.shape == image_to_check.shape
@@ -175,7 +182,7 @@ def check_screenshot(
     expected_filename: str,
     width: int = 800,
     height: int = 600,
-    sleep: int = 0,
+    sleep: int = 100,
     headers: Optional[dict[str, str]] = None,
     media: Optional[list[dict[str, str]]] = None,
     level: float = 1.0,
@@ -189,7 +196,7 @@ def check_screenshot(
 
     See also `check_image` for the other parameters.
 
-    Args:
+    Arguments:
       url: The URL to screenshot
       width: The width of the generated screenshot
       height: The height of the generated screenshot
@@ -202,7 +209,6 @@ def check_screenshot(
       generate_expected_image: See `check_image`
       use_mask: See `check_image`
     """
-
     if headers is None:
         headers = {}
     if media is None: