Prepare pipelines for v222 and fix doctests (#300)

PProfizi · web-flow · commit 3f866d9fb6a3 · 2022-07-21T14:28:40.000+02:00
diff --git a/.github/workflows/ansys_dpf_gate-0.1.dev1-py3-none-any.whl b/.github/workflows/ansys_dpf_gate-0.1.dev1-py3-none-any.whl
diff --git a/.github/workflows/ansys_dpf_gatebin-0.1.dev1-py3-none-linux_x86_64.whl b/.github/workflows/ansys_dpf_gatebin-0.1.dev1-py3-none-linux_x86_64.whl
diff --git a/.github/workflows/ansys_dpf_gatebin-0.1.dev1-py3-none-win_amd64.whl b/.github/workflows/ansys_dpf_gatebin-0.1.dev1-py3-none-win_amd64.whl
diff --git a/.github/workflows/ansys_grpc_dpf-0.5.dev1-py3-none-any.whl b/.github/workflows/ansys_grpc_dpf-0.5.dev1-py3-none-any.whl
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -10,6 +10,7 @@ on:
     branches:
       - master
       - "release*"
+      - "merge*"
 
 concurrency:
   group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
@@ -18,7 +19,7 @@ concurrency:
 env:
   PACKAGE_NAME: ansys-dpf-core
   MODULE: core
-  ANSYS_VERSION: 221
+  ANSYS_VERSION: 222
 
 jobs:
   Build_and_Test:
@@ -34,7 +35,7 @@ jobs:
       - uses: actions/checkout@v3
 
       - name: "Build Package"
-        uses: pyansys/pydpf-actions/build_package@v2.1.1
+        uses: pyansys/pydpf-actions/build_package@v2.2
         with:
           python-version: ${{ matrix.python-version }}
           ANSYS_VERSION: ${{env.ANSYS_VERSION}}
@@ -44,9 +45,10 @@ jobs:
           install_extras: plotting
 
       - name: "Test Package"
-        uses: pyansys/pydpf-actions/test_package@v2.1.1
+        uses: pyansys/pydpf-actions/test_package@v2.2
         with:
           MODULE: ${{env.MODULE}}
+          DEBUG: True
 
       - name: 'Upload to PyPi'
         if: contains(github.ref, 'refs/tags')
@@ -62,10 +64,7 @@ jobs:
 
   build_doc:
     name: Documentation
-    runs-on: windows-2019
-
-    env:
-      ANSYS_VERSION: 221
+    runs-on: windows-latest
 
     steps:
       - uses: actions/checkout@v3
@@ -87,6 +86,16 @@ jobs:
       - name: Set SERVER
         run: echo "SERVER=$env:AWP_ROOT221"  | Out-File -FilePath $Env:GITHUB_ENV -Encoding utf-8 -Append
 
+      - name: "Install gatebin Windows"
+        working-directory: .github\workflows
+        run: pip install ansys_dpf_gatebin-0.1.dev1-py3-none-win_amd64.whl
+
+      - name: "Install pygate"
+        working-directory: .github\workflows
+        run: |
+          pip install ansys_dpf_gate-0.1.dev1-py3-none-any.whl
+          pip install ansys_grpc_dpf-0.5.dev1-py3-none-any.whl
+
       - name: Install ansys-dpf-core
         shell: cmd
         run: |
diff --git a/ansys/dpf/core/core.py b/ansys/dpf/core/core.py
@@ -156,6 +156,8 @@ def download_file(server_file_path, to_client_file_path, server=None):
     >>> import os
     >>> file_path = dpf.upload_file_in_tmp_folder(examples.static_rst)
     >>> dpf.download_file(file_path, examples.static_rst)
+    <BLANKLINE>
+    Downloading...
 
     """
     base = BaseService(server, load_operators=False)
diff --git a/ansys/dpf/core/cyclic_support.py b/ansys/dpf/core/cyclic_support.py
@@ -192,7 +192,7 @@ def sectors_set_for_expansion(self, stage_num=0) -> Scoping:
         >>> multi_stage = examples.download_multi_stage_cyclic_result()
         >>> cyc_support = Model(multi_stage).metadata.result_info.cyclic_support
         >>> print(cyc_support.sectors_set_for_expansion(stage_num=1).ids)
-        [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11]
+        [...0... 1... 2... 3... 4... 5... 6... 7... 8... 9... 10... 11]
 
         """
         sectors_for_expansion = self._api.cyclic_support_get_sectors_scoping(self, stage_num)
@@ -224,7 +224,7 @@ def expand_node_id(self, node_id, sectors=None, stage_num=0):
         >>> multi_stage = examples.download_multi_stage_cyclic_result()
         >>> cyc_support = Model(multi_stage).metadata.result_info.cyclic_support
         >>> print(cyc_support.expand_node_id(1,stage_num=0).ids)
-        [1, 3596, 5816, 8036, 10256, 12476]
+        [...1... 3596... 5816... 8036... 10256... 12476]
 
         """
         if sectors is None:
@@ -262,7 +262,7 @@ def expand_element_id(self, element_id, sectors=None, stage_num=0):
         >>> multi_stage = examples.download_multi_stage_cyclic_result()
         >>> cyc_support = Model(multi_stage).metadata.result_info.cyclic_support
         >>> print(cyc_support.expand_element_id(1,stage_num=0).ids)
-        [1, 1558, 2533, 3508, 4483, 5458]
+        [...1... 1558... 2533... 3508... 4483... 5458]
 
         """
         if sectors is None:
diff --git a/ansys/dpf/core/data_tree.py b/ansys/dpf/core/data_tree.py
@@ -243,6 +243,8 @@ def write_to_txt(self, path=None):
         >>> import tempfile
         >>> import os
         >>> data_tree.write_to_txt(os.path.join(tempfile.mkdtemp(), "data_tree.txt"))
+        <BLANKLINE>
+        Downloading...
 
         """
         from ansys.dpf.core.operators.serialization import data_tree_to_txt
@@ -280,6 +282,8 @@ def write_to_json(self, path=None):
         >>> import tempfile
         >>> import os
         >>> data_tree.write_to_json(os.path.join(tempfile.mkdtemp(), "data_tree.json"))
+        <BLANKLINE>
+        Downloading...
 
         """
         from ansys.dpf.core.operators.serialization import data_tree_to_json
diff --git a/ansys/dpf/core/field_base.py b/ansys/dpf/core/field_base.py
@@ -366,7 +366,8 @@ def append(self, data, scopingid):
         array([[1., 2., 3.],
                [1., 2., 3.]])
         >>> field.scoping.ids
-        [1, 2]
+        <BLANKLINE>
+        ...[1, 2]...
 
         """
         pass
diff --git a/ansys/dpf/core/operator_specification.py b/ansys/dpf/core/operator_specification.py
@@ -142,9 +142,11 @@ class ConfigOptionSpec:
     >>> operator = dpf.operators.math.add()
     >>> config_spec = operator.specification.config_specification
     >>> config_spec.keys()
-    dict_keys(['binary_operation', 'inplace', 'mutex', 'num_threads', 'permissive', 'run_in_parallel', 'use_cache', 'work_by_index'])  # noqa: E501
+    dict_keys(['binary_operation', 'inplace', 'mutex', 'num_threads', 'permissive', \
+    'run_in_parallel', 'use_cache', 'work_by_index'])
     >>> config_spec['inplace']
-    ConfigOptionSpec(name='inplace', type_names=['bool'], default_value_str='false', document='The output is written over the input to save memory if this config is set to true.')  # noqa: E501
+    ConfigOptionSpec(name='inplace', type_names=['bool'], default_value_str='false', \
+    document='The output is written over the input to save memory if this config is set to true.')
 
     """
 
@@ -257,18 +259,22 @@ def properties(self):
         >>> from ansys.dpf import core as dpf
         >>> operator = dpf.operators.math.add()
         >>> operator.specification.properties
-        {'plugin': 'core', 'category': 'math', 'user_name': '+', 'exposure': 'public'}
+        {'category': 'math', 'exposure': 'public', 'plugin': 'core', 'user_name': '+'}
         """
         if self._properties is None:
-            self._properties = dict()
+            temp_properties = dict()
             if self._internal_obj is not None:
                 num_properties = self._api.operator_specification_get_num_properties(self)
                 for i_property in range(num_properties):
                     property_key = self._api.operator_specification_get_property_key(
                         self, i_property
                     )
                     prop = self._api.operator_specification_get_properties(self, property_key)
-                    self._properties[property_key] = prop
+                    temp_properties[property_key] = prop
+            # Reorder the properties for consistency
+            self._properties = dict()
+            for key in sorted(temp_properties.keys()):
+                self._properties[key] = temp_properties[key]
         return self._properties
 
     @property
@@ -284,7 +290,7 @@ def description(self) -> str:
         >>> from ansys.dpf import core as dpf
         >>> operator = dpf.operators.math.scale_by_field()
         >>> operator.specification.description
-        "Scales a field (in 0) by a scalar field (in 1). If one field's scoping has 'overall' location, then these field's values are applied on the entire other field."  # noqa: E501
+        "Scales a field (in 0) by a scalar field (in 1). If one field's ... the entire other field."
         """
         if self._internal_obj is not None:
             return self._api.operator_specification_get_description(self)
@@ -305,7 +311,7 @@ def inputs(self) -> dict:
         >>> 4 in operator.specification.inputs.keys()
         True
         >>> operator.specification.inputs[4]
-        PinSpecification(name='data_sources', _type_names=['data_sources'], optional=False, document='result file path container, used if no streams are set', ellipsis=False)  # noqa: E501
+        PinSpecification(name='data_sources', _type_names=['data_sources'], ...set', ellipsis=False)
         """
         if self._map_input_pin_spec is None:
             self._map_input_pin_spec = {}
@@ -325,7 +331,7 @@ def outputs(self) -> dict:
         >>> from ansys.dpf import core as dpf
         >>> operator = dpf.operators.mesh.mesh_provider()
         >>> operator.specification.outputs
-        {0: PinSpecification(name='mesh', _type_names=['abstract_meshed_region'], optional=False, document='', ellipsis=False)}  # noqa: E501
+        {0: PinSpecification(name='mesh', _type_names=['abstract_meshed_region'], ...=False)}
         """
         if self._map_output_pin_spec is None:
             self._map_output_pin_spec = {}
diff --git a/ansys/dpf/core/results.py b/ansys/dpf/core/results.py
@@ -285,7 +285,8 @@ def on_all_time_freqs(self):
         >>> model = dpf.Model(examples.msup_transient)
         >>> disp = model.results.displacement
         >>> disp.on_all_time_freqs.eval().get_label_scoping("time").ids
-        [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20]
+        <BLANKLINE>
+        ...1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20]...
 
         """
         self._time_scoping = list(
@@ -308,7 +309,8 @@ def on_first_time_freq(self):
         >>> model = dpf.Model(examples.msup_transient)
         >>> disp = model.results.displacement
         >>> disp.on_first_time_freq.eval().get_label_scoping("time").ids
-        [1]
+        <BLANKLINE>
+        ...[1]...
 
         """
         self._time_scoping = 1
@@ -329,7 +331,8 @@ def on_last_time_freq(self):
         >>> model = dpf.Model(examples.msup_transient)
         >>> disp = model.results.displacement
         >>> disp.on_last_time_freq.eval().get_label_scoping("time").ids
-        [20]
+        <BLANKLINE>
+        ...[20]...
 
         """
         self._time_scoping = len(
@@ -421,7 +424,8 @@ def split_by_body(self):
         >>> len(fc_disp)
         11
         >>> fc_disp.get_mat_scoping().ids
-        [1, 5, 6, 10, 2, 7, 8, 13, 4, 12, 15]
+        <BLANKLINE>
+        ...1, 5, 6, 10, 2, 7, 8, 13, 4, 12, 15]...
         >>> disp_mat_10 = fc_disp.get_field_by_mat_id(10)
 
         """
diff --git a/ansys/dpf/core/time_freq_support.py b/ansys/dpf/core/time_freq_support.py
@@ -95,7 +95,8 @@ def time_frequencies(self):
         >>> time_freq_support = model.metadata.time_freq_support
         >>> freq = time_freq_support.time_frequencies
         >>> freq.data
-        array([0.        , 0.019975  , 0.039975  , 0.059975  , 0.079975  ,
+        <BLANKLINE>
+        ...rray([0.        , 0.019975  , 0.039975  , 0.059975  , 0.079975  ,
                0.099975  , 0.119975  , 0.139975  , 0.159975  , 0.179975  ,
                0.199975  , 0.218975  , 0.238975  , 0.258975  , 0.278975  ,
                0.298975  , 0.318975  , 0.338975  , 0.358975  , 0.378975  ,
diff --git a/ansys/dpf/core/workflow.py b/ansys/dpf/core/workflow.py
@@ -366,7 +366,7 @@ def add_operators(self, operators):
         >>> workflow = dpf.Workflow()
         >>> disp_op = dpf.Operator("U")
         >>> max_op = dpf.Operator("min_max")
-        >>> workflow.add_operator([disp_op,max_op])
+        >>> workflow.add_operators([disp_op, max_op])
 
         """
         if isinstance(operators, list):
diff --git a/pytest.ini b/pytest.ini
@@ -3,4 +3,5 @@ filterwarnings =
     ignore::FutureWarning
     ignore::PendingDeprecationWarning
     ignore::DeprecationWarning
-norecursedirs = *
+norecursedirs = *
+doctest_optionflags = NORMALIZE_WHITESPACE ELLIPSIS
diff --git a/tests/conftest.py b/tests/conftest.py
@@ -20,7 +20,7 @@
 # currently running dpf on docker.  Used for testing on CI
 running_docker = ansys.dpf.core.server_types.RUNNING_DOCKER["use_docker"]
 
-local_test_repo = True
+local_test_repo = False
 
 if os.name == "posix":
     import ssl
