From 8fe6c9f2d525c9e44b84246f9a6e2a9c3e190062 Mon Sep 17 00:00:00 2001 From: Nicholas Cilfone Date: Thu, 6 May 2021 14:10:50 -0400 Subject: [PATCH] docstrings Signed-off-by: Nicholas Cilfone --- spock/addons/s3/utils.py | 7 ++++--- spock/handlers.py | 5 +++-- 2 files changed, 7 insertions(+), 5 deletions(-) diff --git a/spock/addons/s3/utils.py b/spock/addons/s3/utils.py index 5ea03ffc..b463f57b 100644 --- a/spock/addons/s3/utils.py +++ b/spock/addons/s3/utils.py @@ -64,7 +64,7 @@ def handle_s3_save_path(temp_path: str, s3_path: str, name: str, s3_config: S3Co name: spock generated filename s3_config: s3_config object - Returns: + *Returns*: """ if s3_config is None: @@ -143,14 +143,15 @@ def upload_s3(bucket: str, obj: str, temp_path: str, s3_session: BaseClient, upload_config: S3UploadConfig): """Attempts to upload the local file to the S3 uri using any extra arguments to the upload - Args: + *Args*: + bucket: s3 bucket obj: s3 object temp_path: temporary path of the config file s3_session: current s3 session upload_config: S3UploadConfig with extra options for the file transfer - Returns: + *Returns*: """ try: diff --git a/spock/handlers.py b/spock/handlers.py index 255bbd87..96efb05f 100644 --- a/spock/handlers.py +++ b/spock/handlers.py @@ -136,13 +136,14 @@ def _handle_possible_s3_save_path(path: str, name: str, create_path: bool, Checks to see if it detects a S3 uri and if so generates a tmp location to write the file to pre-upload - Args: + *Args*: + path: save path name: spock generated file name create_path: create the path for non s3 data s3_config: s3 config object - Returns: + *Returns*: """ is_s3 = check_path_s3(path=path)