fiftyone.internal.secrets

• fiftyone.internal.secrets.providers
  • fiftyone.internal.secrets.providers.iprovider
  • fiftyone.internal.secrets.providers.local
  • Module contents

• fiftyone.internal.secrets.secret

Module contents

FiftyOne secrets.

Copyright 2017-2024, Voxel51, Inc.

voxel51.com

Classes:

ISecretProvider()
EnvSecretProvider()	Exposes secrets from environment variables.
ISecret()	Secret interface.
AbstractSecret(key, value)	Abstract secret.
UnencryptedSecret(key, value)	Fiftyone secret with plaintext value.

class fiftyone.internal.secrets.ISecretProvider

Bases: abc.ABC

Methods:

get(key, **kwargs)	Get a secret by key.
get_sync(key, **kwargs)	Get a secret by key in a synchronous context.
get_multiple(keys, **kwargs)	Get multiple secrets by key.
search(regex, **kwargs)	Get secrets with keys matching regex

abstract async get(key: str, **kwargs) → Optional[fiftyone.internal.secrets.secret.ISecret]

Get a secret by key.

abstract get_sync(key: str, **kwargs) → Optional[fiftyone.internal.secrets.secret.ISecret]

Get a secret by key in a synchronous context.

abstract async get_multiple(keys: List[str], **kwargs) → Dict[str, Optional[fiftyone.internal.secrets.secret.ISecret]]

Get multiple secrets by key.

abstract async search(regex: str, **kwargs) → Dict[str, Optional[fiftyone.internal.secrets.secret.ISecret]]

Get secrets with keys matching regex

class fiftyone.internal.secrets.EnvSecretProvider

Bases: fiftyone.internal.secrets.providers.iprovider.ISecretProvider

Exposes secrets from environment variables.

Methods:

get(key, **kwargs)	Get a secret by key.
get_sync(key, **kwargs)	Get a secret by key in a synchronous context.
get_multiple(keys, **kwargs)	Get multiple secrets by key.
search(regex, **kwargs)	Get secrets with keys matching regex

async get(key, **kwargs) → Optional[fiftyone.internal.secrets.secret.ISecret]

Get a secret by key.

get_sync(key, **kwargs) → Optional[fiftyone.internal.secrets.secret.ISecret]

Get a secret by key in a synchronous context.

async get_multiple(keys: List[str], **kwargs) → Dict[str, Optional[fiftyone.internal.secrets.secret.ISecret]]

Get multiple secrets by key.

async search(regex: str, **kwargs) → Dict[str, Optional[fiftyone.internal.secrets.secret.ISecret]]

Get secrets with keys matching regex

class fiftyone.internal.secrets.ISecret

Bases: abc.ABC

Secret interface.

Attributes:

key	The secret’s string identifier.
value	The secret’s value.

abstract property key

The secret’s string identifier.

abstract property value

The secret’s value.

class fiftyone.internal.secrets.AbstractSecret(key: str, value: str)

Bases: fiftyone.internal.secrets.secret.ISecret, abc.ABC

Abstract secret.

Attributes:

key	The secret’s string identifier.
value	The secret’s value.
is_encrypted	Whether the secret is encrypted.

abstract property key

The secret’s string identifier.

abstract property value

The secret’s value.

abstract property is_encrypted

Whether the secret is encrypted.

class fiftyone.internal.secrets.UnencryptedSecret(key: str, value: str)

Bases: fiftyone.internal.secrets.secret.AbstractSecret

Fiftyone secret with plaintext value.

Attributes:

key	The secret’s string identifier.
value	The secret’s value.
is_encrypted	Whether the secret is encrypted.

property key

The secret’s string identifier.

property value

The secret’s value.

property is_encrypted

Whether the secret is encrypted.