feat(api): add method read_study_api

src/antares/model/study.py

@@ -171,6 +171,24 @@ 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"))
+    json_study.pop("id")
+
+    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,6 +212,11 @@ def service(self) -> BaseStudyService:
         return self._study_service
 
     def read_areas(self) -> list[Area]:
+        area_list = self._area_service.read_areas()
+        areas = dict()
+        for area in area_list:
+            areas.update({area.id: area})
+
         return self._area_service.read_areas()
 
     def get_areas(self) -> MappingProxyType[str, 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,40 @@ 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):
+        base_url = "https://antares.com/api/v1"
+        url = f"{base_url}/studies/{self.study_id}"
+        area_url = f"{url}/areas"
+        json_study = {
+            "id": "22c52f44-4c2a-407b-862b-490887f93dd8",
+            "name": "test_read_areas",
+            "version": "880",
+        }
+
+        settings = StudySettings()
+        settings.general_parameters = GeneralParameters(mode="Adequacy")
+
+        config_urls = re.compile(f"https://antares.com/api/v1/studies/{self.study_id}/config/.*")
+
+        with requests_mock.Mocker() as mocker:
+            mocker.get(url, json=json_study)
+            mocker.get(config_urls, json={})
+            mocker.get(area_url, json={})
+            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_settings = StudySettings(**json_study)
+
+            expected_study = Study(
+                expected_study_name,
+                expected_study_version,
+                ServiceFactory(self.api, expected_study_id, expected_study_name),
+                expected_study_settings,
+            )
+
+            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
@@ -51,6 +51,12 @@ def test_creation_lifecycle(self, antares_web: AntaresWebDesktop):
 
         study = create_study_api("antares-craft-test", "880", api_config)
 
+        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
+
         # tests area creation with default values
         area_name = "FR"
         area_fr = study.create_area(area_name)