ansys-systemcoupling-core 0.7.0__tar.gz → 0.8.0__tar.gz

{ansys_systemcoupling_core-0.7.0 → ansys_systemcoupling_core-0.8.0}/LICENSE

@@ -1,13 +1,13 @@
 MIT License
 
-Copyright (c) 2021 ANSYS, Inc. All rights reserved. 
+Copyright (c) 2023 - 2024 ANSYS, Inc. and/or its affiliates.
 
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
+of the Software, and to permit persons to whom the Software is furnished to do
+so, subject to the following conditions:
 
 The above copyright notice and this permission notice shall be included in all
 copies or substantial portions of the Software.

{ansys_systemcoupling_core-0.7.0 → ansys_systemcoupling_core-0.8.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: ansys-systemcoupling-core
-Version: 0.7.0
+Version: 0.8.0
 Summary: A Python wrapper for Ansys System Coupling.
 Author-email: "ANSYS, Inc." <pyansys.support@ansys.com>
 Maintainer-email: PyAnsys developers <pyansys.maintainers@ansys.com>
@@ -29,21 +29,21 @@ Requires-Dist: matplotlib>=3.8.2
 Requires-Dist: build ; extra == "build"
 Requires-Dist: black==24.8.0 ; extra == "classesgen"
 Requires-Dist: isort==5.13.2 ; extra == "classesgen"
-Requires-Dist: ansys-sphinx-theme==1.0.7 ; extra == "doc"
+Requires-Dist: ansys-sphinx-theme==1.0.11 ; extra == "doc"
 Requires-Dist: jupyter_sphinx==0.5.3 ; extra == "doc"
 Requires-Dist: matplotlib ; extra == "doc"
 Requires-Dist: numpydoc==1.8.0 ; extra == "doc"
 Requires-Dist: pypandoc==1.13 ; extra == "doc"
 Requires-Dist: pytest-sphinx==0.6.3 ; extra == "doc"
 Requires-Dist: Sphinx==8.0.2 ; extra == "doc"
-Requires-Dist: sphinx-autobuild==2024.4.16 ; extra == "doc"
-Requires-Dist: sphinx-autodoc-typehints==2.3.0 ; extra == "doc"
+Requires-Dist: sphinx-autobuild==2024.9.19 ; extra == "doc"
+Requires-Dist: sphinx-autodoc-typehints==2.4.4 ; extra == "doc"
 Requires-Dist: sphinx-copybutton==0.5.2 ; extra == "doc"
 Requires-Dist: sphinx-gallery==0.17.1 ; extra == "doc"
 Requires-Dist: sphinx-notfound-page==1.0.4 ; extra == "doc"
 Requires-Dist: sphinxcontrib-websupport==2.0.0 ; extra == "doc"
 Requires-Dist: sphinxemoji==0.3.1 ; extra == "doc"
-Requires-Dist: ansys-fluent-core==0.24.2 ; extra == "doc"
+Requires-Dist: ansys-fluent-core==0.26.0 ; extra == "doc"
 Requires-Dist: ansys-dpf-core==0.13.0 ; extra == "doc"
 Requires-Dist: ansys-mapdl-core==0.68.4 ; extra == "doc"
 Requires-Dist: codespell==2.3.0 ; extra == "style"

{ansys_systemcoupling_core-0.7.0 → ansys_systemcoupling_core-0.8.0}/pyproject.toml

@@ -5,7 +5,7 @@ build-backend = "flit_core.buildapi"
 [project]
 # Check https://flit.readthedocs.io/en/latest/pyproject_toml.html for all available sections
 name = "ansys-systemcoupling-core"
-version = "0.7.0"
+version = "0.8.0"
 description = "A Python wrapper for Ansys System Coupling."
 readme = "README.rst"
 requires-python = ">=3.10,<3.13"
@@ -56,15 +56,15 @@ classesgen = [
 	"isort==5.13.2",
 ]
 doc = [
-	"ansys-sphinx-theme==1.0.7",
+	"ansys-sphinx-theme==1.0.11",
 	"jupyter_sphinx==0.5.3",
 	"matplotlib",
 	"numpydoc==1.8.0",
 	"pypandoc==1.13",
 	"pytest-sphinx==0.6.3",
 	"Sphinx==8.0.2",
-	"sphinx-autobuild==2024.4.16",
-	"sphinx-autodoc-typehints==2.3.0",
+	"sphinx-autobuild==2024.9.19",
+	"sphinx-autodoc-typehints==2.4.4",
 	"sphinx-copybutton==0.5.2",
 	"sphinx-gallery==0.17.1",
 	"sphinx-notfound-page==1.0.4",
@@ -72,7 +72,7 @@ doc = [
 	"sphinxemoji==0.3.1",
 
 	# pyansys dependencies for sphinx gallery examples
-	"ansys-fluent-core==0.24.2",
+	"ansys-fluent-core==0.26.0",
 	"ansys-dpf-core==0.13.0",
 	"ansys-mapdl-core==0.68.4",
 ]

{ansys_systemcoupling_core-0.7.0 → ansys_systemcoupling_core-0.8.0}/src/ansys/systemcoupling/core/adaptor/impl/injected_commands.py

@@ -148,9 +148,10 @@ def _wrap_add_participant(
         )
 
     if input_file := kwargs.get("input_file", None):
-        session.upload_file(input_file)
-        if os.path.dirname(input_file):
-            kwargs["input_file"] = os.path.basename(input_file)
+        # In PIM-like scenario, the returned file name is what
+        # the container sees. Otherwise input_file should be
+        # unchanged by the upload call.
+        kwargs["input_file"] = session.upload_file(input_file)
 
     return setup._add_participant(**kwargs)
 

{ansys_systemcoupling_core-0.7.0 → ansys_systemcoupling_core-0.8.0}/src/ansys/systemcoupling/core/client/grpc_client.py

@@ -177,12 +177,12 @@ class SycGrpc(object):
         if start_output:
             self.start_output()
 
-    def upload_file(self, *args, **kwargs):
+    def upload_file(self, *args, **kwargs) -> str:
         """Supports file upload to remote instance.
 
         Currently for internal use only.
         """
-        file_transfer_service(self.__pim_instance).upload_file(*args, **kwargs)
+        return file_transfer_service(self.__pim_instance).upload_file(*args, **kwargs)
 
     def download_file(self, *args, **kwargs):
         """Supports file download from remote instance.

{ansys_systemcoupling_core-0.7.0 → ansys_systemcoupling_core-0.8.0}/src/ansys/systemcoupling/core/session.py

@@ -233,7 +233,8 @@ class Session:
 
         Reduces to a no-op if the System Coupling instance is not managed by PIM.
 
-        The remote file may optionally be given a different name from the local one.
+        The remote file may optionally be given a different name from the local one
+        and, if not, any directory prefix is stripped in the PIM case.
 
         Unless ``overwrite`` is ``True``, a ``FileExistsError`` will be raised if
         the remote file already exists.
@@ -246,8 +247,14 @@ class Session:
             remote file name - default is None
         overwrite: bool, optional
             whether to overwrite the remote file if it already exists - default is False
+
+        Returns
+        -------
+        str
+            The remote file name, excluding any directory prefix that might have been
+            present in ``file_name``.
         """
-        self.__rpc.upload_file(file_name, remote_file_name, overwrite)
+        return self.__rpc.upload_file(file_name, remote_file_name, overwrite)
 
     def download_file(
         self, file_name: str, local_file_dir: str = ".", overwrite: bool = False

{ansys_systemcoupling_core-0.7.0 → ansys_systemcoupling_core-0.8.0}/src/ansys/systemcoupling/core/util/file_transfer.py

@@ -29,15 +29,22 @@ from typing import Any, Optional, Protocol
 class FileTransferService(Protocol):  # pragma: no cover
     def upload_file(
         self, file_name: str, remote_file_name: Optional[str], overwrite: bool
-    ): ...
+    ) -> str: ...
 
     def download_file(self, file_name: str, local_file_dir: str, overwrite: bool): ...
 
 
 class NullFileTransferService(FileTransferService):  # pragma: no cover
-    """A do-nothing implementation of file upload/download service."""
+    """An essentially do-nothing implementation of file upload/download
+    service (with a minimal ``upload_file`` implementation)."""
 
-    ...
+    def upload_file(
+        self, file_name: str, remote_file_name: Optional[str], overwrite: bool
+    ) -> str:
+        # TODO - what should the behaviour be if remote_file_name is not None?
+        # It is not obvious that it would even make sense to call the Null
+        # implementation in that case.
+        return file_name
 
 
 class PimFileTransferService:  # pragma: no cover
@@ -70,11 +77,14 @@ class PimFileTransferService:  # pragma: no cover
 
     def upload_file(
         self, file_name: str, remote_file_name: Optional[str], overwrite: bool
-    ):
+    ) -> str:
         """Upload a file to the PIM-managed instance.
 
         The remote file may optionally be given a different name from the local one.
 
+        If the local file name includes a directory path, this is stripped and the
+        remote file is always placed in the "working directory" of the container.
+
         Unless ``overwrite`` is ``True``, a ``FileExistsError`` will be raised if
         the remote file already exists.
 
@@ -86,6 +96,12 @@ class PimFileTransferService:  # pragma: no cover
             remote file name (or use local file name if None)
         overwrite: bool
             whether to overwrite the remote file if it already exists
+
+        Returns
+        -------
+        str
+            The name assigned to the remote file name. If ``file_name`` included
+            a directory prefix, this is stripped from the returned name.
         """
         if os.path.isfile(file_name):
             remote_file_name = remote_file_name or os.path.basename(file_name)
@@ -105,6 +121,7 @@ class PimFileTransferService:  # pragma: no cover
             self.file_service.upload_file(file_name, remote_file_name)
             if delete_copy:
                 os.remove(file_name)
+            return remote_file_name
         else:
             raise FileNotFoundError(f"Local file {file_name} does not exist.")