keystoneauth1.identity.v3.receipt module

class keystoneauth1.identity.v3.receipt.Mapping

Bases: Collection

A Mapping is a generic container for associating key/value pairs.

This class provides concrete generic implementations of all methods except for __getitem__, __iter__, and __len__.

__abstractmethods__ = frozenset({'__getitem__', '__iter__', '__len__'})

__annotations_cache__ = {}

__contains__(key)

__doc__ = 'A Mapping is a generic container for associating key/value\npairs.\n\nThis class provides concrete generic implementations of all\nmethods except for __getitem__, __iter__, and __len__.\n'

__eq__(other)

Return self==value.

__firstlineno__ = 775

abstractmethod __getitem__(key)

__hash__ = None

__module__ = 'collections.abc'

__reversed__ = None

__slots__ = ()

__static_attributes__ = ()

_abc_impl = <_abc._abc_data object>

get(k[, d]) → D[k] if k in D, else d.  d defaults to None.

items() → a set-like object providing a view on D's items

keys() → a set-like object providing a view on D's keys

values() → an object providing a view on D's values

class keystoneauth1.identity.v3.receipt.ReceiptMethod(*, receipt: str)

Bases: AuthMethod

Construct an Auth plugin to continue authentication with a receipt.

Parameters:

receipt – Receipt for authentication.

__abstractmethods__ = frozenset({})

__annotations_cache__ = {'_method_parameters': 'list[str] | None', 'receipt': <class 'str'>}

__doc__ = 'Construct an Auth plugin to continue authentication with a receipt.\n\n:param receipt: Receipt for authentication.\n'

__firstlineno__ = 22

__init__(*, receipt: str) → None

__module__ = 'keystoneauth1.identity.v3.receipt'

__static_attributes__ = ('receipt',)

_abc_impl = <_abc._abc_data object>

get_auth_data(session: Session, auth: Auth, headers: dict[str, str], request_kwargs: dict[str, object]) → tuple[None, None] | tuple[str, Mapping[str, object]]

Add the auth receipt to the headers.

We explicitly return None to avoid being added to the request methods, or body.

get_cache_id_elements() → dict[str, str | None]

Get the elements for this auth method that make it unique.

These elements will be used as part of the keystoneauth1.plugin.BaseIdentityPlugin.get_cache_id() to allow caching of the auth plugin.

Plugins should override this if they want to allow caching of their state.

To avoid collision or overrides the keys of the returned dictionary should be prefixed with the plugin identifier. For example the password plugin returns its username value as ‘password_username’.

receipt: str