pancloud.adapters package

Submodules

pancloud.adapters.adapter module

Base adapter class.

class pancloud.adapters.adapter.StorageAdapter[source]

Bases: abc.ABC

A storage adapter abstract base class.

fetch_credential(credential=None, profile=None)[source]

Fetch credential from store.

Parameters:
  • credential (str) – Credential to fetch.
  • profile (str) – Credentials profile. Defaults to 'default'.
init_store()[source]

Initialize credentials store.

remove_profile(profile=None)[source]

Remove profile from store.

Parameters:profile (str) – Credentials profile to remove.
write_credentials(credentials=None, profile=None, cache_token=None)[source]

Write credentials.

Write credentials to store.

Parameters:
  • cache_token (bool) – If True, stores access_token in token store. Defaults to True.
  • credentials (class) – Read-only credentials.
  • profile (str) – Credentials profile. Defaults to 'default'.

pancloud.adapters.tinydb_adapter module

TinyDB storage adapter.

class pancloud.adapters.tinydb_adapter.TinyDBStore(**kwargs)[source]

Bases: pancloud.adapters.adapter.StorageAdapter

fetch_credential(credential=None, profile=None)[source]

Fetch credential from credentials file.

Parameters:
  • credential (str) – Credential to fetch.
  • profile (str) – Credentials profile. Defaults to 'default'.
Returns:

Fetched credential or None.
Return type:

str, None
init_store()[source]

Initialize credentials store.

remove_profile(profile=None)[source]

Remove profile from credentials file.

Parameters:profile (str) – Credentials profile to remove.
Returns:List of affected document IDs.
Return type:list
write_credentials(credentials=None, profile=None, cache_token=None)[source]

Write credentials.

Write credentials to credentials file. Performs upsert.

Parameters:
  • cache_token (bool) – If True, stores access_token in token store. Defaults to True.
  • credentials (class) – Read-only credentials.
  • profile (str) – Credentials profile. Defaults to 'default'.
Returns:

Affected document ID.
Return type:

int

Module contents

Adapters package.