b2sdk._internal.transfer.outbound.upload_source

class b2sdk._internal.transfer.outbound.upload_source.UploadMode(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: Enum

Mode of file uploads

FULL = 1

always upload the whole file

INCREMENTAL = 2

use incremental uploads when possible

class b2sdk._internal.transfer.outbound.upload_source.AbstractUploadSource

Bases: OutboundTransferSource

The source of data for uploading to b2.

abstract get_content_sha1()

Returns a 40-character string containing the hex SHA1 checksum of the data in the file.

Return type:

Optional[NewType(Sha1HexDigest, str)]

abstract open()

Returns a binary file-like object from which the data can be read.

Return type:

IOBase

is_upload()

Returns True if outbound source is an upload source.

Return type:

bool

is_copy()

Returns True if outbound source is a copy source.

Return type:

bool

is_sha1_known()

Returns information whether SHA1 of the source is currently available. Note that negative result doesn’t mean that SHA1 is not available. Calling get_content_sha1 can still provide a valid digest.

Return type:

bool

class b2sdk._internal.transfer.outbound.upload_source.UploadSourceBytes(data_bytes, content_sha1=None)

Bases: AbstractUploadSource

Parameters:

• data_bytes (bytes | bytearray) –

• content_sha1 (Optional[NewType(Sha1HexDigest, str)]) –

__init__(data_bytes, content_sha1=None)

Initialize upload source using given bytes.

Parameters:

• data_bytes (bytes | bytearray) – Data that is to be uploaded.

• content_sha1 (Optional[NewType(Sha1HexDigest, str)]) – SHA1 hexdigest of the data, or None.

get_content_length()

Returns the number of bytes of data in the file.

Return type:

int

get_content_sha1()

Returns a 40-character string containing the hex SHA1 checksum of the data in the file.

Return type:

Optional[NewType(Sha1HexDigest, str)]

open()

Returns a binary file-like object from which the data can be read.

is_sha1_known()

Returns information whether SHA1 of the source is currently available. Note that negative result doesn’t mean that SHA1 is not available. Calling get_content_sha1 can still provide a valid digest.

Return type:

bool

class b2sdk._internal.transfer.outbound.upload_source.UploadSourceLocalFileBase(local_path, content_sha1=None)

Bases: AbstractUploadSource

Parameters:

• local_path (PathLike | str) –

• content_sha1 (Optional[NewType(Sha1HexDigest, str)]) –

__init__(local_path, content_sha1=None)

Initialize upload source using provided path.

Parameters:

• local_path (PathLike | str) – Any path-like object that points to a file to be uploaded.

• content_sha1 (Optional[NewType(Sha1HexDigest, str)]) – SHA1 hexdigest of the data, or None.

check_path_and_get_size()

Return type:

None

get_content_length()

Returns the number of bytes of data in the file.

Return type:

int

get_content_sha1()

Returns a 40-character string containing the hex SHA1 checksum of the data in the file.

Return type:

Optional[NewType(Sha1HexDigest, str)]

open()

Returns a binary file-like object from which the data can be read.

is_sha1_known()

Returns information whether SHA1 of the source is currently available. Note that negative result doesn’t mean that SHA1 is not available. Calling get_content_sha1 can still provide a valid digest.

Return type:

bool

class b2sdk._internal.transfer.outbound.upload_source.UploadSourceLocalFileRange(local_path, content_sha1=None, offset=0, length=None)

Bases: UploadSourceLocalFileBase

Parameters:

• local_path (PathLike | str) –

• content_sha1 (Optional[NewType(Sha1HexDigest, str)]) –

• offset (int) –

• length (Optional[int]) –

__init__(local_path, content_sha1=None, offset=0, length=None)

Initialize upload source using provided path.

Parameters:

• local_path (PathLike | str) – Any path-like object that points to a file to be uploaded.

• content_sha1 (Optional[NewType(Sha1HexDigest, str)]) – SHA1 hexdigest of the data, or None.

• offset (int) – Position in the file where upload should start from.

• length (Optional[int]) – Amount of data to be uploaded. If None, length of the remainder of the file is taken.

open()

Returns a binary file-like object from which the data can be read.

class b2sdk._internal.transfer.outbound.upload_source.UploadSourceLocalFile(local_path, content_sha1=None)

Bases: UploadSourceLocalFileBase

Parameters:

• local_path (PathLike | str) –

• content_sha1 (Optional[NewType(Sha1HexDigest, str)]) –

get_incremental_sources(file_version, min_part_size=None)

Split the upload into a copy and upload source constructing an incremental upload

This will return a list of upload sources. If the upload cannot split, the method will return [self].

Parameters:

• file_version (BaseFileVersion) –

• min_part_size (Optional[int]) –

Return type:

list[OutboundTransferSource]

class b2sdk._internal.transfer.outbound.upload_source.UploadSourceStream(stream_opener, stream_length=None, stream_sha1=None)

Bases: AbstractUploadSource

Parameters:

• stream_opener (Callable[[], IOBase]) –

• stream_length (Optional[int]) –

• stream_sha1 (Optional[NewType(Sha1HexDigest, str)]) –

__init__(stream_opener, stream_length=None, stream_sha1=None)

Initialize upload source using arbitrary function.

Parameters:

• stream_opener (Callable[[], IOBase]) – A function that opens a stream for uploading.

• stream_length (Optional[int]) – Length of the stream. If None, data will be calculated from the stream the first time it’s required.

• stream_sha1 (Optional[NewType(Sha1HexDigest, str)]) – SHA1 of the stream. If None, data will be calculated from the stream the first time it’s required.

get_content_length()

Returns the number of bytes of data in the file.

Return type:

int

get_content_sha1()

Returns a 40-character string containing the hex SHA1 checksum of the data in the file.

Return type:

Optional[NewType(Sha1HexDigest, str)]

open()

Returns a binary file-like object from which the data can be read.

is_sha1_known()

Returns information whether SHA1 of the source is currently available. Note that negative result doesn’t mean that SHA1 is not available. Calling get_content_sha1 can still provide a valid digest.

Return type:

bool

class b2sdk._internal.transfer.outbound.upload_source.UploadSourceStreamRange(stream_opener, offset=0, stream_length=None, stream_sha1=None)

Bases: UploadSourceStream

Parameters:

• stream_opener (Callable[[], IOBase]) –

• offset (int) –

• stream_length (Optional[int]) –

• stream_sha1 (Optional[NewType(Sha1HexDigest, str)]) –

__init__(stream_opener, offset=0, stream_length=None, stream_sha1=None)

Initialize upload source using arbitrary function.

Parameters:

• stream_opener (Callable[[], IOBase]) – A function that opens a stream for uploading.

• offset (int) – Offset from which stream should be uploaded.

• stream_length (Optional[int]) – Length of the stream. If None, data will be calculated from the stream the first time it’s required.

• stream_sha1 (Optional[NewType(Sha1HexDigest, str)]) – SHA1 of the stream. If None, data will be calculated from the stream the first time it’s required.

open()

Returns a binary file-like object from which the data can be read.