Choose output type for a GenericDataContainer (#1403)

Author: cbellot000

src/ansys/dpf/core/generic_data_container.py

@@ -12,8 +12,11 @@
 if TYPE_CHECKING:  # pragma: no cover
     from ansys.dpf.core import Field, Scoping, StringField, GenericDataContainer
 
+from ansys.dpf.core.dpf_operator import _write_output_type_to_type
+
+
 from ansys.dpf.core import server as server_module
-from ansys.dpf.core import errors
+from ansys.dpf.core import errors, types
 from ansys.dpf.core.any import Any
 from ansys.dpf.core import collection
 from ansys.dpf.core.mapping_types import map_types_to_python
@@ -104,21 +107,32 @@ def set_property(
         any_dpf = Any.new_from(prop, self._server)
         self._api.generic_data_container_set_property_any(self, property_name, any_dpf)
 
-    def get_property(self, property_name):
+    def get_property(self, property_name, output_type: Union[None, type, types] = None):
         """Get property with given name.
 
         Parameters
         ----------
         property_name : str
             Property name.
 
+        output_type : None, type, types, optional
+            Expected type of the output. By default, type is deduced using
+            `GenericDataContainer.get_property_description`.
+
         Returns
         -------
         Property object instance.
         """
         any_ptr = self._api.generic_data_container_get_property_any(self, property_name)
         any_dpf = Any(any_ptr, self._server)
-        output_type = self.get_property_description()[property_name]
+        if output_type is None:
+            output_type = self.get_property_description()[property_name]
+        else:
+            if not isinstance(output_type, type):
+                output_type = _write_output_type_to_type(output_type)
+
+            output_type = str(output_type.__name__)
+
         class_ = getattr(builtins, output_type, None)
         if class_ is None:
             from ansys.dpf import core

tests/test_generic_data_container.py

@@ -1,6 +1,6 @@
 from ansys.dpf import core as dpf
 from conftest import (
-    SERVERS_VERSION_GREATER_THAN_OR_EQUAL_TO_7_0,
+    SERVERS_VERSION_GREATER_THAN_OR_EQUAL_TO_7_0, SERVERS_VERSION_GREATER_THAN_OR_EQUAL_TO_8_0,
 )
 import pytest
 
@@ -68,3 +68,67 @@ def test_get_property_description_generic_data_container(server_type):
         "my-string": "str",
         "my-field": "Field",
     }
+
+
+@pytest.mark.skipif(
+    not SERVERS_VERSION_GREATER_THAN_OR_EQUAL_TO_7_0, reason="Available for servers >=7.0"
+)
+def test_get_by_type_generic_data_container(server_type):
+    gdc = dpf.GenericDataContainer(server=server_type)
+    entity = 42
+    gdc.set_property("my-int", entity)
+    new_entity = gdc.get_property("my-int")
+    assert 42 == new_entity
+    new_entity = gdc.get_property("my-int", int)
+    assert 42 == new_entity
+    new_entity = gdc.get_property("my-int", dpf.types.int)
+    assert 42 == new_entity
+
+    entity = 4.2
+    gdc.set_property("my-float", entity)
+    new_entity = gdc.get_property("my-float")
+    assert 4.2 == new_entity
+    new_entity = gdc.get_property("my-float", float)
+    assert 4.2 == new_entity
+    new_entity = gdc.get_property("my-float", dpf.types.double)
+    assert 4.2 == new_entity
+
+    entity = "hello world"
+    gdc.set_property("my-string", entity)
+    new_entity = gdc.get_property("my-string")
+    assert "hello world" == new_entity
+    new_entity = gdc.get_property("my-string", str)
+    assert "hello world" == new_entity
+    new_entity = gdc.get_property("my-string", dpf.types.string)
+    assert "hello world" == new_entity
+
+    entity = dpf.Field(location="phase", nature=dpf.natures.scalar, server=server_type)
+    gdc.set_property("my-field", entity)
+    new_entity = gdc.get_property("my-field")
+    assert isinstance(new_entity, dpf.Field)
+
+    new_entity = gdc.get_property("my-field", dpf.Field)
+    assert isinstance(new_entity, dpf.Field)
+
+    new_entity = gdc.get_property("my-field", dpf.types.field)
+    assert isinstance(new_entity, dpf.Field)
+
+
+@pytest.mark.skipif(
+    not SERVERS_VERSION_GREATER_THAN_OR_EQUAL_TO_8_0, reason="Available for servers >=8.0"
+)
+def test_get_bytes_generic_data_container(server_type):
+    gdc = dpf.GenericDataContainer(server=server_type)
+
+    entity = "hello world"
+    gdc.set_property("my-string", entity)
+    new_entity = gdc.get_property("my-string")
+    assert "hello world" == new_entity
+    new_entity = gdc.get_property("my-string", str)
+    assert "hello world" == new_entity
+    new_entity = gdc.get_property("my-string", dpf.types.string)
+    assert "hello world" == new_entity
+    new_entity = gdc.get_property("my-string", bytes)
+    assert b"hello world" == new_entity
+    new_entity = gdc.get_property("my-string", dpf.types.bytes)
+    assert b"hello world" == new_entity