b2sdk.sync.folder
- class b2sdk.sync.folder.AbstractFolder[source]
Bases:
object
Interface to a folder full of files, which might be a B2 bucket, a virtual folder in a B2 bucket, or a directory on a local file system.
Files in B2 may have multiple versions, while files in local folders have just one.
- abstract all_files(reporter, policies_manager=<b2sdk.sync.scan_policies.ScanPoliciesManager object>)[source]
Return an iterator over all of the files in the folder, in the order that B2 uses.
It also performs filtering using policies manager.
No matter what the folder separator on the local file system is, “/” is used in the returned file names.
If a file is found, but does not exist (for example due to a broken symlink or a race), reporter will be informed about each such problem.
- Parameters
reporter – a place to report errors
policies_manager – a policies manager object
- b2sdk.sync.folder.join_b2_path(relative_dir_path: str, file_name: str)[source]
Like os.path.join, but for B2 file names where the root directory is called ‘’.
- class b2sdk.sync.folder.LocalFolder(root)[source]
Bases:
b2sdk.sync.folder.AbstractFolder
Folder interface to a directory on the local machine.
- __init__(root)[source]
Initialize a new folder.
- Parameters
root (str) – path to the root of the local folder. Must be unicode.
- all_files(reporter, policies_manager=<b2sdk.sync.scan_policies.ScanPoliciesManager object>)[source]
Yield all files.
- Parameters
reporter – a place to report errors
policies_manager – a policy manager object, default is DEFAULT_SCAN_MANAGER
- class b2sdk.sync.folder.B2Folder(bucket_name, folder_name, api)[source]
Bases:
b2sdk.sync.folder.AbstractFolder
Folder interface to b2.