Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Correctly pass boto3 resource to writers #576

Merged
merged 4 commits into from
Jan 15, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
# Unreleased

- Correctly pass boto3 resource to writers (PR [#576](https://github.com/RaRe-Technologies/smart_open/pull/576), [@jackluo923](https://github.com/jackluo923))
- Improve robustness of S3 reading (PR [#552](https://github.com/RaRe-Technologies/smart_open/pull/552), [@mpenkov](https://github.com/mpenkov))

# 4.1.0, 30 Dec 2020
Expand Down
2 changes: 2 additions & 0 deletions smart_open/s3.py
Original file line number Diff line number Diff line change
Expand Up @@ -261,6 +261,7 @@ def open(
key_id,
min_part_size=min_part_size,
session=session,
resource=resource,
upload_kwargs=multipart_upload_kwargs,
resource_kwargs=resource_kwargs,
)
Expand All @@ -269,6 +270,7 @@ def open(
bucket_id,
key_id,
session=session,
resource=resource,
upload_kwargs=singlepart_upload_kwargs,
resource_kwargs=resource_kwargs,
)
Expand Down
58 changes: 58 additions & 0 deletions smart_open/tests/test_s3.py
Original file line number Diff line number Diff line change
Expand Up @@ -938,6 +938,64 @@ def test_failure(self):
self.assertEqual(partial.call_count, 3)


@moto.mock_s3()
def test_resource_propagation_singlepart():
"""Does the resource parameter make it from the caller to Boto3?"""
#
# Not sure why we need to create the bucket here, as setUpModule should
# have done that for us by now.
#
session = boto3.Session()
resource = session.resource('s3')
bucket = resource.create_bucket(Bucket=BUCKET_NAME)
bucket.wait_until_exists()

with smart_open.s3.open(
BUCKET_NAME,
WRITE_KEY_NAME,
mode='wb',
resource=resource,
multipart_upload=False,
) as writer:
assert writer._resource == resource
assert id(writer._resource) == id(resource)


@moto.mock_s3()
def test_resource_propagation_multipart():
"""Does the resource parameter make it from the caller to Boto3?"""
session = boto3.Session()
resource = session.resource('s3')
bucket = resource.create_bucket(Bucket=BUCKET_NAME)
bucket.wait_until_exists()

with smart_open.s3.open(
BUCKET_NAME,
WRITE_KEY_NAME,
mode='wb',
resource=resource,
multipart_upload=True,
) as writer:
assert writer._resource == resource
assert id(writer._resource) == id(resource)


@moto.mock_s3()
def test_resource_propagation_reader():
"""Does the resource parameter make it from the caller to Boto3?"""
session = boto3.Session()
resource = session.resource('s3')
bucket = resource.create_bucket(Bucket=BUCKET_NAME)
bucket.wait_until_exists()

with smart_open.s3.open(BUCKET_NAME, WRITE_KEY_NAME, mode='wb') as writer:
writer.write(b'hello world')

with smart_open.s3.open(BUCKET_NAME, WRITE_KEY_NAME, mode='rb', resource=resource) as reader:
assert reader._resource == resource
assert id(reader._resource) == id(resource)


if __name__ == '__main__':
logging.basicConfig(format='%(asctime)s : %(levelname)s : %(message)s', level=logging.INFO)
unittest.main()