Raise for version too low

Author: PProfizi

src/ansys/dpf/core/field.py

@@ -30,6 +30,7 @@
 
 from ansys import dpf
 from ansys.dpf.core import dimensionality, errors, meshed_region, scoping, time_freq_support
+from ansys.dpf.core.available_result import Homogeneity
 from ansys.dpf.core.common import (
     _get_size_of_list,
     locations,
@@ -617,18 +618,18 @@ def unit(self):
             return self.field_definition.unit
 
     @unit.setter
-    def unit(self, value):
+    def unit(self, value: str | tuple[Homogeneity, str]):
         """Change the unit for the field.
 
         A single string is interpreted as a known physical unit with an associated homogeneity.
 
-        A tuple of two strings is interpreted as a homogeneity and a unit name.
-            If the homogeneity is Homogeneity.dimensionless, then the unit string is kept as a name.
-            Otherwise, the homogeneity is ignored, and the unit string is interpreted as a known physical unit with an associated homogeneity.
+        For DPF 11.0 (2026 R1) and above: A tuple of two strings is interpreted as a homogeneity and a unit name.
+            If the homogeneity is :py:attr:`Homogeneity.dimensionless`, then the unit string is kept as a name.
+            Otherwise, the homogeneity is ignored, and the unit string interpreted as a known physical unit with an associated homogeneity.
 
         Parameters
         ----------
-        value : str | tuple(Homogeneity, str)
+        value:
             Units for the field.
 
         Examples
@@ -651,10 +652,14 @@ def unit(self, value):
         >>> print(my_field.unit)
         'dollars'
 
+        Notes
+        -----
+        Setting a named dimensionless unit requires DPF 11.0 (2026 R1) or above.
+
         """
-        fielddef = self.field_definition
-        fielddef.unit = value
-        self.field_definition = fielddef
+        field_def = self.field_definition
+        field_def.unit = value
+        self.field_definition = field_def
 
     @property
     def dimensionality(self):

src/ansys/dpf/core/field_definition.py

@@ -22,13 +22,15 @@
 
 """FieldDefinition."""
 
+from __future__ import annotations
+
 from argparse import ArgumentError
 import traceback
 import warnings
 
 from ansys.dpf.core import server as server_module
 from ansys.dpf.core.available_result import Homogeneity
-from ansys.dpf.core.check_version import version_requires
+from ansys.dpf.core.check_version import server_meet_version_and_raise, version_requires
 from ansys.dpf.core.common import natures, shell_layers
 from ansys.dpf.core.dimensionality import Dimensionality
 from ansys.dpf.gate import (
@@ -206,14 +208,37 @@ def is_of_quantity_type(self, quantity_type):
         return is_of_quantity_type
 
     @unit.setter
-    def unit(self, value):
+    def unit(self, value: str | tuple[Homogeneity, str]):
+        """Change the unit for the field definition.
+
+        A single string is interpreted as a known physical unit with an associated homogeneity.
+
+        For DPF 11.0 (2026 R1) and above: A tuple of two strings is interpreted as a homogeneity and a unit name.
+            If the homogeneity is :py:attr:`Homogeneity.dimensionless`, then the unit string is kept as a name.
+            Otherwise, the homogeneity is ignored, and the unit string interpreted as a known physical unit with an associated homogeneity.
+
+        Parameters
+        ----------
+        value:
+            Units for the field.
+
+        Notes
+        -----
+        Setting a named dimensionless unit requires DPF 11.0 (2026 R1) or above.
+
+        """
         # setter with explicit homogeneity: homogeneity is taken into account if it is dimensionless
         if (
             isinstance(value, tuple)
             and len(value) == 2
             and isinstance(value[0], Homogeneity)
             and isinstance(value[1], str)
         ):
+            server_meet_version_and_raise(
+                required_version="11.0",
+                server=self._server,
+                msg="Setting a named dimensionless unit requires DPF 11.0 (2026 R1) or above.",
+            )
             # csfield_definition_set_unit will ignore the homogeneity if it is not dimensionless
             self._api.csfield_definition_set_unit(self, value[1], None, value[0].value, 0, 0)
         # standard unit setter, using string interpreter

tests/conftest.py

@@ -329,6 +329,9 @@ def return_ds(server=None):
     return return_ds
 
 
+SERVERS_VERSION_GREATER_THAN_OR_EQUAL_TO_11_0 = meets_version(
+    get_server_version(core._global_server()), "11.0"
+)
 SERVERS_VERSION_GREATER_THAN_OR_EQUAL_TO_10_0 = meets_version(
     get_server_version(core._global_server()), "10.0"
 )

tests/entry/conftest.py

@@ -71,9 +71,6 @@ def _get_test_files_directory():
         "/tmp/test_files"
     )
 
-SERVERS_VERSION_GREATER_THAN_OR_EQUAL_TO_11_0 = meets_version(
-    get_server_version(core._global_server()), "11.0"
-)
 SERVERS_VERSION_GREATER_THAN_OR_EQUAL_TO_8_1 = meets_version(
     get_server_version(core._global_server()), "8.1"
 )

tests/test_field.py

@@ -33,11 +33,12 @@
 from ansys.dpf.core.available_result import Homogeneity
 from ansys.dpf.core.check_version import server_meet_version
 from ansys.dpf.core.common import locations, shell_layers
-from ansys.dpf.gate.errors import DPFServerException
+from ansys.dpf.gate.errors import DPFServerException, DpfVersionNotSupported
 import conftest
 from conftest import (
     SERVERS_VERSION_GREATER_THAN_OR_EQUAL_TO_8_0,
     SERVERS_VERSION_GREATER_THAN_OR_EQUAL_TO_11_0,
+    raises_for_servers_version_under,
     running_docker,
 )
 
@@ -1426,19 +1427,21 @@ def test_deep_copy_big_field_remote(server_type, server_type_remote_process):
     assert np.allclose(out.data, data)
 
 
-@pytest.mark.skipif(
-    not SERVERS_VERSION_GREATER_THAN_OR_EQUAL_TO_11_0, reason="Available for servers >=11.0"
-)
-def test_set_units():
+def test_set_units(server_type):
     data = np.random.random(100)
     field = dpf.core.field_from_array(data)
     # use string setter with recognized string
     field.unit = "m"
     assert field.unit == "m"
 
-    # use tuple(Homogeneity, string) setter
-    field.unit = (Homogeneity.dimensionless, "sones")
-    assert field.unit == "sones"
+    if server_meet_version("11.0", server_type):
+        # use tuple(Homogeneity, string) setter
+        field.unit = (Homogeneity.dimensionless, "sones")
+        assert field.unit == "sones"
+    else:
+        with pytest.raises(DpfVersionNotSupported):
+            # use tuple(Homogeneity, string) setter
+            field.unit = (Homogeneity.dimensionless, "sones")
 
     # use unrecognized string
     with pytest.raises(DPFServerException):