Re-enable the 'price' attribute on ModelElementalData (#853)

For server version 25.2 or later, re-enable the 'price' attribute
on ModelElementalData.
In order to know the server version, the _field_names method now
takes an optional server_version argument. In the 'ModelElementalData',
the 'price' field is removed if the server version is less than 25.2.

Add back the previous test for the 'price' attribute, and a model
which crashed when accessing the 'price' with 2025R1 and earlier.

Closes #720.

Author: greschd

src/ansys/acp/core/_server/launch.py

@@ -38,14 +38,15 @@
     RemoteFileTransferStrategy,
 )
 from .common import ControllableServerProtocol, LaunchMode, ServerKey
+from .connect import ConnectLaunchConfig
 from .direct import DirectLaunchConfig
 from .docker_compose import DockerComposeLaunchConfig
 
 __all__ = ["launch_acp"]
 
 
 def launch_acp(
-    config: DirectLaunchConfig | DockerComposeLaunchConfig | None = None,
+    config: DirectLaunchConfig | DockerComposeLaunchConfig | ConnectLaunchConfig | None = None,
     launch_mode: LaunchMode | None = None,
     timeout: float | None = 30.0,
     auto_transfer_files: bool = True,

src/ansys/acp/core/_tree_objects/_elemental_or_nodal_data.py

@@ -33,6 +33,8 @@
 if typing.TYPE_CHECKING:  # pragma: no cover
     from pyvista.core.pointset import PolyData, UnstructuredGrid
 
+from packaging.version import Version
+
 from ansys.acp.core._utils.array_conversions import dataarray_to_numpy, to_numpy
 from ansys.api.acp.v0 import mesh_query_pb2, mesh_query_pb2_grpc
 
@@ -113,6 +115,11 @@ def _get_pyvista_mesh_with_all_data(
     )
 
     for name in mesh_data_base._field_names():
+        data = getattr(mesh_data_base, name)
+        # The data can be missing if the field depends on the server version - see
+        # for example the ModelElementalData._field_names method.
+        if data is None:
+            continue
         values = getattr(mesh_data_base, name).values
         target_array = _expand_array(array=values, labels=labels)
         mesh_data_field[name] = target_array
@@ -307,7 +314,7 @@ class ElementalOrNodalDataBase:
     _PB_VALUE_FROM_FIELD_NAME: ClassVar[typing.Callable[[StrEnum], int]]
 
     @classmethod
-    def _field_names(cls) -> list[str]:
+    def _field_names(cls, server_version: Version | None = None) -> list[str]:
         return [
             field.name
             for field in dataclasses.fields(cls)
@@ -459,7 +466,7 @@ def getter(self: TreeObject) -> MeshDataT:
                 resource_path=self._resource_path,
                 data_types=[
                     wrapped_cls._PB_VALUE_FROM_FIELD_NAME(name)  # type: ignore
-                    for name in wrapped_cls._field_names()
+                    for name in wrapped_cls._field_names(server_version=self._server_version)
                 ],
             ),
         )

src/ansys/acp/core/_tree_objects/model.py

@@ -28,6 +28,8 @@
 from typing import Any, cast
 
 import numpy as np
+from packaging.version import Version
+from packaging.version import parse as parse_version
 
 from ansys.api.acp.v0 import (
     boolean_selection_rule_pb2_grpc,
@@ -187,18 +189,29 @@ class ModelElementalData(ElementalData):
     thickness: ScalarData[np.float64] | None = None
     relative_thickness_correction: ScalarData[np.float64] | None = None
     area: ScalarData[np.float64] | None = None
-    # Retrieving the 'price' can crash the server if the model contains void
-    # analysis plies (on an imported solid model).
-    # This is fixed in the backend for 2025R2, but for now we simply comment
-    # out the property. In this way, the other properties can still be accessed,
-    # and we can avoid the crash.
-    # See https://github.com/ansys/pyacp/issues/717
-    # price: ScalarData[np.float64] | None = None
+    price: ScalarData[np.float64] | None = None
     volume: ScalarData[np.float64] | None = None
     mass: ScalarData[np.float64] | None = None
     offset: ScalarData[np.float64] | None = None
     cog: VectorData | None = None
 
+    @classmethod
+    def _field_names(cls, server_version: Version | None = None) -> list[str]:
+        """Bugfix override for #717.
+
+        Override the base class _field_names method to remove the 'price' field
+        if the server version is less than 25.2.
+
+        Before 25.2, retrieving the 'price' could crash the server if the model
+        contains void analysis plies (on an imported solid model).
+        In this way, the other properties can still be accessed, and we can avoid
+        the crash.
+        """
+        res = super()._field_names(server_version)
+        if server_version is not None and server_version < parse_version("25.2"):
+            res.remove("price")
+        return res
+
 
 @dataclasses.dataclass
 class ModelNodalData(NodalData):

tests/data/regression_model_717.acph5

@@ -29,6 +29,7 @@
 
 import numpy as np
 import numpy.testing
+from packaging.version import parse as parse_version
 import pytest
 
 from ansys.acp.core import ElementalDataType, UnitSystemType
@@ -145,20 +146,45 @@ def test_mesh_data(minimal_complete_model):
     numpy.testing.assert_equal(mesh.element_nodes_offsets, np.array([0]))
 
 
-def test_elemental_data(minimal_complete_model):
+def test_elemental_data(acp_instance, minimal_complete_model):
     data = minimal_complete_model.elemental_data
     numpy.testing.assert_allclose(data.element_labels.values, np.array([1]))
     numpy.testing.assert_allclose(data.normal.values, np.array([[0.0, 0.0, 1.0]]))
     numpy.testing.assert_allclose(data.thickness.values, np.array([1e-4]))
     numpy.testing.assert_allclose(data.relative_thickness_correction.values, np.array([1.0]))
     numpy.testing.assert_allclose(data.area.values, np.array([9e4]))
-    # numpy.testing.assert_allclose(data.price.values, np.array([0.0])) # disabled due to issue #717.
+    # The 'price' is disabled on servers prior to 25.2 due to issue #717.
+    if parse_version(acp_instance.server_version) >= parse_version("25.2"):
+        numpy.testing.assert_allclose(data.price.values, np.array([0.0]))
+    else:
+        data.price is None
     numpy.testing.assert_allclose(data.volume.values, np.array([9.0]))
     numpy.testing.assert_allclose(data.mass.values, np.array([7.065e-08]))
     numpy.testing.assert_allclose(data.offset.values, np.array([5e-5]))
     numpy.testing.assert_allclose(data.cog.values, np.array([[0.0, 0.0, 5e-5]]))
 
 
+def test_elemental_data_with_void_filler_analysis_plies(
+    acp_instance, load_model_from_tempfile, skip_before_version
+):
+    """Regression test for issue #717.
+
+    Retrieving the price of a model with void and filler analysis plies crashes the server
+    prior to 25.2.
+    """
+    # On 2024R2, accessing the elemental data failed for this model since the
+    # CoG is not supported for LayeredPolyhedron elements.
+    skip_before_version("25.1")
+
+    is_supported = parse_version(acp_instance.server_version) >= parse_version("25.2")
+
+    with load_model_from_tempfile("regression_model_717.acph5") as model:
+        if is_supported:
+            assert model.elemental_data.price is not None
+        else:
+            assert model.elemental_data.price is None
+
+
 def test_nodal_data(minimal_complete_model):
     data = minimal_complete_model.nodal_data
     numpy.testing.assert_allclose(data.node_labels.values, np.array([1, 2, 3, 4]))
@@ -187,9 +213,16 @@ def test_elemental_data_to_pyvista(minimal_complete_model):
 
 @pytest.mark.graphics
 @pytest.mark.parametrize("component", [e.value for e in ElementalDataType])
-def test_elemental_data_to_pyvista_with_component(minimal_complete_model, component):
+def test_elemental_data_to_pyvista_with_component(
+    acp_instance,
+    minimal_complete_model,
+    component,
+):
     import pyvista
 
+    if component == "price" and parse_version(acp_instance.server_version) < parse_version("25.2"):
+        pytest.skip("Price is not supported on this version of the server.")
+
     data = minimal_complete_model.elemental_data
     if not hasattr(data, component):
         pytest.skip(f"Model elemental data does not contain component '{component}'")