Update comments and remove an unnecessary method return

This commit is contained in:
Michael Mintz 2018-03-05 17:32:42 -05:00
parent 6841882bf2
commit 03a4fd9bb1
1 changed files with 7 additions and 8 deletions

View File

@ -1,5 +1,5 @@
"""
Manager for dealing with uploading/managing files on S3
Manager for dealing with uploading/managing files on Amazon S3
"""
from boto.s3.connection import S3Connection
from boto.s3.key import Key
@ -10,7 +10,7 @@ already_uploaded_files = []
class S3LoggingBucket(object):
"""
A class to upload log files from tests to S3.
A class to upload log files from tests to Amazon S3.
Those files can then be shared easily.
"""
@ -35,7 +35,7 @@ class S3LoggingBucket(object):
def upload_file(self, file_name, file_path):
""" Upload a given file from the file_path to the bucket
with the new name/path file_name. """
with the new name/path file_name. """
upload_key = Key(bucket=self.bucket, name=file_name)
content_type = "text/plain"
if file_name.endswith(".html"):
@ -53,11 +53,10 @@ class S3LoggingBucket(object):
upload_key.make_public()
except Exception:
pass
return file_name
def upload_index_file(self, test_address, timestamp):
""" Create an index.html file with links to all the log files we
just uploaded. """
""" Create an index.html file with links to all the log files
that were just uploaded. """
global already_uploaded_files
already_uploaded_files = list(set(already_uploaded_files))
already_uploaded_files.sort()
@ -75,7 +74,7 @@ class S3LoggingBucket(object):
def save_uploaded_file_names(self, files):
""" Keep a record of all file names that've been uploaded. Upload log
files related to each test after its execution. Once done, use
already_uploaded_files to create an index file. """
files related to each test after its execution. Once done, use
already_uploaded_files to create an index file. """
global already_uploaded_files
already_uploaded_files.extend(files)