keystoneauth1.loading.identity module¶

class keystoneauth1.loading.identity.Any(*args, **kwargs)

Bases: object

Special type indicating an unconstrained type.

Any is assignable to every type.
Any assumed to have all methods and attributes.
All values are assignable to Any.

Note that all the above statements are true from the point of view of static type checkers. At runtime, Any cannot be used with instance checks.

__annotations_cache__ = {}

__dict__ = mappingproxy({'__module__': 'typing', '__firstlineno__': 588, '__doc__': 'Special type indicating an unconstrained type.\n\n- Any is assignable to every type.\n- Any assumed to have all methods and attributes.\n- All values are assignable to Any.\n\nNote that all the above statements are true from the point of view of\nstatic type checkers. At runtime, Any cannot be used with instance\nchecks.\n', '__new__': <staticmethod(<function Any.__new__>)>, '__static_attributes__': (), '__dict__': <attribute '__dict__' of 'Any' objects>, '__weakref__': <attribute '__weakref__' of 'Any' objects>, '__annotations_cache__': {}})

__doc__ = 'Special type indicating an unconstrained type.\n\n- Any is assignable to every type.\n- Any assumed to have all methods and attributes.\n- All values are assignable to Any.\n\nNote that all the above statements are true from the point of view of\nstatic type checkers. At runtime, Any cannot be used with instance\nchecks.\n'

__firstlineno__ = 588

__module__ = 'typing'

static __new__(cls, *args, **kwargs)

__static_attributes__ = ()

__weakref__: list of weak references to the object

class keystoneauth1.loading.identity.BaseFederationLoader

Bases: BaseV3Loader[V3FederationPluginT]

Base Option handling for federation plugins.

This class defines options and handling that should be common to the V3 identity federation API. It provides the options expected by the keystoneauth1.identity.v3.FederationBaseAuth class.

__abstractmethods__ = frozenset({})

__annotations_cache__ = {}

__doc__ = 'Base Option handling for federation plugins.\n\nThis class defines options and handling that should be common to the V3\nidentity federation API. It provides the options expected by the\n:py:class:`keystoneauth1.identity.v3.FederationBaseAuth` class.\n'

__firstlineno__ = 137

__module__ = 'keystoneauth1.loading.identity'

__orig_bases__ = (keystoneauth1.loading.identity.BaseV3Loader[~V3FederationPluginT],)

__parameters__ = (~V3FederationPluginT,)

__static_attributes__ = ()

_abc_impl = <_abc._abc_data object>

get_options() → list[Opt]

Return the list of parameters associated with the auth plugin.

This list may be used to generate CLI or config arguments.

Returns:: A list of Param objects describing available plugin parameters.

class keystoneauth1.loading.identity.BaseGenericLoader

Bases: BaseIdentityLoader[GenericPluginT]

Base Option handling for generic plugins.

This class defines options and handling that should be common to generic plugins. These plugins target the OpenStack identity service however are designed to be independent of API version. It provides the options expected by the keystoneauth1.identity.generic.base.BaseGenericPlugin class.

__abstractmethods__ = frozenset({})

__annotations_cache__ = {}

__doc__ = 'Base Option handling for generic plugins.\n\nThis class defines options and handling that should be common to generic\nplugins. These plugins target the OpenStack identity service however are\ndesigned to be independent of API version. It provides the options expected\nby the :py:class:`keystoneauth1.identity.generic.base.BaseGenericPlugin`\nclass.\n'

__firstlineno__ = 166

__module__ = 'keystoneauth1.loading.identity'

__orig_bases__ = (keystoneauth1.loading.identity.BaseIdentityLoader[~GenericPluginT],)

__parameters__ = (~GenericPluginT,)

__static_attributes__ = ()

_abc_impl = <_abc._abc_data object>

get_options() → list[Opt]

Return the list of parameters associated with the auth plugin.

This list may be used to generate CLI or config arguments.

Returns:: A list of Param objects describing available plugin parameters.

class keystoneauth1.loading.identity.BaseIdentityLoader

Bases: BaseLoader[PluginT]

Base Option handling for identity plugins.

This class defines options and handling that should be common across all plugins that are developed against the OpenStack identity service. It provides the options expected by the keystoneauth1.identity.BaseIdentityPlugin class.

__abstractmethods__ = frozenset({})

__annotations_cache__ = {}

__doc__ = 'Base Option handling for identity plugins.\n\nThis class defines options and handling that should be common across all\nplugins that are developed against the OpenStack identity service. It\nprovides the options expected by the\n:py:class:`keystoneauth1.identity.BaseIdentityPlugin` class.\n'

__firstlineno__ = 45

__module__ = 'keystoneauth1.loading.identity'

__orig_bases__ = (keystoneauth1.loading.base.BaseLoader[~PluginT],)

__parameters__ = (~PluginT,)

__static_attributes__ = ()

_abc_impl = <_abc._abc_data object>

get_options() → list[Opt]

Return the list of parameters associated with the auth plugin.

This list may be used to generate CLI or config arguments.

Returns:: A list of Param objects describing available plugin parameters.

class keystoneauth1.loading.identity.BaseV2Loader

Bases: BaseIdentityLoader[V2PluginT]

Base Option handling for identity plugins.

This class defines options and handling that should be common to the V2 identity API. It provides the options expected by the keystoneauth1.identity.v2.Auth class.

__abstractmethods__ = frozenset({})

__annotations_cache__ = {}

__doc__ = 'Base Option handling for identity plugins.\n\nThis class defines options and handling that should be common to the V2\nidentity API. It provides the options expected by the\n:py:class:`keystoneauth1.identity.v2.Auth` class.\n'

__firstlineno__ = 64

__module__ = 'keystoneauth1.loading.identity'

__orig_bases__ = (keystoneauth1.loading.identity.BaseIdentityLoader[~V2PluginT],)

__parameters__ = (~V2PluginT,)

__static_attributes__ = ()

_abc_impl = <_abc._abc_data object>

get_options() → list[Opt]

Return the list of parameters associated with the auth plugin.

This list may be used to generate CLI or config arguments.

Returns:: A list of Param objects describing available plugin parameters.

class keystoneauth1.loading.identity.BaseV3Loader

Bases: BaseIdentityLoader[V3PluginT]

Base Option handling for identity plugins.

This class defines options and handling that should be common to the V3 identity API. It provides the options expected by the keystoneauth1.identity.v3.Auth class.

__abstractmethods__ = frozenset({})

__annotations_cache__ = {}

__doc__ = 'Base Option handling for identity plugins.\n\nThis class defines options and handling that should be common to the V3\nidentity API. It provides the options expected by the\n:py:class:`keystoneauth1.identity.v3.Auth` class.\n'

__firstlineno__ = 88

__module__ = 'keystoneauth1.loading.identity'

__orig_bases__ = (keystoneauth1.loading.identity.BaseIdentityLoader[~V3PluginT],)

__parameters__ = (~V3PluginT,)

__static_attributes__ = ()

_abc_impl = <_abc._abc_data object>

get_options() → list[Opt]

Return the list of parameters associated with the auth plugin.

This list may be used to generate CLI or config arguments.

Returns:: A list of Param objects describing available plugin parameters.

load_from_options(**kwargs: Any) → V3PluginT

Create a plugin from the arguments retrieved from get_options.

A client can override this function to do argument validation or to handle differences between the registered options and what is required to create the plugin.

class keystoneauth1.loading.identity.TypeVar

Bases: object

Type variable.

The preferred way to construct a type variable is via the dedicated syntax for generic functions, classes, and type aliases:

class Sequence[T]:  # T is a TypeVar
    ...

This syntax can also be used to create bound and constrained type variables:

# S is a TypeVar bound to str
class StrSequence[S: str]:
    ...

# A is a TypeVar constrained to str or bytes
class StrOrBytesSequence[A: (str, bytes)]:
    ...

Type variables can also have defaults:

class IntDefault[T = int]:
…

However, if desired, reusable type variables can also be constructed manually, like so:

T = TypeVar('T')  # Can be anything
S = TypeVar('S', bound=str)  # Can be any subtype of str
A = TypeVar('A', str, bytes)  # Must be exactly str or bytes
D = TypeVar('D', default=int)  # Defaults to int

Type variables exist primarily for the benefit of static type checkers. They serve as the parameters for generic types as well as for generic function and type alias definitions.

The variance of type variables is inferred by type checkers when they are created through the type parameter syntax and when infer_variance=True is passed. Manually created type variables may be explicitly marked covariant or contravariant by passing covariant=True or contravariant=True. By default, manually created type variables are invariant. See PEP 484 and PEP 695 for more details.

__annotate_func__ = None

__annotations_cache__ = {}

__bound__

__constraints__

__contravariant__

__covariant__

__default__

__doc__ = "Type variable.\n\nThe preferred way to construct a type variable is via the dedicated\nsyntax for generic functions, classes, and type aliases::\n\n class Sequence[T]: # T is a TypeVar\n ...\n\nThis syntax can also be used to create bound and constrained type\nvariables::\n\n # S is a TypeVar bound to str\n class StrSequence[S: str]:\n ...\n\n # A is a TypeVar constrained to str or bytes\n class StrOrBytesSequence[A: (str, bytes)]:\n ...\n\nType variables can also have defaults:\n\n class IntDefault[T = int]:\n ...\n\nHowever, if desired, reusable type variables can also be constructed\nmanually, like so::\n\n T = TypeVar('T') # Can be anything\n S = TypeVar('S', bound=str) # Can be any subtype of str\n A = TypeVar('A', str, bytes) # Must be exactly str or bytes\n D = TypeVar('D', default=int) # Defaults to int\n\nType variables exist primarily for the benefit of static type\ncheckers. They serve as the parameters for generic types as well\nas for generic function and type alias definitions.\n\nThe variance of type variables is inferred by type checkers when they\nare created through the type parameter syntax and when\n``infer_variance=True`` is passed. Manually created type variables may\nbe explicitly marked covariant or contravariant by passing\n``covariant=True`` or ``contravariant=True``. By default, manually\ncreated type variables are invariant. See PEP 484 and PEP 695 for more\ndetails.\n"

__infer_variance__

__module__ = 'typing'

__mro_entries__(object, /)

__name__ = 'TypeVar'

classmethod __new__(*args, **kwargs)

__or__(value, /): Return self|value.

__reduce__(): Helper for pickle.

__repr__(): Return repr(self).

__ror__(value, /): Return value|self.

__typing_prepare_subst__(alias, args, /)

__typing_subst__(arg, /)

evaluate_bound

evaluate_constraints

evaluate_default

has_default()

keystoneauth1.loading.identity module

keystoneauth1.loading.identity module¶

keystoneauth1 5.18.0