added encoding option to open_file method

Author: maxcapodi78

pyaedt/generic/general_methods.py

@@ -354,7 +354,7 @@ def check_and_download_folder(local_path, remote_path, overwrite=True):
     return remote_path
 
 
-def open_file(file_path, file_options="r", encoding=None):
+def open_file(file_path, file_options="r", encoding=None, override_existing=True):
     """Open a file and return the object.
 
     Parameters
@@ -367,6 +367,8 @@ def open_file(file_path, file_options="r", encoding=None):
         Name of the encoding used to decode or encode the file.
         The default used is platform dependent, but any encoding supported by Python can be
         passed.
+    override_existing : bool, optional
+        Whether if override existing file in case of open file in write mode on remote machine.
 
     Returns
     -------
@@ -377,17 +379,22 @@ def open_file(file_path, file_options="r", encoding=None):
     dir_name = os.path.dirname(file_path)
     if "r" in file_options:
         if os.path.exists(file_path):
-            return open(file_path, file_options, encoding)
+            return open(file_path, file_options, encoding=encoding)
         elif settings.remote_rpc_session and settings.remote_rpc_session.filemanager.pathexists(
             file_path
         ):  # pragma: no cover
             local_file = os.path.join(tempfile.gettempdir(), os.path.split(file_path)[-1])
             settings.remote_rpc_session.filemanager.download_file(file_path, local_file)
-            return open(local_file, file_options, encoding)
+            return open(local_file, file_options, encoding=encoding)
     elif os.path.exists(dir_name):
-        return open(file_path, file_options, encoding)
+        return open(file_path, file_options, encoding=encoding)
     elif settings.remote_rpc_session and settings.remote_rpc_session.filemanager.pathexists(dir_name):
-        return settings.remote_rpc_session.open_file(file_path, file_options)
+        if "w" in file_options:
+            return settings.remote_rpc_session.create_file(
+                file_path, file_options, encoding=encoding, override=override_existing
+            )
+        else:
+            return settings.remote_rpc_session.open_file(file_path, file_options, encoding=encoding)
     else:
         settings.logger.error("The file or folder %s does not exist", dir_name)
 

pyaedt/rpc/rpyc_services.py

@@ -147,11 +147,11 @@ def _download_dir(self, remotepath, localpath, overwrite=True):
             i += 1
         logger.info("Directory %s downloaded. %s files copied", localpath, i)
 
-    def open_file(self, remote_file, open_options="r"):
-        return self.client.root.open(remote_file, open_options=open_options)
+    def open_file(self, remote_file, open_options="r", encoding=None):
+        return self.client.root.open(remote_file, open_options=open_options, encoding=encoding)
 
-    def create_file(self, remote_file, create_options="w"):
-        return self.client.root.open(remote_file, open_options=create_options)
+    def create_file(self, remote_file, create_options="w", encoding=None, override=True):
+        return self.client.root.create(remote_file, open_options=create_options, encoding=encoding, override=override)
 
     def makedirs(self, remotepath):
         if self.client.root.pathexists(remotepath):
@@ -1029,15 +1029,15 @@ def edb(edbpath=None,
                   use_ppe=use_ppe, )
 
     @staticmethod
-    def exposed_open(filename, open_options="rb"):
-        f = open(filename, open_options)
+    def exposed_open(filename, open_options="rb", encoding=None):
+        f = open(filename, open_options, encoding=encoding)
         return rpyc.restricted(f, ["read", "readlines", "close"], [])
 
     @staticmethod
-    def exposed_create(filename,create_options="wb"):
-        if os.path.exists(filename):
+    def exposed_create(filename,create_options="wb", encoding=None, override=True):
+        if os.path.exists(filename) and not override:
             return "File already exists"
-        f = open(filename, create_options)
+        f = open(filename, create_options, encoding=encoding)
         return rpyc.restricted(f, ["read", "readlines", "write", "writelines", "close"], [])
 
     @staticmethod