Improve info on available qualifiers (#1027)

* Print available qualifiers in result_info

* Add AvailableResult.qualifier_combinations property

* Add test for str(result_info) with qualifiers

* Add test for AvailableResult.qualifier_combinations

* Fix typing

* Fix retro

* Fix retro

* Fix version check in result_info.py

* raise in ResultInfo.__str__ for debug

* Try up required version for qualifiers in ResultInfo print

* Fix test_print_result_info_with_qualifiers

* Set back result_info str server version requirements for qualifiers to 5.0

* Set back result_info str server version requirements for qualifiers to 7.0

* Debug docker

* Debug docker

* Actually test_result_info with qualifiers on all server types

* Remove rogue prints from tests, please use str() instead to test strings

* add verbose mode to delete_downloads()

* Remove progress bars for Workflows in tests

* Remove debug prints

* Revert "Remove debug prints"

This reverts commit f51aba8.

* Revert "Remove progress bars for Workflows in tests"

This reverts commit 9a4df92.

* Revert "add verbose mode to delete_downloads()"

This reverts commit 7d26e0b.

* Revert "Remove rogue prints from tests, please use str() instead to test strings"

This reverts commit 47bf517.

* Revert "Revert "Remove debug prints""

This reverts commit 036fc89.

* Revert "Revert "Remove progress bars for Workflows in tests""

This reverts commit cf45e1f.

* Revert "Revert "Remove rogue prints from tests, please use str() instead to test strings""

This reverts commit 03794f7.

* Revert "Revert "add verbose mode to delete_downloads()""

This reverts commit 329f9ad.

Author: PProfizi

src/ansys/dpf/core/available_result.py

@@ -3,6 +3,7 @@
 ===============
 """
 
+from typing import List
 from warnings import warn
 from ansys.dpf.core.common import _remove_spaces, _make_as_function_name, natures
 from enum import Enum, unique
@@ -250,6 +251,14 @@ def qualifier_labels(self) -> dict:
         """Returns a dictionary of available labels for each available qualifier."""
         return self._qualifier_labels
 
+    @property
+    def qualifier_combinations(self) -> List[dict]:
+        """Returns the list of valid qualifier combinations for this result.
+
+        Each combination is a dictionary which can be used for a result request.
+        """
+        return [q.__dict__() for q in self.qualifiers]
+
 
 _result_properties = {
     "S": {"location": "ElementalNodal", "scripting_name": "stress"},

src/ansys/dpf/core/examples/downloads.py

@@ -10,7 +10,7 @@
 EXAMPLE_REPO = "https://github.com/ansys/example-data/raw/master/"
 
 
-def delete_downloads():
+def delete_downloads(verbose=True):
     """Delete all downloaded examples to free space or update the files"""
     from ansys.dpf.core import LOCAL_DOWNLOADED_EXAMPLES_PATH, examples
 
@@ -34,7 +34,8 @@ def delete_downloads():
                 if not os.path.join(root, name) in not_to_remove:
                     try:
                         os.remove(os.path.join(root, name))
-                        print(f"deleting {os.path.join(root, name)}")
+                        if verbose:
+                            print(f"deleting {os.path.join(root, name)}")
                     except Exception as e:
                         warnings.warn(
                             f"couldn't delete {os.path.join(root, name)} with error:\n {e.args}"
@@ -43,7 +44,8 @@ def delete_downloads():
         if len(dirs) == 0 and len(files) == 0:
             try:
                 os.rmdir(root)
-                print(f"deleting {root}")
+                if verbose:
+                    print(f"deleting {root}")
             except Exception as e:
                 warnings.warn(f"couldn't delete {root} with error:\n {e.args}")
 

src/ansys/dpf/core/result_info.py

@@ -127,8 +127,23 @@ def __str__(self):
                 ]
                 txt += "{0:^4} {1:^2} {2:<30}".format(*line) + "\n"
 
+            if self._server.meet_version("7.0"):
+                qualifiers_labels = self.available_qualifier_labels
+                if len(qualifiers_labels) > 0:
+                    txt += "Available qualifier labels:\n"
+                    for label in qualifiers_labels:
+                        label_support = self.qualifier_label_support(label)
+                        names_field = label_support.string_field_support_by_property("names")
+                        label_names = names_field.data_as_list
+                        label_values = names_field.scoping.ids.tolist()
+                        txt += f"     - {label}: "
+                        for i, value in enumerate(label_values):
+                            label_values[i] = label_names[i] + f" ({value})"
+                        txt += f"{', '.join(label_values)}\n"
+
             return txt
         except Exception as e:
+            raise e
             from ansys.dpf.core.core import _description
 
             return _description(self._internal_obj, self._server)

tests/slow/test_remoteworkflow.py

@@ -16,13 +16,15 @@
 def test_simple_remote_workflow(simple_bar, local_server):
     data_sources1 = core.DataSources(simple_bar)
     wf = core.Workflow()
+    wf.progress_bar = False
     op = ops.result.displacement(data_sources=data_sources1)
     average = core.operators.math.norm_fc(op)
 
     wf.add_operators([op, average])
     wf.set_output_name("out", average.outputs.fields_container)
 
     local_wf = core.Workflow()
+    local_wf.progress_bar = False
     min_max = ops.min_max.min_max_fc()
     local_wf.add_operator(min_max)
     local_wf.set_input_name("in", min_max.inputs.fields_container)
@@ -53,6 +55,7 @@ def test_multi_process_remote_workflow():
     for i in files:
         data_sources1 = core.DataSources(files[i])
         wf = core.Workflow()
+        wf.progress_bar = False
         op = ops.result.displacement(data_sources=data_sources1)
         average = core.operators.math.norm_fc(op)
 
@@ -75,6 +78,7 @@ def test_multi_process_remote_workflow():
         workflows.append(remote_workflow)
 
     local_wf = core.Workflow()
+    local_wf.progress_bar = False
     merge = ops.utility.merge_fields_containers()
     min_max = ops.min_max.min_max_fc(merge)
     local_wf.add_operator(merge)
@@ -95,6 +99,7 @@ def test_multi_process_remote_workflow():
 def test_multi_process_connect_remote_workflow():
     files = examples.download_distributed_files()
     wf = core.Workflow()
+    wf.progress_bar = False
     op = ops.result.displacement()
     average = core.operators.math.norm_fc(op)
 
@@ -121,6 +126,7 @@ def test_multi_process_connect_remote_workflow():
         workflows.append(remote_workflow)
 
     local_wf = core.Workflow()
+    local_wf.progress_bar = False
     merge = ops.utility.merge_fields_containers()
     min_max = ops.min_max.min_max_fc(merge)
     local_wf.add_operator(merge)
@@ -141,6 +147,7 @@ def test_multi_process_connect_remote_workflow():
 def test_multi_process_connect_operator_remote_workflow():
     files = examples.download_distributed_files()
     wf = core.Workflow()
+    wf.progress_bar = False
     op = ops.result.displacement()
     average = core.operators.math.norm_fc(op)
 
@@ -168,6 +175,7 @@ def test_multi_process_connect_operator_remote_workflow():
         workflows.append(remote_workflow)
 
     local_wf = core.Workflow()
+    local_wf.progress_bar = False
     merge = ops.utility.merge_fields_containers()
     min_max = ops.min_max.min_max_fc(merge)
     local_wf.add_operator(merge)
@@ -188,6 +196,7 @@ def test_multi_process_connect_operator_remote_workflow():
 def test_multi_process_getoutput_remote_workflow():
     files = examples.download_distributed_files()
     wf = core.Workflow()
+    wf.progress_bar = False
     op = ops.result.displacement()
     average = core.operators.math.norm_fc(op)
 
@@ -214,6 +223,7 @@ def test_multi_process_getoutput_remote_workflow():
         workflows.append(remote_workflow)
 
     local_wf = core.Workflow()
+    local_wf.progress_bar = False
     merge = ops.utility.merge_fields_containers()
     min_max = ops.min_max.min_max_fc(merge)
     local_wf.add_operator(merge)
@@ -236,6 +246,7 @@ def test_multi_process_getoutput_remote_workflow():
 def test_multi_process_chain_remote_workflow():
     files = examples.download_distributed_files()
     wf = core.Workflow()
+    wf.progress_bar = False
     op = ops.result.displacement()
     average = core.operators.math.norm_fc(op)
 
@@ -262,6 +273,7 @@ def test_multi_process_chain_remote_workflow():
         workflows.append(remote_workflow)
 
     local_wf = core.Workflow()
+    local_wf.progress_bar = False
     merge = ops.utility.merge_fields_containers()
     min_max = ops.min_max.min_max_fc(merge)
     local_wf.add_operator(merge)
@@ -293,6 +305,7 @@ def test_multi_process_chain_remote_workflow():
 )
 def test_remote_workflow_info(local_server):
     wf = core.Workflow()
+    wf.progress_bar = False
     op = ops.result.displacement()
     average = core.operators.math.norm_fc(op)
 
@@ -318,6 +331,7 @@ def test_multi_process_local_remote_local_remote_workflow():
     files = examples.download_distributed_files()
 
     wf = core.Workflow()
+    wf.progress_bar = False
     average = core.operators.math.norm_fc()
 
     wf.add_operators([average])
@@ -340,6 +354,7 @@ def test_multi_process_local_remote_local_remote_workflow():
         remote_workflow = remote_workflow_prov.get_output(0, core.types.workflow)
 
         first_wf = core.Workflow()
+        first_wf.progress_bar = False
         op = ops.result.displacement()
         first_wf.add_operator(op)
         first_wf.set_input_name("data_sources", op.inputs.data_sources)
@@ -351,6 +366,7 @@ def test_multi_process_local_remote_local_remote_workflow():
         workflows.append(remote_workflow)
 
     local_wf = core.Workflow()
+    local_wf.progress_bar = False
     merge = ops.utility.merge_fields_containers()
     min_max = ops.min_max.min_max_fc(merge)
     local_wf.add_operator(merge)
@@ -374,6 +390,7 @@ def test_multi_process_transparent_api_remote_workflow():
     for i in files:
         data_sources1 = core.DataSources(files[i], server=local_servers[i])
         wf = core.Workflow(server=local_servers[i])
+        wf.progress_bar = False
         op = ops.result.displacement(data_sources=data_sources1, server=local_servers[i])
         average = core.operators.math.norm_fc(op, server=local_servers[i])
 
@@ -383,6 +400,7 @@ def test_multi_process_transparent_api_remote_workflow():
         workflows.append(wf)
 
     local_wf = core.Workflow()
+    local_wf.progress_bar = False
     merge = ops.utility.merge_fields_containers()
     min_max = ops.min_max.min_max_fc(merge)
     local_wf.add_operator(merge)
@@ -406,6 +424,7 @@ def test_multi_process_with_names_transparent_api_remote_workflow():
     for i in files:
         data_sources1 = core.DataSources(files[i], server=local_servers[i])
         wf = core.Workflow(server=local_servers[i])
+        wf.progress_bar = False
         op = ops.result.displacement(data_sources=data_sources1, server=local_servers[i])
         average = core.operators.math.norm_fc(op, server=local_servers[i])
 
@@ -415,6 +434,7 @@ def test_multi_process_with_names_transparent_api_remote_workflow():
         workflows.append(wf)
 
     local_wf = core.Workflow()
+    local_wf.progress_bar = False
     merge = ops.utility.merge_fields_containers()
     min_max = ops.min_max.min_max_fc(merge)
     local_wf.add_operator(merge)
@@ -437,6 +457,7 @@ def test_multi_process_transparent_api_connect_local_datasources_remote_workflow
     workflows = []
     for i in files:
         wf = core.Workflow(server=local_servers[i])
+        wf.progress_bar = False
         op = ops.result.displacement(server=local_servers[i])
         average = core.operators.math.norm_fc(op, server=local_servers[i])
 
@@ -446,6 +467,7 @@ def test_multi_process_transparent_api_connect_local_datasources_remote_workflow
         workflows.append(wf)
 
     local_wf = core.Workflow()
+    local_wf.progress_bar = False
     merge = ops.utility.merge_fields_containers()
     min_max = ops.min_max.min_max_fc(merge)
     local_wf.add_operator(merge)
@@ -470,6 +492,7 @@ def test_multi_process_transparent_api_connect_local_op_remote_workflow():
     workflows = []
     for i in files:
         wf = core.Workflow(server=local_servers[i])
+        wf.progress_bar = False
         op = ops.result.displacement(server=local_servers[i])
         average = core.operators.math.norm_fc(op, server=local_servers[i])
 
@@ -479,6 +502,7 @@ def test_multi_process_transparent_api_connect_local_op_remote_workflow():
         workflows.append(wf)
 
     local_wf = core.Workflow()
+    local_wf.progress_bar = False
     merge = ops.utility.merge_fields_containers()
     min_max = ops.min_max.min_max_fc(merge)
     local_wf.add_operator(merge)
@@ -502,6 +526,7 @@ def test_multi_process_transparent_api_connect_local_op_remote_workflow():
 def test_multi_process_transparent_api_create_on_local_remote_workflow():
     files = examples.download_distributed_files()
     wf = core.Workflow()
+    wf.progress_bar = False
     op = ops.result.displacement()
     average = core.operators.math.norm_fc(op)
 
@@ -510,6 +535,7 @@ def test_multi_process_transparent_api_create_on_local_remote_workflow():
     wf.set_input_name("ds", op.inputs.data_sources)
 
     local_wf = core.Workflow()
+    local_wf.progress_bar = False
     merge = ops.utility.merge_fields_containers()
     min_max = ops.min_max.min_max_fc(merge)
     local_wf.add_operator(merge)
@@ -533,6 +559,7 @@ def test_multi_process_transparent_api_create_on_local_remote_workflow():
 def test_multi_process_transparent_api_create_on_local_remote_ith_address_workflow():
     files = examples.download_distributed_files()
     wf = core.Workflow()
+    wf.progress_bar = False
     op = ops.result.displacement()
     average = core.operators.math.norm_fc(op)
 

tests/test_animator.py

@@ -69,6 +69,7 @@ def test_animator_animate(displacement_fields):
     loop_over_field.unit = frequencies.unit
 
     wf = Workflow()
+    wf.progress_bar = False
     extract_field_op = dpf.operators.utility.extract_field(displacement_fields)
     wf.set_input_name("loop_over", extract_field_op.inputs.indices)
     wf.set_output_name("to_render", extract_field_op.outputs.field)
@@ -85,6 +86,7 @@ def test_animator_animate_raise_wrong_scale_factor(remove_gifs, displacement_fie
     loop_over_field.unit = frequencies.unit
 
     wf = Workflow()
+    wf.progress_bar = False
     extract_field_op = dpf.operators.utility.extract_field(displacement_fields)
     wf.set_input_name("loop_over", extract_field_op.inputs.indices)
     wf.set_output_name("to_render", extract_field_op.outputs.field)

tests/test_cff.py

@@ -22,7 +22,7 @@ def test_cff_model(server_type, fluent_multi_species):
 )
 def test_results_cfx(cfx_heating_coil, server_type):
     model = dpf.Model(cfx_heating_coil(server=server_type), server=server_type)
-    print(model)
+    # print(model)
     result_names = [
         "specific_heat",
         "epsilon",
@@ -55,7 +55,7 @@ def test_results_cfx(cfx_heating_coil, server_type):
 )
 def test_results_fluent(fluent_mixing_elbow_steady_state, server_type):
     model = dpf.Model(fluent_mixing_elbow_steady_state(server=server_type), server=server_type)
-    print(model)
+    # print(model)
     result_names = [
         "epsilon",
         "enthalpy",

tests/test_codegeneration.py

@@ -286,7 +286,7 @@ def test_generated_operator_set_config():
     inpt2.unit = "m"
 
     conf = op.math.add.default_config()
-    print(conf)
+    # print(conf)
     conf.set_work_by_index_option(True)
     op1 = op.math.add(config=conf)
     op1.inputs.fieldA.connect(inpt)

tests/test_custom_type_field.py

@@ -27,7 +27,7 @@ def test_set_get_data_custom_type_field(server_type):
         data[i] = np.byte(b"2")
     field.data = data
     assert np.allclose(field.data, data)
-    print(field.data)
+    # print(field.data)
 
 
 @conftest.raises_for_servers_version_under("5.0")
@@ -96,7 +96,7 @@ def test_set_get_field_def_custom_type_field(server_type):
 
     copy = field.field_definition
 
-    print(copy.dimensionality)
+    # print(copy.dimensionality)
     assert copy.dimensionality == dpf.core.Dimensionality([3], dpf.core.natures.vector)
     assert copy.location == core.locations.elemental
     assert copy.name == "thing"

tests/test_cyclic_support.py

@@ -117,6 +117,7 @@ def test_cyc_support_from_to_workflow(cyclic_lin_rst, server_type):
     cyc_support = result_info.cyclic_support
     op = dpf.operators.metadata.cyclic_mesh_expansion(server=server_type)
     wf = dpf.Workflow(server=server_type)
+    wf.progress_bar = False
     wf.set_input_name("sup", op.inputs.cyclic_support)
     wf.set_output_name("sup", op.outputs.cyclic_support)
     wf.connect("sup", cyc_support)

tests/test_elements.py

@@ -136,7 +136,7 @@ def test_no_element_descriptor():
     # descriptor = dpf.element_types.descriptor(89)
     # assert not descriptor
     descriptor = dpf.element_types.descriptor(dpf.element_types.General)
-    print(descriptor)
+    # print(descriptor)
     unknown_shape = "unknown_shape"
     assert descriptor.shape == unknown_shape
     assert dpf.element_types.descriptor(dpf.element_types.General).shape == unknown_shape