Add Ruff

.github/workflows/main.yaml

@@ -34,7 +34,7 @@ jobs:
       # When we upgrade this we should also upgrade the requirements
       # in the documentation: doc/integrator/requirements.rst
       # and the first pyupgrade pre-commit hook in .pre-commit-config.yaml
-      MIN_PYTHON_VERSION: '3.8'
+      MIN_PYTHON_VERSION: '3.10'
 
     steps:
       - run: '! ls BACKPORT_TODO'

.pre-commit-config.yaml

@@ -104,64 +104,28 @@ repos:
             docker/config/haproxy_dev/localhost\.pem
             |geoportal/c2cgeoportal_geoportal/scaffolds/create/{{cookiecutter\.project}}/mapserver/data/TM_EUROPE_BORDERS-0.3\.sql
           )$
-  - repo: https://github.com/asottile/pyupgrade
-    rev: v3.19.0
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.8.1
     hooks:
-      # The script that will run on the project host
-      - id: pyupgrade
+      - id: ruff-format
         args:
-          - --py38-plus
-        files: |-
-          (?x)^(
-            geoportal/c2cgeoportal_geoportal/scaffolds/create/{{cookiecutter\.project}}/(build
-            |scripts/.*)
-            |scripts/(get-version
-            |upgrade)
-          )$
-      # All other
-      - id: pyupgrade
-        args:
-          - --py310-plus
-        # geoportal/c2cgeoportal_geoportal/views/theme\.py is present because of issue:
-        # https://bugs.launchpad.net/lxml/+bug/2079018
-        exclude: |-
-          (?x)^(
-            geoportal/c2cgeoportal_geoportal/scaffolds/create/{{cookiecutter\.project}}/(build
-            |scripts/.*)
-            |scripts/(get-version
-            |upgrade)
-            |geoportal/c2cgeoportal_geoportal/views/theme\.py
-          )$
-  - repo: https://github.com/PyCQA/autoflake
-    rev: v2.3.1
-    hooks:
-      - id: autoflake
-  - repo: https://github.com/PyCQA/isort
-    rev: 5.13.2
-    hooks:
-      - id: isort
-  - repo: https://github.com/psf/black
-    rev: 24.10.0
-    hooks:
-      - id: black
+          - --line-length=110
         exclude: |-
           (?x)^(
-            commons/c2cgeoportal_commons/alembic/script\.py\.mako
-            |.*\.rst
-            |.*\.rst\.tmpl
-            |geoportal/c2cgeoportal_geoportal/scaffolds/advance_create/{{cookiecutter.project}}/geoportal/{{cookiecutter.package}}_geoportal/__init__\.py
+            geoportal/c2cgeoportal_geoportal/scaffolds/advance_create/{{cookiecutter.project}}/geoportal/{{cookiecutter.package}}_geoportal/__init__\.py
           )$
   - repo: https://github.com/PyCQA/prospector
     rev: v1.13.3
     hooks:
       - id: prospector
         args:
-          - --tool=pydocstyle
+          - --tool=ruff
           - --die-on-tool-error
           - --output-format=pylint
         additional_dependencies:
-          - prospector-profile-duplicated==1.8.0 # pypi
+          - prospector-profile-duplicated==1.8.1 # pypi
           - prospector-profile-utils==1.13.0 # pypi
+          - ruff==0.8.1 # pypi
   - repo: https://github.com/sbrunner/jsonschema-validator
     rev: 0.3.2
     hooks:

.prospector.yaml

@@ -3,35 +3,23 @@ inherits:
   - utils:base
   - utils:fix
   - utils:no-design-checks
+  - utils:unsafe
+  - utils:c2cwsgiutils
 
 ignore-paths:
   - commons/setup.py
   - geoportal/setup.py
   - admin/setup.py
   - geoportal/c2cgeoportal_geoportal/scaffolds
   - docker/qgisserver
+  - commons/c2cgeoportal_commons/alembic/main
+  - commons/c2cgeoportal_commons/alembic/static
 
-pycodestyle:
-  disable:
-    # Buggy checks with Python 3.12
-    - W604 # backticks are deprecated, use 'repr()'
-    - W603 # '<>' is deprecated, use '!='
-    - E702 # multiple statements on one line (semicolon)
-    - E713 # test for membership should be 'not in'
+mypy:
+  options:
+    python_version: '3.10'
 
-pydocstyle:
+ruff:
   disable:
     - D102 # Missing docstring in public method
-    - D104 # Missing docstring in public package
-    - D105 # Missing docstring in magic method
-    - D107 # Missing docstring in __init__
-    - D200 # One-line docstring should fit on one line with quotes
-    - D202 # No blank lines allowed after function docstring (found 1)
-    - D203 # 1 blank line required before class docstring (found 0)
-    - D212 # Multi-line docstring summary should start at the first line
-    - D407 # Missing dashed underline after section ('Arguments')
-    - D412 # No blank lines allowed between a section header and its content ('Arguments')
-
-bandit:
-  options:
-    config: .bandit.yaml
+    - D107 # Missing docstring in `__init__`

admin/c2cgeoportal_admin/__init__.py

@@ -93,7 +93,9 @@ def get_tm_session(
     )
 
     # Add fake user as we do not have authentication from geoportal
-    from c2cgeoportal_commons.models.static import User  # pylint: disable=import-outside-toplevel
+    from c2cgeoportal_commons.models.static import (  # pylint: disable=import-outside-toplevel
+        User,
+    )
 
     config.add_request_method(
         lambda request: User(

admin/c2cgeoportal_admin/lib/ogcserver_synchronizer.py

@@ -29,16 +29,15 @@
 import functools
 import logging
 from io import StringIO
-from typing import Any, Optional, cast
+from typing import Any, cast
 from xml.etree.ElementTree import Element  # nosec
 
 import pyramid.request
 import requests
-from defusedxml import ElementTree
-from sqlalchemy.orm.session import Session
-
 from c2cgeoportal_commons.lib.url import get_url2
 from c2cgeoportal_commons.models import main
+from defusedxml import ElementTree
+from sqlalchemy.orm.session import Session
 
 
 class dry_run_transaction:  # noqa ignore=N801: class names should use CapWords convention
@@ -238,7 +237,7 @@ def get_theme(self, el: ElementTree) -> main.Theme:
         name = name_el.text
 
         theme = cast(
-            Optional[main.Theme],
+            main.Theme | None,
             self._request.dbsession.query(main.Theme).filter(main.Theme.name == name).one_or_none(),
         )
 
@@ -263,7 +262,7 @@ def get_layer_group(self, el: Element, parent: main.TreeGroup) -> main.LayerGrou
         assert name is not None
 
         group = cast(
-            Optional[main.LayerGroup],
+            main.LayerGroup | None,
             (
                 self._request.dbsession.query(main.LayerGroup)
                 .filter(main.LayerGroup.name == name)
@@ -294,7 +293,7 @@ def get_layer_wms(self, el: Element, parent: main.TreeGroup | None = None) -> ma
         assert name is not None
 
         layer = cast(
-            Optional[main.LayerWMS],
+            main.LayerWMS | None,
             self._request.dbsession.query(main.LayerWMS).filter(main.LayerWMS.name == name).one_or_none(),
         )
 
@@ -358,7 +357,7 @@ def get_layer_wms(self, el: Element, parent: main.TreeGroup | None = None) -> ma
 
         return layer
 
-    @functools.lru_cache(maxsize=10)
+    @functools.lru_cache(maxsize=10)  # noqa: B019
     def wms_capabilities(self) -> bytes:
         errors: set[str] = set()
         url = get_url2(

admin/c2cgeoportal_admin/schemas/dimensions.py

@@ -30,11 +30,10 @@
 
 import colander
 from c2cgeoform.schema import GeoFormSchemaNode
+from c2cgeoportal_commons.models.main import Dimension
 from deform.widget import MappingWidget, SequenceWidget
 from sqlalchemy.orm.attributes import InstrumentedAttribute
 
-from c2cgeoportal_commons.models.main import Dimension
-
 
 def dimensions_schema_node(
     prop: InstrumentedAttribute[Any],  # pylint: disable=unsubscriptable-object

admin/c2cgeoportal_admin/schemas/functionalities.py

@@ -31,12 +31,11 @@
 import colander
 from c2cgeoform.ext.deform_ext import RelationCheckBoxListWidget
 from c2cgeoform.schema import GeoFormManyToManySchemaNode, manytomany_validator
+from c2cgeoportal_commons.models.main import Functionality
 from sqlalchemy import inspect, select
 from sqlalchemy.orm.attributes import InstrumentedAttribute
 from sqlalchemy.sql.functions import concat
 
-from c2cgeoportal_commons.models.main import Functionality
-
 
 def available_functionalities_for(settings: dict[str, Any], model: type[Any]) -> list[dict[str, Any]]:
     """Return filtered list of functionality definitions."""
@@ -81,7 +80,6 @@ def functionalities_schema_node(
     prop: InstrumentedAttribute[Any], model: type[Any]
 ) -> colander.SequenceSchema:
     """Get the schema of the functionalities."""
-
     return colander.SequenceSchema(
         GeoFormManyToManySchemaNode(Functionality, None),
         name=prop.key,

admin/c2cgeoportal_admin/schemas/interfaces.py

@@ -31,9 +31,8 @@
 import colander
 from c2cgeoform.ext.deform_ext import RelationCheckBoxListWidget
 from c2cgeoform.schema import GeoFormManyToManySchemaNode, manytomany_validator
-from sqlalchemy.orm.attributes import InstrumentedAttribute
-
 from c2cgeoportal_commons.models.main import Interface
+from sqlalchemy.orm.attributes import InstrumentedAttribute
 
 
 def interfaces_schema_node(

admin/c2cgeoportal_admin/schemas/metadata.py

@@ -31,14 +31,14 @@
 import colander
 import pyramid.request
 from c2cgeoform.schema import GeoFormSchemaNode
+from c2cgeoportal_commons.lib.validators import url
+from c2cgeoportal_commons.models.main import Metadata
 from deform.widget import MappingWidget, SelectWidget, SequenceWidget, TextAreaWidget
 from sqlalchemy import inspect
 from sqlalchemy.orm.attributes import InstrumentedAttribute
 from sqlalchemy.orm.mapper import Mapper
 
 from c2cgeoportal_admin import _
-from c2cgeoportal_commons.lib.validators import url
-from c2cgeoportal_commons.models.main import Metadata
 
 
 def get_relevant_for(model: type[Any] | Mapper[Any]) -> set[str]:
@@ -202,7 +202,6 @@ def _translate_available_metadata(
 
 def metadata_schema_node(prop: InstrumentedAttribute[Any], model: type[Any]) -> colander.SequenceSchema:
     """Get the schema of a collection of metadata."""
-
     # Deferred which returns a dictionary with metadata name as key and metadata definition as value.
     # Needed to get the metadata types on UI side.
     metadata_definitions_dict = colander.deferred(

admin/c2cgeoportal_admin/schemas/restriction_areas.py

@@ -31,9 +31,8 @@
 import colander
 from c2cgeoform.ext.deform_ext import RelationCheckBoxListWidget
 from c2cgeoform.schema import GeoFormManyToManySchemaNode, manytomany_validator
-from sqlalchemy.orm.attributes import InstrumentedAttribute
-
 from c2cgeoportal_commons.models.main import RestrictionArea
+from sqlalchemy.orm.attributes import InstrumentedAttribute
 
 
 def restrictionareas_schema_node(

admin/c2cgeoportal_admin/schemas/roles.py

@@ -31,9 +31,8 @@
 import colander
 from c2cgeoform.ext.deform_ext import RelationCheckBoxListWidget
 from c2cgeoform.schema import GeoFormManyToManySchemaNode, manytomany_validator
-from sqlalchemy.orm.attributes import InstrumentedAttribute
-
 from c2cgeoportal_commons.models.main import Role
+from sqlalchemy.orm.attributes import InstrumentedAttribute
 
 
 def roles_schema_node(

admin/c2cgeoportal_admin/schemas/treegroup.py

@@ -34,13 +34,13 @@
 import pyramid.request
 import sqlalchemy
 from c2cgeoform.schema import GeoFormSchemaNode
+from c2cgeoportal_commons.lib.literal import Literal
+from c2cgeoportal_commons.models.main import LayergroupTreeitem, TreeGroup, TreeItem
 from sqlalchemy.orm import aliased
 from sqlalchemy.sql.expression import case, func
 
 from c2cgeoportal_admin import _
 from c2cgeoportal_admin.widgets import ChildrenWidget, ChildWidget
-from c2cgeoportal_commons.lib.literal import Literal
-from c2cgeoportal_commons.models.main import LayergroupTreeitem, TreeGroup, TreeItem
 
 _LOG = logging.getLogger(__name__)
 
@@ -74,7 +74,8 @@ def treeitems(
     assert isinstance(dbsession, sqlalchemy.orm.Session)
 
     group = case(
-        (func.count(LayergroupTreeitem.id) == 0, "Unlinked"), else_="Others"  # pylint: disable=not-callable
+        (func.count(LayergroupTreeitem.id) == 0, "Unlinked"),  # pylint: disable=not-callable
+        else_="Others",
     )
 
     query = (
@@ -123,7 +124,7 @@ def treeitems(
 def children_validator(node, cstruct):
     """Get the validator on the children nodes."""
     for dict_ in cstruct:
-        if not dict_["treeitem_id"] in [item["id"] for item in node.candidates]:
+        if dict_["treeitem_id"] not in [item["id"] for item in node.candidates]:
             raise colander.Invalid(
                 node,
                 _("Value {} does not exist in table {} or is not allowed to avoid cycles").format(

admin/c2cgeoportal_admin/views/__init__.py

@@ -4,9 +4,7 @@
 
 
 class IsAdminPredicate:
-    """
-    A custom predicate that checks if the request is for the admin interface.
-    """
+    """A custom predicate that checks if the request is for the admin interface."""
 
     def __init__(self, val, info):
         del info

admin/c2cgeoportal_admin/views/dimension_layers.py

@@ -32,10 +32,10 @@
 
 import sqlalchemy.orm.query
 from c2cgeoform.views.abstract_views import ListField
+from c2cgeoportal_commons.models.main import DimensionLayer
 from sqlalchemy.orm import subqueryload
 
 from c2cgeoportal_admin.views.layers import LayerViews
-from c2cgeoportal_commons.models.main import DimensionLayer
 
 _list_field = partial(ListField, DimensionLayer)