Merge branch 'SC-1453' into 'develop'

SC-1453: Add method for updating top metadata

See merge request SOLO-band/python-sdk!91

Author: tmestan-zade-rogii

src/rogii_solo/exceptions.py

@@ -1,5 +1,14 @@
+from typing import Optional
+
+
 class BaseRogiiSoloException(Exception):
-    pass
+    default_message = 'Error occurred.'
+
+    def __init__(self, message: Optional[str] = None):
+        self.message = message or self.default_message
+
+    def __str__(self):
+        return str(self.message)
 
 
 class ProjectNotFoundException(BaseRogiiSoloException):
@@ -16,3 +25,7 @@ class TraceNotFoundException(BaseRogiiSoloException):
 
 class InterpretationOutOfTrajectoryException(BaseRogiiSoloException):
     pass
+
+
+class InvalidTopDataException(BaseRogiiSoloException):
+    default_message = 'Measured depth value in project units must be in [0; 100000] range.'

src/rogii_solo/papi/base.py

@@ -1308,3 +1308,10 @@ def replace_well_trajectory(
         }
 
         return self._send_put_request(url=url, request_data=request_data, headers=headers)
+
+    def update_top_meta(self, top_id: str, name: str, md: PapiVar, headers: Optional[Dict] = None) -> bool:
+        url = f'tops/{top_id}'
+        request_data = {'name': name, 'md': md}
+        response = self._send_patch_request(url=url, request_data=request_data, headers=headers)
+
+        return response.status_code == status_codes.ok

src/rogii_solo/topset.py

@@ -3,8 +3,9 @@
 from pandas import DataFrame
 
 import rogii_solo.well
-from rogii_solo.base import BaseObject, ComplexObject, ObjectRepository
+from rogii_solo.base import ComplexObject, ObjectRepository
 from rogii_solo.calculations.converters import feet_to_meters
+from rogii_solo.exceptions import InvalidTopDataException
 from rogii_solo.papi.client import PapiClient
 from rogii_solo.papi.types import PapiStarredTops
 from rogii_solo.utils.objects import find_by_uuid
@@ -40,7 +41,8 @@ def tops(self) -> ObjectRepository['Top']:
         if self._tops is None:
             self._tops = ObjectRepository(
                 objects=[
-                    Top(topset=self, **item) for item in self._papi_client.get_topset_tops_data(topset_id=self.uuid)
+                    Top(papi_client=self._papi_client, topset=self, **item)
+                    for item in self._papi_client.get_topset_tops_data(topset_id=self.uuid)
                 ]
             )
 
@@ -71,6 +73,9 @@ def starred_top_bottom(self):
         return self._starred_top_bottom
 
     def create_top(self, name: str, md: float):
+        if not 0 <= md <= 100000:
+            raise InvalidTopDataException
+
         top_id = self._papi_client.create_topset_top(
             topset_id=self.uuid, name=name, md=self._papi_client.prepare_papi_var(md)
         )
@@ -90,8 +95,10 @@ def _get_starred_tops_data(self):
         return self._starred_tops_data
 
 
-class Top(BaseObject):
-    def __init__(self, topset: Topset, **kwargs):
+class Top(ComplexObject):
+    def __init__(self, papi_client: PapiClient, topset: Topset, **kwargs):
+        super().__init__(papi_client)
+
         self.topset = topset
         self.measure_units = topset.well.project.measure_unit
 
@@ -111,3 +118,21 @@ def to_dict(self, get_converted: bool = True) -> Dict[str, Any]:
 
     def to_df(self, get_converted: bool = True) -> DataFrame:
         return DataFrame([self.to_dict(get_converted)])
+
+    def update_meta(self, name: str, md: float):
+        if not 0 <= md <= 100000:
+            raise InvalidTopDataException
+
+        func_data = {
+            func_param: func_arg
+            for func_param, func_arg in locals().items()
+            if func_arg is not None and func_param != 'self'
+        }
+        request_data = {key: self._papi_client.prepare_papi_var(value) for key, value in func_data.items()}
+
+        is_updated = self._papi_client.update_top_meta(top_id=self.uuid, **request_data)
+
+        if is_updated:
+            self.__dict__.update(func_data)
+
+        return self

tests/test_solo_client_papi.py

@@ -2,15 +2,17 @@
 from math import fabs
 from typing import Any
 
+import pytest
+
 from rogii_solo.calculations.constants import DELTA
 from rogii_solo.calculations.interpretation import get_segments, get_segments_with_dip
 from rogii_solo.calculations.trajectory import calculate_trajectory
+from rogii_solo.exceptions import InvalidTopDataException
 from tests.papi_data import (
     EI_LAST_SEGMENT_EXTENDED_NAME,
     LOG_NAME,
     NESTED_WELL_NAME,
     STARRED_NESTED_WELL_NAME,
-    STARRED_TOPSET_NAME,
     TYPEWELL_NAME,
     WELL_NAME,
 )
@@ -229,11 +231,27 @@ def test_create_typewell_log(project_papi):
     assert typewell.logs.find_by_name(log_name) is not None
 
 
+def test_update_log_meta(project_papi):
+    well = project_papi.wells.find_by_name(WELL_NAME)
+    assert well is not None
+
+    log = well.logs.find_by_name(LOG_NAME)
+    assert log is not None
+
+    input_data = {
+        'name': f'Log {random.randint(0, 10000)}',
+    }
+    log.update_meta(**input_data)
+
+    log_data = log.to_dict()
+    assert log_data['name'] == input_data['name']
+
+
 def test_create_topset_top(project_papi):
     well = project_papi.wells.find_by_name(WELL_NAME)
     assert well is not None
 
-    topset = well.topsets.find_by_name(STARRED_TOPSET_NAME)
+    topset = well.starred_topset
     assert topset is not None
 
     input_data = {
@@ -251,6 +269,68 @@ def test_create_topset_top(project_papi):
     assert np_is_close(top_data['md'], input_data['md'])
 
 
+def test_create_topset_top_with_invalid_md(project_papi):
+    well = project_papi.wells.find_by_name(WELL_NAME)
+    assert well is not None
+
+    topset = well.starred_topset
+    assert topset is not None
+
+    input_data = {
+        'name': f'Top {random.randint(0, 10000)}',
+        'md': -1,
+    }
+    with pytest.raises(InvalidTopDataException):
+        topset.create_top(**input_data)
+
+    input_data = {
+        'name': f'Top {random.randint(0, 10000)}',
+        'md': 1000001,
+    }
+    with pytest.raises(InvalidTopDataException):
+        topset.create_top(**input_data)
+
+
+def test_update_topset_top_meta(project_papi):
+    well = project_papi.wells.find_by_name(WELL_NAME)
+    assert well is not None
+
+    top = well.starred_topset.starred_top_center
+    assert top is not None
+
+    input_data = {
+        'name': f'Top {random.randint(0, 10000)}',
+        'md': random.randint(11400, 11500),
+    }
+    top.update_meta(**input_data)
+
+    top_data = top.to_dict()
+    assert top_data['name'] == input_data['name']
+    assert np_is_close(top_data['md'], input_data['md'])
+
+
+def test_update_topset_top_with_incorrect_md(project_papi):
+    well = project_papi.wells.find_by_name(WELL_NAME)
+    assert well is not None
+
+    top = well.starred_topset.starred_top_center
+    assert top is not None
+
+    input_data = {
+        'name': f'Top {random.randint(0, 10000)}',
+        'md': -1,
+    }
+    with pytest.raises(InvalidTopDataException):
+        top.update_meta(**input_data)
+
+    input_data = {
+        'name': f'Top {random.randint(0, 10000)}',
+        'md': 1000001,
+    }
+    with pytest.raises(InvalidTopDataException):
+        top.update_meta(**input_data)
+
+
 def test_update_well_meta(project_papi):
     well = project_papi.wells.find_by_name(WELL_NAME)
     assert well is not None