rebase with dev

alembic/versions/bae9c99bc42d_add_user_name_and_updated_at_to_commands.py

@@ -0,0 +1,36 @@
+"""add_user_name_and_updated_at_to_commands
+
+Revision ID: bae9c99bc42d
+Revises: 00a9ceb38842
+Create Date: 2024-11-29 09:13:04.292874
+
+"""
+from alembic import op
+import sqlalchemy as sa
+
+
+# revision identifiers, used by Alembic.
+revision = 'bae9c99bc42d'
+down_revision = '00a9ceb38842'
+branch_labels = None
+depends_on = None
+
+USER_ID_FKEY = 'commandblock_user_id_fk'
+
+
+def upgrade():
+    # ### commands auto generated by Alembic - please adjust! ###
+    with op.batch_alter_table('commandblock', schema=None) as batch_op:
+        batch_op.add_column(sa.Column('user_id', sa.Integer(), nullable=True))
+        batch_op.add_column(sa.Column('updated_at', sa.DateTime(), nullable=True))
+        batch_op.create_foreign_key(USER_ID_FKEY, 'identities', ['user_id'], ['id'], ondelete='SET NULL')
+    # ### end Alembic commands ###
+
+
+def downgrade():
+    # ### commands auto generated by Alembic - please adjust! ###
+    with op.batch_alter_table('commandblock', schema=None) as batch_op:
+        batch_op.drop_constraint(USER_ID_FKEY, type_='foreignkey')
+        batch_op.drop_column('updated_at')
+        batch_op.drop_column('user_id')
+    # ### end Alembic commands ###

antarest/__init__.py

@@ -19,9 +19,9 @@
 
 # Standard project metadata
 
-__version__ = "2.18.1"
+__version__ = "2.18.3"
 __author__ = "RTE, Antares Web Team"
-__date__ = "2024-12-02"
+__date__ = "2024-12-17"
 # noinspection SpellCheckingInspection
 __credits__ = "(c) Réseau de Transport de l’Électricité (RTE)"
 

antarest/core/cache/business/local_chache.py

@@ -15,6 +15,8 @@
 import time
 from typing import Dict, List, Optional
 
+from typing_extensions import override
+
 from antarest.core.config import CacheConfig
 from antarest.core.interfaces.cache import ICache
 from antarest.core.model import JSON
@@ -40,6 +42,7 @@ def __init__(self, config: CacheConfig = CacheConfig()):
             daemon=True,
         )
 
+    @override
     def start(self) -> None:
         self.checker_thread.start()
 
@@ -55,6 +58,7 @@ def checker(self) -> None:
                 for id in to_delete:
                     del self.cache[id]
 
+    @override
     def put(self, id: str, data: JSON, duration: int = 3600) -> None:  # Duration in second
         with self.lock:
             logger.info(f"Adding cache key {id}")
@@ -64,6 +68,7 @@ def put(self, id: str, data: JSON, duration: int = 3600) -> None:  # Duration in
                 duration=duration,
             )
 
+    @override
     def get(self, id: str, refresh_duration: Optional[int] = None) -> Optional[JSON]:
         res = None
         with self.lock:
@@ -76,12 +81,14 @@ def get(self, id: str, refresh_duration: Optional[int] = None) -> Optional[JSON]
                 res = self.cache[id].data
         return res
 
+    @override
     def invalidate(self, id: str) -> None:
         with self.lock:
             logger.info(f"Removing cache key {id}")
             if id in self.cache:
                 del self.cache[id]
 
+    @override
     def invalidate_all(self, ids: List[str]) -> None:
         with self.lock:
             logger.info(f"Removing cache keys {ids}")

antarest/core/cache/business/redis_cache.py

@@ -14,6 +14,7 @@
 from typing import List, Optional
 
 from redis.client import Redis
+from typing_extensions import override
 
 from antarest.core.interfaces.cache import ICache
 from antarest.core.model import JSON
@@ -31,17 +32,20 @@ class RedisCache(ICache):
     def __init__(self, redis_client: Redis):  # type: ignore
         self.redis = redis_client
 
+    @override
     def start(self) -> None:
         # Assuming the Redis service is already running; no need to start it here.
         pass
 
+    @override
     def put(self, id: str, data: JSON, duration: int = 3600) -> None:
         redis_element = RedisCacheElement(duration=duration, data=data)
         redis_key = f"cache:{id}"
         logger.info(f"Adding cache key {id}")
         self.redis.set(redis_key, redis_element.model_dump_json())
         self.redis.expire(redis_key, duration)
 
+    @override
     def get(self, id: str, refresh_timeout: Optional[int] = None) -> Optional[JSON]:
         redis_key = f"cache:{id}"
         result = self.redis.get(redis_key)
@@ -58,10 +62,12 @@ def get(self, id: str, refresh_timeout: Optional[int] = None) -> Optional[JSON]:
         logger.info(f"Cache key {id} not found")
         return None
 
+    @override
     def invalidate(self, id: str) -> None:
         logger.info(f"Removing cache key {id}")
         self.redis.delete(f"cache:{id}")
 
+    @override
     def invalidate_all(self, ids: List[str]) -> None:
         logger.info(f"Removing cache keys {ids}")
         self.redis.delete(*[f"cache:{id}" for id in ids])

antarest/core/configdata/model.py

@@ -14,6 +14,7 @@
 from typing import Any, Optional
 
 from sqlalchemy import Column, Integer, String  # type: ignore
+from typing_extensions import override
 
 from antarest.core.persistence import Base
 from antarest.core.serialization import AntaresBaseModel
@@ -30,11 +31,13 @@ class ConfigData(Base):  # type: ignore
     key = Column(String(), primary_key=True)
     value = Column(String(), nullable=True)
 
+    @override
     def __eq__(self, other: Any) -> bool:
         if not isinstance(other, ConfigData):
             return False
         return bool(other.key == self.key and other.value == self.value and other.owner == self.owner)
 
+    @override
     def __repr__(self) -> str:
         return f"key={self.key}, value={self.value}, owner={self.owner}"
 

antarest/core/exceptions.py

@@ -15,6 +15,7 @@
 from http import HTTPStatus
 
 from fastapi.exceptions import HTTPException
+from typing_extensions import override
 
 
 class ShouldNotHappenException(Exception):
@@ -81,6 +82,7 @@ def __init__(self, path: str, *area_ids: str):
             detail = f"{self.object_name.title()} {detail}"
         super().__init__(HTTPStatus.NOT_FOUND, detail)
 
+    @override
     def __str__(self) -> str:
         """Return a string representation of the exception."""
         return self.detail
@@ -127,6 +129,7 @@ def __init__(self, path: str, section_id: str):
         detail = f"{object_name.title()} '{section_id}' not found in '{path}'"
         super().__init__(HTTPStatus.NOT_FOUND, detail)
 
+    @override
     def __str__(self) -> str:
         """Return a string representation of the exception."""
         return self.detail
@@ -172,6 +175,7 @@ def __init__(self, path: str):
             detail = f"{self.object_name.title()} {detail}"
         super().__init__(HTTPStatus.NOT_FOUND, detail)
 
+    @override
     def __str__(self) -> str:
         return self.detail
 
@@ -227,6 +231,7 @@ def __init__(self, area_id: str, *duplicates: str):
             detail = f"{self.object_name.title()} {detail}"
         super().__init__(HTTPStatus.CONFLICT, detail)
 
+    @override
     def __str__(self) -> str:
         """Return a string representation of the exception."""
         return self.detail
@@ -397,6 +402,7 @@ def __init__(self, object_id: str, binding_ids: t.Sequence[str], *, object_type:
         )
         super().__init__(HTTPStatus.FORBIDDEN, message)
 
+    @override
     def __str__(self) -> str:
         """Return a string representation of the exception."""
         return self.detail
@@ -429,6 +435,7 @@ def __init__(self, output_id: str) -> None:
         message = f"Output '{output_id}' not found"
         super().__init__(HTTPStatus.NOT_FOUND, message)
 
+    @override
     def __str__(self) -> str:
         """Return a string representation of the exception."""
         return self.detail
@@ -463,6 +470,7 @@ def __init__(self, output_id: str, mc_root: str) -> None:
         message = f"The output '{output_id}' sub-folder '{mc_root}' does not exist"
         super().__init__(HTTPStatus.NOT_FOUND, message)
 
+    @override
     def __str__(self) -> str:
         """Return a string representation of the exception."""
         return self.detail
@@ -552,6 +560,7 @@ def __init__(self, binding_constraint_id: str, *ids: str) -> None:
         }[min(count, 2)]
         super().__init__(HTTPStatus.NOT_FOUND, message)
 
+    @override
     def __str__(self) -> str:
         """Return a string representation of the exception."""
         return self.detail
@@ -572,6 +581,7 @@ def __init__(self, binding_constraint_id: str, *ids: str) -> None:
         }[min(count, 2)]
         super().__init__(HTTPStatus.CONFLICT, message)
 
+    @override
     def __str__(self) -> str:
         """Return a string representation of the exception."""
         return self.detail
@@ -589,6 +599,7 @@ def __init__(self, binding_constraint_id: str, term_json: str) -> None:
         )
         super().__init__(HTTPStatus.UNPROCESSABLE_ENTITY, message)
 
+    @override
     def __str__(self) -> str:
         """Return a string representation of the exception."""
         return self.detail
@@ -688,6 +699,11 @@ def __init__(self, message: str) -> None:
         super().__init__(HTTPStatus.NOT_FOUND, message)
 
 
+class PathIsAFolderError(HTTPException):
+    def __init__(self, message: str) -> None:
+        super().__init__(HTTPStatus.UNPROCESSABLE_ENTITY, message)
+
+
 class WorkspaceNotFound(HTTPException):
     """
     This will be raised when we try to load a workspace that does not exist

antarest/core/filetransfer/model.py

@@ -16,6 +16,7 @@
 from typing import Optional
 
 from sqlalchemy import Boolean, Column, DateTime, Integer, String  # type: ignore
+from typing_extensions import override
 
 from antarest.core.persistence import Base
 from antarest.core.serialization import AntaresBaseModel
@@ -81,6 +82,7 @@ def to_dto(self) -> FileDownloadDTO:
             error_message=self.error_message or "",
         )
 
+    @override
     def __repr__(self) -> str:
         return (
             f"(id={self.id},"

antarest/core/interfaces/eventbus.py

@@ -14,6 +14,8 @@
 from enum import StrEnum
 from typing import Any, Awaitable, Callable, List, Optional
 
+from typing_extensions import override
+
 from antarest.core.model import PermissionInfo
 from antarest.core.serialization import AntaresBaseModel
 
@@ -140,32 +142,39 @@ class DummyEventBusService(IEventBus):
     def __init__(self) -> None:
         self.events: List[Event] = []
 
+    @override
     def queue(self, event: Event, queue: str) -> None:
         # Noop
         pass
 
+    @override
     def add_queue_consumer(self, listener: Callable[[Event], Awaitable[None]], queue: str) -> str:
         return ""
 
+    @override
     def remove_queue_consumer(self, listener_id: str) -> None:
         # Noop
         pass
 
+    @override
     def push(self, event: Event) -> None:
         # Noop
         self.events.append(event)
 
+    @override
     def add_listener(
         self,
         listener: Callable[[Event], Awaitable[None]],
         type_filter: Optional[List[EventType]] = None,
     ) -> str:
         return ""
 
+    @override
     def remove_listener(self, listener_id: str) -> None:
         # Noop
         pass
 
+    @override
     def start(self, threaded: bool = True) -> None:
         # Noop
         pass

antarest/core/logging/utils.py

@@ -20,6 +20,7 @@
 from starlette.middleware.base import BaseHTTPMiddleware, RequestResponseEndpoint
 from starlette.requests import Request
 from starlette.responses import Response
+from typing_extensions import override
 
 from antarest.core.config import Config
 
@@ -39,6 +40,7 @@ class CustomDefaultFormatter(logging.Formatter):
     fields to the log record with a value of `None`.
     """
 
+    @override
     def format(self, record: logging.LogRecord) -> str:
         """
         Formats the specified log record using the custom formatter,
@@ -169,13 +171,15 @@ def configure_logger(config: Config, handler_cls: str = "logging.FileHandler") -
 
 
 class LoggingMiddleware(BaseHTTPMiddleware):
+    @override
     async def dispatch(self, request: Request, call_next: RequestResponseEndpoint) -> Response:
         with RequestContext(request):
             response = await call_next(request)
         return response
 
 
 class ContextFilter(logging.Filter):
+    @override
     def filter(self, record: logging.LogRecord) -> bool:
         request: Optional[Request] = _request.get()
         request_id: Optional[str] = _request_id.get()

antarest/core/model.py

@@ -13,6 +13,9 @@
 import enum
 from typing import TYPE_CHECKING, Any, Dict, List, Optional, Union
 
+import typing_extensions as te
+from pydantic import StringConstraints
+
 from antarest.core.serialization import AntaresBaseModel
 
 if TYPE_CHECKING:
@@ -22,6 +25,7 @@
 JSON = Dict[str, Any]
 ELEMENT = Union[str, int, float, bool, bytes]
 SUB_JSON = Union[ELEMENT, JSON, List[Any], None]
+LowerCaseStr = te.Annotated[str, StringConstraints(to_lower=True)]
 
 
 class PublicMode(enum.StrEnum):