c2cgeoportal-commons 2.8.1.146__py3-none-any.whl → 2.9.0.350__py3-none-any.whl

c2cgeoportal_commons/models/sqlalchemy.py

@@ -1,4 +1,4 @@
-# Copyright (c) 2012-2023, Camptocamp SA
+# Copyright (c) 2012-2025, Camptocamp SA
 # All rights reserved.
 
 # Redistribution and use in source and binary forms, with or without
@@ -25,7 +25,7 @@
 # of the authors and should not be interpreted as representing official policies,
 # either expressed or implied, of the FreeBSD Project.
 import json
-from typing import Any, Dict, Optional, Type
+from typing import Any
 
 from sqlalchemy.engine import Dialect
 from sqlalchemy.types import VARCHAR, TypeDecorator, UserDefinedType
@@ -33,34 +33,35 @@ from sqlalchemy.types import VARCHAR, TypeDecorator, UserDefinedType
 
 # get from https://docs.sqlalchemy.org/en/latest/orm/extensions/
 # mutable.html#establishing-mutability-on-scalar-column-values
-class JSONEncodedDict(TypeDecorator):  # type: ignore
+class JSONEncodedDict(TypeDecorator[Any]):
     """Represent an immutable structure as a json-encoded string."""
 
     impl = VARCHAR
 
-    def process_bind_param(self, value: Optional[Dict[str, Any]], _: Dialect) -> Optional[str]:
+    def process_bind_param(self, value: dict[str, Any] | None, _: Dialect) -> str | None:
         return json.dumps(value) if value is not None else None
 
-    def process_result_value(self, value: Optional[str], _: Dialect) -> Optional[Dict[str, Any]]:
+    def process_result_value(self, value: str | None, _: Dialect) -> dict[str, Any] | None:
         return json.loads(value) if value is not None else None
 
     @property
-    def python_type(self) -> Type[Any]:
+    def python_type(self) -> type[Any]:
         return dict
 
-    def process_literal_param(self, value: str, dialect: Any) -> str:
+    def process_literal_param(self, value: Any | None, dialect: Any) -> str:
+        assert isinstance(value, str)
         del dialect
         return json.dumps(value)
 
 
-class TsVector(UserDefinedType):  # type: ignore
+class TsVector(UserDefinedType[dict[str, str]]):  # pylint: disable=abstract-method
     """A custom type for PostgreSQL's tsvector type."""
 
     cache_ok = True
 
-    def get_col_spec(self) -> str:
+    def get_col_spec(self) -> str:  # type: ignore[override] # pylint: disable=arguments-differ
         return "TSVECTOR"
 
     @property
-    def python_type(self) -> Type[Any]:
+    def python_type(self) -> type[Any]:
         return dict

c2cgeoportal_commons/models/static.py

@@ -1,4 +1,4 @@
-# Copyright (c) 2011-2023, Camptocamp SA
+# Copyright (c) 2011-2025, Camptocamp SA
 # All rights reserved.
 
 # Redistribution and use in source and binary forms, with or without
@@ -28,18 +28,18 @@
 
 import crypt
 import logging
-from datetime import datetime
+import os
+from datetime import datetime, timezone
 from hashlib import sha1
 from hmac import compare_digest as compare_hash
-from typing import Any, List, Optional
+from typing import Any
 
-import pytz
 import sqlalchemy.schema
 from c2c.template.config import config
 from sqlalchemy import Column, ForeignKey, Table
 from sqlalchemy.dialects.postgresql import HSTORE
 from sqlalchemy.ext.mutable import MutableDict
-from sqlalchemy.orm import backref, relationship
+from sqlalchemy.orm import Mapped, backref, mapped_column, relationship
 from sqlalchemy.types import Boolean, DateTime, Integer, String, Unicode
 
 from c2cgeoportal_commons.lib.literal import Literal
@@ -51,7 +51,7 @@ try:
     from colander import Email, drop
     from deform.widget import DateTimeInputWidget, HiddenWidget
 except ModuleNotFoundError:
-    drop = None
+    drop = None  # pylint: disable=invalid-name
 
     class GenericClass:
         """Generic class."""
@@ -63,10 +63,11 @@ except ModuleNotFoundError:
     HiddenWidget = GenericClass
     DateTimeInputWidget = GenericClass
     CollenderGeometry = GenericClass
-    RelationSelect2Widget = GenericClass
+    RelationSelect2Widget = GenericClass  # type: ignore[misc,assignment]
 
 
-LOG = logging.getLogger(__name__)
+_LOG = logging.getLogger(__name__)
+_OPENID_CONNECT_ENABLED = os.environ.get("OPENID_CONNECT_ENABLED", "false").lower() in ("true", "yes", "1")
 
 _schema: str = config["schema_static"] or "static"
 
@@ -123,31 +124,49 @@ class User(Base):  # type: ignore
         ),
     }
     __c2cgeoform_config__ = {"duplicate": True}
-    item_type = Column(
+    item_type: Mapped[str] = mapped_column(
         "type", String(10), nullable=False, info={"colanderalchemy": {"widget": HiddenWidget()}}
     )
     __mapper_args__ = {"polymorphic_on": item_type, "polymorphic_identity": "user"}
 
-    id = Column(Integer, primary_key=True, info={"colanderalchemy": {"widget": HiddenWidget()}})
-    username = Column(
+    id: Mapped[int] = mapped_column(
+        Integer, primary_key=True, info={"colanderalchemy": {"widget": HiddenWidget()}}
+    )
+    username: Mapped[str] = mapped_column(
         Unicode,
         unique=True,
         nullable=False,
+        info={
+            "colanderalchemy": (
+                {
+                    "title": _("Username"),
+                    "description": _("Name used for authentication (must be unique)."),
+                }
+                if not _OPENID_CONNECT_ENABLED
+                else {"widget": HiddenWidget()}
+            )
+        },
+    )
+    display_name: Mapped[str] = mapped_column(
+        Unicode,
         info={
             "colanderalchemy": {
-                "title": _("Username"),
-                "description": _("Name used for authentication (must be unique)."),
+                "title": _("Display name"),
+                "description": _("Name displayed in the application."),
             }
         },
     )
-    _password = Column("password", Unicode, nullable=False, info={"colanderalchemy": {"exclude": True}})
-    temp_password = Column(
+    _password: Mapped[str] = mapped_column(
+        "password", Unicode, nullable=False, info={"colanderalchemy": {"exclude": True}}
+    )
+    temp_password: Mapped[str | None] = mapped_column(
         "temp_password", Unicode, nullable=True, info={"colanderalchemy": {"exclude": True}}
     )
-    tech_data = Column(MutableDict.as_mutable(HSTORE), info={"colanderalchemy": {"exclude": True}})
-    email = Column(
+    tech_data = mapped_column(MutableDict.as_mutable(HSTORE), info={"colanderalchemy": {"exclude": True}})
+    email: Mapped[str] = mapped_column(
         Unicode,
         nullable=False,
+        index=True,
         info={
             "colanderalchemy": {
                 "title": _("Email"),
@@ -158,19 +177,24 @@ class User(Base):  # type: ignore
             }
         },
     )
-    is_password_changed = Column(
+    is_password_changed: Mapped[bool] = mapped_column(
         Boolean,
         default=False,
         info={
-            "colanderalchemy": {
-                "title": _("The user changed his password"),
-                "description": _("Indicates if user has changed his password."),
-            }
+            "colanderalchemy": (
+                {
+                    "title": _("The user changed his password"),
+                    "description": _("Indicates if user has changed his password."),
+                }
+                if not _OPENID_CONNECT_ENABLED
+                else {"exclude": True}
+            )
         },
     )
 
-    settings_role_id = Column(
-        Integer,
+    settings_role_id: Mapped[int] = mapped_column(
+        Integer(),
+        nullable=True,
         info={
             "colanderalchemy": {
                 "title": _("Settings from role"),
@@ -213,36 +237,49 @@ class User(Base):  # type: ignore
         },
     )
 
-    last_login = Column(
+    last_login: Mapped[datetime] = mapped_column(
         DateTime(timezone=True),
+        nullable=True,
         info={
-            "colanderalchemy": {
-                "title": _("Last login"),
-                "description": _("Date of the user's last login."),
-                "missing": drop,
-                "widget": DateTimeInputWidget(readonly=True),
-            }
+            "colanderalchemy": (
+                {
+                    "title": _("Last login"),
+                    "description": _("Date of the user's last login."),
+                    "missing": drop,
+                    "widget": DateTimeInputWidget(readonly=True),
+                }
+                if not _OPENID_CONNECT_ENABLED
+                else {"exclude": True}
+            )
         },
     )
 
-    expire_on = Column(
+    expire_on: Mapped[datetime | None] = mapped_column(
         DateTime(timezone=True),
         info={
-            "colanderalchemy": {
-                "title": _("Expiration date"),
-                "description": _("After this date the user will not be able to login anymore."),
-            }
+            "colanderalchemy": (
+                {
+                    "title": _("Expiration date"),
+                    "description": _("After this date the user will not be able to login anymore."),
+                }
+                if not _OPENID_CONNECT_ENABLED
+                else {"exclude": True}
+            )
         },
     )
 
-    deactivated = Column(
+    deactivated: Mapped[bool] = mapped_column(
         Boolean,
         default=False,
         info={
-            "colanderalchemy": {
-                "title": _("Deactivated"),
-                "description": _("Deactivate a user without removing it completely."),
-            }
+            "colanderalchemy": (
+                {
+                    "title": _("Deactivated"),
+                    "description": _("Deactivate a user without removing it completely."),
+                }
+                if not _OPENID_CONNECT_ENABLED
+                else {"exclude": True}
+            )
         },
     )
 
@@ -252,12 +289,14 @@ class User(Base):  # type: ignore
         password: str = "",
         email: str = "",
         is_password_changed: bool = False,
-        settings_role: Optional[Role] = None,
-        roles: Optional[List[Role]] = None,
-        expire_on: Optional[datetime] = None,
+        settings_role: Role | None = None,
+        roles: list[Role] | None = None,
+        expire_on: datetime | None = None,
         deactivated: bool = False,
+        display_name: str | None = None,
     ) -> None:
         self.username = username
+        self.display_name = display_name or username
         self.password = password
         self.tech_data = {}
         self.email = email
@@ -271,7 +310,7 @@ class User(Base):  # type: ignore
     @property
     def password(self) -> str:
         """Get the password."""
-        return self._password  # type: ignore
+        return self._password
 
     @password.setter
     def password(self, password: str) -> None:
@@ -322,10 +361,10 @@ class User(Base):  # type: ignore
         return False
 
     def expired(self) -> bool:
-        return self.expire_on is not None and self.expire_on < datetime.now(pytz.utc)
+        return self.expire_on is not None and self.expire_on < datetime.now(timezone.utc)
 
     def update_last_login(self) -> None:
-        self.last_login = datetime.now(pytz.utc)
+        self.last_login = datetime.now(timezone.utc)
 
     def __str__(self) -> str:
         return self.username or ""
@@ -336,13 +375,13 @@ class Shorturl(Base):  # type: ignore
 
     __tablename__ = "shorturl"
     __table_args__ = {"schema": _schema}
-    id = Column(Integer, primary_key=True)
-    url = Column(Unicode)
-    ref = Column(String(20), index=True, unique=True, nullable=False)
-    creator_email = Column(Unicode(200))
-    creation = Column(DateTime)
-    last_hit = Column(DateTime)
-    nb_hits = Column(Integer)
+    id: Mapped[int] = mapped_column(Integer, primary_key=True)
+    url: Mapped[str] = mapped_column(Unicode)
+    ref: Mapped[str] = mapped_column(String(20), index=True, unique=True, nullable=False)
+    creator_email: Mapped[str | None] = mapped_column(Unicode(200), nullable=True)
+    creation: Mapped[datetime] = mapped_column(DateTime)
+    last_hit: Mapped[datetime] = mapped_column(DateTime, nullable=True)
+    nb_hits: Mapped[int] = mapped_column(Integer)
 
 
 class OAuth2Client(Base):  # type: ignore
@@ -352,8 +391,10 @@ class OAuth2Client(Base):  # type: ignore
     __table_args__ = {"schema": _schema}
     __colanderalchemy_config__ = {"title": _("OAuth2 Client"), "plural": _("OAuth2 Clients")}
     __c2cgeoform_config__ = {"duplicate": True}
-    id = Column(Integer, primary_key=True, info={"colanderalchemy": {"widget": HiddenWidget()}})
-    client_id = Column(
+    id: Mapped[int] = mapped_column(
+        Integer, primary_key=True, info={"colanderalchemy": {"widget": HiddenWidget()}}
+    )
+    client_id: Mapped[str] = mapped_column(
         Unicode,
         unique=True,
         info={
@@ -363,7 +404,7 @@ class OAuth2Client(Base):  # type: ignore
             }
         },
     )
-    secret = Column(
+    secret: Mapped[str] = mapped_column(
         Unicode,
         info={
             "colanderalchemy": {
@@ -372,7 +413,7 @@ class OAuth2Client(Base):  # type: ignore
             }
         },
     )
-    redirect_uri = Column(
+    redirect_uri: Mapped[str] = mapped_column(
         Unicode,
         info={
             "colanderalchemy": {
@@ -386,7 +427,7 @@ class OAuth2Client(Base):  # type: ignore
             }
         },
     )
-    state_required = Column(
+    state_required: Mapped[bool] = mapped_column(
         Boolean,
         default=False,
         info={
@@ -399,7 +440,7 @@ class OAuth2Client(Base):  # type: ignore
             }
         },
     )
-    pkce_required = Column(
+    pkce_required: Mapped[bool] = mapped_column(
         Boolean,
         default=False,
         info={
@@ -425,15 +466,19 @@ class OAuth2BearerToken(Base):  # type: ignore
             "schema": _schema,
         },
     )
-    id = Column(Integer, primary_key=True)
-    client_id = Column(Integer, ForeignKey(_schema + ".oauth2_client.id", ondelete="CASCADE"), nullable=False)
+    id: Mapped[int] = mapped_column(Integer, primary_key=True)
+    client_id: Mapped[int] = mapped_column(
+        Integer, ForeignKey(_schema + ".oauth2_client.id", ondelete="CASCADE"), nullable=False
+    )
     client = relationship(OAuth2Client)
-    user_id = Column(Integer, ForeignKey(_schema + ".user.id", ondelete="CASCADE"), nullable=False)
+    user_id: Mapped[int] = mapped_column(
+        Integer, ForeignKey(_schema + ".user.id", ondelete="CASCADE"), nullable=False
+    )
     user = relationship(User)
-    access_token = Column(Unicode(100), unique=True)
-    refresh_token = Column(Unicode(100), unique=True)
-    expire_at = Column(DateTime(timezone=True))  # in one hour
-    state = Column(String)
+    access_token: Mapped[str] = mapped_column(Unicode(100), unique=True)
+    refresh_token: Mapped[str] = mapped_column(Unicode(100), unique=True)
+    expire_at: Mapped[datetime] = mapped_column(DateTime(timezone=True))  # in one hour
+    state = mapped_column(String, nullable=True)
 
 
 class OAuth2AuthorizationCode(Base):  # type: ignore
@@ -446,17 +491,21 @@ class OAuth2AuthorizationCode(Base):  # type: ignore
             "schema": _schema,
         },
     )
-    id = Column(Integer, primary_key=True)
-    client_id = Column(Integer, ForeignKey(_schema + ".oauth2_client.id", ondelete="CASCADE"), nullable=False)
+    id: Mapped[int] = mapped_column(Integer, primary_key=True)
+    client_id: Mapped[int] = mapped_column(
+        Integer, ForeignKey(_schema + ".oauth2_client.id", ondelete="CASCADE"), nullable=False
+    )
     client = relationship(OAuth2Client)
-    user_id = Column(Integer, ForeignKey(_schema + ".user.id", ondelete="CASCADE"), nullable=False)
+    user_id: Mapped[int] = mapped_column(
+        Integer, ForeignKey(_schema + ".user.id", ondelete="CASCADE"), nullable=False
+    )
     user = relationship(User)
-    redirect_uri = Column(Unicode)
-    code = Column(Unicode(100), unique=True)
-    state = Column(String)
-    challenge = Column(String(128))
-    challenge_method = Column(String(6))
-    expire_at = Column(DateTime(timezone=True))  # in 10 minutes
+    redirect_uri: Mapped[str] = mapped_column(Unicode)
+    code: Mapped[str] = mapped_column(Unicode(100), unique=True, nullable=True)
+    state: Mapped[str | None] = mapped_column(String, nullable=True)
+    challenge: Mapped[str] = mapped_column(String(128), nullable=True)
+    challenge_method: Mapped[str] = mapped_column(String(6), nullable=True)
+    expire_at: Mapped[datetime] = mapped_column(DateTime(timezone=True))  # in 10 minutes
 
 
 class Log(AbstractLog):

c2cgeoportal_commons/testing/__init__.py

@@ -1,4 +1,4 @@
-# Copyright (c) 2018-2023, Camptocamp SA
+# Copyright (c) 2018-2025, Camptocamp SA
 # All rights reserved.
 
 # Redistribution and use in source and binary forms, with or without
@@ -26,7 +26,7 @@
 # either expressed or implied, of the FreeBSD Project.
 
 
-from typing import Any, Dict
+from typing import Any
 
 import zope.sqlalchemy
 from sqlalchemy import engine_from_config
@@ -35,19 +35,22 @@ from sqlalchemy.orm import Session, configure_mappers, sessionmaker
 from transaction import TransactionManager
 
 
-def get_engine(settings: Dict[str, Any], prefix: str = "sqlalchemy.") -> Engine:
+def get_engine(settings: dict[str, Any], prefix: str = "sqlalchemy.") -> Engine:
     """Get the engine."""
     return engine_from_config(settings, prefix)
 
 
-def get_session_factory(engine: Engine) -> sessionmaker:
+def get_session_factory(engine: Engine) -> sessionmaker[Session]:  # pylint: disable=unsubscriptable-object
     """Get the session factory."""
     factory = sessionmaker()
     factory.configure(bind=engine)
     return factory
 
 
-def get_tm_session(session_factory: sessionmaker, transaction_manager: TransactionManager) -> Session:
+def get_tm_session(
+    session_factory: sessionmaker[Session],  # pylint: disable=unsubscriptable-object
+    transaction_manager: TransactionManager,
+) -> Session:
     """
     Get a ``sqlalchemy.orm.Session`` instance backed by a transaction.
 
@@ -68,6 +71,7 @@ def get_tm_session(session_factory: sessionmaker, transaction_manager: Transacti
               dbsession = get_tm_session(session_factory, transaction.manager)
     """
     dbsession = session_factory()
+    assert isinstance(dbsession, Session)
     zope.sqlalchemy.register(dbsession, transaction_manager=transaction_manager)
     return dbsession
 
@@ -86,7 +90,7 @@ def generate_mappers() -> None:
 
 
 def get_session(
-    settings: Dict[str, Any], transaction_manager: TransactionManager, prefix: str = "sqlalchemy."
+    settings: dict[str, Any], transaction_manager: TransactionManager, prefix: str = "sqlalchemy."
 ) -> Session:
     """Get the session."""
     configure_mappers()

c2cgeoportal_commons/testing/initializedb.py

@@ -1,4 +1,4 @@
-# Copyright (c) 2017-2021, Camptocamp SA
+# Copyright (c) 2017-2025, Camptocamp SA
 # All rights reserved.
 
 # Redistribution and use in source and binary forms, with or without
@@ -28,15 +28,16 @@
 
 import os
 import sys
-from typing import List, cast
+from typing import cast
 
+import sqlalchemy
 from sqlalchemy.engine import Connection
 from sqlalchemy.orm import Session
 
 from c2cgeoportal_commons.models import Base
 
 
-def usage(argv: List[str]) -> None:
+def usage(argv: list[str]) -> None:
     """Get the usage."""
     cmd = os.path.basename(argv[0])
     print(f"usage: {cmd} <config_uri> [var=value]\n" '(example: "{cmd} development.ini")')
@@ -50,15 +51,15 @@ SELECT count(*) AS count
 FROM information_schema.schemata
 WHERE schema_name = '{schema_name}';
 """
-    result = connection.execute(sql)
+    result = connection.execute(sqlalchemy.text(sql))
     row = result.first()
-    return cast(bool, row[0] == 1)
+    return cast(bool, row[0] == 1)  # type: ignore[index]
 
 
 def truncate_tables(connection: Connection) -> None:
     """Truncate all the tables defined in the model."""
     for t in Base.metadata.sorted_tables:
-        connection.execute(f"TRUNCATE TABLE {t.schema}.{t.name} CASCADE;")
+        connection.execute(sqlalchemy.text(f"TRUNCATE TABLE {t.schema}.{t.name} CASCADE;"))
 
 
 def setup_test_data(dbsession: Session) -> None:

{c2cgeoportal_commons-2.8.1.146.dist-info → c2cgeoportal_commons-2.9.0.350.dist-info}/METADATA

@@ -1,13 +1,11 @@
 Metadata-Version: 2.1
 Name: c2cgeoportal-commons
-Version: 2.8.1.146
+Version: 2.9.0.350
 Summary: c2cgeoportal commons
 Home-page: https://github.com/camptocamp/c2cgeoportal/
 Author: Camptocamp
 Author-email: info@camptocamp.com
-License: UNKNOWN
 Keywords: web gis geoportail c2cgeoportal geocommune pyramid
-Platform: UNKNOWN
 Classifier: Development Status :: 6 - Mature
 Classifier: Environment :: Web Environment
 Classifier: Framework :: Pyramid
@@ -16,16 +14,15 @@ Classifier: License :: OSI Approved :: BSD License
 Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python
 Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.10
 Classifier: Topic :: Scientific/Engineering :: GIS
 Classifier: Typing :: Typed
+Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 Requires-Dist: GeoAlchemy2
-Requires-Dist: c2c.template
-Requires-Dist: jinja2 (>=3.1.3)
 Requires-Dist: papyrus
 Requires-Dist: pyramid
-Requires-Dist: setuptools (>=65.5.1)
+Requires-Dist: setuptools >=78.1.1
 Requires-Dist: sqlalchemy
 Requires-Dist: transaction
 Requires-Dist: zope.event
@@ -67,5 +64,3 @@ use `common/testing/initialized.py` to create the database (`development.ini` at
 ```
 make test
 ```
-
-