ansys-systemcoupling-core 0.7.0__py3-none-any.whl → 0.8.0__py3-none-any.whl

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/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/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/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.")
 

{ansys_systemcoupling_core-0.7.0.dist-info → ansys_systemcoupling_core-0.8.0.dist-info}/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.dist-info → ansys_systemcoupling_core-0.8.0.dist-info}/METADATA

@@ -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.dist-info → ansys_systemcoupling_core-0.8.0.dist-info}/RECORD

@@ -1,6 +1,6 @@
 ansys/systemcoupling/core/__init__.py,sha256=9dek5li8pDDRA5oBI3mPeOwu784_qzwzse3lTNLyUWU,7404
 ansys/systemcoupling/core/_version.py,sha256=WDT4Te1BIWgZU3Gt3WrwVwiGFs4nolWZXbwX-Ubj_r4,1579
-ansys/systemcoupling/core/session.py,sha256=HKXmPBGv-netx4CHr3PNMWXYQO8lsp0n99V20Um-jgo,10737
+ansys/systemcoupling/core/session.py,sha256=yjnZI-OFKLjnooVRg5e0M9MIJGV38Cm041mcdb6nMCs,10983
 ansys/systemcoupling/core/syc_version.py,sha256=dn1BRe9hzGD2QAsuk6OLjxNcznJlpyiPIZh9Zjrwdqc,3783
 ansys/systemcoupling/core/adaptor/api_23_1/_add_participant.py,sha256=_Wbmc-g3FyEyFodFjklI8IBJ3lLIWEIMHsMdAFlddsM,1198
 ansys/systemcoupling/core/adaptor/api_23_1/_clear_state.py,sha256=z13uOkk8M-Ue1_znQXEyGvYOYW1zHSV-MpZgEMDPlTg,215
@@ -516,7 +516,7 @@ ansys/systemcoupling/core/adaptor/api_25_1/write_csv_chart_files.py,sha256=32YlQ
 ansys/systemcoupling/core/adaptor/api_25_1/write_ensight.py,sha256=cy1ZUL2Td2WCfuuWWIUigMmPdxwRKqV9msH0pJI624Y,1278
 ansys/systemcoupling/core/adaptor/impl/get_status_messages.py,sha256=3wSnWTUS3q4VdufmHZ7jxyVCZONITFtP_tUB-8NnQuU,4210
 ansys/systemcoupling/core/adaptor/impl/get_syc_version.py,sha256=CIq2J8h8Eapq_jrXpMMHAa9oqSSaNR5G7NAYZseVgJg,2489
-ansys/systemcoupling/core/adaptor/impl/injected_commands.py,sha256=EqSCqXUEGf-cLKLeQvA4oVA1zVkvrpWDeMPtlPe5b4s,19094
+ansys/systemcoupling/core/adaptor/impl/injected_commands.py,sha256=5FlUQUr0fuPvUh1YPaU38eh_duRHeg6NzpvyxCND5SI,19177
 ansys/systemcoupling/core/adaptor/impl/root_source.py,sha256=d-NSP104VjR65qTiqp1rlST6VYJRUPf9YHcpR8ABssQ,12828
 ansys/systemcoupling/core/adaptor/impl/static_info.py,sha256=5U1CYNASPl4zNGjIw3Slwkhq-8v7GVKrih0HO_bIjSk,15691
 ansys/systemcoupling/core/adaptor/impl/syc_proxy.py,sha256=-jF5zSwwiyJXLxocWK01v5AYDDtLyZRiMPfcqeOvim8,4906
@@ -529,7 +529,7 @@ ansys/systemcoupling/core/charts/message_dispatcher.py,sha256=zuNY3NthWag1yf7Rkj
 ansys/systemcoupling/core/charts/plot_functions.py,sha256=Li5HYCWkRTAvFGqnI6p636qayTPqphHLOtWI861vtgA,3276
 ansys/systemcoupling/core/charts/plotdefinition_manager.py,sha256=UFQjYei3gk3GYVUksSPYbtcxFbcfepZscGg55ok5OQg,12446
 ansys/systemcoupling/core/charts/plotter.py,sha256=L_hIanq5sV6LVSu3dn3yjoeCPBpEccyxXk2fFCt85_s,11833
-ansys/systemcoupling/core/client/grpc_client.py,sha256=KxVzj--kLOL6ij0YlgxG3t8YgvLK2sHqjeDJuQtbAtc,14933
+ansys/systemcoupling/core/client/grpc_client.py,sha256=8g7oASjQ2FEfnxDJ6K4Wl9EOkUUAqq_fMuGVC3zxTXk,14947
 ansys/systemcoupling/core/client/syc_container.py,sha256=_EZRscY5iWyJPbqY-ep_e6Y-Nu1XKygduzVYjg5xJg8,3170
 ansys/systemcoupling/core/client/syc_process.py,sha256=udVsRxD5QaaL1n7MPjmpIvybv5dlPmXiO2KCPRNnWGE,5635
 ansys/systemcoupling/core/client/variant.py,sha256=di_eWRZnDQ69cknunYxRAOnbnwXnG6aZ_Se1VxOX7VQ,3064
@@ -548,13 +548,13 @@ ansys/systemcoupling/core/native_api/object_path.py,sha256=DAULeS_asHMf1O3PiFnLL
 ansys/systemcoupling/core/participant/manager.py,sha256=kJzfsTA1HquDQT-j3ib9OQMD0QRpvWGpnPMYDDvnYZU,9685
 ansys/systemcoupling/core/participant/mapdl.py,sha256=v9Ms6uVaPj1-AbZYsaAY9JR_WpkLD7xSOJ3kQRGgtT0,11166
 ansys/systemcoupling/core/participant/protocol.py,sha256=Kc90wvz-ZDJfhvL-SrlFymdb_mn2oqVucaRZW7BfFWM,2479
-ansys/systemcoupling/core/util/file_transfer.py,sha256=h_Ny-rcawVbmNooyKmCbjMkDhGIAX8rZHsZ-odJIS1o,5756
+ansys/systemcoupling/core/util/file_transfer.py,sha256=ZYRYAo6wDRVB7ihEMbK3JHYAoXiU5lxo6yzGTd830jo,6560
 ansys/systemcoupling/core/util/logging.py,sha256=dFj0migeyUGke7sYL-hN80amMnUvuIO1kkCsOH_8ipc,5059
 ansys/systemcoupling/core/util/name_util.py,sha256=AqALTBRe9hjS0SqbKk2BnN09pCq0M1irhd9illTTuwk,1470
 ansys/systemcoupling/core/util/pathstr.py,sha256=xfnBAee68WG1R8s2LkoO9fLYZsJ0Nrx84woVuQv9bVY,1941
 ansys/systemcoupling/core/util/state_keys.py,sha256=52gk88CJw1K3YIC6hg7Jc6_C2_EznQjrB1FrpcjhI1M,4545
 ansys/systemcoupling/core/util/yaml_helper.py,sha256=6j2VNGXSEiJ11GUsUn4Z3wbPB9Cw-5JBsb5gWHAVsYo,2982
-ansys_systemcoupling_core-0.7.0.dist-info/LICENSE,sha256=4sCWlgkqcWBhkmfDi4UpSkzpTxXvMhLfR0G6dxLQuMA,1090
-ansys_systemcoupling_core-0.7.0.dist-info/WHEEL,sha256=EZbGkh7Ie4PoZfRQ8I0ZuP9VklN_TvcZ6DSE5Uar4z4,81
-ansys_systemcoupling_core-0.7.0.dist-info/METADATA,sha256=ZGiIfKR1A9GhJLcntfEoUHu4AbWchViT_KHDWCBY9rc,10963
-ansys_systemcoupling_core-0.7.0.dist-info/RECORD,,
+ansys_systemcoupling_core-0.8.0.dist-info/LICENSE,sha256=JgD60xBjdC80Y3_bDlvjsoWCc6vghcXDvbHvRTRmdY0,1098
+ansys_systemcoupling_core-0.8.0.dist-info/WHEEL,sha256=EZbGkh7Ie4PoZfRQ8I0ZuP9VklN_TvcZ6DSE5Uar4z4,81
+ansys_systemcoupling_core-0.8.0.dist-info/METADATA,sha256=ndbuY_i0J7WKo2ZMiZlB5YA0RhP4kTJK0wcQMEQicNs,10964
+ansys_systemcoupling_core-0.8.0.dist-info/RECORD,,