feat(link): add update endpoint for link

antarest/core/exceptions.py

@@ -300,6 +300,11 @@ def __init__(self, message: str) -> None:
         super().__init__(HTTPStatus.UNPROCESSABLE_ENTITY, message)
 
 
+class LinkNotFound(HTTPException):
+    def __init__(self, message: str) -> None:
+        super().__init__(HTTPStatus.NOT_FOUND, message)
+
+
 class VariantStudyParentNotValid(HTTPException):
     def __init__(self, message: str) -> None:
         super().__init__(HTTPStatus.UNPROCESSABLE_ENTITY, message)

antarest/study/business/link_management.py

@@ -14,17 +14,19 @@
 
 from antares.study.version import StudyVersion
 
-from antarest.core.exceptions import ConfigFileNotFound
+from antarest.core.exceptions import ConfigFileNotFound, LinkNotFound, LinkValidationError
 from antarest.core.model import JSON
 from antarest.study.business.all_optional_meta import all_optional_model, camel_case_model
 from antarest.study.business.model.link_model import LinkDTO, LinkInternal
 from antarest.study.business.utils import execute_or_add_commands
 from antarest.study.model import RawStudy, Study
 from antarest.study.storage.rawstudy.model.filesystem.config.links import LinkProperties
+from antarest.study.storage.rawstudy.model.filesystem.factory import FileStudy
 from antarest.study.storage.storage_service import StudyStorageService
 from antarest.study.storage.variantstudy.model.command.create_link import CreateLink
 from antarest.study.storage.variantstudy.model.command.remove_link import RemoveLink
 from antarest.study.storage.variantstudy.model.command.update_config import UpdateConfig
+from antarest.study.storage.variantstudy.model.command.update_link import UpdateLink
 
 _ALL_LINKS_PATH = "input/links"
 
@@ -76,6 +78,49 @@ def create_link(self, study: Study, link_creation_dto: LinkDTO) -> LinkDTO:
 
         return link_creation_dto
 
+    def update_link(self, study: RawStudy, link_dto: LinkDTO) -> LinkDTO:
+        link = link_dto.to_internal(StudyVersion.parse(study.version))
+        file_study = self.storage_service.get_storage(study).get_raw(study)
+
+        self.check_link_existence(file_study, link)
+
+        command = UpdateLink(
+            area1=link.area1,
+            area2=link.area2,
+            parameters=link.model_dump(
+                include=link_dto.model_fields_set, exclude={"area1", "area2"}, exclude_none=True
+            ),
+            command_context=self.storage_service.variant_study_service.command_factory.command_context,
+            study_version=file_study.config.version,
+        )
+
+        execute_or_add_commands(study, file_study, [command], self.storage_service)
+
+        updated_link = self.get_internal_link(study, link)
+
+        return updated_link.to_dto()
+
+    def check_link_existence(self, file_study: FileStudy, link: LinkInternal) -> None:
+        area_from, area_to = sorted([link.area1, link.area2])
+        try:
+            file_study.tree.get(["input", "links", area_from, "properties", area_to])
+        except KeyError:
+            raise LinkNotFound(f"The link {area_from} -> {area_to} is not present in the study")
+
+    def get_internal_link(self, study: RawStudy, link: LinkInternal) -> LinkInternal:
+        file_study = self.storage_service.get_storage(study).get_raw(study)
+
+        area_from, area_to = sorted([link.area1, link.area2])
+        try:
+            link_properties = file_study.tree.get(["input", "links", area_from, "properties", area_to])
+        except KeyError:
+            raise LinkValidationError(f"The link {area_from} -> {area_to} is not present in the study")
+
+        link_properties.update({"area1": area_from, "area2": area_to})
+        updated_link = LinkInternal.model_validate(link_properties)
+
+        return updated_link
+
     def delete_link(self, study: RawStudy, area1_id: str, area2_id: str) -> None:
         file_study = self.storage_service.get_storage(study).get_raw(study)
         command = RemoveLink(

antarest/study/business/model/link_model.py

@@ -44,6 +44,9 @@ class Area(AntaresBaseModel):
     def validate_areas(self) -> t.Self:
         if self.area1 == self.area2:
             raise LinkValidationError(f"Cannot create a link that goes from and to the same single area: {self.area1}")
+        area_from, area_to = sorted([self.area1, self.area2])
+        self.area1 = area_from
+        self.area2 = area_to
         return self
 
 

antarest/study/business/table_mode_management.py

@@ -201,7 +201,11 @@ def update_table_data(
         elif table_type == TableModeType.LINK:
             links_map = {tuple(key.split(" / ")): LinkOutput(**values) for key, values in data.items()}
             updated_map = self._link_manager.update_links_props(study, links_map)  # type: ignore
-            excludes = set() if int(study.version) >= STUDY_VERSION_8_2 else {"filter_synthesis", "filter_year_by_year"}
+            excludes = (
+                set()
+                if StudyVersion.parse(study.version) >= STUDY_VERSION_8_2
+                else {"filter_synthesis", "filter_year_by_year"}
+            )
             data = {
                 f"{area1_id} / {area2_id}": link.model_dump(by_alias=True, exclude=excludes)
                 for (area1_id, area2_id), link in updated_map.items()

antarest/study/business/xpansion_management.py

@@ -21,7 +21,7 @@
 from fastapi import HTTPException, UploadFile
 from pydantic import Field, ValidationError, field_validator, model_validator
 
-from antarest.core.exceptions import BadZipBinary, ChildNotFoundError
+from antarest.core.exceptions import BadZipBinary, ChildNotFoundError, LinkNotFound
 from antarest.core.model import JSON
 from antarest.core.serialization import AntaresBaseModel
 from antarest.study.business.all_optional_meta import all_optional_model
@@ -255,11 +255,6 @@ class XpansionCandidateDTO(AntaresBaseModel):
     )
 
 
-class LinkNotFound(HTTPException):
-    def __init__(self, message: str) -> None:
-        super().__init__(http.HTTPStatus.NOT_FOUND, message)
-
-
 class XpansionFileNotFoundError(HTTPException):
     def __init__(self, message: str) -> None:
         super().__init__(http.HTTPStatus.NOT_FOUND, message)

antarest/study/service.py

@@ -1905,6 +1905,25 @@ def create_link(
         )
         return new_link
 
+    def update_link(
+        self,
+        uuid: str,
+        link_update_dto: LinkDTO,
+        params: RequestParameters,
+    ) -> LinkDTO:
+        study = self.get_study(uuid)
+        assert_permission(params.user, study, StudyPermissionType.WRITE)
+        self._assert_study_unarchived(study)
+        updated_link = self.links_manager.update_link(study, link_update_dto)
+        self.event_bus.push(
+            Event(
+                type=EventType.STUDY_DATA_EDITED,
+                payload=study.to_json_summary(),
+                permissions=PermissionInfo.from_study(study),
+            )
+        )
+        return updated_link
+
     def update_area(
         self,
         uuid: str,

antarest/study/storage/variantstudy/business/command_reverter.py

@@ -99,6 +99,10 @@ def _revert_create_link(base_command: CreateLink, history: t.List["ICommand"], b
             )
         ]
 
+    @staticmethod
+    def _revert_update_link(base_command: CreateLink, history: t.List["ICommand"], base: FileStudy) -> t.List[ICommand]:
+        raise NotImplementedError("The revert function for UpdateLink is not available")
+
     @staticmethod
     def _revert_remove_link(base_command: RemoveLink, history: t.List["ICommand"], base: FileStudy) -> t.List[ICommand]:
         raise NotImplementedError("The revert function for RemoveLink is not available")

antarest/study/storage/variantstudy/command_factory.py

@@ -43,6 +43,7 @@
 from antarest.study.storage.variantstudy.model.command.update_comments import UpdateComments
 from antarest.study.storage.variantstudy.model.command.update_config import UpdateConfig
 from antarest.study.storage.variantstudy.model.command.update_district import UpdateDistrict
+from antarest.study.storage.variantstudy.model.command.update_link import UpdateLink
 from antarest.study.storage.variantstudy.model.command.update_playlist import UpdatePlaylist
 from antarest.study.storage.variantstudy.model.command.update_raw_file import UpdateRawFile
 from antarest.study.storage.variantstudy.model.command.update_scenario_builder import UpdateScenarioBuilder
@@ -55,6 +56,7 @@
     CommandName.CREATE_DISTRICT.value: CreateDistrict,
     CommandName.REMOVE_DISTRICT.value: RemoveDistrict,
     CommandName.CREATE_LINK.value: CreateLink,
+    CommandName.UPDATE_LINK.value: UpdateLink,
     CommandName.REMOVE_LINK.value: RemoveLink,
     CommandName.CREATE_BINDING_CONSTRAINT.value: CreateBindingConstraint,
     CommandName.UPDATE_BINDING_CONSTRAINT.value: UpdateBindingConstraint,

antarest/study/storage/variantstudy/model/command/common.py

@@ -31,6 +31,7 @@ class CommandName(Enum):
     CREATE_DISTRICT = "create_district"
     REMOVE_DISTRICT = "remove_district"
     CREATE_LINK = "create_link"
+    UPDATE_LINK = "update_link"
     REMOVE_LINK = "remove_link"
     CREATE_BINDING_CONSTRAINT = "create_binding_constraint"
     UPDATE_BINDING_CONSTRAINT = "update_binding_constraint"