Merge branch 'SC-1698' into 'develop'

SC-1698: Fix well attributes and comments conversion and rounding

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

Author: tmestan-zade-rogii

src/rogii_solo/comment.py

@@ -38,7 +38,6 @@ def comment_boxes(self) -> ObjectRepository['CommentBox']:
 class CommentBox(BaseObject):
     def __init__(self, comment: Comment, **kwargs):
         self.comment = comment
-        self.measure_units = comment.well.project.measure_unit
 
         self.commentbox_id = None
         self.text = None
@@ -47,12 +46,14 @@ def __init__(self, comment: Comment, **kwargs):
         self.__dict__.update(kwargs)
 
     def to_dict(self, get_converted: bool = True) -> Dict[str, Any]:
+        measure_units = self.comment.well.project.measure_unit
+
         return {
             'commentbox_id': self.commentbox_id,
             'text': self.text,
-            'anchor_md': self.convert_z(value=self.anchor_md, measure_units=self.measure_units)
-            if get_converted
-            else self.anchor_md,
+            'anchor_md': self.safe_round(
+                self.convert_z(value=self.anchor_md, measure_units=measure_units) if get_converted else self.anchor_md
+            ),
         }
 
     def to_df(self, get_converted: bool = True) -> DataFrame:

src/rogii_solo/well.py

@@ -307,7 +307,7 @@ def comments(self) -> ObjectRepository[Comment]:
     @property
     def attributes(self) -> 'WellAttributes':
         if self._attributes is None:
-            self._attributes = WellAttributes(**self._get_attributes_data())
+            self._attributes = WellAttributes(well=self, **self._get_attributes_data())
 
         return self._attributes
 
@@ -435,14 +435,34 @@ def update_meta(
 
 
 class WellAttributes(BaseObject):
-    def __init__(self, **kwargs):
+    def __init__(self, well: Well, **kwargs):
+        self.well = well
+
         self.__dict__.update(kwargs)
 
-    def to_dict(self) -> Dict:
-        return self.__dict__
+    def to_dict(self, get_converted: bool = True) -> Dict:
+        measure_units = self.well.project.measure_unit
+        data = self.__dict__
+
+        return {
+            'Name': data['Name'],
+            'API': data['API'],
+            'Operator': data['Operator'],
+            'KB': self.safe_round(
+                self.convert_z(value=data['KB'], measure_units=measure_units) if get_converted else data['KB']
+            ),
+            'Azimuth VS': self.safe_round(
+                self.convert_angle(data['Azimuth VS']) if get_converted else data['Azimuth VS']
+            ),
+            'Convergence': self.safe_round(
+                self.convert_angle(data['Convergence']) if get_converted else data['Convergence']
+            ),
+            'X-srf': self.safe_round(data['X-srf'] if get_converted else feet_to_meters(data['X-srf'])),
+            'Y-srf': self.safe_round(data['Y-srf'] if get_converted else feet_to_meters(data['Y-srf'])),
+        }
 
-    def to_df(self) -> DataFrame:
-        return DataFrame(self.to_dict(), index=[0])
+    def to_df(self, get_converted: bool = True) -> DataFrame:
+        return DataFrame(self.to_dict(get_converted), index=[0])
 
 
 class NestedWell(ComplexObject):

tests/main/test_data_conversion.py

@@ -1158,3 +1158,228 @@ def test_get_not_converted_ftm_earth_model(ftm_project):
     for idx, layer in enumerate(layers):
         # Must be changed when public method with layer tvd is available
         assert np_is_close(layers_data[idx]['tvt'], layer.tvt)
+
+
+def test_get_converted_meter_well_attributes(project):
+    well = project.wells.find_by_name(WELL_NAME)
+    assert well is not None
+
+    well_data = well.to_dict()
+    assert well_data
+
+    attributes = well.attributes
+    assert attributes is not None
+
+    attributes_data = attributes.to_dict()
+    assert attributes_data
+
+    assert np_is_close(well_data['kb'], attributes_data['KB'])
+    assert np_is_close(well_data['azimuth'], attributes_data['Azimuth VS'])
+    assert np_is_close(well_data['convergence'], attributes_data['Convergence'])
+    assert np_is_close(well_data['xsrf_real'], attributes_data['X-srf'])
+    assert np_is_close(well_data['ysrf_real'], attributes_data['Y-srf'])
+
+
+def test_get_not_converted_meter_well_attributes(project):
+    well = project.wells.find_by_name(WELL_NAME)
+    assert well is not None
+
+    well_data = well.to_dict(get_converted=False)
+    assert well_data
+
+    attributes = well.attributes
+    assert attributes is not None
+
+    attributes_data = attributes.to_dict(get_converted=False)
+    assert attributes_data
+
+    assert np_is_close(well_data['kb'], attributes_data['KB'])
+    assert np_is_close(well_data['azimuth'], attributes_data['Azimuth VS'])
+    assert np_is_close(well_data['convergence'], attributes_data['Convergence'])
+    assert np_is_close(well_data['xsrf_real'], attributes_data['X-srf'])
+    assert np_is_close(well_data['ysrf_real'], attributes_data['Y-srf'])
+
+
+def test_get_converted_foot_well_attributes(ft_project):
+    well = ft_project.wells.find_by_name(WELL_NAME)
+    assert well is not None
+
+    well_data = well.to_dict()
+    assert well_data
+
+    attributes = well.attributes
+    assert attributes is not None
+
+    attributes_data = attributes.to_dict()
+    assert attributes_data
+
+    assert np_is_close(well_data['kb'], attributes_data['KB'])
+    assert np_is_close(well_data['azimuth'], attributes_data['Azimuth VS'])
+    assert np_is_close(well_data['convergence'], attributes_data['Convergence'])
+    assert np_is_close(well_data['xsrf_real'], attributes_data['X-srf'])
+    assert np_is_close(well_data['ysrf_real'], attributes_data['Y-srf'])
+
+
+def test_get_not_converted_foot_well_attributes(ft_project):
+    well = ft_project.wells.find_by_name(WELL_NAME)
+    assert well is not None
+
+    well_data = well.to_dict(get_converted=False)
+    assert well_data
+
+    attributes = well.attributes
+    assert attributes is not None
+
+    attributes_data = attributes.to_dict(get_converted=False)
+    assert attributes_data
+
+    assert np_is_close(well_data['kb'], attributes_data['KB'])
+    assert np_is_close(well_data['azimuth'], attributes_data['Azimuth VS'])
+    assert np_is_close(well_data['convergence'], attributes_data['Convergence'])
+    assert np_is_close(well_data['xsrf_real'], attributes_data['X-srf'])
+    assert np_is_close(well_data['ysrf_real'], attributes_data['Y-srf'])
+
+
+def test_get_converted_ftm_well_attributes(ftm_project):
+    well = ftm_project.wells.find_by_name(WELL_NAME)
+    assert well is not None
+
+    well_data = well.to_dict()
+    assert well_data
+
+    attributes = well.attributes
+    assert attributes is not None
+
+    attributes_data = attributes.to_dict()
+    assert attributes_data
+
+    assert np_is_close(well_data['kb'], attributes_data['KB'])
+    assert np_is_close(well_data['azimuth'], attributes_data['Azimuth VS'])
+    assert np_is_close(well_data['convergence'], attributes_data['Convergence'])
+    assert np_is_close(well_data['xsrf_real'], attributes_data['X-srf'])
+    assert np_is_close(well_data['ysrf_real'], attributes_data['Y-srf'])
+
+
+def test_get_not_converted_ftm_well_attributes(ftm_project):
+    well = ftm_project.wells.find_by_name(WELL_NAME)
+    assert well is not None
+
+    well_data = well.to_dict(get_converted=False)
+    assert well_data
+
+    attributes = well.attributes
+    assert attributes is not None
+
+    attributes_data = attributes.to_dict(get_converted=False)
+    assert attributes_data
+
+    assert np_is_close(well_data['kb'], attributes_data['KB'])
+    assert np_is_close(well_data['azimuth'], attributes_data['Azimuth VS'])
+    assert np_is_close(well_data['convergence'], attributes_data['Convergence'])
+    assert np_is_close(well_data['xsrf_real'], attributes_data['X-srf'])
+    assert np_is_close(well_data['ysrf_real'], attributes_data['Y-srf'])
+
+
+def test_get_converted_meter_comment_box(project):
+    well = project.wells.find_by_name(WELL_NAME)
+    assert well is not None
+
+    comments = well.comments
+    assert comments is not None
+
+    comment_box = comments[0].comment_boxes[0]
+    assert comment_box is not None
+
+    comment_box_data = comment_box.to_dict()
+    assert comment_box_data
+
+    assert np_is_close(
+        comment_box_data['anchor_md'],
+        Convertible.convert_z(value=comment_box.anchor_md, measure_units=project.measure_unit),
+    )
+
+
+def test_get_not_converted_meter_comment_box(project):
+    well = project.wells.find_by_name(WELL_NAME)
+    assert well is not None
+
+    comments = well.comments
+    assert comments is not None
+
+    comment_box = comments[0].comment_boxes[0]
+    assert comment_box is not None
+
+    comment_box_data = comment_box.to_dict(get_converted=False)
+    assert comment_box_data
+
+    assert np_is_close(comment_box_data['anchor_md'], comment_box.anchor_md)
+
+
+def test_get_converted_ft_comment_box(ft_project):
+    well = ft_project.wells.find_by_name(WELL_NAME)
+    assert well is not None
+
+    comments = well.comments
+    assert comments is not None
+
+    comment_box = comments[0].comment_boxes[0]
+    assert comment_box is not None
+
+    comment_box_data = comment_box.to_dict()
+    assert comment_box_data
+
+    assert np_is_close(
+        comment_box_data['anchor_md'],
+        Convertible.convert_z(value=comment_box.anchor_md, measure_units=ft_project.measure_unit),
+    )
+
+
+def test_get_not_converted_ft_comment_box(ft_project):
+    well = ft_project.wells.find_by_name(WELL_NAME)
+    assert well is not None
+
+    comments = well.comments
+    assert comments is not None
+
+    comment_box = comments[0].comment_boxes[0]
+    assert comment_box is not None
+
+    comment_box_data = comment_box.to_dict(get_converted=False)
+    assert comment_box_data
+
+    assert np_is_close(comment_box_data['anchor_md'], comment_box.anchor_md)
+
+
+def test_get_converted_ftm_comment_box(ftm_project):
+    well = ftm_project.wells.find_by_name(WELL_NAME)
+    assert well is not None
+
+    comments = well.comments
+    assert comments is not None
+
+    comment_box = comments[0].comment_boxes[0]
+    assert comment_box is not None
+
+    comment_box_data = comment_box.to_dict()
+    assert comment_box_data
+
+    assert np_is_close(
+        comment_box_data['anchor_md'],
+        Convertible.convert_z(value=comment_box.anchor_md, measure_units=ftm_project.measure_unit),
+    )
+
+
+def test_get_not_converted_ftm_comment_box(ftm_project):
+    well = ftm_project.wells.find_by_name(WELL_NAME)
+    assert well is not None
+
+    comments = well.comments
+    assert comments is not None
+
+    comment_box = comments[0].comment_boxes[0]
+    assert comment_box is not None
+
+    comment_box_data = comment_box.to_dict(get_converted=False)
+    assert comment_box_data
+
+    assert np_is_close(comment_box_data['anchor_md'], comment_box.anchor_md)

tests/main/test_solo_client.py

@@ -620,6 +620,15 @@ def test_get_well_attributes(project):
     assert attributes_data
     assert not attributes_df.empty
 
+    assert attributes_data['Name']
+    assert attributes_data['API']
+    assert attributes_data['Operator']
+    assert attributes_data['KB']
+    assert attributes_data['Azimuth VS']
+    assert attributes_data['Convergence']
+    assert attributes_data['X-srf']
+    assert attributes_data['Y-srf']
+
 
 def test_get_earth_model(project):
     starred_interpretation = project.wells.find_by_name(WELL_NAME).starred_interpretation

tests/papi_data.py

@@ -1641,12 +1641,12 @@
                 {
                     'commentbox_id': '3e277460-4156-496d-850c-48e64ab8b273',
                     'text': 'Comment Text 1',
-                    'anchor_md': {'val': 2375.2755905511813},
+                    'anchor_md': {'val': 9999.999999998},
                 },
                 {
                     'commentbox_id': '7a31617e-393e-4cda-9fd5-bdeec1a08222',
                     'text': 'Comment Text 2',
-                    'anchor_md': {'val': 2375.2755905511813},
+                    'anchor_md': {'val': 9999.999999998},
                 },
             ],
         },
@@ -1660,15 +1660,15 @@
 }
 
 WELL_ATTRIBUTES_DATA_RESPONSE = {
-    'Name': {'value': 'nameWell', 'attribute_id': 1},
+    'Name': {'value': WELL_NAME, 'attribute_id': 1},
     'API': {'value': 'api', 'attribute_id': 2},
     'Well Type': {'value': 'Deviated', 'attribute_id': 3},
     'Operator': {'value': 'operator', 'attribute_id': 4},
-    'KB': {'value': {'val': 1.0}, 'attribute_id': 7},
-    'Azimuth VS': {'value': {'val': 2.0}, 'attribute_id': 8},
-    'Convergence': {'value': {'val': 3.0}, 'attribute_id': 9},
-    'X-srf': {'value': {'val': 13.123359580052492}, 'attribute_id': 12},
-    'Y-srf': {'value': {'val': 16.404199475065617}, 'attribute_id': 13},
+    'KB': {'value': {'val': WELL_KB}, 'attribute_id': 7},
+    'Azimuth VS': {'value': {'val': WELL_AZIMUTH}, 'attribute_id': 8},
+    'Convergence': {'value': {'val': WELL_CONVERGENCE}, 'attribute_id': 9},
+    'X-srf': {'value': {'val': WELL_XSRF_REAL}, 'attribute_id': 12},
+    'Y-srf': {'value': {'val': WELL_YSRF_REAL}, 'attribute_id': 13},
     'Spud date': {'value': '2022-11-17T13:15:31.000+00:00', 'attribute_id': 17},
     '# of Stages': {'value': 43, 'attribute_id': 43},
     'Final TVD': {'value': {'val': 0.49}, 'attribute_id': 49},