b2sdk.raw_api
– B2 raw api wrapper¶
- class b2sdk.raw_api.MetadataDirectiveMode(value)[source]¶
Bases:
Enum
Mode of handling metadata when copying a file
- COPY = 401¶
copy metadata from the source file
- REPLACE = 402¶
ignore the source file metadata and set it to provided values
- class b2sdk.raw_api.LifecycleRule[source]¶
Bases:
TypedDict
Lifecycle Rule.
External documentation: B2 Cloud Storage Lifecycle Rules.
- fileNamePrefix: str¶
- daysFromHidingToDeleting: NotRequired[int | None]¶
- daysFromUploadingToHiding: NotRequired[int | None]¶
- class b2sdk.raw_api.AbstractRawApi[source]¶
Bases:
object
Direct access to the B2 web apis.
- abstract copy_file(api_url, account_auth_token, source_file_id, new_file_name, bytes_range=None, metadata_directive=None, content_type=None, file_info=None, destination_bucket_id=None, destination_server_side_encryption=None, source_server_side_encryption=None, file_retention=None, legal_hold=None, cache_control=None)[source]¶
- Parameters
destination_server_side_encryption (EncryptionSetting | None) –
source_server_side_encryption (EncryptionSetting | None) –
file_retention (FileRetentionSetting | None) –
legal_hold (LegalHold | None) –
cache_control (str | None) –
- abstract copy_part(api_url, account_auth_token, source_file_id, large_file_id, part_number, bytes_range=None, destination_server_side_encryption=None, source_server_side_encryption=None)[source]¶
- Parameters
destination_server_side_encryption (EncryptionSetting | None) –
source_server_side_encryption (EncryptionSetting | None) –
- abstract create_bucket(api_url, account_auth_token, account_id, bucket_name, bucket_type, bucket_info=None, cors_rules=None, lifecycle_rules=None, default_server_side_encryption=None, is_file_lock_enabled=None, replication=None)[source]¶
- abstract create_key(api_url, account_auth_token, account_id, capabilities, key_name, valid_duration_seconds, bucket_id, name_prefix)[source]¶
- abstract download_file_from_url(account_auth_token_or_none, url, range_=None, encryption=None)[source]¶
- Parameters
encryption (EncryptionSetting | None) –
- abstract get_download_authorization(api_url, account_auth_token, bucket_id, file_name_prefix, valid_duration_in_seconds)[source]¶
- abstract list_buckets(api_url, account_auth_token, account_id, bucket_id=None, bucket_name=None)[source]¶
- abstract list_file_names(api_url, account_auth_token, bucket_id, start_file_name=None, max_file_count=None, prefix=None)[source]¶
- abstract list_file_versions(api_url, account_auth_token, bucket_id, start_file_name=None, start_file_id=None, max_file_count=None, prefix=None)[source]¶
- abstract list_keys(api_url, account_auth_token, account_id, max_key_count=None, start_application_key_id=None)[source]¶
- abstract list_parts(api_url, account_auth_token, file_id, start_part_number, max_part_count)[source]¶
- abstract list_unfinished_large_files(api_url, account_auth_token, bucket_id, start_file_id=None, max_file_count=None, prefix=None)[source]¶
- abstract start_large_file(api_url, account_auth_token, bucket_id, file_name, content_type, file_info, server_side_encryption=None, file_retention=None, legal_hold=None, cache_control=None)[source]¶
- Parameters
server_side_encryption (EncryptionSetting | None) –
file_retention (FileRetentionSetting | None) –
legal_hold (LegalHold | None) –
cache_control (str | None) –
- abstract update_bucket(api_url, account_auth_token, account_id, bucket_id, bucket_type=None, bucket_info=None, cors_rules=None, lifecycle_rules=None, if_revision_is=None, default_server_side_encryption=None, default_retention=None, replication=None, is_file_lock_enabled=None)[source]¶
- abstract update_file_retention(api_url, account_auth_token, file_id, file_name, file_retention, bypass_governance=False)[source]¶
- Parameters
file_retention (
FileRetentionSetting
) –bypass_governance (
bool
) –
- classmethod get_upload_file_headers(upload_auth_token, file_name, content_length, content_type, content_sha1, file_info, server_side_encryption, file_retention, legal_hold, custom_upload_timestamp=None, cache_control=None)[source]¶
- Parameters
upload_auth_token (str) –
file_name (str) –
content_length (int) –
content_type (str) –
content_sha1 (str) –
file_info (dict) –
server_side_encryption (EncryptionSetting | None) –
file_retention (FileRetentionSetting | None) –
legal_hold (LegalHold | None) –
custom_upload_timestamp (int | None) –
cache_control (str | None) –
- Return type
- abstract upload_file(upload_url, upload_auth_token, file_name, content_length, content_type, content_sha1, file_info, data_stream, server_side_encryption=None, file_retention=None, legal_hold=None, custom_upload_timestamp=None, cache_control=None)[source]¶
- Parameters
server_side_encryption (EncryptionSetting | None) –
file_retention (FileRetentionSetting | None) –
legal_hold (LegalHold | None) –
custom_upload_timestamp (int | None) –
cache_control (str | None) –
- abstract upload_part(upload_url, upload_auth_token, part_number, content_length, sha1_sum, input_stream, server_side_encryption=None)[source]¶
- Parameters
server_side_encryption (EncryptionSetting | None) –
- class b2sdk.raw_api.B2RawHTTPApi(b2_http)[source]¶
Bases:
AbstractRawApi
Provide access to the B2 web APIs, exactly as they are provided by b2.
Requires that you provide all necessary URLs and auth tokens for each call.
Each API call decodes the returned JSON and returns a dict.
- For details on what each method does, see the B2 docs:
This class is intended to be a super-simple, very thin layer on top of the HTTP calls. It can be mocked-out for testing higher layers. And this class can be tested by exercising each call just once, which is relatively quick.
- create_bucket(api_url, account_auth_token, account_id, bucket_name, bucket_type, bucket_info=None, cors_rules=None, lifecycle_rules=None, default_server_side_encryption=None, is_file_lock_enabled=None, replication=None)[source]¶
- create_key(api_url, account_auth_token, account_id, capabilities, key_name, valid_duration_seconds, bucket_id, name_prefix)[source]¶
- download_file_from_url(account_auth_token_or_none, url, range_=None, encryption=None)[source]¶
Issue a streaming request for download of a file, potentially authorized.
- Parameters
account_auth_token_or_none (str) – an optional account auth token to pass in
url (str) – the full URL to download from
range (tuple) – two-element tuple for http Range header
encryption (EncryptionSetting | None) – encryption settings for downloading
encryption –
- Returns
b2_http response
- get_download_authorization(api_url, account_auth_token, bucket_id, file_name_prefix, valid_duration_in_seconds)[source]¶
- list_file_names(api_url, account_auth_token, bucket_id, start_file_name=None, max_file_count=None, prefix=None)[source]¶
- list_file_versions(api_url, account_auth_token, bucket_id, start_file_name=None, start_file_id=None, max_file_count=None, prefix=None)[source]¶
- list_keys(api_url, account_auth_token, account_id, max_key_count=None, start_application_key_id=None)[source]¶
- list_unfinished_large_files(api_url, account_auth_token, bucket_id, start_file_id=None, max_file_count=None, prefix=None)[source]¶
- start_large_file(api_url, account_auth_token, bucket_id, file_name, content_type, file_info, server_side_encryption=None, file_retention=None, legal_hold=None, custom_upload_timestamp=None, cache_control=None)[source]¶
- Parameters
server_side_encryption (EncryptionSetting | None) –
file_retention (FileRetentionSetting | None) –
legal_hold (LegalHold | None) –
custom_upload_timestamp (int | None) –
cache_control (str | None) –
- update_bucket(api_url, account_auth_token, account_id, bucket_id, bucket_type=None, bucket_info=None, cors_rules=None, lifecycle_rules=None, if_revision_is=None, default_server_side_encryption=None, default_retention=None, replication=None, is_file_lock_enabled=None)[source]¶
- update_file_retention(api_url, account_auth_token, file_id, file_name, file_retention, bypass_governance=False)[source]¶
- Parameters
file_retention (
FileRetentionSetting
) –bypass_governance (
bool
) –
- update_file_legal_hold(api_url, account_auth_token, file_id, file_name, legal_hold)[source]¶
- Parameters
legal_hold (
LegalHold
) –
- unprintable_to_hex(string)[source]¶
Replace unprintable chars in string with a hex representation.
- Parameters
string – an arbitrary string, possibly with unprintable characters.
- Returns
the string, with unprintable characters changed to hex (e.g., “”)
- check_b2_filename(filename)[source]¶
Raise an appropriate exception with details if the filename is unusable.
See https://www.backblaze.com/b2/docs/files.html for the rules.
- Parameters
filename – a proposed filename in unicode
- Returns
None if the filename is usable
- upload_file(upload_url, upload_auth_token, file_name, content_length, content_type, content_sha1, file_info, data_stream, server_side_encryption=None, file_retention=None, legal_hold=None, custom_upload_timestamp=None, cache_control=None)[source]¶
Upload one, small file to b2.
- Parameters
upload_url – the upload_url from b2_authorize_account
upload_auth_token – the auth token from b2_authorize_account
file_name – the name of the B2 file
content_length – number of bytes in the file
content_type – MIME type
content_sha1 – hex SHA1 of the contents of the file
file_info (dict) – extra file info to upload
data_stream – a file like object from which the contents of the file can be read
server_side_encryption (EncryptionSetting | None) – encryption setting for the file
file_retention (FileRetentionSetting | None) – retention setting for the file
legal_hold (LegalHold | None) – legal hold setting for the file
custom_upload_timestamp (int | None) – custom upload timestamp for the file
cache_control (str | None) – an optional cache control setting. Syntax based on the section 14.9 of RFC 2616. Example string value: ‘public, max-age=86400, s-maxage=3600, no-transform’.
- Returns
- upload_part(upload_url, upload_auth_token, part_number, content_length, content_sha1, data_stream, server_side_encryption=None)[source]¶
- Parameters
server_side_encryption (EncryptionSetting | None) –
- copy_file(api_url, account_auth_token, source_file_id, new_file_name, bytes_range=None, metadata_directive=None, content_type=None, file_info=None, destination_bucket_id=None, destination_server_side_encryption=None, source_server_side_encryption=None, file_retention=None, legal_hold=None, cache_control=None)[source]¶
- Parameters
destination_server_side_encryption (EncryptionSetting | None) –
source_server_side_encryption (EncryptionSetting | None) –
file_retention (FileRetentionSetting | None) –
legal_hold (LegalHold | None) –
cache_control (str | None) –
- copy_part(api_url, account_auth_token, source_file_id, large_file_id, part_number, bytes_range=None, destination_server_side_encryption=None, source_server_side_encryption=None)[source]¶
- Parameters
destination_server_side_encryption (EncryptionSetting | None) –
source_server_side_encryption (EncryptionSetting | None) –