This is an automated email from the ASF dual-hosted git repository.
yasithdev pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/airavata.git
The following commit(s) were added to refs/heads/master by this push:
new ea4424ecc6 Drop inaccurate "Return Path" docstring boilerplate from
SDK file ops (#676)
ea4424ecc6 is described below
commit ea4424ecc6fb3a7ac94527ab82bd43d474dd0059
Author: Yasith Jayawardana <[email protected]>
AuthorDate: Sat Jun 13 01:44:38 2026 -0400
Drop inaccurate "Return Path" docstring boilerplate from SDK file ops (#676)
The line "Return Path: /{project_name}/{experiment_name}" was copy-pasted
into six
airavata_experiments file-operation docstrings (upload/list/download/etc.)
where it
does not describe the actual return value — only make_experiment_dir
returns that
path, and its first docstring line already says so. Remove the boilerplate.
---
airavata-python-sdk/airavata_experiments/airavata.py | 12 ------------
1 file changed, 12 deletions(-)
diff --git a/airavata-python-sdk/airavata_experiments/airavata.py
b/airavata-python-sdk/airavata_experiments/airavata.py
index 3de4a58582..3210bb974d 100644
--- a/airavata-python-sdk/airavata_experiments/airavata.py
+++ b/airavata-python-sdk/airavata_experiments/airavata.py
@@ -300,8 +300,6 @@ class AiravataOperator:
"""
Make experiment directory on storage resource, and return the remote path
- Return Path: /{project_name}/{experiment_name}
-
"""
host = sr_host
port = self.default_sftp_port()
@@ -315,8 +313,6 @@ class AiravataOperator:
Upload local files to a remote directory of a storage resource
TODO add data_svc fallback
- Return Path: /{project_name}/{experiment_name}
-
"""
# step = experiment staging
@@ -374,8 +370,6 @@ class AiravataOperator:
List files in a remote directory of a storage resource
TODO add data_svc fallback
- Return Path: /{project_name}/{experiment_name}
-
"""
res = requests.post(f"{self.connection_svc_url()}/agent/execute/shell",
json={
"agentId": agent_ref,
@@ -410,8 +404,6 @@ class AiravataOperator:
Download files from a remote directory of a storage resource to a local
directory
TODO add data_svc fallback
- Return Path: /{project_name}/{experiment_name}
-
"""
import os
fp = os.path.join(".", remote_file)
@@ -456,8 +448,6 @@ class AiravataOperator:
Execute a command on a remote directory of a storage resource
TODO add data_svc fallback
- Return Path: /{project_name}/{experiment_name}
-
"""
res = requests.post(f"{self.connection_svc_url()}/agent/execute/shell",
json={
"agentId": agent_ref,
@@ -485,8 +475,6 @@ class AiravataOperator:
Download files from a remote directory of a storage resource to a local
directory
TODO add data_svc fallback
- Return Path: /{project_name}/{experiment_name}
-
"""
import os
fp = os.path.join(".", remote_file)
