rw

Read and write related API.

class s3pathlib.core.rw.ReadAndWriteAPIMixin

A mixin class that implements the Text / Bytes, Read / Write methods.

read_bytes(version_id: str = OPT, if_match: str = OPT, if_modified_since: datetime = OPT, if_none_match: str = OPT, if_unmodified_since: datetime = OPT, range: str = OPT, response_cache_control: str = OPT, response_content_disposition: str = OPT, response_content_encoding: str = OPT, response_content_language: str = OPT, response_content_type: str = OPT, response_expires: str = OPT, sse_customer_algorithm: str = OPT, sse_customer_key: str = OPT, request_payer: str = OPT, part_number: int = OPT, expected_bucket_owner: str = OPT, checksum_mode: str = OPT, bsm: BotoSesManager | S3Client | None = None) → bytes

Read binary data from s3 object. A simple wrapper around get_object.

It also updates this S3Path object’s metadata and attributes like etag, size, version_id, etc with the get_object response.

Example:

>>> s3path = S3Path.from_s3_uri("s3://my-bucket/my-file.txt")
>>> s3path.write_bytes(b"hello", metadata={"creator": "me"})
>>> s3path.read_bytes()
b'hello'
>>> s3path.size
5
>>> s3path.metadata
{'creator': 'me'}

Parameters:

• version_id – See get_object.

• if_match – See get_object.

• if_modified_since – See get_object.

• if_none_match – See get_object.

• if_unmodified_since – See get_object.

• range – See get_object.

• response_cache_control – See get_object.

• response_content_disposition – See get_object.

• response_content_encoding – See get_object.

• response_content_language – See get_object.

• response_content_type – See get_object.

• response_expires – See get_object.

• sse_customer_algorithm – See get_object.

• sse_customer_key – See get_object.

• request_payer – See get_object.

• part_number – See get_object.

• expected_bucket_owner – See get_object.

• checksum_mode – See get_object.

• bsm – See bsm.

Returns:

the binary data.

Added in version 1.0.3.

Changed in version 1.1.2: automatically store metadata in cache.

Changed in version 2.0.1: add version_id parameter, and now support full list of get_object arguments.

read_text(encoding='utf-8', errors='strict', version_id: str = OPT, if_match: str = OPT, if_modified_since: datetime = OPT, if_none_match: str = OPT, if_unmodified_since: datetime = OPT, range: str = OPT, response_cache_control: str = OPT, response_content_disposition: str = OPT, response_content_encoding: str = OPT, response_content_language: str = OPT, response_content_type: str = OPT, response_expires: str = OPT, sse_customer_algorithm: str = OPT, sse_customer_key: str = OPT, request_payer: str = OPT, part_number: int = OPT, expected_bucket_owner: str = OPT, checksum_mode: str = OPT, bsm: BotoSesManager | S3Client | None = None) → str

Read text data from s3 object. A simple wrapper around get_object.

It also updates this S3Path object’s metadata and attributes like etag, size, version_id, etc with the get_object response.

Example:

>>> s3path = S3Path("s3://my-bucket/my-file.txt")
>>> s3path.write_text("hello", metadata={"creator": "me"})
>>> s3path.read_text()
'hello'
>>> s3path.size
5
>>> s3path.metadata
{'creator': 'me'}

Parameters:

• encoding – See decode.

• errors – See decode.

• version_id – See get_object.

• if_match – See get_object.

• if_modified_since – See get_object.

• if_none_match – See get_object.

• if_unmodified_since – See get_object.

• range – See get_object.

• response_cache_control – See get_object.

• response_content_disposition – See get_object.

• response_content_encoding – See get_object.

• response_content_language – See get_object.

• response_content_type – See get_object.

• response_expires – See get_object.

• sse_customer_algorithm – See get_object.

• sse_customer_key – See get_object.

• request_payer – See get_object.

• part_number – See get_object.

• expected_bucket_owner – See get_object.

• checksum_mode – See get_object.

• bsm – See bsm.

Returns:

the string data.

Added in version 1.0.3.

Changed in version 1.1.2: automatically store metadata in cache.

Changed in version 2.0.1: add version_id parameter, and now support full list of get_object arguments.

write_bytes(data: bytes, metadata: Dict[str, str] = OPT, tags: Dict[str, str] = OPT, acl: str = OPT, cache_control: str = OPT, content_disposition: str = OPT, content_encoding: str = OPT, content_language: str = OPT, content_length: int = OPT, content_md5: str = OPT, content_type: str = OPT, checksum_algorithm: str = OPT, checksum_crc32: str = OPT, checksum_crc32c: str = OPT, checksum_sha1: str = OPT, checksum_sha256: str = OPT, expires_datetime: datetime = OPT, grant_full_control: str = OPT, grant_read: str = OPT, grant_read_acp: str = OPT, grant_write_acp: str = OPT, server_side_encryption: str = OPT, storage_class: str = OPT, website_redirect_location: str = OPT, sse_customer_algorithm: str = OPT, sse_customer_key: str = OPT, sse_kms_key_id: str = OPT, sse_kms_encryption_context: str = OPT, bucket_key_enabled: bool = OPT, request_payer: str = OPT, object_lock_mode: str = OPT, object_lock_retain_until_datetime: datetime = OPT, object_lock_legal_hold_status: str = OPT, expected_bucket_owner: str = OPT, bsm: BotoSesManager | S3Client | None = None) → S3Path

Write binary data to s3 object. A simple wrapper around put_object.

Example:

>>> s3path = S3Path("s3://my-bucket/my-file.txt")
>>> s3path.write_bytes(b"hello", metadata={"creator": "me"})
>>> s3path.size
5
>>> s3path.metadata
{'creator': 'me'}

Parameters:

• data – the text you want to write.

• metadata – the s3 object metadata in string key value pair dict.

• tags – the s3 object tags in string key value pair dict.

• acl – See put_object.

• cache_control – See put_object.

• content_disposition – See put_object.

• content_encoding – See put_object.

• content_language – See put_object.

• content_length – See put_object.

• content_md5 – See put_object.

• content_type – See put_object.

• checksum_algorithm – See put_object.

• checksum_crc32 – See put_object.

• checksum_crc32c – See put_object.

• checksum_sha1 – See put_object.

• checksum_sha256 – See put_object.

• expires_datetime – See put_object.

• grant_full_control – See put_object.

• grant_read – See put_object.

• grant_read_acp – See put_object.

• grant_write_acp – See put_object.

• server_side_encryption – See put_object.

• storage_class – See put_object.

• website_redirect_location – See put_object.

• sse_customer_algorithm – See put_object.

• sse_customer_key – See put_object.

• sse_kms_key_id – See put_object.

• sse_kms_encryption_context – See put_object.

• bucket_key_enabled – See put_object.

• request_payer – See put_object.

• object_lock_mode – See put_object.

• object_lock_retain_until_datetime – See put_object.

• object_lock_legal_hold_status – See put_object.

• expected_bucket_owner – See put_object.

• bsm – See bsm.

Returns:

A new S3Path object with the same bucket and key, but the new metadata representing the object you just put.

Added in version 1.0.3.

Changed in version 1.1.1: add metadata and tags parameters.

write_text(data: str, encoding: str = 'utf-8', errors: str = 'strict', metadata: Dict[str, str] = OPT, tags: Dict[str, str] = OPT, acl: str = OPT, cache_control: str = OPT, content_disposition: str = OPT, content_encoding: str = OPT, content_language: str = OPT, content_length: int = OPT, content_md5: str = OPT, content_type: str = OPT, checksum_algorithm: str = OPT, checksum_crc32: str = OPT, checksum_crc32c: str = OPT, checksum_sha1: str = OPT, checksum_sha256: str = OPT, expires_datetime: datetime = OPT, grant_full_control: str = OPT, grant_read: str = OPT, grant_read_acp: str = OPT, grant_write_acp: str = OPT, server_side_encryption: str = OPT, storage_class: str = OPT, website_redirect_location: str = OPT, sse_customer_algorithm: str = OPT, sse_customer_key: str = OPT, sse_kms_key_id: str = OPT, sse_kms_encryption_context: str = OPT, bucket_key_enabled: bool = OPT, request_payer: str = OPT, object_lock_mode: str = OPT, object_lock_retain_until_datetime: datetime = OPT, object_lock_legal_hold_status: str = OPT, expected_bucket_owner: str = OPT, bsm: BotoSesManager | S3Client | None = None) → S3Path

Write text to s3 object. A simple wrapper around put_object.

Example:

>>> s3path = S3Path("s3://my-bucket/my-file.txt")
>>> s3path.write_text("hello", metadata={"creator": "me"})
>>> s3path.size
5
>>> s3path.metadata
{'creator': 'me'}

Parameters:

• data – the text you want to write.

• encoding – See encode.

• errors – See encode.

• metadata – the s3 object metadata in string key value pair dict.

• tags – the s3 object tags in string key value pair dict.

• acl – See put_object.

• cache_control – See put_object.

• content_disposition – See put_object.

• content_encoding – See put_object.

• content_language – See put_object.

• content_length – See put_object.

• content_md5 – See put_object.

• content_type – See put_object.

• checksum_algorithm – See put_object.

• checksum_crc32 – See put_object.

• checksum_crc32c – See put_object.

• checksum_sha1 – See put_object.

• checksum_sha256 – See put_object.

• expires_datetime – See put_object.

• grant_full_control – See put_object.

• grant_read – See put_object.

• grant_read_acp – See put_object.

• grant_write_acp – See put_object.

• server_side_encryption – See put_object.

• storage_class – See put_object.

• website_redirect_location – See put_object.

• sse_customer_algorithm – See put_object.

• sse_customer_key – See put_object.

• sse_kms_key_id – See put_object.

• sse_kms_encryption_context – See put_object.

• bucket_key_enabled – See put_object.

• request_payer – See put_object.

• object_lock_mode – See put_object.

• object_lock_retain_until_datetime – See put_object.

• object_lock_legal_hold_status – See put_object.

• expected_bucket_owner – See put_object.

• bsm – See bsm.

Returns:

A new S3Path object with the same bucket and key, but the new metadata representing the object you just put.

Added in version 1.0.3.

Changed in version 1.1.1: add metadata and tags parameters.

touch(exist_ok: bool = False, metadata: Dict[str, str] = OPT, tags: Dict[str, str] = OPT, acl: str = OPT, cache_control: str = OPT, content_disposition: str = OPT, content_encoding: str = OPT, content_language: str = OPT, content_length: int = OPT, content_md5: str = OPT, content_type: str = OPT, checksum_algorithm: str = OPT, checksum_crc32: str = OPT, checksum_crc32c: str = OPT, checksum_sha1: str = OPT, checksum_sha256: str = OPT, expires_datetime: datetime = OPT, grant_full_control: str = OPT, grant_read: str = OPT, grant_read_acp: str = OPT, grant_write_acp: str = OPT, server_side_encryption: str = OPT, storage_class: str = OPT, website_redirect_location: str = OPT, sse_customer_algorithm: str = OPT, sse_customer_key: str = OPT, sse_kms_key_id: str = OPT, sse_kms_encryption_context: str = OPT, bucket_key_enabled: bool = OPT, request_payer: str = OPT, object_lock_mode: str = OPT, object_lock_retain_until_datetime: datetime = OPT, object_lock_legal_hold_status: str = OPT, expected_bucket_owner: str = OPT, bsm: BotoSesManager | S3Client | None = None)

Create an empty S3 object at the S3 location if the S3 object not exists. Do nothing if already exists.

Example:

>>> s3path = S3Path("s3://my-bucket/my-file.txt")
>>> s3path.write_text("hello", metadata={"creator": "me"})
>>> s3path.size
5
>>> s3path.metadata
{'creator': 'me'}

Parameters:

• exist_ok – if True, it won’t raise error when the S3 object already exists.

• data – the text you want to write.

• metadata – the s3 object metadata in string key value pair dict.

• tags – the s3 object tags in string key value pair dict.

• acl – See put_object.

• cache_control – See put_object.

• content_disposition – See put_object.

• content_encoding – See put_object.

• content_language – See put_object.

• content_length – See put_object.

• content_md5 – See put_object.

• content_type – See put_object.

• checksum_algorithm – See put_object.

• checksum_crc32 – See put_object.

• checksum_crc32c – See put_object.

• checksum_sha1 – See put_object.

• checksum_sha256 – See put_object.

• expires_datetime – See put_object.

• grant_full_control – See put_object.

• grant_read – See put_object.

• grant_read_acp – See put_object.

• grant_write_acp – See put_object.

• server_side_encryption – See put_object.

• storage_class – See put_object.

• website_redirect_location – See put_object.

• sse_customer_algorithm – See put_object.

• sse_customer_key – See put_object.

• sse_kms_key_id – See put_object.

• sse_kms_encryption_context – See put_object.

• bucket_key_enabled – See put_object.

• request_payer – See put_object.

• object_lock_mode – See put_object.

• object_lock_retain_until_datetime – See put_object.

• object_lock_legal_hold_status – See put_object.

• expected_bucket_owner – See put_object.

• bsm – See bsm.

Added in version 1.0.6.

Changed in version 1.2.1: add metadata and tags parameters.

mkdir(exist_ok: bool = False, parents: bool = False, bsm: BotoSesManager | S3Client | None = None)

Make an S3 folder (empty “/” file)

Example:

>>> s3dir = S3Path("s3://my-bucket/my-folder/").to_dir()
>>> s3dir.to_dir(exist_ok=True)

Parameters:

• exist_ok – If True, it won’t raise error when the S3 folder already exists.

• parents – If True, all parent folders will be created.

• bsm – See bsm.

Added in version 1.0.6.