maint: changes to the example files

Author: moe-ad

examples/05-file-IO/00-hdf5_double_float_comparison.py

@@ -36,7 +36,7 @@
 # Import the ``dpf-core`` module and its examples files, and then create a
 # temporary directory.
 
-import os
+from pathlib import Path
 
 from ansys.dpf import core as dpf
 from ansys.dpf.core import examples
@@ -78,8 +78,8 @@
 # Define a temporary folder for outputs
 tmpdir = dpf.core.make_tmp_dir_server(dpf.SERVER)
 files = [
-    dpf.path_utilities.join(tmpdir, "dpf_float.h5"),
-    dpf.path_utilities.join(tmpdir, "dpf_double.h5"),
+    Path(dpf.path_utilities.join(tmpdir, "dpf_float.h5")),
+    Path(dpf.path_utilities.join(tmpdir, "dpf_double.h5")),
 ]
 ###############################################################################
 # Export with simple precision.
@@ -98,8 +98,8 @@
 # Download the resulting .h5 files if necessary
 
 if not dpf.SERVER.local_server:
-    float_file_path = os.path.join(os.getcwd(), "dpf_float.h5")
-    double_file_path = os.path.join(os.getcwd(), "dpf_double.h5")
+    float_file_path = Path.cwd() / "dpf_float.h5"
+    double_file_path = Path.cwd() / "dpf_double.h5"
     dpf.download_file(files[0], float_file_path)
     dpf.download_file(files[1], double_file_path)
 else:
@@ -109,8 +109,8 @@
 
 ###############################################################################
 # Compare simple precision versus double precision.
-float_precision = os.stat(float_file_path).st_size
-double_precision = os.stat(double_file_path).st_size
+float_precision = float_file_path.stat().st_size
+double_precision = double_file_path.stat().st_size
 print(
     f"size with float precision: {float_precision}\n"
     f"size with double precision: {double_precision}"

examples/05-file-IO/04-basic-load-file.py

@@ -58,16 +58,16 @@
 # ~~~~~~~~~~~~~
 # Export the fields container in the CSV format:
 
-import os
+from pathlib import Path
 
 csv_file_name = "simple_bar_fc.csv"
 # Define an output path for the resulting .csv file
 if not dpf.SERVER.local_server:
     # Define it server-side if using a remote server
     tmp_dir_path = dpf.core.make_tmp_dir_server(dpf.SERVER)
-    server_file_path = dpf.path_utilities.join(tmp_dir_path, csv_file_name)
+    server_file_path = Path(dpf.path_utilities.join(tmp_dir_path, csv_file_name))
 else:
-    server_file_path = os.path.join(os.getcwd(), csv_file_name)
+    server_file_path = Path.cwd() / csv_file_name
 
 # Perform the export to csv on the server side
 export_csv_operator = dpf.operators.serialization.field_to_csv()
@@ -81,7 +81,7 @@
 # Download the file ``simple_bar_fc.csv``:
 
 if not dpf.SERVER.local_server:
-    downloaded_client_file_path = os.path.join(os.getcwd(), "simple_bar_fc_downloaded.csv")
+    downloaded_client_file_path = Path.cwd() / "simple_bar_fc_downloaded.csv"
     dpf.download_file(server_file_path, downloaded_client_file_path)
 else:
     downloaded_client_file_path = server_file_path
@@ -98,7 +98,7 @@
 mesh.plot(server_fc_out)
 
 # Remove file to avoid polluting.
-os.remove(downloaded_client_file_path)
+downloaded_client_file_path.unlink()
 
 ###############################################################################
 # Make operations over the fields container

examples/08-python-operators/00-wrapping_numpy_capabilities.py

@@ -57,11 +57,12 @@
 # Download and display the Python script.
 
 from ansys.dpf.core.examples import download_easy_statistics
+from pathlib import Path
 
-operator_file_path = download_easy_statistics()
+operator_file_path = Path(download_easy_statistics())
 
-with open(operator_file_path, "r") as f:
-    for line in f.readlines():
+with operator_file_path.open() as file:
+    for line in file.readlines():
         print("\t\t\t" + line)
 
 ###############################################################################
@@ -76,15 +77,14 @@
 # - The third argument is the name of the function used to record operators.
 #
 
-import os
 from ansys.dpf import core as dpf
 from ansys.dpf.core import examples
 
 # Python plugins are not supported in process.
 dpf.start_local_server(config=dpf.AvailableServerConfigs.GrpcServer)
 
-operator_server_file_path = dpf.upload_file_in_tmp_folder(operator_file_path)
-dpf.load_library(os.path.dirname(operator_server_file_path), "py_easy_statistics", "load_operators")
+operator_server_file_path = Path(dpf.upload_file_in_tmp_folder(operator_file_path))
+dpf.load_library(operator_server_file_path.parent, "py_easy_statistics", "load_operators")
 
 ###############################################################################
 # Instantiate the operator.

examples/08-python-operators/01-package_python_operators.py

@@ -72,8 +72,6 @@
 #   for the plug-in package that is used to record operators.
 #
 
-import os
-
 from ansys.dpf import core as dpf
 from ansys.dpf.core import examples
 
@@ -83,7 +81,7 @@
 tmp = dpf.make_tmp_dir_server()
 dpf.upload_files_in_folder(dpf.path_utilities.join(tmp, "average_filter_plugin"), plugin_folder)
 dpf.load_library(
-    os.path.join(dpf.path_utilities.join(tmp, "average_filter_plugin")),
+    dpf.path_utilities.join(tmp, "average_filter_plugin"),
     "py_average_filter",
     "load_operators",
 )

examples/08-python-operators/02-python_operators_with_dependencies.py

@@ -58,11 +58,12 @@
 # created for you.
 
 import os
+from pathlib import Path
 
 from ansys.dpf.core import examples
 
-plugin_path = examples.download_gltf_plugin()
-folder_root = os.path.join(os.getcwd().rsplit("pydpf-core", 1)[0], "pydpf-core")
+plugin_path = Path(examples.download_gltf_plugin())
+folder_root = Path(__file__).parent.parent.parent
 
 # %%
 # To add third-party modules as dependencies to a plug-in package, you must
@@ -83,8 +84,9 @@
 # To simplify this step, you can add a requirements file in the plug-in package:
 #
 print("\033[1m gltf_plugin/requirements.txt: \n \033[0m")
-with open(os.path.join(plugin_path, "requirements.txt"), "r") as f:
-    for line in f.readlines():
+requirements_path = plugin_path / "requirements.txt"
+with requirements_path.open("r") as file:
+    for line in file.readlines():
         print("\t\t\t" + line)
 
 
@@ -117,26 +119,21 @@
 #
 #    create_sites_for_python_operators.sh -pluginpath /path/to/plugin -zippath /path/to/plugin/assets/linx64.zip # noqa: E501
 
-
-if os.name == "nt" and not os.path.exists(
-    os.path.join(plugin_path, "assets", "gltf_sites_winx64.zip")
-):
-    cmd_file = os.path.join(
-        folder_root,
-        "doc",
-        "source",
-        "user_guide",
-        "create_sites_for_python_operators.ps1",
+site_path = plugin_path / "assets" / "gltf_sites_winx64.zip"
+if os.name == "nt" and not site_path.exists():
+    cmd_file = (
+        folder_root / "doc" / "source" / "user_guide" / "create_sites_for_python_operators.ps1"
     )
     args = [
         "powershell",
-        cmd_file,
+        str(cmd_file),
         "-pluginpath",
-        plugin_path,
+        str(plugin_path),
         "-zippath",
-        os.path.join(plugin_path, "assets", "gltf_sites_winx64.zip"),
+        str(plugin_path / "assets" / "gltf_sites_winx64.zip"),
     ]
     print(args)
+
     import subprocess
 
     process = subprocess.run(args, stdout=subprocess.PIPE, stderr=subprocess.PIPE)
@@ -150,20 +147,15 @@
         )
     else:
         print("Installing pygltf in a virtual environment succeeded")
-elif os.name == "posix" and not os.path.exists(
-    os.path.join(plugin_path, "assets", "gltf_sites_linx64.zip")
-):
-    cmd_file = os.path.join(
-        folder_root,
-        "doc",
-        "source",
-        "user_guide",
-        "create_sites_for_python_operators.sh",
+
+elif os.name == "posix" and not site_path.exists():
+    cmd_file = (
+        folder_root / "doc" / "source" / "user_guide" / "create_sites_for_python_operators.sh"
     )
     run_cmd = f"{cmd_file}"
     args = (
         f' -pluginpath "{plugin_path}" '
-        f"-zippath \"{os.path.join(plugin_path, 'assets', 'gltf_sites_linx64.zip')}\""
+        f'-zippath \"{plugin_path / "assets" / "gltf_sites_winx64.zip"}\"'
     )
     print(run_cmd + args)
     os.system(f"chmod u=rwx,o=x {cmd_file}")
@@ -189,9 +181,9 @@
 # Python plugins are not supported in process.
 dpf.start_local_server(config=dpf.AvailableServerConfigs.GrpcServer)
 
-tmp = dpf.make_tmp_dir_server()
-dpf.upload_files_in_folder(dpf.path_utilities.join(tmp, "plugins", "gltf_plugin"), plugin_path)
-dpf.upload_file(plugin_path + ".xml", dpf.path_utilities.join(tmp, "plugins", "gltf_plugin.xml"))
+tmp = Path(dpf.make_tmp_dir_server())
+dpf.upload_files_in_folder(dpf.path_utilities.join(str(tmp), "plugins", "gltf_plugin"), plugin_path)
+dpf.upload_file(str(plugin_path) + ".xml", dpf.path_utilities.join(str(tmp), "plugins", "gltf_plugin.xml"))
 
 dpf.load_library(
     dpf.path_utilities.join(tmp, "plugins", "gltf_plugin"),
@@ -235,8 +227,6 @@
 # Use the custom operator
 # -----------------------
 
-import os
-
 model = dpf.Model(dpf.upload_file_in_tmp_folder(examples.find_static_rst()))
 
 mesh = model.metadata.meshed_region
@@ -245,14 +235,14 @@
 displacement = model.results.displacement()
 displacement.inputs.mesh_scoping(skin_mesh)
 displacement.inputs.mesh(skin_mesh)
-new_operator.inputs.path(os.path.join(tmp, "out"))
+new_operator.inputs.path(str(tmp / "out"))
 new_operator.inputs.mesh(skin_mesh)
 new_operator.inputs.field(displacement.outputs.fields_container()[0])
 new_operator.run()
 
 print("operator ran successfully")
 
-dpf.download_file(os.path.join(tmp, "out.glb"), os.path.join(os.getcwd(), "out.glb"))
+dpf.download_file(tmp / "out.glb", Path.cwd / "out.glb")
 
 # %%
 # You can download :download:`output <images/thumb/out.glb>` from the ``gltf`` operator.