fix(matrix): rename upload in update inside user methods (#94)

src/antares/craft/model/st_storage.py

@@ -113,17 +113,17 @@ def get_upper_rule_curve(self) -> pd.DataFrame:
     def get_storage_inflows(self) -> pd.DataFrame:
         return self._storage_service.get_storage_matrix(self, STStorageMatrixName.INFLOWS)
 
-    def upload_pmax_injection(self, p_max_injection_matrix: pd.DataFrame) -> None:
-        self._storage_service.upload_storage_matrix(self, STStorageMatrixName.PMAX_INJECTION, p_max_injection_matrix)
+    def update_pmax_injection(self, p_max_injection_matrix: pd.DataFrame) -> None:
+        self._storage_service.update_storage_matrix(self, STStorageMatrixName.PMAX_INJECTION, p_max_injection_matrix)
 
-    def upload_pmax_withdrawal(self, p_max_withdrawal_matrix: pd.DataFrame) -> None:
-        self._storage_service.upload_storage_matrix(self, STStorageMatrixName.PMAX_WITHDRAWAL, p_max_withdrawal_matrix)
+    def update_pmax_withdrawal(self, p_max_withdrawal_matrix: pd.DataFrame) -> None:
+        self._storage_service.update_storage_matrix(self, STStorageMatrixName.PMAX_WITHDRAWAL, p_max_withdrawal_matrix)
 
-    def upload_lower_rule_curve(self, lower_rule_curve_matrix: pd.DataFrame) -> None:
-        self._storage_service.upload_storage_matrix(self, STStorageMatrixName.LOWER_CURVE_RULE, lower_rule_curve_matrix)
+    def update_lower_rule_curve(self, lower_rule_curve_matrix: pd.DataFrame) -> None:
+        self._storage_service.update_storage_matrix(self, STStorageMatrixName.LOWER_CURVE_RULE, lower_rule_curve_matrix)
 
-    def upload_upper_rule_curve(self, upper_rule_curve_matrix: pd.DataFrame) -> None:
-        self._storage_service.upload_storage_matrix(self, STStorageMatrixName.UPPER_RULE_CURVE, upper_rule_curve_matrix)
+    def update_upper_rule_curve(self, upper_rule_curve_matrix: pd.DataFrame) -> None:
+        self._storage_service.update_storage_matrix(self, STStorageMatrixName.UPPER_RULE_CURVE, upper_rule_curve_matrix)
 
-    def upload_storage_inflows(self, inflows_matrix: pd.DataFrame) -> None:
-        self._storage_service.upload_storage_matrix(self, STStorageMatrixName.INFLOWS, inflows_matrix)
+    def update_storage_inflows(self, inflows_matrix: pd.DataFrame) -> None:
+        self._storage_service.update_storage_matrix(self, STStorageMatrixName.INFLOWS, inflows_matrix)

src/antares/craft/service/api_services/services/area.py

@@ -41,7 +41,7 @@
 from antares.craft.service.api_services.models.renewable import RenewableClusterPropertiesAPI
 from antares.craft.service.api_services.models.st_storage import STStoragePropertiesAPI
 from antares.craft.service.api_services.models.thermal import ThermalClusterPropertiesAPI
-from antares.craft.service.api_services.utils import get_matrix, upload_series
+from antares.craft.service.api_services.utils import get_matrix, update_series
 from antares.craft.service.base_services import (
     BaseAreaService,
     BaseHydroService,
@@ -202,19 +202,19 @@ def create_thermal_cluster(
             # Upload matrices
             if prepro is not None:
                 matrix_path = f"input/thermal/prepro/{area_id}/{thermal_id}/data"
-                upload_series(self._base_url, self.study_id, self._wrapper, prepro, matrix_path)
+                update_series(self._base_url, self.study_id, self._wrapper, prepro, matrix_path)
             if modulation is not None:
                 matrix_path = f"input/thermal/prepro/{area_id}/{thermal_id}/modulation"
-                upload_series(self._base_url, self.study_id, self._wrapper, modulation, matrix_path)
+                update_series(self._base_url, self.study_id, self._wrapper, modulation, matrix_path)
             if series is not None:
                 matrix_path = f"input/thermal/series/{area_id}/{thermal_id}/series"
-                upload_series(self._base_url, self.study_id, self._wrapper, series, matrix_path)
+                update_series(self._base_url, self.study_id, self._wrapper, series, matrix_path)
             if co2_cost is not None:
                 matrix_path = f"input/thermal/series/{area_id}/{thermal_id}/CO2Cost"
-                upload_series(self._base_url, self.study_id, self._wrapper, co2_cost, matrix_path)
+                update_series(self._base_url, self.study_id, self._wrapper, co2_cost, matrix_path)
             if fuel_cost is not None:
                 matrix_path = f"input/thermal/series/{area_id}/{thermal_id}/fuelCost"
-                upload_series(self._base_url, self.study_id, self._wrapper, fuel_cost, matrix_path)
+                update_series(self._base_url, self.study_id, self._wrapper, fuel_cost, matrix_path)
 
         except APIError as e:
             raise ThermalCreationError(cluster_name, area_id, e.message) from e
@@ -322,39 +322,39 @@ def create_load(self, area_id: str, series: pd.DataFrame) -> None:
             expected_rows = 8760
             if rows_number < expected_rows:
                 raise MatrixUploadError(area_id, "load", f"Expected {expected_rows} rows and received {rows_number}.")
-            upload_series(self._base_url, self.study_id, self._wrapper, series, series_path)
+            update_series(self._base_url, self.study_id, self._wrapper, series, series_path)
         except APIError as e:
             raise MatrixUploadError(area_id, "load", e.message) from e
 
     @override
     def create_wind(self, area_id: str, series: pd.DataFrame) -> None:
         try:
             series_path = f"input/wind/series/wind_{area_id}"
-            upload_series(self._base_url, self.study_id, self._wrapper, series, series_path)
+            update_series(self._base_url, self.study_id, self._wrapper, series, series_path)
         except APIError as e:
             raise MatrixUploadError(area_id, "wind", e.message) from e
 
     @override
     def create_reserves(self, area_id: str, series: pd.DataFrame) -> None:
         try:
             series_path = f"input/reserves/{area_id}"
-            upload_series(self._base_url, self.study_id, self._wrapper, series, series_path)
+            update_series(self._base_url, self.study_id, self._wrapper, series, series_path)
         except APIError as e:
             raise MatrixUploadError(area_id, "reserves", e.message) from e
 
     @override
     def create_solar(self, area_id: str, series: pd.DataFrame) -> None:
         try:
             series_path = f"input/solar/series/solar_{area_id}"
-            upload_series(self._base_url, self.study_id, self._wrapper, series, series_path)
+            update_series(self._base_url, self.study_id, self._wrapper, series, series_path)
         except APIError as e:
             raise MatrixUploadError(area_id, "solar", e.message) from e
 
     @override
     def create_misc_gen(self, area_id: str, series: pd.DataFrame) -> None:
         try:
             series_path = f"input/misc-gen/miscgen-{area_id}"
-            upload_series(self._base_url, self.study_id, self._wrapper, series, series_path)
+            update_series(self._base_url, self.study_id, self._wrapper, series, series_path)
         except APIError as e:
             raise MatrixUploadError(area_id, "misc-gen", e.message) from e
 

src/antares/craft/service/api_services/services/hydro.py

@@ -23,7 +23,7 @@
 )
 from antares.craft.model.hydro import HydroProperties, HydroPropertiesUpdate
 from antares.craft.service.api_services.models.hydro import HydroPropertiesAPI
-from antares.craft.service.api_services.utils import get_matrix, upload_series
+from antares.craft.service.api_services.utils import get_matrix, update_series
 from antares.craft.service.base_services import BaseHydroService
 from typing_extensions import override
 
@@ -134,7 +134,7 @@ def get_energy(self, area_id: str) -> pd.DataFrame:
     @override
     def update_maxpower(self, area_id: str, series: pd.DataFrame) -> None:
         try:
-            upload_series(
+            update_series(
                 self._base_url, self.study_id, self._wrapper, series, f"input/hydro/common/capacity/maxpower_{area_id}"
             )
         except APIError as e:
@@ -143,7 +143,7 @@ def update_maxpower(self, area_id: str, series: pd.DataFrame) -> None:
     @override
     def update_reservoir(self, area_id: str, series: pd.DataFrame) -> None:
         try:
-            upload_series(
+            update_series(
                 self._base_url, self.study_id, self._wrapper, series, f"input/hydro/common/capacity/reservoir_{area_id}"
             )
         except APIError as e:
@@ -152,7 +152,7 @@ def update_reservoir(self, area_id: str, series: pd.DataFrame) -> None:
     @override
     def update_inflow_pattern(self, area_id: str, series: pd.DataFrame) -> None:
         try:
-            upload_series(
+            update_series(
                 self._base_url,
                 self.study_id,
                 self._wrapper,
@@ -165,7 +165,7 @@ def update_inflow_pattern(self, area_id: str, series: pd.DataFrame) -> None:
     @override
     def update_credits_modulation(self, area_id: str, series: pd.DataFrame) -> None:
         try:
-            upload_series(
+            update_series(
                 self._base_url,
                 self.study_id,
                 self._wrapper,
@@ -178,7 +178,7 @@ def update_credits_modulation(self, area_id: str, series: pd.DataFrame) -> None:
     @override
     def update_water_values(self, area_id: str, series: pd.DataFrame) -> None:
         try:
-            upload_series(
+            update_series(
                 self._base_url,
                 self.study_id,
                 self._wrapper,
@@ -191,14 +191,14 @@ def update_water_values(self, area_id: str, series: pd.DataFrame) -> None:
     @override
     def update_ror_series(self, area_id: str, series: pd.DataFrame) -> None:
         try:
-            upload_series(self._base_url, self.study_id, self._wrapper, series, f"input/hydro/series/{area_id}/ror")
+            update_series(self._base_url, self.study_id, self._wrapper, series, f"input/hydro/series/{area_id}/ror")
         except APIError as e:
             raise MatrixUploadError(area_id, "ror", e.message) from e
 
     @override
     def update_mod_series(self, area_id: str, series: pd.DataFrame) -> None:
         try:
-            upload_series(
+            update_series(
                 self._base_url,
                 self.study_id,
                 self._wrapper,
@@ -211,7 +211,7 @@ def update_mod_series(self, area_id: str, series: pd.DataFrame) -> None:
     @override
     def update_mingen(self, area_id: str, series: pd.DataFrame) -> None:
         try:
-            upload_series(
+            update_series(
                 self._base_url,
                 self.study_id,
                 self._wrapper,
@@ -224,7 +224,7 @@ def update_mingen(self, area_id: str, series: pd.DataFrame) -> None:
     @override
     def update_energy(self, area_id: str, series: pd.DataFrame) -> None:
         try:
-            upload_series(
+            update_series(
                 self._base_url,
                 self.study_id,
                 self._wrapper,

src/antares/craft/service/api_services/services/link.py

@@ -28,7 +28,7 @@
 )
 from antares.craft.model.link import Link, LinkProperties, LinkPropertiesUpdate, LinkUi, LinkUiUpdate
 from antares.craft.service.api_services.models.link import LinkPropertiesAndUiAPI
-from antares.craft.service.api_services.utils import get_matrix, upload_series
+from antares.craft.service.api_services.utils import get_matrix, update_series
 from antares.craft.service.base_services import BaseLinkService
 from typing_extensions import override
 
@@ -148,7 +148,7 @@ def get_parameters(self, area_from: str, area_to: str) -> pd.DataFrame:
     def create_parameters(self, series: pd.DataFrame, area_from: str, area_to: str) -> None:
         try:
             series_path = f"input/links/{area_from}/{area_to}_parameters"
-            upload_series(self._base_url, self.study_id, self._wrapper, series, series_path)
+            update_series(self._base_url, self.study_id, self._wrapper, series, series_path)
         except APIError as e:
             raise LinkUploadError(area_from, area_to, "parameters", e.message) from e
 
@@ -165,7 +165,7 @@ def get_capacity_direct(self, area_from: str, area_to: str) -> pd.DataFrame:
     def create_capacity_direct(self, series: pd.DataFrame, area_from: str, area_to: str) -> None:
         try:
             series_path = f"input/links/{area_from}/capacities/{area_to}_direct"
-            upload_series(self._base_url, self.study_id, self._wrapper, series, series_path)
+            update_series(self._base_url, self.study_id, self._wrapper, series, series_path)
         except APIError as e:
             raise LinkUploadError(area_from, area_to, "directcapacity", e.message) from e
 
@@ -182,7 +182,7 @@ def get_capacity_indirect(self, area_from: str, area_to: str) -> pd.DataFrame:
     def create_capacity_indirect(self, series: pd.DataFrame, area_from: str, area_to: str) -> None:
         try:
             series_path = f"input/links/{area_from}/capacities/{area_to}_indirect"
-            upload_series(self._base_url, self.study_id, self._wrapper, series, series_path)
+            update_series(self._base_url, self.study_id, self._wrapper, series, series_path)
         except APIError as e:
             raise LinkUploadError(area_from, area_to, "indirectcapacity", e.message) from e
 

src/antares/craft/service/api_services/services/renewable.py

@@ -25,7 +25,7 @@
 )
 from antares.craft.model.renewable import RenewableCluster, RenewableClusterProperties, RenewableClusterPropertiesUpdate
 from antares.craft.service.api_services.models.renewable import RenewableClusterPropertiesAPI
-from antares.craft.service.api_services.utils import get_matrix, upload_series
+from antares.craft.service.api_services.utils import get_matrix, update_series
 from antares.craft.service.base_services import BaseRenewableService
 from typing_extensions import override
 
@@ -73,7 +73,7 @@ def update_renewable_matrix(self, renewable_cluster: RenewableCluster, matrix: p
                 / "series"
             )
 
-            upload_series(self._base_url, self.study_id, self._wrapper, matrix, path.as_posix())
+            update_series(self._base_url, self.study_id, self._wrapper, matrix, path.as_posix())
         except APIError as e:
             raise RenewableMatrixUpdateError(renewable_cluster.area_id, renewable_cluster.id, e.message) from e
 

src/antares/craft/service/api_services/services/st_storage.py

@@ -64,7 +64,7 @@ def update_st_storage_properties(
         return new_properties
 
     @override
-    def upload_storage_matrix(self, storage: STStorage, ts_name: STStorageMatrixName, matrix: pd.DataFrame) -> None:
+    def update_storage_matrix(self, storage: STStorage, ts_name: STStorageMatrixName, matrix: pd.DataFrame) -> None:
         url = f"{self._base_url}/studies/{self.study_id}/areas/{storage.area_id}/storages/{storage.id}/series/{ts_name.value}"
         try:
             body = {

src/antares/craft/service/api_services/services/thermal.py

@@ -30,7 +30,7 @@
     ThermalClusterPropertiesUpdate,
 )
 from antares.craft.service.api_services.models.thermal import ThermalClusterPropertiesAPI
-from antares.craft.service.api_services.utils import get_matrix, upload_series
+from antares.craft.service.api_services.utils import get_matrix, update_series
 from antares.craft.service.base_services import BaseThermalService
 from typing_extensions import override
 
@@ -80,7 +80,7 @@ def update_thermal_matrix(
             / ts_name.value
         )
         try:
-            upload_series(self._base_url, self.study_id, self._wrapper, matrix, path.as_posix())
+            update_series(self._base_url, self.study_id, self._wrapper, matrix, path.as_posix())
         except APIError as e:
             raise ThermalMatrixUpdateError(
                 thermal_cluster.area_id, thermal_cluster.name, ts_name.value, e.message

src/antares/craft/service/api_services/utils.py

@@ -17,7 +17,7 @@
 from antares.craft.exceptions.exceptions import TaskFailedError, TaskTimeOutError
 
 
-def upload_series(base_url: str, study_id: str, wrapper: RequestWrapper, series: pd.DataFrame, path: str) -> None:
+def update_series(base_url: str, study_id: str, wrapper: RequestWrapper, series: pd.DataFrame, path: str) -> None:
     url = f"{base_url}/studies/{study_id}/raw?path={path}"
     array_data = series.to_numpy().tolist()
     wrapper.post(url, json=array_data)

src/antares/craft/service/base_services.py

@@ -737,7 +737,7 @@ def get_storage_matrix(self, storage: "STStorage", ts_name: "STStorageMatrixName
         pass
 
     @abstractmethod
-    def upload_storage_matrix(self, storage: "STStorage", ts_name: "STStorageMatrixName", matrix: pd.DataFrame) -> None:
+    def update_storage_matrix(self, storage: "STStorage", ts_name: "STStorageMatrixName", matrix: pd.DataFrame) -> None:
         pass
 
 

src/antares/craft/service/local_services/services/st_storage.py

@@ -42,7 +42,7 @@ def read_st_storages(self, area_id: str) -> List[STStorage]:
         raise NotImplementedError
 
     @override
-    def upload_storage_matrix(self, storage: STStorage, ts_name: STStorageMatrixName, matrix: pd.DataFrame) -> None:
+    def update_storage_matrix(self, storage: STStorage, ts_name: STStorageMatrixName, matrix: pd.DataFrame) -> None:
         raise NotImplementedError
 
     @override

tests/antares/services/api_services/test_matrix_api.py

@@ -77,7 +77,7 @@ def test_create_load_fails(self):
             ):
                 self.area.create_load(pd.DataFrame(data=np.ones((8760, 1))))
 
-    def test_upload_wrongly_formatted_load_matrix_fails(self):
+    def test_update_wrongly_formatted_load_matrix_fails(self):
         with requests_mock.Mocker() as mocker:
             url = f"https://antares.com/api/v1/studies/{self.study_id}/raw?path=input/load/series/load_{self.area.id}"
             mocker.post(url, json={"description": self.antares_web_description_msg}, status_code=404)

tests/antares/services/api_services/test_renewable_api.py

@@ -97,7 +97,7 @@ def test_get_renewable_matrices_fails(self):
             ):
                 self.renewable.get_timeseries()
 
-    def test_upload_renewable_matrices_success(self):
+    def test_update_renewable_matrices_success(self):
         with requests_mock.Mocker() as mocker:
             url = (
                 f"https://antares.com/api/v1/studies/{self.study_id}/raw?path=input/renewables/series/"
@@ -106,7 +106,7 @@ def test_upload_renewable_matrices_success(self):
             mocker.post(url, status_code=200)
             self.renewable.update_renewable_matrix(self.matrix)
 
-    def test_upload_renewable_matrices_fail(self):
+    def test_update_renewable_matrices_fail(self):
         with requests_mock.Mocker() as mocker:
             url = (
                 f"https://antares.com/api/v1/studies/{self.study_id}/raw?path=input/renewables/series/"

tests/antares/services/api_services/test_st_storage_api.py

@@ -100,16 +100,16 @@ def test_get_storage_matrix_fails(self):
             ):
                 self.storage.get_storage_inflows()
 
-    def test_upload_storage_matrix_success(self):
+    def test_update_storage_matrix_success(self):
         with requests_mock.Mocker() as mocker:
             url = (
                 f"https://antares.com/api/v1/studies/{self.study_id}/areas/{self.storage.area_id}"
                 f"/storages/{self.storage.id}/series/inflows"
             )
             mocker.put(url, status_code=200)
-            self.storage.upload_storage_inflows(self.matrix)
+            self.storage.update_storage_inflows(self.matrix)
 
-    def test_upload_storage_matrix_fails(self):
+    def test_update_storage_matrix_fails(self):
         with requests_mock.Mocker() as mocker:
             url = (
                 f"https://antares.com/api/v1/studies/{self.study_id}/areas/{self.storage.area_id}"
@@ -121,7 +121,7 @@ def test_upload_storage_matrix_fails(self):
                 match=f"Could not upload inflows matrix for storage {self.storage.id} inside area {self.area.id}:"
                 f" {self.antares_web_description_msg}",
             ):
-                self.storage.upload_storage_inflows(self.matrix)
+                self.storage.update_storage_inflows(self.matrix)
 
     def test_read_st_storages(self):
         json_storage = [

tests/integration/test_web_client.py

@@ -328,11 +328,11 @@ def test_creation_lifecycle(self, antares_web: AntaresWebDesktop, tmp_path):
             match=f"Could not upload {STStorageMatrixName.INFLOWS.value} matrix for storage {battery_fr.id}"
             f" inside area {area_fr.id}",
         ):
-            battery_fr.upload_storage_inflows(wrong_matrix)
+            battery_fr.update_storage_inflows(wrong_matrix)
 
         # Case that succeeds
         injection_matrix = pd.DataFrame(data=np.zeros((8760, 1)))
-        battery_fr.upload_pmax_injection(injection_matrix)
+        battery_fr.update_pmax_injection(injection_matrix)
 
         # tests get pmax_injection matrix
         assert battery_fr.get_pmax_injection().equals(injection_matrix)