Merge pull request #11327 from camptocamp/use-private-variables

Make logger and cache region private

admin/c2cgeoportal_admin/schemas/treegroup.py

@@ -42,7 +42,7 @@
 from c2cgeoportal_commons.lib.literal import Literal
 from c2cgeoportal_commons.models.main import LayergroupTreeitem, TreeGroup, TreeItem
 
-LOG = logging.getLogger(__name__)
+_LOG = logging.getLogger(__name__)
 
 # Correspondence between TreeItem.item_type and route table segment
 ITEM_TYPE_ROUTE_MAP = {
@@ -149,7 +149,7 @@ def treeitem_edit_url(request: pyramid.request.Request, treeitem: TreeGroup) ->
         return None
     table = ITEM_TYPE_ROUTE_MAP.get(treeitem.item_type, None)
     if table is None:
-        LOG.warning("%s not found in ITEM_TYPE_ROUTE_MAP", treeitem.item_type)
+        _LOG.warning("%s not found in ITEM_TYPE_ROUTE_MAP", treeitem.item_type)
         return None
     return request.route_url(  # type: ignore
         "c2cgeoform_item",

admin/c2cgeoportal_admin/views/ogc_servers.py

@@ -62,7 +62,7 @@
 base_schema = GeoFormSchemaNode(OGCServer, widget=FormWidget(fields_template="ogcserver_fields"))
 base_schema.add_unique_validator(OGCServer.name, OGCServer.id)
 
-LOG = logging.getLogger(__name__)
+_LOG = logging.getLogger(__name__)
 
 
 @view_defaults(match_param="table=ogc_servers")
@@ -252,8 +252,8 @@ def update_cache() -> None:
                     timeout=60,
                 )
                 if not response.ok:
-                    LOG.error("Error while cleaning the OGC server cache:\n%s", response.text)
+                    _LOG.error("Error while cleaning the OGC server cache:\n%s", response.text)
 
             threading.Thread(target=update_cache).start()
         except Exception:
-            LOG.error("Error on cleaning the OGC server cache", exc_info=True)
+            _LOG.error("Error on cleaning the OGC server cache", exc_info=True)

commons/c2cgeoportal_commons/alembic/env.py

@@ -37,7 +37,7 @@
 from plaster.loaders import setup_logging
 from sqlalchemy import engine_from_config, pool
 
-LOG = logging.getLogger(__name__)
+_LOG = logging.getLogger(__name__)
 
 
 # Interpret the config file for Python logging.

commons/c2cgeoportal_commons/lib/email_.py

@@ -1,4 +1,4 @@
-# Copyright (c) 2013-2023, Camptocamp SA
+# Copyright (c) 2013-2024, Camptocamp SA
 # All rights reserved.
 
 # Redistribution and use in source and binary forms, with or without
@@ -42,7 +42,7 @@ class HTTPInternalServerError(BaseException):  # type: ignore
         """Fallback class."""
 
 
-LOG = logging.getLogger(__name__)
+_LOG = logging.getLogger(__name__)
 
 
 def send_email_config(settings: dict[str, Any], email_config_name: str, email: str, **kwargs: Any) -> None:
@@ -59,7 +59,7 @@ def send_email_config(settings: dict[str, Any], email_config_name: str, email: s
             smtp_config,
         )
     except gaierror:
-        LOG.exception("Unable to send the email.")
+        _LOG.exception("Unable to send the email.")
         raise HTTPInternalServerError("See server logs for details")  # pylint: disable=raise-missing-from
 
 

commons/c2cgeoportal_commons/lib/url.py

@@ -1,4 +1,4 @@
-# Copyright (c) 2013-2023, Camptocamp SA
+# Copyright (c) 2013-2024, Camptocamp SA
 # All rights reserved.
 
 # Redistribution and use in source and binary forms, with or without
@@ -32,7 +32,7 @@
 
 from pyramid.request import Request
 
-LOG = logging.getLogger(__name__)
+_LOG = logging.getLogger(__name__)
 
 
 class Url:
@@ -55,7 +55,7 @@ def __init__(self, url: Optional[str] = None):
             try:
                 self._port = url_split.port
             except ValueError as error:
-                LOG.debug(error)
+                _LOG.debug(error)
             self.path = url_split.path
             self.query = dict(urllib.parse.parse_qsl(url_split.query))
             self.fragment = url_split.fragment
@@ -94,7 +94,7 @@ def netloc(self, netloc: str) -> None:
         if len(netloc_split) == 2:
             allowed = re.compile(r"^[0-9]+$")
             if not allowed.match(netloc_split[1]):
-                LOG.debug("The netloc '%s' contains invalid port", netloc)
+                _LOG.debug("The netloc '%s' contains invalid port", netloc)
                 self._port = None
             else:
                 self._port = int(netloc_split[1])

commons/c2cgeoportal_commons/models/__init__.py

@@ -57,7 +57,7 @@ class BaseType(sqlalchemy.ext.declarative.DeclarativeMeta, type):
 DBSessions: dict[str, sqlalchemy.orm.scoping.scoped_session[sqlalchemy.orm.Session]] = {}
 
 
-LOG = logging.getLogger(__name__)
+_LOG = logging.getLogger(__name__)
 
 
 class InvalidateCacheEvent:
@@ -77,4 +77,4 @@ def _cache_invalidate_cb() -> None:
         zope.event.notify(InvalidateCacheEvent())
 
 except ModuleNotFoundError:
-    LOG.error("c2cwsgiutils broadcast not found")
+    _LOG.error("c2cwsgiutils broadcast not found")

commons/c2cgeoportal_commons/models/main.py

@@ -91,7 +91,7 @@ def state_str(state: Any) -> str:
     # information
     sqlalchemy.orm.base.state_str = state_str
 
-LOG = logging.getLogger(__name__)
+_LOG = logging.getLogger(__name__)
 
 _schema: str = config["schema"] or "main"
 _srid: int = cast(int, config["srid"]) or 3857

commons/c2cgeoportal_commons/models/static.py

@@ -66,7 +66,7 @@ def __init__(self, *args: Any, **kwargs: Any):
     RelationSelect2Widget = GenericClass  # type: ignore[misc,assignment]
 
 
-LOG = logging.getLogger(__name__)
+_LOG = logging.getLogger(__name__)
 
 _schema: str = config["schema_static"] or "static"
 

docker/qgisserver/geomapfish_qgisserver/__init__.py

@@ -15,7 +15,7 @@
 
 from . import gmf_logging
 
-LOG = logging.getLogger(__name__)
+_LOG = logging.getLogger(__name__)
 
 
 def serverClassFactory(  # pylint: disable=invalid-name
@@ -32,12 +32,12 @@ def serverClassFactory(  # pylint: disable=invalid-name
             level=Qgis.Critical,
         )
 
-    LOG.info("Starting GeoMapFish access restriction...")
+    _LOG.info("Starting GeoMapFish access restriction...")
 
     try:
         from .accesscontrol import GeoMapFishAccessControl  # pylint: disable=import-outside-toplevel
 
         return GeoMapFishAccessControl(serverIface)
     except Exception:  # pylint: disable=broad-exception-caught
-        LOG.error("Cannot setup GeoMapFishAccessControl", exc_info=True)
+        _LOG.error("Cannot setup GeoMapFishAccessControl", exc_info=True)
         return None