c2cwsgiutils 6.2.0.dev35__tar.gz → 6.2.0.dev39__tar.gz

{c2cwsgiutils-6.2.0.dev35 → c2cwsgiutils-6.2.0.dev39}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: c2cwsgiutils
-Version: 6.2.0.dev35
+Version: 6.2.0.dev39
 Summary: Common utilities for Camptocamp WSGI applications
 Home-page: https://github.com/camptocamp/c2cwsgiutils
 License: BSD-2-Clause
@@ -33,23 +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: 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 == "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
@@ -57,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
 
@@ -673,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.2.0.dev35 → c2cwsgiutils-6.2.0.dev39}/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.dev35 → c2cwsgiutils-6.2.0.dev39}/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.2.0.dev35 → c2cwsgiutils-6.2.0.dev39}/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.2.0.dev35 → c2cwsgiutils-6.2.0.dev39}/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(
       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]
@@ -122,7 +123,7 @@ def check_image(
         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
@@ -139,7 +140,7 @@ def check_image(
         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)
@@ -201,6 +202,7 @@ def check_screenshot(
       level: See `check_image`
       generate_expected_image: See `check_image`
       use_mask: See `check_image`
+
     """
     if headers is None:
         headers = {}

{c2cwsgiutils-6.2.0.dev35 → c2cwsgiutils-6.2.0.dev39}/c2cwsgiutils/acceptance/package-lock.json

@@ -6,7 +6,7 @@
     "": {
       "dependencies": {
         "commander": "12.1.0",
-        "puppeteer": "23.7.1"
+        "puppeteer": "23.9.0"
       }
     },
     "node_modules/@babel/code-frame": {
@@ -379,9 +379,9 @@
       }
     },
     "node_modules/devtools-protocol": {
-      "version": "0.0.1354347",
-      "resolved": "https://registry.npmjs.org/devtools-protocol/-/devtools-protocol-0.0.1354347.tgz",
-      "integrity": "sha512-BlmkSqV0V84E2WnEnoPnwyix57rQxAM5SKJjf4TbYOCGLAWtz8CDH8RIaGOjPgPCXo2Mce3kxSY497OySidY3Q==",
+      "version": "0.0.1367902",
+      "resolved": "https://registry.npmjs.org/devtools-protocol/-/devtools-protocol-0.0.1367902.tgz",
+      "integrity": "sha512-XxtPuC3PGakY6PD7dG66/o8KwJ/LkH2/EKe19Dcw58w53dv4/vSQEkn/SzuyhHE2q4zPgCkxQBxus3VV4ql+Pg==",
       "license": "BSD-3-Clause"
     },
     "node_modules/emoji-regex": {
@@ -868,17 +868,17 @@
       }
     },
     "node_modules/puppeteer": {
-      "version": "23.7.1",
-      "resolved": "https://registry.npmjs.org/puppeteer/-/puppeteer-23.7.1.tgz",
-      "integrity": "sha512-jS6XehagMvxQ12etwY/4EOYZ0Sm8GAsrtGhdQn4AqpJAyHc3RYl7tGd4QYh/MmShDw8sF9FWYQqGidhoXaqokQ==",
+      "version": "23.9.0",
+      "resolved": "https://registry.npmjs.org/puppeteer/-/puppeteer-23.9.0.tgz",
+      "integrity": "sha512-WfB8jGwFV+qrD9dcJJVvWPFJBU6kxeu2wxJz9WooDGfM3vIiKLgzImEDBxUQnCBK/2cXB3d4dV6gs/LLpgfLDg==",
       "hasInstallScript": true,
       "license": "Apache-2.0",
       "dependencies": {
         "@puppeteer/browsers": "2.4.1",
         "chromium-bidi": "0.8.0",
         "cosmiconfig": "^9.0.0",
-        "devtools-protocol": "0.0.1354347",
-        "puppeteer-core": "23.7.1",
+        "devtools-protocol": "0.0.1367902",
+        "puppeteer-core": "23.9.0",
         "typed-query-selector": "^2.12.0"
       },
       "bin": {
@@ -889,15 +889,15 @@
       }
     },
     "node_modules/puppeteer-core": {
-      "version": "23.7.1",
-      "resolved": "https://registry.npmjs.org/puppeteer-core/-/puppeteer-core-23.7.1.tgz",
-      "integrity": "sha512-Om/qCZhd+HLoAr7GltrRAZpS3uOXwHu7tXAoDbNcJADHjG2zeAlDArgyIPXYGG4QB/EQUHk13Q6RklNxGM73Pg==",
+      "version": "23.9.0",
+      "resolved": "https://registry.npmjs.org/puppeteer-core/-/puppeteer-core-23.9.0.tgz",
+      "integrity": "sha512-hLVrav2HYMVdK0YILtfJwtnkBAwNOztUdR4aJ5YKDvgsbtagNr6urUJk9HyjRA9e+PaLI3jzJ0wM7A4jSZ7Qxw==",
       "license": "Apache-2.0",
       "dependencies": {
         "@puppeteer/browsers": "2.4.1",
         "chromium-bidi": "0.8.0",
         "debug": "^4.3.7",
-        "devtools-protocol": "0.0.1354347",
+        "devtools-protocol": "0.0.1367902",
         "typed-query-selector": "^2.12.0",
         "ws": "^8.18.0"
       },

{c2cwsgiutils-6.2.0.dev35 → c2cwsgiutils-6.2.0.dev39}/c2cwsgiutils/acceptance/package.json

@@ -1,7 +1,7 @@
 {
   "dependencies": {
     "commander": "12.1.0",
-    "puppeteer": "23.7.1"
+    "puppeteer": "23.9.0"
   },
   "type": "module"
 }

{c2cwsgiutils-6.2.0.dev35 → c2cwsgiutils-6.2.0.dev39}/c2cwsgiutils/acceptance/print.py

@@ -21,6 +21,7 @@ class PrintConnection(connection.Connection):
             base_url: The base URL to the print server (including the /print)
             app: The name of the application to use
             origin: The origin and referrer to include in the requests
+
         """
         super().__init__(base_url=base_url, origin=origin)
         self.session.headers["Referrer"] = origin

{c2cwsgiutils-6.2.0.dev35 → c2cwsgiutils-6.2.0.dev39}/c2cwsgiutils/acceptance/utils.py

@@ -32,6 +32,7 @@ def retry_timeout(what: Callable[[], Any], timeout: float = _DEFAULT_TIMEOUT, in
         what: the function to try
         timeout: the timeout to get a success
         interval: the interval between try
+
     """
     timeout = time.perf_counter() + timeout
     while True:
@@ -46,7 +47,7 @@ def retry_timeout(what: Callable[[], Any], timeout: float = _DEFAULT_TIMEOUT, in
             error = str(e)
             _LOG.info("  Failed: %s", e)
         if time.perf_counter() > timeout:
-            assert False, "Timeout: " + error
+            raise AssertionError("Timeout: " + error)
         time.sleep(interval)
 
 

{c2cwsgiutils-6.2.0.dev35 → c2cwsgiutils-6.2.0.dev39}/c2cwsgiutils/auth.py

@@ -12,32 +12,32 @@ from requests_oauthlib import OAuth2Session
 from c2cwsgiutils.config_utils import config_bool, env_or_config, env_or_settings
 
 _COOKIE_AGE = 7 * 24 * 3600
-SECRET_PROP = "c2c.secret"  # nosec  # noqa
-SECRET_ENV = "C2C_SECRET"  # nosec  # noqa
+SECRET_PROP = "c2c.secret"  # noqa: S105
+SECRET_ENV = "C2C_SECRET"  # noqa: S105
 _GITHUB_REPOSITORY_PROP = "c2c.auth.github.repository"
 _GITHUB_REPOSITORY_ENV = "C2C_AUTH_GITHUB_REPOSITORY"
 _GITHUB_ACCESS_TYPE_PROP = "c2c.auth.github.access_type"
 _GITHUB_ACCESS_TYPE_ENV = "C2C_AUTH_GITHUB_ACCESS_TYPE"
 GITHUB_AUTH_URL_PROP = "c2c.auth.github.auth_url"
 GITHUB_AUTH_URL_ENV = "C2C_AUTH_GITHUB_AUTH_URL"
-GITHUB_TOKEN_URL_PROP = "c2c.auth.github.token_url"  # nosec
-GITHUB_TOKEN_URL_ENV = "C2C_AUTH_GITHUB_TOKEN_URL"  # nosec
+GITHUB_TOKEN_URL_PROP = "c2c.auth.github.token_url"  # noqa: S105
+GITHUB_TOKEN_URL_ENV = "C2C_AUTH_GITHUB_TOKEN_URL"  # noqa: S105
 GITHUB_USER_URL_PROP = "c2c.auth.github.user_url"
 GITHUB_USER_URL_ENV = "C2C_AUTH_GITHUB_USER_URL"
 _GITHUB_REPO_URL_PROP = "c2c.auth.github.repo_url"
 _GITHUB_REPO_URL_ENV = "C2C_AUTH_GITHUB_REPO_URL"
 GITHUB_CLIENT_ID_PROP = "c2c.auth.github.client_id"
 GITHUB_CLIENT_ID_ENV = "C2C_AUTH_GITHUB_CLIENT_ID"
-GITHUB_CLIENT_SECRET_PROP = "c2c.auth.github.client_secret"  # nosec # noqa
-GITHUB_CLIENT_SECRET_ENV = "C2C_AUTH_GITHUB_CLIENT_SECRET"  # nosec # noqa
+GITHUB_CLIENT_SECRET_PROP = "c2c.auth.github.client_secret"  # noqa: S105
+GITHUB_CLIENT_SECRET_ENV = "C2C_AUTH_GITHUB_CLIENT_SECRET"  # noqa: S105
 GITHUB_SCOPE_PROP = "c2c.auth.github.scope"
 GITHUB_SCOPE_ENV = "C2C_AUTH_GITHUB_SCOPE"
 # To be able to use private repository
 GITHUB_SCOPE_DEFAULT = "repo"
 GITHUB_AUTH_COOKIE_PROP = "c2c.auth.github.auth.cookie"
 GITHUB_AUTH_COOKIE_ENV = "C2C_AUTH_GITHUB_COOKIE"
-GITHUB_AUTH_SECRET_PROP = "c2c.auth.github.auth.secret"  # nosec # noqa
-GITHUB_AUTH_SECRET_ENV = "C2C_AUTH_GITHUB_SECRET"  # nosec # noqa
+GITHUB_AUTH_SECRET_PROP = "c2c.auth.github.auth.secret"  # noqa: S105
+GITHUB_AUTH_SECRET_ENV = "C2C_AUTH_GITHUB_SECRET"  # noqa: S105
 GITHUB_AUTH_PROXY_URL_PROP = "c2c.auth.github.auth.proxy_url"
 GITHUB_AUTH_PROXY_URL_ENV = "C2C_AUTH_GITHUB_PROXY_URL"
 USE_SESSION_PROP = "c2c.use_session"
@@ -209,6 +209,7 @@ def check_access(
         request: is the request object.
         repo: is the repository to check access to (<organization>/<repository>).
         access_type: is the type of access to check (admin|push|pull).
+
     """
     if not is_auth(request):
         return False

{c2cwsgiutils-6.2.0.dev35 → c2cwsgiutils-6.2.0.dev39}/c2cwsgiutils/broadcast/__init__.py

@@ -19,7 +19,7 @@ _broadcaster: Optional[interface.BaseBroadcaster] = None
 
 def init(config: Optional[pyramid.config.Configurator] = None) -> None:
     """Initialize the broadcaster with Redis, if configured, for backward compatibility."""
-    warnings.warn("init function is deprecated; use includeme instead")
+    warnings.warn("init function is deprecated; use includeme instead", stacklevel=2)
     includeme(config)
 
 

{c2cwsgiutils-6.2.0.dev35 → c2cwsgiutils-6.2.0.dev39}/c2cwsgiutils/broadcast/local.py

@@ -9,17 +9,21 @@ class LocalBroadcaster(interface.BaseBroadcaster):
     """Fake implementation of broadcasting messages (will just answer locally)."""
 
     def __init__(self) -> None:
+        """Initialize the broadcaster."""
         self._subscribers: MutableMapping[str, Callable[..., Any]] = {}
 
     def subscribe(self, channel: str, callback: Callable[..., Any]) -> None:
+        """Subscribe to a channel."""
         self._subscribers[channel] = callback
 
     def unsubscribe(self, channel: str) -> None:
+        """Unsubscribe from a channel."""
         del self._subscribers[channel]
 
     def broadcast(
         self, channel: str, params: Mapping[str, Any], expect_answers: bool, timeout: float
     ) -> Optional[list[Any]]:
+        """Broadcast a message to all the listeners."""
         subscriber = self._subscribers.get(channel, None)
         answers = [utils.add_host_info(subscriber(**params))] if subscriber is not None else []
         return answers if expect_answers else None

{c2cwsgiutils-6.2.0.dev35 → c2cwsgiutils-6.2.0.dev39}/c2cwsgiutils/broadcast/redis.py

@@ -23,6 +23,7 @@ class RedisBroadcaster(interface.BaseBroadcaster):
         master: "redis.client.Redis[str]",
         slave: "redis.client.Redis[str]",
     ) -> None:
+        """Initialize the broadcaster."""
         from c2cwsgiutils import redis_utils  # pylint: disable=import-outside-toplevel
 
         self._master = master
@@ -40,6 +41,8 @@ class RedisBroadcaster(interface.BaseBroadcaster):
         return self._broadcast_prefix + channel
 
     def subscribe(self, channel: str, callback: Callable[..., Any]) -> None:
+        """Subscribe to a channel."""
+
         def wrapper(message: Mapping[str, Any]) -> None:
             _LOG.debug("Received a broadcast on %s: %s", message["channel"], repr(message["data"]))
             data = json.loads(message["data"])
@@ -58,6 +61,7 @@ class RedisBroadcaster(interface.BaseBroadcaster):
         self._pub_sub.subscribe(**{actual_channel: wrapper})
 
     def unsubscribe(self, channel: str) -> None:
+        """Unsubscribe from a channel."""
         _LOG.debug("Unsubscribing from %s")
         actual_channel = self._get_channel(channel)
         self._pub_sub.unsubscribe(actual_channel)
@@ -65,6 +69,7 @@ class RedisBroadcaster(interface.BaseBroadcaster):
     def broadcast(
         self, channel: str, params: Mapping[str, Any], expect_answers: bool, timeout: float
     ) -> Optional[list[Any]]:
+        """Broadcast a message to all the listeners."""
         if expect_answers:
             return self._broadcast_with_answer(channel, params, timeout)
         else:
@@ -85,7 +90,8 @@ class RedisBroadcaster(interface.BaseBroadcaster):
                 cond.notify()
 
         answer_channel = self._get_channel(channel) + "".join(
-            random.choice(string.ascii_uppercase + string.digits) for _ in range(10)  # nosec
+            random.choice(string.ascii_uppercase + string.digits)  # noqa: S311
+            for _ in range(10)
         )
         _LOG.debug("Subscribing for broadcast answers on %s", answer_channel)
         self._pub_sub.subscribe(**{answer_channel: callback})
@@ -98,7 +104,7 @@ class RedisBroadcaster(interface.BaseBroadcaster):
             with cond:
                 while len(answers) < nb_received:
                     to_wait = timeout_time - time.perf_counter()
-                    if to_wait <= 0.0:  # pragma: no cover
+                    if to_wait <= 0.0:
                         _LOG.warning(
                             "timeout waiting for %d/%d answers on %s",
                             len(answers),

{c2cwsgiutils-6.2.0.dev35 → c2cwsgiutils-6.2.0.dev39}/c2cwsgiutils/client_info.py

@@ -16,9 +16,11 @@ class Filter:
     """
 
     def __init__(self, application: Callable[[dict[str, str], Any], Any]):
+        """Initialize the filter."""
         self._application = application
 
     def __call__(self, environ: dict[str, str], start_response: Any) -> Any:
+        """Update the environ with the headers."""
         # https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Forwarded
         if "HTTP_FORWARDED" in environ:
             _handle_forwarded(environ)

{c2cwsgiutils-6.2.0.dev35 → c2cwsgiutils-6.2.0.dev39}/c2cwsgiutils/coverage_setup.py

@@ -10,7 +10,7 @@ _LOG = logging.getLogger(__name__)
 
 def init() -> None:
     """Initialize the code coverage, for backward compatibility."""
-    warnings.warn("init function is deprecated; use includeme instead")
+    warnings.warn("init function is deprecated; use includeme instead", stacklevel=2)
     includeme()
 
 
@@ -22,7 +22,7 @@ def includeme(config: Optional[pyramid.config.Configurator] = None) -> None:
     import coverage  # pylint: disable=import-outside-toplevel
 
     _LOG.warning("Setting up code coverage")
-    report_dir = "/tmp/coverage/api"  # nosec
+    report_dir = "/tmp/coverage/api"  # noqa: S108
     os.makedirs(report_dir, exist_ok=True)
     cov = coverage.Coverage(
         data_file=os.path.join(report_dir, "coverage"),

{c2cwsgiutils-6.2.0.dev35 → c2cwsgiutils-6.2.0.dev39}/c2cwsgiutils/db.py

@@ -66,8 +66,11 @@ def setup_session(
         force_slave: The method/paths that needs to use the slave
 
     Returns: The SQLAlchemy session, the R/W engine and the R/O engine
+
     """
-    warnings.warn("setup_session function is deprecated; use init and request.dbsession instead")
+    warnings.warn(
+        "setup_session function is deprecated; use init and request.dbsession instead", stacklevel=2
+    )
     if slave_prefix is None:
         slave_prefix = master_prefix
     settings = config.registry.settings
@@ -122,8 +125,11 @@ def create_session(
         engine_config: The rest of the parameters are passed as is to the sqlalchemy.create_engine function
 
     Returns: The SQLAlchemy session
+
     """
-    warnings.warn("create_session function is deprecated; use init and request.dbsession instead")
+    warnings.warn(
+        "create_session function is deprecated; use init and request.dbsession instead", stacklevel=2
+    )
     if slave_url is None:
         slave_url = url
 
@@ -215,6 +221,7 @@ class SessionFactory(_sessionmaker):
         ro_engine: sqlalchemy.engine.Engine,
         rw_engine: sqlalchemy.engine.Engine,
     ):
+        """Initialize the session factory."""
         super().__init__()
         self.master_paths: Iterable[Pattern[str]] = (
             list(map(_RE_COMPILE, force_master)) if force_master else []
@@ -232,6 +239,7 @@ class SessionFactory(_sessionmaker):
     def __call__(  # type: ignore
         self, request: Optional[pyramid.request.Request], readwrite: Optional[bool] = None, **local_kw: Any
     ) -> _scoped_session:
+        """Set the engine based on the request."""
         if readwrite is not None:
             if readwrite and not FORCE_READONLY:
                 _LOG.debug("Using %s database", self.rw_engine.c2c_name)  # type: ignore
@@ -374,6 +382,7 @@ def init(
         force_slave: The method/paths that needs to use the slave
 
     Returns: The SQLAlchemy session
+
     """
     settings = config.get_settings()
     settings["tm.manager_hook"] = "pyramid_tm.explicit_manager"

{c2cwsgiutils-6.2.0.dev35 → c2cwsgiutils-6.2.0.dev39}/c2cwsgiutils/db_maintenance_view.py

@@ -15,7 +15,7 @@ _REDIS_PREFIX = "c2c_db_maintenance_"
 
 def install_subscriber(config: pyramid.config.Configurator) -> None:
     """Install the view to configure the loggers, if configured to do so, for backward compatibility."""
-    warnings.warn("install_subscriber function is deprecated; use includeme instead")
+    warnings.warn("install_subscriber function is deprecated; use includeme instead", stacklevel=2)
     includeme(config)
 
 

{c2cwsgiutils-6.2.0.dev35 → c2cwsgiutils-6.2.0.dev39}/c2cwsgiutils/debug/__init__.py

@@ -16,7 +16,7 @@ dump_memory_maps = utils.dump_memory_maps
 
 def init(config: pyramid.config.Configurator) -> None:
     """Initialize the debug tools, for backward compatibility."""
-    warnings.warn("init function is deprecated; use includeme instead")
+    warnings.warn("init function is deprecated; use includeme instead", stacklevel=2)
     includeme(config)
 
 
@@ -37,6 +37,8 @@ def init_daemon(config: Optional[pyramid.config.Configurator] = None) -> None:
     those requests.
     """
     if config_utils.env_or_config(config, ENV_KEY, CONFIG_KEY, type_=config_utils.config_bool):
-        from c2cwsgiutils.debug import _listeners  # pylint: disable=import-outside-toplevel
+        from c2cwsgiutils.debug import (  # pylint: disable=import-outside-toplevel
+            _listeners,
+        )
 
         _listeners.init()

{c2cwsgiutils-6.2.0.dev35 → c2cwsgiutils-6.2.0.dev39}/c2cwsgiutils/debug/_views.py

@@ -79,7 +79,7 @@ def _dump_memory_diff(request: pyramid.request.Request) -> list[Any]:
     try:
         if request.params.get("no_warmup", "0").lower() in ("1", "true", "on"):
             request.invoke_subrequest(sub_request)
-    except Exception:  # nosec  # pylint: disable=broad-except
+    except Exception:  # pylint: disable=broad-except
         pass
 
     _LOG.debug("checking memory growth for %s", path)
@@ -151,8 +151,7 @@ def _headers(request: pyramid.request.Request) -> Mapping[str, Any]:
     }
     if "status" in request.params:
         raise exception_response(int(request.params["status"]), detail=result)
-    else:
-        return result
+    return result
 
 
 def _error(request: pyramid.request.Request) -> Any:

{c2cwsgiutils-6.2.0.dev35 → c2cwsgiutils-6.2.0.dev39}/c2cwsgiutils/errors.py

@@ -9,7 +9,12 @@ from typing import Any, Callable
 import pyramid.request
 import sqlalchemy.exc
 from cornice import cors
-from pyramid.httpexceptions import HTTPError, HTTPException, HTTPRedirection, HTTPSuccessful
+from pyramid.httpexceptions import (
+    HTTPError,
+    HTTPException,
+    HTTPRedirection,
+    HTTPSuccessful,
+)
 from webob.request import DisconnectionError
 
 from c2cwsgiutils import auth, config_utils
@@ -152,7 +157,7 @@ def _passthrough(exception: HTTPException, request: pyramid.request.Request) ->
 
 def init(config: pyramid.config.Configurator) -> None:
     """Initialize the error views, for backward compatibility."""
-    warnings.warn("init function is deprecated; use includeme instead")
+    warnings.warn("init function is deprecated; use includeme instead", stacklevel=2)
     includeme(config)