c2cgeoportal-geoportal 2.6.0__py2.py3-none-any.whl → 2.8.1.180__py2.py3-none-any.whl

c2cgeoportal_geoportal/lib/functionality.py

@@ -1,5 +1,3 @@
-# -*- coding: utf-8 -*-
-
 # Copyright (c) 2011-2021, Camptocamp SA
 # All rights reserved.
 
@@ -31,6 +29,7 @@
 import logging.config
 from typing import Any, Dict, List, Set, Union, cast
 
+import pyramid.request
 from sqlalchemy.orm import joinedload
 
 from c2cgeoportal_commons.models import main, static
@@ -42,13 +41,13 @@ CACHE_REGION_OBJ = get_region("obj")
 CACHE_REGION = get_region("std")
 
 
-@CACHE_REGION_OBJ.cache_on_arguments()
+@CACHE_REGION_OBJ.cache_on_arguments()  # type: ignore
 def _get_role(name: str) -> Dict[str, Any]:
     from c2cgeoportal_commons.models import DBSession  # pylint: disable=import-outside-toplevel
 
     role = (
-        DBSession.query(static.Role)
-        .filter(static.Role.name == name)
+        DBSession.query(main.Role)
+        .filter(main.Role.name == name)
         .options(joinedload(main.Role.functionalities))
         .one_or_none()
     )
@@ -56,19 +55,23 @@ def _get_role(name: str) -> Dict[str, Any]:
     return {"settings_functionalities": struct, "roles_functionalities": {name: struct}}
 
 
-def _user_to_struct(user):
+def _user_to_struct(user: static.User) -> Dict[str, Any]:
     return {
         "settings_functionalities": _role_to_struct(user.settings_role),
         "roles_functionalities": {role.name: _role_to_struct(role) for role in user.roles},
     }
 
 
-def _role_to_struct(role):
+def _role_to_struct(role: main.Role) -> List[Dict[str, Any]]:
     return [{"name": f.name, "value": f.value} for f in role.functionalities] if role else []
 
 
 def _get_db_functionality(
-    name, user: Dict[str, Any], types, request, errors
+    name: str,
+    user: Dict[str, Any],
+    types: Dict[str, Dict[str, Any]],
+    request: pyramid.request.Request,
+    errors: Set[str],
 ) -> List[Union[str, int, float, bool, List[Any], Dict[str, Any]]]:
     if types.get(name, {}).get("single", False):
         values = [
@@ -91,16 +94,17 @@ def _get_db_functionality(
     return [r for r in values if r is not None]
 
 
-@CACHE_REGION_OBJ.cache_on_arguments()
-def _get_functionalities_type(request):
+@CACHE_REGION_OBJ.cache_on_arguments()  # type: ignore
+def _get_functionalities_type(request: pyramid.request.Request) -> Dict[str, Dict[str, Any]]:
     return get_types_map(
         request.registry.settings.get("admin_interface", {}).get("available_functionalities", [])
     )
 
 
 def get_functionality(
-    name, request, is_intranet_
+    name: str, request: pyramid.request.Request, is_intranet_: bool
 ) -> List[Union[str, int, float, bool, List[Any], Dict[str, Any]]]:
+    """Get all the functionality for the current user."""
     result: List[Union[str, int, float, bool, List[Any], Dict[str, Any]]] = []
     errors: Set[str] = set()
 
@@ -135,12 +139,13 @@ def get_functionality(
             errors,
         )
 
-    if errors != set():  # pragma: no cover
+    if errors != set():
         LOG.error("\n".join(errors))
     return result
 
 
-def get_mapserver_substitution_params(request):
+def get_mapserver_substitution_params(request: pyramid.request.Request) -> Dict[str, str]:
+    """Get the parameters used by the mapserver substitution."""
     params: Dict[str, str] = {}
     mss = get_functionality("mapserver_substitution", request, is_intranet(request))
     if mss:
@@ -149,13 +154,11 @@ def get_mapserver_substitution_params(request):
             index = s.find("=")
             if index > 0:
                 attribute = "s_" + s[:index]
-                # fmt: off
-                value = s[index + 1:]
-                # fmt: on
+                value = s[index + 1 :]
                 if attribute in params:
                     params[attribute] += "," + value
                 else:
                     params[attribute] = value
             else:
-                LOG.warning("Mapserver Substitution '%s' does not " "respect pattern: <attribute>=<value>", s)
+                LOG.warning("Mapserver Substitution '%s' does not respect pattern: <attribute>=<value>", s)
     return params

c2cgeoportal_geoportal/lib/headers.py

@@ -1,6 +1,4 @@
-# -*- coding: utf-8 -*-
-
-# Copyright (c) 2013-2020, Camptocamp SA
+# Copyright (c) 2013-2021, Camptocamp SA
 # All rights reserved.
 
 # Redistribution and use in source and binary forms, with or without
@@ -29,16 +27,27 @@
 
 
 import re
+from typing import Callable
+
+import pyramid.registry
+import pyramid.request
+import pyramid.response
 
 
 class HeadersTween:
-    def __init__(self, handler, registry):
+    """Add the header on all the application."""
+
+    def __init__(
+        self,
+        handler: Callable[[pyramid.request.Request], pyramid.response.Response],
+        registry: pyramid.registry.Registry,
+    ) -> None:
         self.handler = handler
         self.settings = [
             (re.compile(e["pattern"]), e["headers"]) for e in registry.settings["global_headers"]
         ]
 
-    def __call__(self, request):
+    def __call__(self, request: pyramid.request.Request) -> pyramid.response.Response:
         response = self.handler(request)
 
         for pattern, headers in self.settings:

c2cgeoportal_geoportal/lib/i18n.py

@@ -1,6 +1,4 @@
-# -*- coding: utf-8 -*-
-
-# Copyright (c) 2020, Camptocamp SA
+# Copyright (c) 2020-2021, Camptocamp SA
 # All rights reserved.
 
 # Redistribution and use in source and binary forms, with or without
@@ -29,11 +27,13 @@
 
 
 import os
+from typing import List
 
 LOCALE_PATH = "/etc/geomapfish/locale/"
 
 
-def available_locale_names(path=LOCALE_PATH):
+def available_locale_names(path: str = LOCALE_PATH) -> List[str]:
+    """Get the available locales."""
     if not os.path.exists(path):
         return []
     return [d for d in os.listdir(path) if os.path.isdir(os.path.join(path, d))]

c2cgeoportal_geoportal/lib/layers.py

@@ -1,6 +1,4 @@
-# -*- coding: utf-8 -*-
-
-# Copyright (c) 2018-2020, Camptocamp SA
+# Copyright (c) 2018-2021, Camptocamp SA
 # All rights reserved.
 
 # Redistribution and use in source and binary forms, with or without
@@ -28,25 +26,38 @@
 # either expressed or implied, of the FreeBSD Project.
 
 
+from typing import Any, Dict, Iterable, Optional
+
 from pyramid.request import Request
+from sqlalchemy.ext.declarative import DeclarativeMeta
+from sqlalchemy.orm.query import Query
 
 from c2cgeoportal_geoportal.lib import caching, get_roles_id
 
 CACHE_REGION = caching.get_region("std")
 
 
-def _get_layers_query(request: Request, what):
+def _get_layers_query(request: Request, what: DeclarativeMeta) -> Query:
     from c2cgeoportal_commons.models import DBSession, main  # pylint: disable=import-outside-toplevel
 
     q = DBSession.query(what)
-    q = q.join(main.Layer.restrictionareas)  # pylint: disable=no-member
+    q = q.join(main.Layer.restrictionareas)
     q = q.join(main.RestrictionArea.roles)
     q = q.filter(main.Role.id.in_(get_roles_id(request)))
 
     return q
 
 
-def get_protected_layers_query(request: Request, ogc_server_ids, what=None):
+def get_protected_layers_query(
+    request: Request,
+    ogc_server_ids: Optional[Iterable[int]],
+    what: DeclarativeMeta = None,
+) -> Query:
+    """
+    Get the protected layers query.
+
+    Private layers but accessible to the user.
+    """
     from c2cgeoportal_commons.models import main  # pylint: disable=import-outside-toplevel
 
     q = _get_layers_query(request, what)
@@ -57,7 +68,8 @@ def get_protected_layers_query(request: Request, ogc_server_ids, what=None):
     return q
 
 
-def get_writable_layers_query(request: Request, ogc_server_ids):
+def get_writable_layers_query(request: Request, ogc_server_ids: Iterable[int]) -> Query:
+    """Get the writable layers query."""
     from c2cgeoportal_commons.models import main  # pylint: disable=import-outside-toplevel
 
     q = _get_layers_query(request, main.LayerWMS)
@@ -68,7 +80,12 @@ def get_writable_layers_query(request: Request, ogc_server_ids):
     )
 
 
-def get_protected_layers(request: Request, ogc_server_ids):
+def get_protected_layers(request: Request, ogc_server_ids: Iterable[int]) -> Dict[int, DeclarativeMeta]:
+    """
+    Get the protected layers.
+
+    Private layers but accessible to the user.
+    """
     from c2cgeoportal_commons.models import DBSession, main  # pylint: disable=import-outside-toplevel
 
     q = get_protected_layers_query(request, ogc_server_ids, what=main.LayerWMS)
@@ -77,7 +94,8 @@ def get_protected_layers(request: Request, ogc_server_ids):
     return {r.id: r for r in results}
 
 
-def get_writable_layers(request: Request, ogc_server_ids):
+def get_writable_layers(request: Request, ogc_server_ids: Iterable[int]) -> Dict[int, DeclarativeMeta]:
+    """Get the writable layers."""
     from c2cgeoportal_commons.models import DBSession  # pylint: disable=import-outside-toplevel
 
     q = get_writable_layers_query(request, ogc_server_ids)
@@ -86,8 +104,9 @@ def get_writable_layers(request: Request, ogc_server_ids):
     return {r.id: r for r in results}
 
 
-@CACHE_REGION.cache_on_arguments()
-def get_private_layers(ogc_server_ids):
+@CACHE_REGION.cache_on_arguments()  # type: ignore
+def get_private_layers(ogc_server_ids: Iterable[int]) -> Dict[int, Any]:
+    """Get the private layers."""
     from c2cgeoportal_commons.models import DBSession, main  # pylint: disable=import-outside-toplevel
 
     q = (