Cache

b2sdk caches the mapping between bucket name and bucket id, so that the user of the library does not need to maintain the mapping to call the api.

class b2sdk.v3.AbstractCache

clear()

abstract get_bucket_id_or_none_from_bucket_name(name)

abstract get_bucket_name_or_none_from_allowed()

abstract get_bucket_name_or_none_from_bucket_id(bucket_id)

Parameters:

bucket_id (str) –

Return type:

Optional[str]

abstract list_bucket_names_ids()

List buckets in the cache.

Return type:

list[tuple[str, str]]

Returns:

list of tuples (bucket_name, bucket_id)

abstract save_bucket(bucket)

abstract set_bucket_name_cache(buckets)

class b2sdk.v3.AuthInfoCache(info)

A cache that stores data persistently in StoredAccountInfo.

Parameters:

info (AbstractAccountInfo) –

__init__(info)

Parameters:

info (AbstractAccountInfo) –

get_bucket_id_or_none_from_bucket_name(name)

get_bucket_name_or_none_from_bucket_id(bucket_id)

Return type:

Optional[str]

get_bucket_name_or_none_from_allowed()

list_bucket_names_ids()

List buckets in the cache.

Return type:

list[tuple[str, str]]

Returns:

list of tuples (bucket_name, bucket_id)

save_bucket(bucket)

set_bucket_name_cache(buckets)

clear()

class b2sdk.v3.DummyCache

A cache that does nothing.

get_bucket_id_or_none_from_bucket_name(name)

get_bucket_name_or_none_from_bucket_id(bucket_id)

Parameters:

bucket_id (str) –

Return type:

Optional[str]

get_bucket_name_or_none_from_allowed()

list_bucket_names_ids()

List buckets in the cache.

Return type:

list[tuple[str, str]]

Returns:

list of tuples (bucket_name, bucket_id)

save_bucket(bucket)

set_bucket_name_cache(buckets)

clear()

class b2sdk.v3.InMemoryCache

A cache that stores the information in memory.

__init__()

get_bucket_id_or_none_from_bucket_name(name)

get_bucket_name_or_none_from_bucket_id(bucket_id)

Parameters:

bucket_id (str) –

Return type:

Optional[str]

get_bucket_name_or_none_from_allowed()

list_bucket_names_ids()

List buckets in the cache.

Return type:

list[tuple[str, str]]

Returns:

list of tuples (bucket_name, bucket_id)

save_bucket(bucket)

set_bucket_name_cache(buckets)

clear()