b2sdk._internal.sync.action

class b2sdk._internal.sync.action.AbstractAction

Bases: object

An action to take, such as uploading, downloading, or deleting a file. Multi-threaded tasks create a sequence of Actions which are then run by a pool of threads.

An action can depend on other actions completing. An example of this is making sure a CreateBucketAction happens before an UploadFileAction.

run(bucket, reporter, dry_run=False)

Main action routine.

Parameters:

• bucket (b2sdk._internal.bucket.Bucket) – a Bucket object

• reporter (ProgressReport) – a place to report errors

• dry_run (bool) – if True, perform a dry run

abstract get_bytes()

Return the number of bytes to transfer for this action.

Return type:

int

abstract do_action(bucket, reporter)

Perform the action, returning only after the action is completed.

Parameters:

• bucket (Bucket) – a Bucket object

• reporter (ProgressReport) – a place to report errors

Return type:

None

abstract do_report(bucket, reporter)

Report the action performed.

Parameters:

• bucket (Bucket) – a Bucket object

• reporter (ProgressReport) – a place to report errors

Return type:

None

class b2sdk._internal.sync.action.B2UploadAction(local_full_path, relative_name, b2_file_name, mod_time_millis, size, encryption_settings_provider)

Bases: AbstractAction

File uploading action.

Parameters:

• local_full_path (str) –

• relative_name (str) –

• b2_file_name (str) –

• mod_time_millis (int) –

• size (int) –

• encryption_settings_provider (AbstractSyncEncryptionSettingsProvider) –

__init__(local_full_path, relative_name, b2_file_name, mod_time_millis, size, encryption_settings_provider)

Parameters:

• local_full_path (str) – a local file path

• relative_name (str) – a relative file name

• b2_file_name (str) – a name of a new remote file

• mod_time_millis (int) – file modification time in milliseconds

• size (int) – a file size

• encryption_settings_provider (AbstractSyncEncryptionSettingsProvider) – encryption setting provider

get_bytes()

Return file size.

Return type:

int

get_all_sources()

Get list of sources required to complete this upload

Return type:

list[OutboundTransferSource]

do_action(bucket, reporter)

Perform the uploading action, returning only after the action is completed.

Parameters:

• bucket (Bucket) – a Bucket object

• reporter (ProgressReport) – a place to report errors

Return type:

None

do_report(bucket, reporter)

Report the uploading action performed.

Parameters:

• bucket (Bucket) – a Bucket object

• reporter (ProgressReport) – a place to report errors

Return type:

None

class b2sdk._internal.sync.action.B2IncrementalUploadAction(local_full_path, relative_name, b2_file_name, mod_time_millis, size, encryption_settings_provider, file_version=None, absolute_minimum_part_size=None)

Bases: B2UploadAction

Parameters:

• local_full_path (str) –

• relative_name (str) –

• b2_file_name (str) –

• mod_time_millis (int) –

• size (int) –

• encryption_settings_provider (AbstractSyncEncryptionSettingsProvider) –

• file_version (Optional[FileVersion]) –

• absolute_minimum_part_size (Optional[int]) –

__init__(local_full_path, relative_name, b2_file_name, mod_time_millis, size, encryption_settings_provider, file_version=None, absolute_minimum_part_size=None)

Parameters:

• local_full_path (str) – a local file path

• relative_name (str) – a relative file name

• b2_file_name (str) – a name of a new remote file

• mod_time_millis (int) – file modification time in milliseconds

• size (int) – a file size

• encryption_settings_provider (AbstractSyncEncryptionSettingsProvider) – encryption setting provider

• file_version (Optional[FileVersion]) – version of file currently on the server

• absolute_minimum_part_size (Optional[int]) – minimum file part size for large files

get_all_sources()

Get list of sources required to complete this upload

Return type:

list[OutboundTransferSource]

class b2sdk._internal.sync.action.B2HideAction(relative_name, b2_file_name)

Bases: AbstractAction

Parameters:

• relative_name (str) –

• b2_file_name (str) –

__init__(relative_name, b2_file_name)

Parameters:

• relative_name (str) – a relative file name

• b2_file_name (str) – a name of a remote file

get_bytes()

Return file size.

Returns:

always zero

Return type:

int

do_action(bucket, reporter)

Perform the hiding action, returning only after the action is completed.

Parameters:

• bucket (Bucket) – a Bucket object

• reporter (ProgressReport) – a place to report errors

Return type:

None

do_report(bucket, reporter)

Report the hiding action performed.

Parameters:

• bucket (Bucket) – a Bucket object

• reporter (SyncReport) – a place to report errors

class b2sdk._internal.sync.action.B2DownloadAction(source_path, b2_file_name, local_full_path, encryption_settings_provider)

Bases: AbstractAction

Parameters:

• source_path (B2Path) –

• b2_file_name (str) –

• local_full_path (str) –

• encryption_settings_provider (AbstractSyncEncryptionSettingsProvider) –

__init__(source_path, b2_file_name, local_full_path, encryption_settings_provider)

Parameters:

• source_path (B2Path) – the file to be downloaded

• b2_file_name (str) – b2_file_name

• local_full_path (str) – a local file path

• encryption_settings_provider (AbstractSyncEncryptionSettingsProvider) – encryption setting provider

get_bytes()

Return file size.

Return type:

int

do_action(bucket, reporter)

Perform the downloading action, returning only after the action is completed.

Parameters:

• bucket (Bucket) – a Bucket object

• reporter (ProgressReport) – a place to report errors

Return type:

None

do_report(bucket, reporter)

Report the downloading action performed.

Parameters:

• bucket (Bucket) – a Bucket object

• reporter (ProgressReport) – a place to report errors

Return type:

None

class b2sdk._internal.sync.action.B2CopyAction(b2_file_name, source_path, dest_b2_file_name, source_bucket, destination_bucket, encryption_settings_provider)

Bases: AbstractAction

File copying action.

Parameters:

• b2_file_name (str) –

• source_path (B2Path) –

• source_bucket (Bucket) –

• destination_bucket (Bucket) –

• encryption_settings_provider (AbstractSyncEncryptionSettingsProvider) –

__init__(b2_file_name, source_path, dest_b2_file_name, source_bucket, destination_bucket, encryption_settings_provider)

Parameters:

• b2_file_name (str) – a b2_file_name

• source_path (B2Path) – the file to be copied

• dest_b2_file_name – a name of a destination remote file

• source_bucket (Bucket) – bucket to copy from

• destination_bucket (Bucket) – bucket to copy to

• encryption_settings_provider (AbstractSyncEncryptionSettingsProvider) – encryption setting provider

get_bytes()

Return file size.

Return type:

int

do_action(bucket, reporter)

Perform the copying action, returning only after the action is completed.

Parameters:

• bucket (Bucket) – a Bucket object

• reporter (ProgressReport) – a place to report errors

Return type:

None

do_report(bucket, reporter)

Report the copying action performed.

Parameters:

• bucket (Bucket) – a Bucket object

• reporter (ProgressReport) – a place to report errors

Return type:

None

class b2sdk._internal.sync.action.B2DeleteAction(relative_name, b2_file_name, file_id, note)

Bases: AbstractAction

Parameters:

• relative_name (str) –

• b2_file_name (str) –

• file_id (str) –

• note (str) –

__init__(relative_name, b2_file_name, file_id, note)

Parameters:

• relative_name (str) – a relative file name

• b2_file_name (str) – a name of a remote file

• file_id (str) – a file ID

• note (str) – a deletion note

get_bytes()

Return file size.

Return type:

int

Returns:

always zero

do_action(bucket, reporter)

Perform the deleting action, returning only after the action is completed.

Parameters:

• bucket (Bucket) – a Bucket object

• reporter (ProgressReport) – a place to report errors

do_report(bucket, reporter)

Report the deleting action performed.

Parameters:

• bucket (Bucket) – a Bucket object

• reporter (SyncReport) – a place to report errors

class b2sdk._internal.sync.action.LocalDeleteAction(relative_name, full_path)

Bases: AbstractAction

Parameters:

• relative_name (str) –

• full_path (str) –

__init__(relative_name, full_path)

Parameters:

• relative_name (str) – a relative file name

• full_path (str) – a full local path

get_bytes()

Return file size.

Return type:

int

Returns:

always zero

do_action(bucket, reporter)

Perform the deleting of a local file action, returning only after the action is completed.

Parameters:

• bucket (Bucket) – a Bucket object

• reporter (ProgressReport) – a place to report errors

do_report(bucket, reporter)

Report the deleting of a local file action performed.

Parameters:

• bucket (Bucket) – a Bucket object

• reporter (SyncReport) – a place to report errors