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

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 = (