REFACTOR: pathlib refactor multi-files (#5943)

Author: jvela018

doc/changelog.d/5943.miscellaneous.md

@@ -0,0 +1 @@
+pathlib refactor multi-files

src/ansys/aedt/core/maxwellcircuit.py

@@ -25,7 +25,7 @@
 """This module contains the ``MaxwellCircuit`` class."""
 
 import math
-import os
+from pathlib import Path
 
 from ansys.aedt.core.application.analysis_maxwell_circuit import AnalysisMaxwellCircuit
 from ansys.aedt.core.generic.file_utils import open_file
@@ -223,7 +223,7 @@ def export_netlist_from_schematic(self, output_file):
 
         Parameters
         ----------
-        output_file : str
+        output_file : str or :class:`pathlib.Path`
             File path to export the netlist to.
 
         Returns
@@ -232,7 +232,7 @@ def export_netlist_from_schematic(self, output_file):
             Netlist file path when successful, ``False`` when failed.
 
         """
-        if os.path.splitext(output_file)[1] != ".sph":
+        if Path(output_file).suffix != ".sph":
             self.logger.error("Invalid file extension. It must be ``.sph``.")
             return False
         try:

src/ansys/aedt/core/modeler/cad/object_3d.py

@@ -34,7 +34,7 @@
 """
 
 import math
-import os
+from pathlib import Path
 import re
 
 from ansys.aedt.core.generic.constants import AEDT_UNITS
@@ -184,11 +184,11 @@ def _bounding_box_sat(self):
 
         """
         tmp_path = self._primitives._app.working_directory
-        filename = os.path.join(tmp_path, self.name + ".sat")
+        filename = Path(tmp_path) / (self.name + ".sat")
 
         self._primitives._app.export_3d_model(self.name, tmp_path, ".sat", [self.name])
 
-        if not os.path.isfile(filename):
+        if not Path(filename).is_file():
             raise Exception(f"Cannot export the ACIS SAT file for object {self.name}")
 
         with open_file(filename, "r") as fh:
@@ -212,7 +212,7 @@ def _bounding_box_sat(self):
             return False
 
         try:
-            os.remove(filename)
+            Path(filename).unlink()
         except Exception:
             self.logger.warning("ERROR: Cannot remove temp file.")
         return bb
@@ -309,7 +309,7 @@ def export_image(self, output_file=None):
 
         Parameters
         ----------
-        output_file : str, optional
+        output_file : str or :class:`pathlib.Path`, optional
             File name with full path. If `None` the exported image will be a ``png`` file that
             will be saved in ``working_directory``.
             To access the ``working_directory`` the use ``app.working_directory`` property.
@@ -320,7 +320,7 @@ def export_image(self, output_file=None):
             File path.
         """
         if not output_file:
-            output_file = os.path.join(self._primitives._app.working_directory, self.name + ".png")
+            output_file = Path(self._primitives._app.working_directory) / (self.name + ".png")
         model_obj = self._primitives._app.post.plot_model_obj(
             objects=[self.name],
             show=False,

src/ansys/aedt/core/modeler/modeler_pcb.py

@@ -22,7 +22,7 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 # SOFTWARE.
 
-import os
+from pathlib import Path
 import re
 from warnings import warn
 
@@ -134,11 +134,11 @@ def o_model_manager(self):  # pragma: no cover
 
     @property
     def _edb_folder(self):
-        return os.path.join(self._app.project_path, self._app.project_name + ".aedb")
+        return Path(self._app.project_path) / (self._app.project_name + ".aedb")
 
     @property
     def _edb_file(self):
-        return os.path.join(self._edb_folder, "edb.def")
+        return Path(self._edb_folder) / "edb.def"
 
     @property
     def edb(self):
@@ -156,7 +156,7 @@ def edb(self):
             from pyedb import Edb
 
             self._edb = None
-            if os.path.exists(self._edb_file) or inside_desktop:
+            if Path(self._edb_file).exists() or inside_desktop:
                 self._edb = Edb(
                     self._edb_folder,
                     self._app.design_name,
@@ -519,7 +519,7 @@ def import_cadence_brd(self, input_file, output_dir=None, name=None):
         output_dir : str, optional
             Path where the EDB is to be created. The default is ``None``, in which
             case the project directory is used.
-        name : str, optional
+        name : str or :class:`pathlib.Path`, optional
             Name of the EDB. The default is ``None``, in which
             case the board name is used.
 
@@ -535,11 +535,11 @@ def import_cadence_brd(self, input_file, output_dir=None, name=None):
         if not output_dir:
             output_dir = self.projdir
         if not name:
-            name = os.path.basename(input_file)
-            name = os.path.splitext(name)[0]
+            name = Path(input_file).name
+            name = Path(name).stem
 
         self._oimportexport.ImportExtracta(
-            input_file, os.path.join(output_dir, name + ".aedb"), os.path.join(output_dir, name + ".xml")
+            input_file, str(Path(output_dir) / (name + ".aedb")), str(Path(output_dir) / (name + ".xml"))
         )
         self._app.__init__(self._app.desktop_class.active_project().GetName())
         return True
@@ -572,7 +572,7 @@ def import_ipc2581(self, input_file, output_dir=None, name=None):
         output_dir : str, optional
             Path where the EDB is to be created. The default is ``None``, in which
             case the project directory is used.
-        name : str, optional
+        name : str or :class:`pathlib.Path`, optional
             Name of the EDB. The default is ``None``, in which
             case the board name is used.
 
@@ -588,11 +588,11 @@ def import_ipc2581(self, input_file, output_dir=None, name=None):
         if not output_dir:
             output_dir = self.projdir
         if not name:
-            name = os.path.basename(input_file)
-            name = os.path.splitext(name)[0]
+            name = Path(input_file).name
+            name = Path(name).stem
 
         self._oimportexport.ImportIPC(
-            input_file, os.path.join(output_dir, name + ".aedb"), os.path.join(output_dir, name + ".xml")
+            input_file, str(Pathn(output_dir) / (name + ".aedb")), str(Path(output_dir) / (name + ".xml"))
         )
         self._app.__init__(self._app.desktop_class.active_project().GetName())
         return True
@@ -955,9 +955,9 @@ def set_touchstone_model(self, assignment, input_file, model_name=None):
         ----------
         assignment : str
             Name of the component.
-        input_file : str, optional
+        input_file : str or :class:`pathlib.Path`, optional
             Full path to the model file. The default is ``None``.
-        model_name : str, optional
+        model_name : str or :class:`pathlib.Path`, optional
             Name of the model. The default is ``None``, in which case the model name is the file name without an
             extension.
 
@@ -977,12 +977,12 @@ def set_touchstone_model(self, assignment, input_file, model_name=None):
         """
 
         if not model_name:
-            model_name = os.path.splitext(os.path.basename(input_file))[0]
+            model_name = Path(Path(input_file).name).stem
             if "." in model_name:
                 model_name = model_name.replace(".", "_")
         if model_name in list(self.omodel_manager.GetNames()):
             model_name = generate_unique_name(model_name, n=2)
-        num_terminal = int(os.path.splitext(input_file)[1].lower().strip(".sp"))
+        num_terminal = int(Path(input_file).suffix.lower().strip(".sp"))
 
         port_names = []
         with open_file(input_file, "r") as f:
@@ -1019,7 +1019,7 @@ def set_touchstone_model(self, assignment, input_file, model_name=None):
             ["NAME:PortInfoBlk"],
             ["NAME:PortOrderBlk"],
             "filename:=",
-            input_file,
+            str(input_file),
             "numberofports:=",
             num_terminal,
             "sssfilename:=",

src/ansys/aedt/core/q3d.py

@@ -24,7 +24,7 @@
 
 """This module contains these classes: ``Q2d``, ``Q3d``, and ``QExtractor``."""
 
-import os
+from pathlib import Path
 import re
 import warnings
 
@@ -59,7 +59,7 @@ class QExtractor(FieldAnalysis3D, object):
     @property
     def design_file(self):
         """Design file."""
-        design_file = os.path.join(self.working_directory, "design_data.json")
+        design_file = Path(self.working_directory) / "design_data.json"
         return design_file
 
     def __init__(
@@ -239,7 +239,7 @@ def export_mesh_stats(self, setup, variations="", output_file=None, setup_type="
             Setup name.
         variations : str, optional
             Variation list. The default is ``""``.
-        output_file : str, optional
+        output_file : str or :class:`pathlib.Path`, optional
             Full path to the mesh statistics file. The default is ``None``, in which
             case the working directory is used.
         setup_type : str, optional
@@ -256,9 +256,9 @@ def export_mesh_stats(self, setup, variations="", output_file=None, setup_type="
         >>> oDesign.ExportMeshStats
         """
         if not output_file:
-            output_file = os.path.join(self.working_directory, "meshstats.ms")
-        self.odesign.ExportMeshStats(setup, variations, setup_type, output_file)
-        return output_file
+            output_file = Path(self.working_directory) / "meshstats.ms"
+        self.odesign.ExportMeshStats(setup, variations, setup_type, str(output_file))
+        return str(output_file)
 
     @pyaedt_function_handler()
     def edit_sources(
@@ -503,7 +503,7 @@ def export_matrix_data(
         bool
             ``True`` when successful, ``False`` when failed.
         """
-        if os.path.splitext(file_name)[1] not in [".m", ".lvl", ".csv", ".txt"]:
+        if Path(file_name).suffix not in [".m", ".lvl", ".csv", ".txt"]:
             self.logger.error("Extension is invalid. Possible extensions are *.m, *.lvl, *.csv, and *.txt.")
             return False
 
@@ -921,7 +921,7 @@ def export_equivalent_circuit(
         >>> aedtapp.export_equivalent_circuit(output_file="test_export_circuit.cir",
         ...                                   setup=mysetup.name,sweep="LastAdaptive", variations=["d: 20mm"])
         """
-        if os.path.splitext(output_file)[1] not in [
+        if Path(output_file).suffix not in [
             ".cir",
             ".sml",
             ".sp",
@@ -2507,7 +2507,7 @@ def export_w_elements(self, analyze=False, export_folder=None):
         analyze : bool, optional
             Whether to analyze before export. Solutions must be present for the design.
             The default is ``False``.
-        export_folder : str, optional
+        export_folder : str or :class:`pathlib.Path`, optional
             Full path to the folder to export files to. The default is ``None``, in
             which case the working directory is used.
 
@@ -2519,8 +2519,8 @@ def export_w_elements(self, analyze=False, export_folder=None):
         exported_files = []
         if not export_folder:
             export_folder = self.working_directory
-        if not os.path.exists(export_folder):
-            os.makedirs(export_folder)
+        if not Path(export_folder).exists():
+            Path(export_folder).mkdir()
         if analyze:
             self.analyze()
         setups = self.oanalysis.GetSetups()
@@ -2535,12 +2535,12 @@ def export_w_elements(self, analyze=False, export_folder=None):
                 if len(variation_array) == 1:
                     try:
                         export_file = f"{self.project_name}_{s}_{sweep}.sp"
-                        export_path = os.path.join(export_folder, export_file)
+                        export_path = Path(export_folder) / export_file
                         subckt_name = f"w_{self.project_name}"
                         self.oanalysis.ExportCircuit(
                             solution_name,
                             variation_array[0],
-                            export_path,
+                            str(export_path),
                             [
                                 "NAME:CircuitData",
                                 "MatrixName:=",
@@ -2579,12 +2579,12 @@ def export_w_elements(self, analyze=False, export_folder=None):
                         varCount += 1
                         try:
                             export_file = f"{self.project_name}_{s}_{sweep}_{varCount}.sp"
-                            export_path = os.path.join(export_folder, export_file)
+                            export_path = Path(export_folder) / export_file
                             subckt_name = f"w_{self.project_name}_{varCount}"
                             self.oanalysis.ExportCircuit(
                                 solution_name,
                                 variation,
-                                export_path,
+                                str(export_path),
                                 [
                                     "NAME:CircuitData",
                                     "MatrixName:=",

tests/system/general/test_01_3dlayout_edb.py

@@ -23,6 +23,7 @@
 # SOFTWARE.
 
 import os
+from pathlib import Path
 
 from ansys.aedt.core import Hfss3dLayout
 from ansys.aedt.core.generic.settings import is_linux
@@ -230,7 +231,7 @@ def test_05_change_property(self, aedtapp):
         assert aedtapp.modeler.change_property(f"Excitations:{ports[0].name}", "Impedance", "49ohm", "EM Design")
 
     def test_06_assign_touchstone_model(self, aedtapp):
-        model_path = os.path.join(TESTS_GENERAL_PATH, "example_models", "TEDB", "GRM32_DC0V_25degC_series.s2p")
+        model_path = Path(TESTS_GENERAL_PATH) / "example_models" / "TEDB" / "GRM32_DC0V_25degC_series.s2p"
         assert aedtapp.modeler.set_touchstone_model(assignment="C217", input_file=model_path, model_name="Test1")
 
     def test_07_assign_spice_model(self, aedtapp):

tests/system/general/test_36_Q2D_PostProcessing.py

@@ -22,7 +22,7 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 # SOFTWARE.
 
-import os
+from pathlib import Path
 
 from ansys.aedt.core import Q2d
 import pytest
@@ -59,29 +59,29 @@ def init(self, q2d_solved_sweep_app, q2d_solved_nominal_app, local_scratch):
         self.local_scratch = local_scratch
 
     def test_01_export_w_elements_from_sweep(self, q2d_solved_sweep_app, local_scratch):
-        export_folder = os.path.join(local_scratch.path, "export_folder")
+        export_folder = Path(local_scratch.path) / "export_folder"
         files = q2d_solved_sweep_app.export_w_elements(False, export_folder)
         assert len(files) == 3
         for file in files:
-            _, ext = os.path.splitext(file)
+            ext = Path(file).suffix
             assert ext == ".sp"
-            assert os.path.isfile(file)
+            assert Path(file).is_file()
 
     def test_02_export_w_elements_from_nominal(self, q2d_solved_nominal_app, local_scratch):
-        export_folder = os.path.join(local_scratch.path, "export_folder")
+        export_folder = Path(local_scratch.path) / "export_folder"
         files = q2d_solved_nominal_app.export_w_elements(False, export_folder)
         assert len(files) == 1
         for file in files:
-            _, ext = os.path.splitext(file)
+            ext = Path(file).suffix
             assert ext == ".sp"
-            assert os.path.isfile(file)
+            assert Path(file).is_file()
 
     def test_03_export_w_elements_to_working_directory(self, q2d_solved_nominal_app):
         files = q2d_solved_nominal_app.export_w_elements(False)
         assert len(files) == 1
         for file in files:
-            _, ext = os.path.splitext(file)
+            ext = Path(file).suffix
             assert ext == ".sp"
-            assert os.path.isfile(file)
-            file_dir = os.path.abspath(os.path.dirname(file))
-            assert file_dir == os.path.abspath(self.q2d_solved_nominal_app.working_directory)
+            assert Path(file).is_file()
+            file_dir = Path(file).parent.absolute()
+            assert file_dir == Path(self.q2d_solved_nominal_app.working_directory).absolute()

tests/system/visualization/test_12_PostProcessing.py

@@ -23,6 +23,7 @@
 # SOFTWARE.
 
 import os
+from pathlib import Path
 import sys
 import tempfile
 
@@ -567,8 +568,8 @@ def test_60_test_parse_vector(self):
         assert isinstance(out, list)
 
     def test_61_export_mesh(self, q3dtest):
-        assert os.path.exists(q3dtest.export_mesh_stats("Setup1"))
-        assert os.path.exists(q3dtest.export_mesh_stats("Setup1"))
+        assert Path(q3dtest.export_mesh_stats("Setup1")).exists()
+        assert Path(q3dtest.export_mesh_stats("Setup1")).exists()
 
     def test_62_eye_diagram(self, eye_test):
         rep = eye_test.post.reports_by_category.eye_diagram("AEYEPROBE(OutputEye)", "QuickEyeAnalysis")