This is an automated email from the ASF dual-hosted git repository. machristie pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/airavata-django-portal-sdk.git
commit 7d8a750a68e8e34d8307364f59ff928af3102d27 Author: Marcus Christie <[email protected]> AuthorDate: Thu Jul 29 14:01:00 2021 -0400 AIRAVATA-3485 Document the optional experiment_id parameter in user_storage API --- airavata_django_portal_sdk/user_storage/api.py | 30 +++++++++++++++++++++----- 1 file changed, 25 insertions(+), 5 deletions(-) diff --git a/airavata_django_portal_sdk/user_storage/api.py b/airavata_django_portal_sdk/user_storage/api.py index c548d42..c9194f2 100644 --- a/airavata_django_portal_sdk/user_storage/api.py +++ b/airavata_django_portal_sdk/user_storage/api.py @@ -75,7 +75,11 @@ def get_user_storage_provider(request, owner_username=None, storage_resource_id= def save(request, path, file, name=None, content_type=None, storage_resource_id=None, experiment_id=None): - "Save file in path in the user's storage and return DataProduct." + """ + Save file in path in the user's storage and return DataProduct. If + `experiment_id` provided then the path will be relative to the experiment + data directory. + """ if _is_remote_api(): if name is None and hasattr(file, 'name'): name = os.path.basename(file.name) @@ -273,7 +277,10 @@ def exists(request, data_product=None, data_product_uri=None): def dir_exists(request, path, storage_resource_id=None, experiment_id=None): - "Return True if path exists in user's data store." + """ + Return True if path exists in user's data store. If `experiment_id` provided + then the path will be relative to the experiment data directory. + """ if _is_remote_api(): resp = _call_remote_api(request, "/user-storage/~/", @@ -291,7 +298,10 @@ def dir_exists(request, path, storage_resource_id=None, experiment_id=None): def user_file_exists(request, path, storage_resource_id=None, experiment_id=None): - """If file exists, return data product URI, else None.""" + """ + If file exists, return data product URI, else None. If `experiment_id` + provided then the path will be relative to the experiment data directory. + """ if _is_remote_api(): resp = _call_remote_api(request, "/user-storage/~/{path}", @@ -315,7 +325,10 @@ def user_file_exists(request, path, storage_resource_id=None, experiment_id=None def delete_dir(request, path, storage_resource_id=None, experiment_id=None): - """Delete path in user's data store, if it exists.""" + """ + Delete path in user's data store, if it exists. If `experiment_id` provided + then the path will be relative to the experiment data directory. + """ if _is_remote_api(): resp = _call_remote_api(request, "/user-storage/~/{path}", @@ -497,7 +510,11 @@ def delete(request, data_product=None, data_product_uri=None): def listdir(request, path, storage_resource_id=None, experiment_id=None): - """Return a tuple of two lists, one for directories, the second for files.""" + """ + Return a tuple of two lists, one for directories, the second for files. If + `experiment_id` provided then the path will be relative to the experiment + data directory. + """ if _is_remote_api(): resp = _call_remote_api(request, @@ -649,6 +666,9 @@ def create_user_dir(request, path="", dir_names=(), create_unique=False, storage them for file paths, for example, converting spaces to underscores. Returns a tuple of the storage_resource_id and resource_path of the directory resource. + + If `experiment_id` provided then the path will be relative to the experiment + data directory. """ if _is_remote_api(): logger.debug(f"path={path}")
