b2sdk.sync.action
- class b2sdk.sync.action.AbstractAction[source]
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)[source]
Main action routine.
- Parameters
bucket (b2sdk.bucket.Bucket) – a Bucket object
reporter – a place to report errors
dry_run (bool) – if True, perform a dry run
- class b2sdk.sync.action.B2UploadAction(local_full_path, relative_name, b2_file_name, mod_time_millis, size, encryption_settings_provider: AbstractSyncEncryptionSettingsProvider)[source]
Bases:
AbstractAction
File uploading action.
- __init__(local_full_path, relative_name, b2_file_name, mod_time_millis, size, encryption_settings_provider: AbstractSyncEncryptionSettingsProvider)[source]
- 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 (b2sdk.v2.AbstractSyncEncryptionSettingsProvider) – encryption setting provider
- do_action(bucket, reporter)[source]
Perform the uploading action, returning only after the action is completed.
- Parameters
bucket (b2sdk.v2.Bucket) – a Bucket object
reporter – a place to report errors
- class b2sdk.sync.action.B2HideAction(relative_name, b2_file_name)[source]
Bases:
AbstractAction
- class b2sdk.sync.action.B2DownloadAction(source_path: B2Path, b2_file_name: str, local_full_path: str, encryption_settings_provider: AbstractSyncEncryptionSettingsProvider)[source]
Bases:
AbstractAction
- __init__(source_path: B2Path, b2_file_name: str, local_full_path: str, encryption_settings_provider: AbstractSyncEncryptionSettingsProvider)[source]
- Parameters
source_path (b2sdk.v2.B2Path) – the file to be downloaded
b2_file_name (str) – b2_file_name
local_full_path (str) – a local file path
encryption_settings_provider (b2sdk.v2.AbstractSyncEncryptionSettingsProvider) – encryption setting provider
- do_action(bucket, reporter)[source]
Perform the downloading action, returning only after the action is completed.
- Parameters
bucket (b2sdk.v2.Bucket) – a Bucket object
reporter – a place to report errors
- class b2sdk.sync.action.B2CopyAction(b2_file_name: str, source_path: B2Path, dest_b2_file_name, source_bucket: Bucket, destination_bucket: Bucket, encryption_settings_provider: AbstractSyncEncryptionSettingsProvider)[source]
Bases:
AbstractAction
File copying action.
- __init__(b2_file_name: str, source_path: B2Path, dest_b2_file_name, source_bucket: Bucket, destination_bucket: Bucket, encryption_settings_provider: AbstractSyncEncryptionSettingsProvider)[source]
- Parameters
b2_file_name (str) – a b2_file_name
source_path (b2sdk.v2.B2Path) – the file to be copied
dest_b2_file_name (str) – a name of a destination remote file
source_bucket (Bucket) – bucket to copy from
destination_bucket (Bucket) – bucket to copy to
encryption_settings_provider (b2sdk.v2.AbstractSyncEncryptionSettingsProvider) – encryption setting provider
- class b2sdk.sync.action.B2DeleteAction(relative_name, b2_file_name, file_id, note)[source]
Bases:
AbstractAction
- class b2sdk.sync.action.LocalDeleteAction(relative_name, full_path)[source]
Bases:
AbstractAction