feat: accept pathlib.Path as input in missing methods (#1385)

Co-authored-by: pyansys-ci-bot <[email protected]>

Author: RobPasMue

doc/changelog.d/1385.added.md

@@ -0,0 +1 @@
+accept pathlib.Path as input in missing methods

src/ansys/geometry/core/designer/design.py

@@ -311,7 +311,7 @@ def __build_export_file_location(self, location: Path | str | None, ext: str) ->
         """
         return (Path(location) if location else Path.cwd()) / f"{self.name}.{ext}"
 
-    def export_to_scdocx(self, location: Path | str | None = None) -> str:
+    def export_to_scdocx(self, location: Path | str | None = None) -> Path:
         """Export the design to an scdocx file.
 
         Parameters
@@ -322,7 +322,7 @@ def export_to_scdocx(self, location: Path | str | None = None) -> str:
 
         Returns
         -------
-        str
+        ~pathlib.Path
             The path to the saved file.
         """
         # Define the file location
@@ -334,7 +334,7 @@ def export_to_scdocx(self, location: Path | str | None = None) -> str:
         # Return the file location
         return file_location
 
-    def export_to_parasolid_text(self, location: Path | str | None = None) -> str:
+    def export_to_parasolid_text(self, location: Path | str | None = None) -> Path:
         """Export the design to a Parasolid text file.
 
         Parameters
@@ -345,7 +345,7 @@ def export_to_parasolid_text(self, location: Path | str | None = None) -> str:
 
         Returns
         -------
-        str
+        ~pathlib.Path
             The path to the saved file.
         """
         # Determine the extension based on the backend type
@@ -360,7 +360,7 @@ def export_to_parasolid_text(self, location: Path | str | None = None) -> str:
         # Return the file location
         return file_location
 
-    def export_to_parasolid_bin(self, location: Path | str | None = None) -> str:
+    def export_to_parasolid_bin(self, location: Path | str | None = None) -> Path:
         """Export the design to a Parasolid binary file.
 
         Parameters
@@ -371,7 +371,7 @@ def export_to_parasolid_bin(self, location: Path | str | None = None) -> str:
 
         Returns
         -------
-        str
+        ~pathlib.Path
             The path to the saved file.
         """
         # Determine the extension based on the backend type
@@ -386,7 +386,7 @@ def export_to_parasolid_bin(self, location: Path | str | None = None) -> str:
         # Return the file location
         return file_location
 
-    def export_to_fmd(self, location: Path | str | None = None) -> str:
+    def export_to_fmd(self, location: Path | str | None = None) -> Path:
         """Export the design to an FMD file.
 
         Parameters
@@ -397,7 +397,7 @@ def export_to_fmd(self, location: Path | str | None = None) -> str:
 
         Returns
         -------
-        str
+        ~pathlib.Path
             The path to the saved file.
         """
         # Define the file location
@@ -409,7 +409,7 @@ def export_to_fmd(self, location: Path | str | None = None) -> str:
         # Return the file location
         return file_location
 
-    def export_to_step(self, location: Path | str | None = None) -> str:
+    def export_to_step(self, location: Path | str | None = None) -> Path:
         """Export the design to a STEP file.
 
         Parameters
@@ -420,7 +420,7 @@ def export_to_step(self, location: Path | str | None = None) -> str:
 
         Returns
         -------
-        str
+        ~pathlib.Path
             The path to the saved file.
         """
         # Define the file location
@@ -432,7 +432,7 @@ def export_to_step(self, location: Path | str | None = None) -> str:
         # Return the file location
         return file_location
 
-    def export_to_iges(self, location: Path | str = None) -> str:
+    def export_to_iges(self, location: Path | str = None) -> Path:
         """Export the design to an IGES file.
 
         Parameters
@@ -443,7 +443,7 @@ def export_to_iges(self, location: Path | str = None) -> str:
 
         Returns
         -------
-        str
+        ~pathlib.Path
             The path to the saved file.
         """
         # Define the file location
@@ -455,7 +455,7 @@ def export_to_iges(self, location: Path | str = None) -> str:
         # Return the file location
         return file_location
 
-    def export_to_pmdb(self, location: Path | str | None = None) -> str:
+    def export_to_pmdb(self, location: Path | str | None = None) -> Path:
         """Export the design to a PMDB file.
 
         Parameters
@@ -466,7 +466,7 @@ def export_to_pmdb(self, location: Path | str | None = None) -> str:
 
         Returns
         -------
-        str
+        ~pathlib.Path
             The path to the saved file.
         """
         # Define the file location

src/ansys/geometry/core/modeler.py

@@ -285,7 +285,7 @@ def _upload_file(
     @protect_grpc
     def open_file(
         self,
-        file_path: str,
+        file_path: str | Path,
         upload_to_server: bool = True,
         import_options: ImportOptions = ImportOptions(),
     ) -> "Design":
@@ -301,7 +301,7 @@ def open_file(
 
         Parameters
         ----------
-        file_path : str
+        file_path : str, ~pathlib.Path
             Path of the file to open. The extension of the file must be included.
         upload_to_server : bool
             True if the service is running on a remote machine. If service is running on the local
@@ -314,6 +314,9 @@ def open_file(
         Design
             Newly imported design.
         """
+        # Use str format of Path object here
+        file_path = str(file_path) if isinstance(file_path, Path) else file_path
+
         # Format-specific logic - upload the whole containing folder for assemblies
         if upload_to_server:
             if any(
@@ -343,7 +346,7 @@ def __repr__(self) -> str:
 
     @protect_grpc
     def run_discovery_script_file(
-        self, file_path: str, script_args: dict[str, str] | None = None, import_design=False
+        self, file_path: str | Path, script_args: dict[str, str] | None = None, import_design=False
     ) -> tuple[dict[str, str], Optional["Design"]]:
         """Run a Discovery script file.
 
@@ -374,7 +377,7 @@ def run_discovery_script_file(
 
         Parameters
         ----------
-        file_path : str
+        file_path : str, ~pathlib.Path
             Path of the file. The extension of the file must be included.
         script_args : dict[str, str], optional.
             Arguments to pass to the script. By default, ``None``.
@@ -398,6 +401,9 @@ def run_discovery_script_file(
             If the Discovery script fails to run. Otherwise, assume that the script
             ran successfully.
         """
+        # Use str format of Path object here
+        file_path = str(file_path) if isinstance(file_path, Path) else file_path
+
         serv_path = self._upload_file(file_path)
         ga_stub = DbuApplicationStub(self._grpc_client.channel)
         request = RunScriptFileRequest(