r39132 closed pull request #3979: [AIRFLOW-XXX] Fix undocumented params in
S3_hook
URL: https://github.com/apache/incubator-airflow/pull/3979
This is a PR merged from a forked repository.
As GitHub hides the original diff on merge, it is displayed below for
the sake of provenance:
As this is a foreign pull request (from a fork), the diff is supplied
below (as it won't show otherwise due to GitHub magic):
diff --git a/airflow/hooks/S3_hook.py b/airflow/hooks/S3_hook.py
index f62fdc9145..35d26fd2b5 100644
--- a/airflow/hooks/S3_hook.py
+++ b/airflow/hooks/S3_hook.py
@@ -72,6 +72,13 @@ def get_bucket(self, bucket_name):
def check_for_prefix(self, bucket_name, prefix, delimiter):
"""
Checks that a prefix exists in a bucket
+
+ :param bucket_name: the name of the bucket
+ :type bucket_name: str
+ :param prefix: a key prefix
+ :type prefix: str
+ :param delimiter: the delimiter marks key hierarchy.
+ :type delimiter: str
"""
prefix = prefix + delimiter if prefix[-1] != delimiter else prefix
prefix_split = re.split(r'(\w+[{d}])$'.format(d=delimiter), prefix, 1)
@@ -253,6 +260,13 @@ def check_for_wildcard_key(self,
wildcard_key, bucket_name=None, delimiter=''):
"""
Checks that a key matching a wildcard expression exists in a bucket
+
+ :param wildcard_key: the path to the key
+ :type wildcard_key: str
+ :param bucket_name: the name of the bucket
+ :type bucket_name: str
+ :param delimiter: the delimiter marks key hierarchy
+ :type delimiter: str
"""
return self.get_wildcard_key(wildcard_key=wildcard_key,
bucket_name=bucket_name,
@@ -266,6 +280,8 @@ def get_wildcard_key(self, wildcard_key, bucket_name=None,
delimiter=''):
:type wildcard_key: str
:param bucket_name: the name of the bucket
:type bucket_name: str
+ :param delimiter: the delimiter marks key hierarchy
+ :type delimiter: str
"""
if not bucket_name:
(bucket_name, wildcard_key) = self.parse_s3_url(wildcard_key)
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
[email protected]
With regards,
Apache Git Services
