feat(api): add method read_study_api

src/antares/model/study.py

@@ -171,6 +171,23 @@ def _directory_not_exists(local_path: Path) -> None:
     )
 
 
+def read_study_api(api_config: APIconf, study_id: str) -> "Study":
+    session = api_config.set_up_api_conf()
+    wrapper = RequestWrapper(session)
+    base_url = f"{api_config.get_host()}/api/v1"
+    json_study = wrapper.get(f"{base_url}/studies/{study_id}").json()
+
+    study_name = json_study.pop("name")
+    study_version = str(json_study.pop("version"))
+
+    study_settings = _returns_study_settings(base_url, study_id, wrapper, False, None)
+    study = Study(study_name, study_version, ServiceFactory(api_config, study_id, study_name), study_settings)
+
+    study.read_areas()
+
+    return study
+
+
 class Study:
     def __init__(
         self,
@@ -194,7 +211,13 @@ def service(self) -> BaseStudyService:
         return self._study_service
 
     def read_areas(self) -> list[Area]:
-        return self._area_service.read_areas()
+        """
+        Synchronize the internal study object with the actual object written in an antares study
+        Returns: the synchronized area list
+        """
+        area_list = self._area_service.read_areas()
+        self._areas = {area.id: area for area in area_list}
+        return area_list
 
     def get_areas(self) -> MappingProxyType[str, Area]:
         return MappingProxyType(dict(sorted(self._areas.items())))

src/antares/service/api_services/area_api.py

@@ -560,7 +560,6 @@ def read_areas(self) -> List[Area]:
         base_api_url = f"{self._base_url}/studies/{self.study_id}/areas"
         ui_url = "ui=true"
         url_properties_form = "properties/form"
-
         json_resp = self._wrapper.get(base_api_url + "?" + ui_url).json()
         for area in json_resp:
             area_url = base_api_url + "/" + f"{area}/"

tests/antares/services/api_services/test_study_api.py

@@ -30,7 +30,7 @@
 from antares.model.link import Link, LinkProperties, LinkUi
 from antares.model.settings.general import GeneralParameters
 from antares.model.settings.study_settings import StudySettings
-from antares.model.study import Study, create_study_api
+from antares.model.study import Study, create_study_api, read_study_api
 from antares.service.service_factory import ServiceFactory
 
 
@@ -199,3 +199,103 @@ def test_create_binding_constraint_fails(self):
                 match=f"Could not create the binding constraint {constraint_name}: {self.antares_web_description_msg}",
             ):
                 self.study.create_binding_constraint(name=constraint_name)
+
+    def test_read_study_api(self):
+        json_study = {
+            "id": "22c52f44-4c2a-407b-862b-490887f93dd8",
+            "name": "test_read_areas",
+            "version": "880",
+        }
+
+        json_ui = {
+            "zone": {
+                "ui": {"x": 0, "y": 0, "color_r": 230, "color_g": 108, "color_b": 44, "layers": "0"},
+                "layerX": {"0": 0},
+                "layerY": {"0": 0},
+                "layerColor": {"0": "230, 108, 44"},
+            }
+        }
+
+        json_thermal = [
+            {
+                "id": "therm_un",
+                "group": "Gas",
+                "name": "therm_un",
+                "enabled": "true",
+                "unitCount": 1,
+                "nominalCapacity": 0,
+            }
+        ]
+
+        json_renewable = [
+            {
+                "id": "test_renouvelable",
+                "group": "Solar Thermal",
+                "name": "test_renouvelable",
+                "enabled": "true",
+                "unitCount": 1,
+                "nominalCapacity": 0,
+                "tsInterpretation": "power-generation",
+            }
+        ]
+
+        json_st_storage = [
+            {
+                "id": "test_storage",
+                "group": "Pondage",
+                "name": "test_storage",
+                "injectionNominalCapacity": 0,
+                "withdrawalNominalCapacity": 0,
+                "reservoirCapacity": 0,
+                "efficiency": 1,
+                "initialLevel": 0.5,
+                "initialLevelOptim": "false",
+                "enabled": "true",
+            }
+        ]
+
+        json_properties = {
+            "energyCostUnsupplied": 0,
+            "energyCostSpilled": 0,
+            "nonDispatchPower": "true",
+            "dispatchHydroPower": "true",
+            "otherDispatchPower": "true",
+            "filterSynthesis": ["weekly", "daily", "hourly", "monthly", "annual"],
+            "filterByYear": ["weekly", "daily", "hourly", "monthly", "annual"],
+            "adequacyPatchMode": "outside",
+        }
+
+        config_urls = re.compile(f"https://antares.com/api/v1/studies/{self.study_id}/config/.*")
+
+        base_url = "https://antares.com/api/v1"
+        url = f"{base_url}/studies/{self.study_id}"
+        area_url = f"{url}/areas"
+        area_props_url = f"{area_url}/zone/properties/form"
+        thermal_url = f"{area_url}/zone/clusters/thermal"
+        renewable_url = f"{area_url}/zone/clusters/renewable"
+        storage_url = f"{area_url}/zone/storages"
+
+        with requests_mock.Mocker() as mocker:
+            mocker.get(url, json=json_study)
+            mocker.get(config_urls, json={})
+            mocker.get(area_url, json=json_ui)
+            mocker.get(area_props_url, json=json_properties)
+            mocker.get(renewable_url, json=json_renewable)
+            mocker.get(thermal_url, json=json_thermal)
+            mocker.get(storage_url, json=json_st_storage)
+            actual_study = read_study_api(self.api, self.study_id)
+
+            expected_study_name = json_study.pop("name")
+            expected_study_id = json_study.pop("id")
+            expected_study_version = json_study.pop("version")
+
+            expected_study = Study(
+                expected_study_name,
+                expected_study_version,
+                ServiceFactory(self.api, expected_study_id, expected_study_name),
+                None,
+            )
+
+            assert actual_study.name == expected_study.name
+            assert actual_study.version == expected_study.version
+            assert actual_study.service.study_id == expected_study.service.study_id

tests/integration/test_web_client.py

@@ -30,7 +30,7 @@
 from antares.model.settings.general import GeneralParameters, Mode
 from antares.model.settings.study_settings import PlaylistParameters, StudySettings
 from antares.model.st_storage import STStorageGroup, STStorageMatrixName, STStorageProperties
-from antares.model.study import create_study_api
+from antares.model.study import create_study_api, read_study_api
 from antares.model.thermal import ThermalClusterGroup, ThermalClusterProperties
 
 from tests.integration.antares_web_desktop import AntaresWebDesktop
@@ -219,6 +219,26 @@ def test_creation_lifecycle(self, antares_web: AntaresWebDesktop):
         assert actual_hydro.area_id == area_fr.id
         assert actual_hydro.properties == area_fr.hydro.properties
 
+        # tests study reading method and comparing ids, name, areas and settings
+        actual_study = read_study_api(api_config, study.service.study_id)
+
+        assert study.service.study_id == actual_study.service.study_id
+        assert study.name == actual_study.name
+        assert study.version == actual_study.version
+        assert list(study.get_areas().keys()) == list(actual_study.get_areas().keys())
+        assert (
+            study.get_areas()["fr"].get_thermals().get("cluster_test").id
+            == actual_study.get_areas()["fr"].get_thermals().get("cluster_test").id
+        )
+        assert (
+            study.get_areas()["fr"].get_renewables().get("cluster_test").id
+            == actual_study.get_areas()["fr"].get_renewables().get("cluster_test").id
+        )
+        assert (
+            study.get_areas()["fr"].get_st_storages().get("cluster_test").id
+            == actual_study.get_areas()["fr"].get_st_storages().get("cluster_test").id
+        )
+
         # test short term storage creation with properties
         st_storage_name = "wind_onshore"
         storage_properties = STStorageProperties(reservoir_capacity=0.5)