c2cgeoportal-admin 2.8.1.181__py3-none-any.whl → 2.9rc2__py3-none-any.whl

c2cgeoportal_admin/views/ogc_servers.py

@@ -1,4 +1,4 @@
-# Copyright (c) 2017-2023, Camptocamp SA
+# Copyright (c) 2017-2024, Camptocamp SA
 # All rights reserved.
 
 # Redistribution and use in source and binary forms, with or without
@@ -29,11 +29,22 @@
 import logging
 import threading
 from functools import partial
-from typing import Any, Dict, List, Union, cast
+from typing import Any, cast
 
 import requests
+from c2cgeoform import JSONDict
 from c2cgeoform.schema import GeoFormSchemaNode
-from c2cgeoform.views.abstract_views import AbstractViews, ItemAction, ListField, UserMessage
+from c2cgeoform.views.abstract_views import (
+    AbstractViews,
+    DeleteResponse,
+    GridResponse,
+    IndexResponse,
+    ItemAction,
+    ListField,
+    ObjectResponse,
+    SaveResponse,
+    UserMessage,
+)
 from deform.widget import FormWidget
 from pyramid.httpexceptions import HTTPFound
 from pyramid.view import view_config, view_defaults
@@ -51,11 +62,11 @@ _list_field = partial(ListField, OGCServer)
 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")
-class OGCServerViews(LoggedViews):
+class OGCServerViews(LoggedViews[OGCServer]):
     """The OGC server administration view."""
 
     _list_fields = [
@@ -82,18 +93,18 @@ class OGCServerViews(LoggedViews):
         ),
     }
 
-    @view_config(route_name="c2cgeoform_index", renderer="../templates/index.jinja2")  # type: ignore
-    def index(self) -> Dict[str, Any]:
-        return super().index()  # type: ignore
+    @view_config(route_name="c2cgeoform_index", renderer="../templates/index.jinja2")  # type: ignore[misc]
+    def index(self) -> IndexResponse:
+        return super().index()
 
-    @view_config(route_name="c2cgeoform_grid", renderer="fast_json")  # type: ignore
-    def grid(self) -> Dict[str, Any]:
-        return super().grid()  # type: ignore
+    @view_config(route_name="c2cgeoform_grid", renderer="fast_json")  # type: ignore[misc]
+    def grid(self) -> GridResponse:
+        return super().grid()
 
     def schema(self) -> GeoFormSchemaNode:
         obj = self._get_object()
 
-        schema = self._base_schema.clone()
+        schema = cast(GeoFormSchemaNode, self._base_schema.clone())
         schema["url"].description = Literal(
             _("{}<br>Current runtime value is: {}").format(
                 schema["url"].description,
@@ -108,9 +119,9 @@ class OGCServerViews(LoggedViews):
         )
         return schema
 
-    def _item_actions(self, item: OGCServer, readonly: bool = False) -> List[Any]:
-        actions = cast(List[Any], super()._item_actions(item, readonly))
-        if inspect(item).persistent:
+    def _item_actions(self, item: OGCServer, readonly: bool = False) -> list[Any]:
+        actions = cast(list[Any], super()._item_actions(item, readonly))
+        if inspect(item).persistent:  # type: ignore[attr-defined]
             actions.insert(
                 next((i for i, v in enumerate(actions) if v.name() == "delete")),
                 ItemAction(
@@ -138,23 +149,24 @@ class OGCServerViews(LoggedViews):
             )
         return actions
 
-    @view_config(  # type: ignore
+    @view_config(  # type: ignore[misc]
         route_name="c2cgeoform_item", request_method="GET", renderer="../templates/edit.jinja2"
     )
-    def view(self) -> Dict[str, Any]:
-        return super().edit(self.schema())  # type: ignore
+    def view(self) -> ObjectResponse:
+        return super().edit(self.schema())
 
-    @view_config(  # type: ignore
+    @view_config(  # type: ignore[misc]
         route_name="c2cgeoform_item", request_method="POST", renderer="../templates/edit.jinja2"
     )
-    def save(self) -> Union[HTTPFound, Dict[str, Any]]:
-        result: Union[HTTPFound, Dict[str, Any]] = super().save()
+    def save(self) -> SaveResponse:
+        result = super().save()
         if isinstance(result, HTTPFound):
+            assert self._obj is not None
             self._update_cache(self._obj)
         return result
 
-    @view_config(route_name="c2cgeoform_item", request_method="DELETE", renderer="fast_json")  # type: ignore
-    def delete(self) -> Dict[str, Any]:
+    @view_config(route_name="c2cgeoform_item", request_method="DELETE", renderer="fast_json")  # type: ignore[misc]
+    def delete(self) -> DeleteResponse:
         obj = self._get_object()
         if len(obj.layers) > 0:
             return {
@@ -166,20 +178,20 @@ class OGCServerViews(LoggedViews):
                     _query=[("msg_col", "cannot_delete")],
                 ),
             }
-        result: Dict[str, Any] = super().delete()
+        result = super().delete()
         cache_invalidate_cb()
         return result
 
-    @view_config(  # type: ignore
+    @view_config(  # type: ignore[misc]
         route_name="c2cgeoform_item_duplicate", request_method="GET", renderer="../templates/edit.jinja2"
     )
-    def duplicate(self) -> Dict[str, Any]:
-        return super().duplicate()  # type: ignore
+    def duplicate(self) -> ObjectResponse:
+        return super().duplicate()
 
-    @view_config(  # type: ignore
+    @view_config(  # type: ignore[misc]
         route_name="ogcserver_synchronize", renderer="../templates/ogcserver_synchronize.jinja2"
     )
-    def synchronize(self) -> Dict[str, Any]:
+    def synchronize(self) -> JSONDict:
         obj = self._get_object()
 
         if self._request.method == "GET":
@@ -202,6 +214,7 @@ class OGCServerViews(LoggedViews):
                 clean=clean,
             )
 
+            ogc_server_id = obj.id
             if "check" in self._request.params:
                 synchronizer.check_layers()
 
@@ -214,7 +227,7 @@ class OGCServerViews(LoggedViews):
                 self._create_log(LogAction.SYNCHRONIZE, obj)
 
             return {
-                "ogcserver": obj,
+                "ogcserver": self._request.dbsession.query(OGCServer).get(ogc_server_id),
                 "success": True,
                 "report": synchronizer.report(),
             }
@@ -235,11 +248,12 @@ class OGCServerViews(LoggedViews):
                         _query={
                             "came_from": self._request.current_route_url(),
                         },
-                    )
+                    ),
+                    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)
+        except Exception:  # pylint: disable=broad-exception-caught
+            _LOG.error("Error on cleaning the OGC server cache", exc_info=True)

c2cgeoportal_admin/views/restriction_areas.py

@@ -1,4 +1,4 @@
-# Copyright (c) 2017-2023, Camptocamp SA
+# Copyright (c) 2017-2024, Camptocamp SA
 # All rights reserved.
 
 # Redistribution and use in source and binary forms, with or without
@@ -29,8 +29,16 @@
 from functools import partial
 
 import colander
+import sqlalchemy.orm.query
 from c2cgeoform.schema import GeoFormManyToManySchemaNode, GeoFormSchemaNode
-from c2cgeoform.views.abstract_views import ListField
+from c2cgeoform.views.abstract_views import (
+    DeleteResponse,
+    GridResponse,
+    IndexResponse,
+    ListField,
+    ObjectResponse,
+    SaveResponse,
+)
 from deform.widget import FormWidget
 from pyramid.view import view_config, view_defaults
 from sqlalchemy.orm import subqueryload
@@ -88,7 +96,7 @@ base_schema.add(
 
 
 @view_defaults(match_param="table=restriction_areas")
-class RestrictionAreaViews(LoggedViews):
+class RestrictionAreaViews(LoggedViews[RestrictionArea]):
     """The restriction area administration view."""
 
     _list_fields = [
@@ -110,35 +118,37 @@ class RestrictionAreaViews(LoggedViews):
     _model = RestrictionArea
     _base_schema = base_schema
 
-    def _base_query(self):
+    def _base_query(self) -> sqlalchemy.orm.query.Query[RestrictionArea]:
+        session = self._request.dbsession
+        assert isinstance(session, sqlalchemy.orm.Session)
         return (
-            self._request.dbsession.query(RestrictionArea)
-            .options(subqueryload("roles"))
-            .options(subqueryload("layers"))
+            session.query(RestrictionArea)
+            .options(subqueryload(RestrictionArea.roles))
+            .options(subqueryload(RestrictionArea.layers))
         )
 
-    @view_config(route_name="c2cgeoform_index", renderer="../templates/index.jinja2")
-    def index(self):
+    @view_config(route_name="c2cgeoform_index", renderer="../templates/index.jinja2")  # type: ignore[misc]
+    def index(self) -> IndexResponse:
         return super().index()
 
-    @view_config(route_name="c2cgeoform_grid", renderer="fast_json")
-    def grid(self):
+    @view_config(route_name="c2cgeoform_grid", renderer="fast_json")  # type: ignore[misc]
+    def grid(self) -> GridResponse:
         return super().grid()
 
-    @view_config(route_name="c2cgeoform_item", request_method="GET", renderer="../templates/edit.jinja2")
-    def view(self):
+    @view_config(route_name="c2cgeoform_item", request_method="GET", renderer="../templates/edit.jinja2")  # type: ignore[misc]
+    def view(self) -> ObjectResponse:
         return super().edit()
 
-    @view_config(route_name="c2cgeoform_item", request_method="POST", renderer="../templates/edit.jinja2")
-    def save(self):
+    @view_config(route_name="c2cgeoform_item", request_method="POST", renderer="../templates/edit.jinja2")  # type: ignore[misc]
+    def save(self) -> SaveResponse:
         return super().save()
 
-    @view_config(route_name="c2cgeoform_item", request_method="DELETE", renderer="fast_json")
-    def delete(self):
+    @view_config(route_name="c2cgeoform_item", request_method="DELETE", renderer="fast_json")  # type: ignore[misc]
+    def delete(self) -> DeleteResponse:
         return super().delete()
 
-    @view_config(
+    @view_config(  # type: ignore[misc]
         route_name="c2cgeoform_item_duplicate", request_method="GET", renderer="../templates/edit.jinja2"
     )
-    def duplicate(self):
+    def duplicate(self) -> ObjectResponse:
         return super().duplicate()

c2cgeoportal_admin/views/roles.py

@@ -1,4 +1,4 @@
-# Copyright (c) 2017-2023, Camptocamp SA
+# Copyright (c) 2017-2024, Camptocamp SA
 # All rights reserved.
 
 # Redistribution and use in source and binary forms, with or without
@@ -29,8 +29,16 @@
 from functools import partial
 
 import colander
+import sqlalchemy.orm.query
 from c2cgeoform.schema import GeoFormManyToManySchemaNode, GeoFormSchemaNode
-from c2cgeoform.views.abstract_views import ListField
+from c2cgeoform.views.abstract_views import (
+    DeleteResponse,
+    GridResponse,
+    IndexResponse,
+    ListField,
+    ObjectResponse,
+    SaveResponse,
+)
 from deform.widget import FormWidget
 from pyramid.view import view_config, view_defaults
 from sqlalchemy.orm import subqueryload
@@ -100,7 +108,7 @@ base_schema["users"].children[0].description = ""
 
 
 @view_defaults(match_param="table=roles")
-class RoleViews(LoggedViews):
+class RoleViews(LoggedViews[Role]):
     """The roles administration view."""
 
     _list_fields = [
@@ -119,35 +127,37 @@ class RoleViews(LoggedViews):
     _model = Role
     _base_schema = base_schema
 
-    def _base_query(self):
+    def _base_query(self) -> sqlalchemy.orm.query.Query[Role]:
+        session = self._request.dbsession
+        assert isinstance(session, sqlalchemy.orm.Session)
         return (
-            self._request.dbsession.query(Role)
-            .options(subqueryload("functionalities"))
-            .options(subqueryload("restrictionareas"))
+            session.query(Role)
+            .options(subqueryload(Role.functionalities))
+            .options(subqueryload(Role.restrictionareas))
         )
 
-    @view_config(route_name="c2cgeoform_index", renderer="../templates/index.jinja2")
-    def index(self):
+    @view_config(route_name="c2cgeoform_index", renderer="../templates/index.jinja2")  # type: ignore[misc]
+    def index(self) -> IndexResponse:
         return super().index()
 
-    @view_config(route_name="c2cgeoform_grid", renderer="fast_json")
-    def grid(self):
+    @view_config(route_name="c2cgeoform_grid", renderer="fast_json")  # type: ignore[misc]
+    def grid(self) -> GridResponse:
         return super().grid()
 
-    @view_config(route_name="c2cgeoform_item", request_method="GET", renderer="../templates/edit.jinja2")
-    def view(self):
+    @view_config(route_name="c2cgeoform_item", request_method="GET", renderer="../templates/edit.jinja2")  # type: ignore[misc]
+    def view(self) -> ObjectResponse:
         return super().edit()
 
-    @view_config(route_name="c2cgeoform_item", request_method="POST", renderer="../templates/edit.jinja2")
-    def save(self):
+    @view_config(route_name="c2cgeoform_item", request_method="POST", renderer="../templates/edit.jinja2")  # type: ignore[misc]
+    def save(self) -> SaveResponse:
         return super().save()
 
-    @view_config(route_name="c2cgeoform_item", request_method="DELETE", renderer="fast_json")
-    def delete(self):
+    @view_config(route_name="c2cgeoform_item", request_method="DELETE", renderer="fast_json")  # type: ignore[misc]
+    def delete(self) -> DeleteResponse:
         return super().delete()
 
-    @view_config(
+    @view_config(  # type: ignore[misc]
         route_name="c2cgeoform_item_duplicate", request_method="GET", renderer="../templates/edit.jinja2"
     )
-    def duplicate(self):
+    def duplicate(self) -> ObjectResponse:
         return super().duplicate()

c2cgeoportal_admin/views/themes.py

@@ -1,4 +1,4 @@
-# Copyright (c) 2017-2023, Camptocamp SA
+# Copyright (c) 2017-2024, Camptocamp SA
 # All rights reserved.
 
 # Redistribution and use in source and binary forms, with or without
@@ -27,11 +27,18 @@
 
 
 from functools import partial
-from typing import Optional, cast
+from typing import cast
 
 import sqlalchemy
 from c2cgeoform.schema import GeoFormSchemaNode
-from c2cgeoform.views.abstract_views import ListField
+from c2cgeoform.views.abstract_views import (
+    DeleteResponse,
+    GridResponse,
+    IndexResponse,
+    ListField,
+    ObjectResponse,
+    SaveResponse,
+)
 from deform.widget import FormWidget
 from pyramid.view import view_config, view_defaults
 from sqlalchemy.orm import subqueryload
@@ -57,11 +64,11 @@ base_schema.add_unique_validator(Theme.name, Theme.id)
 
 
 @view_defaults(match_param="table=themes")
-class ThemeViews(TreeItemViews):
+class ThemeViews(TreeItemViews[Theme]):
     """The theme administration view."""
 
     _list_fields = (
-        TreeItemViews._list_fields
+        TreeItemViews._list_fields  # type: ignore[misc] # pylint: disable=protected-access
         + [
             _list_field("ordering"),
             _list_field("public"),
@@ -89,47 +96,51 @@ class ThemeViews(TreeItemViews):
                 filter_column=Interface.name,
             ),
         ]
-        + TreeItemViews._extra_list_fields_no_parents
+        + TreeItemViews._extra_list_fields_no_parents  # pylint: disable=protected-access
     )
 
     _id_field = "id"
     _model = Theme
     _base_schema = base_schema
 
-    def _base_query(self, query: Optional[sqlalchemy.orm.query.Query] = None) -> sqlalchemy.orm.query.Query:
-        return super()._base_query(
+    def _base_query(self) -> sqlalchemy.orm.query.Query[Theme]:
+        return super()._sub_query(
             self._request.dbsession.query(Theme)
             .distinct()
-            .outerjoin("interfaces")
+            .outerjoin(Theme.interfaces)
             .outerjoin(Theme.restricted_roles)
             .outerjoin(Theme.functionalities)
-            .options(subqueryload("functionalities"))
-            .options(subqueryload("restricted_roles"))
-            .options(subqueryload("interfaces"))
+            .options(subqueryload(Theme.functionalities))
+            .options(subqueryload(Theme.restricted_roles))
+            .options(subqueryload(Theme.interfaces))
         )
 
-    @view_config(route_name="c2cgeoform_index", renderer="../templates/index.jinja2")
-    def index(self):
+    def _sub_query(self, query: sqlalchemy.orm.query.Query[Theme]) -> sqlalchemy.orm.query.Query[Theme]:
+        del query
+        return self._base_query()
+
+    @view_config(route_name="c2cgeoform_index", renderer="../templates/index.jinja2")  # type: ignore[misc]
+    def index(self) -> IndexResponse:
         return super().index()
 
-    @view_config(route_name="c2cgeoform_grid", renderer="fast_json")
-    def grid(self):
+    @view_config(route_name="c2cgeoform_grid", renderer="fast_json")  # type: ignore[misc]
+    def grid(self) -> GridResponse:
         return super().grid()
 
-    @view_config(route_name="c2cgeoform_item", request_method="GET", renderer="../templates/edit.jinja2")
-    def view(self):
+    @view_config(route_name="c2cgeoform_item", request_method="GET", renderer="../templates/edit.jinja2")  # type: ignore[misc]
+    def view(self) -> ObjectResponse:
         return super().edit()
 
-    @view_config(route_name="c2cgeoform_item", request_method="POST", renderer="../templates/edit.jinja2")
-    def save(self):
+    @view_config(route_name="c2cgeoform_item", request_method="POST", renderer="../templates/edit.jinja2")  # type: ignore[misc]
+    def save(self) -> SaveResponse:
         return super().save()
 
-    @view_config(route_name="c2cgeoform_item", request_method="DELETE", renderer="fast_json")
-    def delete(self):
+    @view_config(route_name="c2cgeoform_item", request_method="DELETE", renderer="fast_json")  # type: ignore[misc]
+    def delete(self) -> DeleteResponse:
         return super().delete()
 
-    @view_config(
+    @view_config(  # type: ignore[misc]
         route_name="c2cgeoform_item_duplicate", request_method="GET", renderer="../templates/edit.jinja2"
     )
-    def duplicate(self):
+    def duplicate(self) -> ObjectResponse:
         return super().duplicate()

c2cgeoportal_admin/views/themes_ordering.py

@@ -1,4 +1,4 @@
-# Copyright (c) 2017-2021, Camptocamp SA
+# Copyright (c) 2017-2024, Camptocamp SA
 # All rights reserved.
 
 # Redistribution and use in source and binary forms, with or without
@@ -28,7 +28,7 @@
 
 import colander
 from c2cgeoform.schema import GeoFormSchemaNode
-from c2cgeoform.views.abstract_views import AbstractViews
+from c2cgeoform.views.abstract_views import AbstractViews, ObjectResponse, SaveResponse
 from deform import ValidationFailure
 from pyramid.httpexceptions import HTTPFound
 from pyramid.view import view_config
@@ -39,7 +39,7 @@ from c2cgeoportal_admin.widgets import ChildrenWidget, ChildWidget
 from c2cgeoportal_commons.models.main import Theme, TreeItem
 
 
-class ThemeOrderSchema(GeoFormSchemaNode):  # type: ignore # pylint: disable=abstract-method
+class ThemeOrderSchema(GeoFormSchemaNode):  # pylint: disable=abstract-method
     """The theme order schema."""
 
     def objectify(self, dict_, context=None):
@@ -68,7 +68,7 @@ def themes_validator(node, cstruct):
             )
 
 
-class ThemesOrderingSchema(colander.MappingSchema):  # type: ignore
+class ThemesOrderingSchema(colander.MappingSchema):  # type: ignore[misc]
     """The theme ordering schema."""
 
     themes = colander.SequenceSchema(
@@ -91,13 +91,13 @@ class ThemesOrderingSchema(colander.MappingSchema):  # type: ignore
     )
 
 
-class ThemesOrdering(AbstractViews):  # type: ignore
+class ThemesOrdering(AbstractViews[ThemesOrderingSchema]):
     """The theme ordering admin view."""
 
     _base_schema = ThemesOrderingSchema()
 
-    @view_config(route_name="layertree_ordering", request_method="GET", renderer="../templates/edit.jinja2")
-    def view(self):
+    @view_config(route_name="layertree_ordering", request_method="GET", renderer="../templates/edit.jinja2")  # type: ignore[misc]
+    def view(self) -> ObjectResponse:
         form = self._form()
         dict_ = {
             "themes": [
@@ -108,13 +108,13 @@ class ThemesOrdering(AbstractViews):  # type: ignore
         return {
             "title": form.title,
             "form": form,
-            "form_render_args": (dict_,),
+            "form_render_args": [dict_],
             "form_render_kwargs": {"request": self._request, "actions": []},
             "deform_dependencies": form.get_widget_resources(),
         }
 
-    @view_config(route_name="layertree_ordering", request_method="POST", renderer="../templates/edit.jinja2")
-    def save(self):
+    @view_config(route_name="layertree_ordering", request_method="POST", renderer="../templates/edit.jinja2")  # type: ignore[misc]
+    def save(self) -> SaveResponse:
         try:
             form = self._form()
             form_data = self._request.POST.items()
@@ -131,7 +131,7 @@ class ThemesOrdering(AbstractViews):  # type: ignore
             return {
                 "title": form.title,
                 "form": e,
-                "form_render_args": tuple(),
+                "form_render_args": [],
                 "form_render_kwargs": {"request": self._request, "actions": []},
                 "deform_dependencies": form.get_widget_resources(),
             }

c2cgeoportal_admin/views/treeitems.py

@@ -1,4 +1,4 @@
-# Copyright (c) 2017-2023, Camptocamp SA
+# Copyright (c) 2017-2024, Camptocamp SA
 # All rights reserved.
 
 # Redistribution and use in source and binary forms, with or without
@@ -27,9 +27,10 @@
 
 
 from functools import partial
+from typing import Generic, TypeVar
 
 import sqlalchemy
-from c2cgeoform.views.abstract_views import ListField
+from c2cgeoform.views.abstract_views import ListField, SaveResponse
 from pyramid.view import view_config
 from sqlalchemy.orm import subqueryload
 from sqlalchemy.sql.functions import concat
@@ -40,7 +41,10 @@ from c2cgeoportal_commons.models.main import LayergroupTreeitem, Metadata, TreeG
 _list_field = partial(ListField, TreeItem)
 
 
-class TreeItemViews(LoggedViews):
+_T = TypeVar("_T", bound=TreeItem)
+
+
+class TreeItemViews(LoggedViews[_T], Generic[_T]):
     """The admin tree item view."""
 
     _list_fields = [
@@ -68,8 +72,8 @@ class TreeItemViews(LoggedViews):
         )
     ] + _extra_list_fields_no_parents
 
-    @view_config(route_name="c2cgeoform_item", request_method="POST", renderer="../templates/edit.jinja2")
-    def save(self):
+    @view_config(route_name="c2cgeoform_item", request_method="POST", renderer="../templates/edit.jinja2")  # type: ignore[misc]
+    def save(self) -> SaveResponse:
         response = super().save()
         # correctly handles the validation error as if there is a validation error, cstruct is empty
         has_to_be_registered_in_parent = (
@@ -81,11 +85,9 @@ class TreeItemViews(LoggedViews):
             self._request.dbsession.add(rel)
         return response
 
-    def _base_query(  # pylint: disable=arguments-differ
-        self, query: sqlalchemy.orm.query.Query
-    ) -> sqlalchemy.orm.query.Query:
+    def _sub_query(self, query: sqlalchemy.orm.query.Query[TreeItem]) -> sqlalchemy.orm.query.Query[TreeItem]:
         return (
-            query.outerjoin("metadatas")
-            .options(subqueryload("parents_relation").joinedload("treegroup"))
-            .options(subqueryload("metadatas"))
+            query.outerjoin(TreeItem.metadatas)
+            .options(subqueryload(TreeItem.parents_relation).joinedload(LayergroupTreeitem.treegroup))
+            .options(subqueryload(TreeItem.metadatas))
         )