welearn-database 1.4.4__tar.gz → 1.4.5.dev0__tar.gz

{welearn_database-1.4.4 → welearn_database-1.4.5.dev0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: welearn-database
-Version: 1.4.4
+Version: 1.4.5.dev0
 Summary: All stuff related to relationnal database from the WeLearn project
 License: cc-by-sa-nc
 Author: Théo

{welearn_database-1.4.4 → welearn_database-1.4.5.dev0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "welearn-database"
-version = "1.4.4"
+version = "1.4.5.dev0"
 description = "All stuff related to relationnal database from the WeLearn project"
 authors = [
     {name = "Théo",email = "theo.nardin@cri-paris.org"}

welearn_database-1.4.5.dev0/welearn_database/alembic/versions/8b780aea403a_add_university_data.py

@@ -0,0 +1,48 @@
+"""add_university_data
+
+Revision ID: 8b780aea403a
+Revises: f1ce0ad2845b
+Create Date: 2026-06-03 11:34:02.441435
+
+"""
+
+from typing import Sequence, Union
+
+import sqlalchemy as sa
+from alembic import op
+from sqlalchemy.dialects import postgresql
+
+# revision identifiers, used by Alembic.
+revision: str = "8b780aea403a"
+down_revision: Union[str, None] = "f1ce0ad2845b"
+branch_labels: Union[str, Sequence[str], None] = None
+depends_on: Union[str, Sequence[str], None] = None
+
+
+def upgrade() -> None:
+    op.add_column(
+        "inferred_user",
+        sa.Column("university_title", sa.String(), nullable=True),
+        schema="user_related",
+    )
+    op.add_column(
+        "inferred_user",
+        sa.Column(
+            "role",
+            postgresql.ENUM(
+                "student",
+                "teacher",
+                "staff",
+                name="university_role",
+                schema="user_related",
+            ),
+            nullable=True,
+        ),
+        schema="user_related",
+    )
+
+
+def downgrade() -> None:
+    op.drop_column("inferred_user", "university_title", schema="user_related")
+    op.drop_column("inferred_user", "role", schema="user_related")
+    op.execute("DROP TYPE user_related.university_role")

{welearn_database-1.4.4 → welearn_database-1.4.5.dev0}/welearn_database/data/enumeration.py

@@ -43,3 +43,9 @@ class ExternalIdType(StrEnum):
 class FilterType(StrEnum):
     SDG = auto()
     SOURCE = auto()
+
+
+class UniversityRole(StrEnum):
+    STUDENT = auto()
+    TEACHER = auto()
+    STAFF = auto()

{welearn_database-1.4.4 → welearn_database-1.4.5.dev0}/welearn_database/data/models/document_related.py

@@ -11,7 +11,6 @@ from sqlalchemy import (
     LargeBinary,
     UniqueConstraint,
     func,
-    text,
     types,
 )
 from sqlalchemy.dialects.postgresql import ARRAY, ENUM, TIMESTAMP

{welearn_database-1.4.4 → welearn_database-1.4.5.dev0}/welearn_database/data/models/user_related.py

@@ -3,11 +3,12 @@ from uuid import UUID
 
 from sqlalchemy import ForeignKey, func, types
 from sqlalchemy.dialects.postgresql import ENUM, TIMESTAMP
-from sqlalchemy.orm import Mapped, mapped_column, relationship
+from sqlalchemy.orm import Mapped, mapped_column, relationship, validates
 
-from welearn_database.data.enumeration import DbSchemaEnum, FilterType
+from welearn_database.data.enumeration import DbSchemaEnum, FilterType, UniversityRole
 from welearn_database.data.models.document_related import WeLearnDocument
 
+from ...exceptions import EarlyEnumerationVerificationError
 from . import Base
 
 schema_name = DbSchemaEnum.USER_RELATED.value
@@ -216,6 +217,15 @@ class InferredUser(Base):
         types.Uuid, primary_key=True, nullable=False, server_default="gen_random_uuid()"
     )
     origin_referrer: Mapped[str | None]
+    university_title: Mapped[str | None]
+    role: Mapped[str] = mapped_column(
+        ENUM(
+            *(r.value.lower() for r in UniversityRole),
+            name="university_role",
+            schema="user_related",
+        ),
+        nullable=True,
+    )
     created_at: Mapped[datetime] = mapped_column(
         TIMESTAMP(timezone=False),
         nullable=False,
@@ -223,6 +233,13 @@ class InferredUser(Base):
         server_default="NOW()",
     )
 
+    @validates("role")
+    def validate_role(self, key, value):
+        valid_roles = {r.value.lower() for r in UniversityRole}
+        if value not in valid_roles:
+            raise EarlyEnumerationVerificationError(f"Invalid role: {value}")
+        return value
+
 
 class EndpointRequest(Base):
     __tablename__ = "endpoint_request"

{welearn_database-1.4.4 → welearn_database-1.4.5.dev0}/welearn_database/exceptions.py

@@ -1,4 +1,10 @@
-class InvalidURLScheme(Exception):
+class WeLearnDatabaseException(Exception):
+    """
+    Base class for all WeLearnDatabase exceptions
+    """
+
+
+class InvalidURLScheme(WeLearnDatabaseException):
     """
     Scheme detected in URL is not accepted
     """
@@ -7,7 +13,7 @@ class InvalidURLScheme(Exception):
         super().__init__(msg, *args)
 
 
-class InvalidDOI(Exception):
+class InvalidDOI(WeLearnDatabaseException):
     """
     Scheme detected in DOI is not accepted
     """
@@ -16,7 +22,7 @@ class InvalidDOI(Exception):
         super().__init__(msg, *args)
 
 
-class ContentIsTooShort(Exception):
+class ContentIsTooShort(WeLearnDatabaseException):
     """
     The string used as content is too short, it should be at least 25 characters long
     """
@@ -27,3 +33,14 @@ class ContentIsTooShort(Exception):
         *args,
     ):
         super().__init__(msg, *args)
+
+
+class EarlyEnumerationVerificationError(WeLearnDatabaseException):
+    """
+    SQLAlchemy detect an enumeration value that is not in the list of accepted values
+    """
+
+    def __init__(
+        self, msg="Enumeration value is not in the list of accepted values", *args
+    ):
+        super().__init__(msg, *args)