From ea1f96c2ebd641002b264869d7d671c786fb5773 Mon Sep 17 00:00:00 2001 From: Theo Pascoli Date: Thu, 30 Jan 2025 08:58:08 +0100 Subject: [PATCH] feat(area): rename area_name to area_id --- antarest/study/business/area_management.py | 2 +- .../variantstudy/model/command/move_area.py | 14 +++++++------- tests/storage/business/test_arealink_manager.py | 2 +- tests/variantstudy/test_command_factory.py | 2 +- 4 files changed, 10 insertions(+), 10 deletions(-) diff --git a/antarest/study/business/area_management.py b/antarest/study/business/area_management.py index 1871c876ac..854101bc25 100644 --- a/antarest/study/business/area_management.py +++ b/antarest/study/business/area_management.py @@ -684,7 +684,7 @@ def update_area_ui(self, study: Study, area_id: str, area_ui: UpdateAreaUi, laye file_study = self.storage_service.get_storage(study).get_raw(study) command = MoveArea( - area_name=area_id, + area_id=area_id, new_area_parameters=area_ui.model_dump(), layer=layer, command_context=self.storage_service.variant_study_service.command_factory.command_context, diff --git a/antarest/study/storage/variantstudy/model/command/move_area.py b/antarest/study/storage/variantstudy/model/command/move_area.py index 08ab6f5b1f..e98f03f493 100644 --- a/antarest/study/storage/variantstudy/model/command/move_area.py +++ b/antarest/study/storage/variantstudy/model/command/move_area.py @@ -36,7 +36,7 @@ class MoveArea(ICommand): # Command parameters # ================== - area_name: str + area_id: str new_area_parameters: t.Dict[str, t.Any] layer: str @@ -45,14 +45,14 @@ def _apply_config(self, study_data: FileStudyTreeConfig) -> t.Tuple[CommandOutpu return ( CommandOutput( status=True, - message=f"area '{self.area_name}' updated", + message=f"area '{self.area_id}' updated", ), {}, ) @override def _apply(self, study_data: FileStudy, listener: t.Optional[ICommandListener] = None) -> CommandOutput: - current_area = study_data.tree.get(["input", "areas", self.area_name, "ui"]) + current_area = study_data.tree.get(["input", "areas", self.area_id, "ui"]) if self.layer == "0": ui = current_area["ui"] @@ -63,7 +63,7 @@ def _apply(self, study_data: FileStudy, listener: t.Optional[ICommandListener] = current_area["layerY"][self.layer] = self.new_area_parameters["y"] current_area["layerColor"][self.layer] = ",".join(map(str, self.new_area_parameters["color_rgb"])) - study_data.tree.save(current_area, ["input", "areas", self.area_name, "ui"]) + study_data.tree.save(current_area, ["input", "areas", self.area_id, "ui"]) output, _ = self._apply_config(study_data.config) @@ -73,19 +73,19 @@ def _apply(self, study_data: FileStudy, listener: t.Optional[ICommandListener] = def to_dto(self) -> CommandDTO: return CommandDTO( action=CommandName.MOVE_AREA.value, - args={"area_name": self.area_name, "new_area_parameters": self.new_area_parameters, "layer": self.layer}, + args={"area_id": self.area_id, "new_area_parameters": self.new_area_parameters, "layer": self.layer}, study_version=self.study_version, ) @override def match_signature(self) -> str: - return str(self.command_name.value + MATCH_SIGNATURE_SEPARATOR + self.area_name) + return str(self.command_name.value + MATCH_SIGNATURE_SEPARATOR + self.area_id) @override def match(self, other: ICommand, equal: bool = False) -> bool: if not isinstance(other, MoveArea): return False - return self.area_name == other.area_name + return self.area_id == other.area_id @override def _create_diff(self, other: "ICommand") -> t.List["ICommand"]: diff --git a/tests/storage/business/test_arealink_manager.py b/tests/storage/business/test_arealink_manager.py index ea213915e6..5434c622cc 100644 --- a/tests/storage/business/test_arealink_manager.py +++ b/tests/storage/business/test_arealink_manager.py @@ -185,7 +185,7 @@ def test_area_crud(empty_study: FileStudy, matrix_service: SimpleMatrixService): id=None, action=CommandName.MOVE_AREA.value, args={ - "area_name": "test", + "area_id": "test", "new_area_parameters": { "x": 100, "y": 200, diff --git a/tests/variantstudy/test_command_factory.py b/tests/variantstudy/test_command_factory.py index 3996c3bd94..31f05f8140 100644 --- a/tests/variantstudy/test_command_factory.py +++ b/tests/variantstudy/test_command_factory.py @@ -41,7 +41,7 @@ CommandDTO(action=CommandName.REMOVE_AREA.value, args=[{"id": "id"}], study_version=STUDY_VERSION_8_8), CommandDTO( action=CommandName.MOVE_AREA.value, - args={"area_name": "id", "new_area_parameters": {}, "layer": "0"}, + args={"area_id": "id", "new_area_parameters": {}, "layer": "0"}, study_version=STUDY_VERSION_8_8, ), CommandDTO(