Merge branch 'main' into rcanton/remove_result_props

Author: rafacanton

.github/workflows/ci.yml

@@ -198,11 +198,15 @@ jobs:
       matrix:
         version:
           - ${{ fromJson(vars.ANSYS_VERSIONS_RETRO_WITH_PATCH) }}
-          - ${{ fromJson(vars.ANSYS_VERSION_LAST_RELEASED_WITH_PATCH) }}
+        docstring:
+          - "false"
+        include:
+          - version: ${{ fromJson(vars.ANSYS_VERSION_LAST_RELEASED_WITH_PATCH) }}
+            docstring: "true"
     uses: ./.github/workflows/tests.yml
     with:
       ANSYS_VERSION: ${{ matrix.version.version }}
       python_versions: '["3.10"]'
-      DOCSTRING: false
+      DOCSTRING: ${{ matrix.docstring }}
       standalone_suffix: ${{ matrix.version.patch }}
     secrets: inherit

src/ansys/dpf/core/available_result.py

@@ -125,6 +125,13 @@ class AvailableResult:
     >>> transient = examples.download_transient_result()
     >>> model = dpf.Model(transient)
     >>> result_info = model.metadata.result_info
+    >>> res = result_info["displacement"]
+    >>> res.name
+    'displacement'
+    >>> res.homogeneity
+    'length'
+    >>> res.dimensionality
+    'vector'
 
     Create the operator of the given available result.
 

src/ansys/dpf/core/collection.py

@@ -32,11 +32,11 @@
 from ansys.dpf.core.collection_base import CollectionBase
 from ansys.dpf.core.common import create_dpf_instance
 
-TYPE = TypeVar("TYPE")
+T = TypeVar("T")
+S = TypeVar("S")
 
 
-# Explicit Generic[TYPE] helps some type checkers Collection as a generic.
-class Collection(CollectionBase[TYPE], Generic[TYPE]):
+class Collection(CollectionBase[T]):
     """Represents a collection of dpf objects organised by label spaces.
 
     Parameters
@@ -94,7 +94,7 @@ def get_entries(self, label_space):
         """
         return super()._get_entries(label_space)
 
-    def get_entry(self, label_space_or_index) -> TYPE:
+    def get_entry(self, label_space_or_index) -> T:
         """Retrieve the entry at a requested index or label space.
 
         Raises an exception if the request returns more than one entry.
@@ -126,7 +126,7 @@ def add_entry(self, label_space, entry):
         return super()._add_entry(label_space, Any.new_from(entry, server=self._server))
 
     @classmethod
-    def collection_factory(cls, subtype: TYPE) -> Type[Collection[TYPE]]:
+    def collection_factory(cls, subtype: Type[S]) -> Type[Collection[S]]:
         """Create classes deriving from Collection at runtime for a given subtype.
 
         This factory method dynamically creates a new class that inherits from Collection
@@ -141,7 +141,7 @@ def collection_factory(cls, subtype: TYPE) -> Type[Collection[TYPE]]:
 
         Returns
         -------
-        Type[Collection[TYPE]]
+        Type[Collection[S]]
             A new class that inherits from Collection and is specialized for the given
             subtype. The class name will be "{subtype.__name__}sCollection".
 

src/ansys/dpf/core/result_info.py

@@ -110,6 +110,11 @@ class ResultInfo:
     >>> model = dpf.Model(transient)
     >>> result_info = model.metadata.result_info # printable result_info
 
+    >>> result_info["displacement"].name
+    'displacement'
+    >>> result_info["displacement"].homogeneity
+    'length'
+
     """
 
     def __init__(

tests/test_resultinfo.py

@@ -137,15 +137,18 @@ def test_byitem_resultinfo(model):
     assert res[0] is not None
 
 
-# def test_get_result_resultinfo_from_index(model):
-#     res = model.metadata.result_info[3]
-#     assert res.name == "acceleration"
-#     assert res.n_components == 3
-#     assert res.dimensionality == "vector"
-#     assert res.homogeneity == "acceleration"
-#     assert res.unit == "m/s^2"
-#     assert res.name == "acceleration"
-#     assert res.qualifiers == []
+def test_get_result_resultinfo_from_index(model):
+    if SERVERS_VERSION_GREATER_THAN_OR_EQUAL_TO_11_0:
+        res = model.metadata.result_info[3]
+    else:
+        res = model.metadata.result_info[2]
+    assert res.name == "acceleration"
+    assert res.n_components == 3
+    assert res.dimensionality == "vector"
+    assert res.homogeneity == "acceleration"
+    assert res.unit == "m/s^2"
+    assert res.name == "acceleration"
+    assert res.qualifiers == []
 
 
 def test_print_result_info(model):