FEAT: upload and open a file

src/ansys/geometry/core/modeler.py

@@ -2,6 +2,8 @@
 import logging
 from pathlib import Path
 
+from ansys.api.geometry.v0.commands_pb2 import UploadFileRequest
+from ansys.api.geometry.v0.commands_pb2_grpc import CommandsStub
 from beartype.typing import TYPE_CHECKING, Optional, Union
 from grpc import Channel
 
@@ -103,6 +105,39 @@ def close(self) -> None:
         """``Modeler`` easy-access method to the client's ``close()`` method."""
         return self.client.close()
 
+    def upload_file(self, file_path: str) -> str:
+        """
+        Upload a file from the client to the server. ``file_path`` must include the extension.
+        The new file created on the server will have the same name and extension.
+
+        Parameters
+        ----------
+        file_path : str
+            The path of the file. Must include extension.
+
+        Returns
+        -------
+        file_path : str
+            The full path of the uploaded file on the server machine.
+        """
+        import os
+
+        if not os.path.exists(file_path):
+            message = f"Could not find file: {file_path}"
+            raise ValueError(message)
+        if os.path.isdir(file_path):
+            raise ValueError("File path must lead to a file, not a directory.")
+
+        file_name = os.path.split(file_path)[1]
+
+        with open(file_path, "rb") as file:
+            data = file.read()
+
+        c_stub = CommandsStub(self._client.channel)
+
+        response = c_stub.UploadFile(UploadFileRequest(data=data, file_name=file_name))
+        return response.file_path
+
     def __repr__(self):
         """String representation of the modeler."""
         lines = []

tests/integration/test_design.py

@@ -1,5 +1,7 @@
 """Test design interaction."""
 
+import os
+
 from pint import Quantity
 import pytest
 
@@ -801,6 +803,25 @@ def test_download_file(modeler: Modeler, tmp_path_factory: pytest.TempPathFactor
     assert fmd_file.exists()
 
 
+def test_upload_file(modeler: Modeler, tmp_path_factory: pytest.TempPathFactory):
+    file = tmp_path_factory.mktemp("upload_file") / "example.scdocx"
+    file_size = 1024
+
+    # Write random bytes
+    with open(file, "wb") as fout:
+        fout.write(os.urandom(file_size))
+
+    assert file.exists()
+
+    # Read the file to get its bytes
+    with open(file, "rb") as f:
+        data = f.read()
+
+    # Upload file
+    path_on_server = modeler.upload_file(data, "example.scdocx")
+    assert path_on_server is not None
+
+
 def test_slot_extrusion(modeler: Modeler):
     """Test the extrusion of a slot."""
     # Create your design on the server side