FM / loading

/usr/lib/python2.6/site-packages/keystoneauth1/loading/

/usr/lib/python2.6/site-packages/keystoneauth1/loading

Name	Size	Mode	Actions
_plugins/	-	0755	rm
base.py	3953	0644	edit dl rm
base.pyc	4607	0644	edit dl rm
cli.py	3990	0644	edit dl rm
cli.pyc	3690	0644	edit dl rm
conf.py	4777	0644	edit dl rm
conf.pyc	4186	0644	edit dl rm
identity.py	6148	0644	edit dl rm
identity.pyc	6628	0644	edit dl rm
opts.py	3308	0644	edit dl rm
opts.pyc	3380	0644	edit dl rm
session.py	10154	0644	edit dl rm
session.pyc	9460	0644	edit dl rm
__init__.py	2132	0644	edit dl rm
__init__.pyc	1382	0644	edit dl rm

Edit: /usr/lib/python2.6/site-packages/keystoneauth1/loading/base.py (3953B)

import abc

import six
import stevedore

from keystoneauth1 import exceptions

PLUGIN_NAMESPACE = 'keystoneauth1.plugin'

__all__ = ['get_available_plugin_names',
           'get_available_plugin_loaders',
           'get_plugin_loader',
           'get_plugin_options',
           'BaseLoader',
           'PLUGIN_NAMESPACE']

def get_available_plugin_names():
    """Get the names of all the plugins that are available on the system.

This is particularly useful for help and error text to prompt a user for
    example what plugins they may specify.

:returns: A list of names.
    :rtype: frozenset
    """
    mgr = stevedore.ExtensionManager(namespace=PLUGIN_NAMESPACE)
    return frozenset(mgr.names())

def get_available_plugin_loaders():
    """Retrieve all the plugin classes available on the system.

:returns: A dict with plugin entrypoint name as the key and the plugin
              loader as the value.
    :rtype: dict
    """
    mgr = stevedore.ExtensionManager(namespace=PLUGIN_NAMESPACE,
                                     invoke_on_load=True,
                                     propagate_map_exceptions=True)

return dict(mgr.map(lambda ext: (ext.entry_point.name, ext.obj)))

def get_plugin_loader(name):
    """Retrieve a plugin class by its entrypoint name.

:param str name: The name of the object to get.

:returns: An auth plugin class.
    :rtype: :py:class:`keystoneauth1.loading.BaseLoader`

:raises keystonauth.exceptions.NoMatchingPlugin: if a plugin cannot be
                                                        created.
    """
    try:
        mgr = stevedore.DriverManager(namespace=PLUGIN_NAMESPACE,
                                      invoke_on_load=True,
                                      name=name)
    except RuntimeError:
        raise exceptions.NoMatchingPlugin(name)

return mgr.driver

def get_plugin_options(name):
    """Get the options for a specific plugin.

This will be the list of options that is registered and loaded by the
    specified plugin.

:returns: A list of :py:class:`keystoneauth1.loading.Opt` options.

:raises keystonauth.exceptions.NoMatchingPlugin: if a plugin cannot be
                                                     created.
    """
    return get_plugin_loader(name).get_options()

@six.add_metaclass(abc.ABCMeta)
class BaseLoader(object):

@abc.abstractproperty
    def plugin_class(self):
        raise NotImplemented()

@abc.abstractmethod
    def get_options(self):
        """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.
        :rtype: list
        """
        return []

def load_from_options(self, **kwargs):
        """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.
        """
        missing_required = [o for o in self.get_options()
                            if o.required and kwargs.get(o.dest) is None]

if missing_required:
            raise exceptions.MissingRequiredOptions(missing_required)

return self.plugin_class(**kwargs)

# Licensed under the Apache License, Version 2.0 (the "License"); you may # not use this file except in compliance with the License. You may obtain # a copy of the License at # # http://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law or agreed to in writing, software # distributed under the License is distributed on an "AS IS" BASIS, WITHOUT # WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the # License for the specific language governing permissions and limitations # under the License. import abc import six import stevedore from keystoneauth1 import exceptions PLUGIN_NAMESPACE = 'keystoneauth1.plugin' __all__ = ['get_available_plugin_names', 'get_available_plugin_loaders', 'get_plugin_loader', 'get_plugin_options', 'BaseLoader', 'PLUGIN_NAMESPACE'] def get_available_plugin_names(): """Get the names of all the plugins that are available on the system. This is particularly useful for help and error text to prompt a user for example what plugins they may specify. :returns: A list of names. :rtype: frozenset """ mgr = stevedore.ExtensionManager(namespace=PLUGIN_NAMESPACE) return frozenset(mgr.names()) def get_available_plugin_loaders(): """Retrieve all the plugin classes available on the system. :returns: A dict with plugin entrypoint name as the key and the plugin loader as the value. :rtype: dict """ mgr = stevedore.ExtensionManager(namespace=PLUGIN_NAMESPACE, invoke_on_load=True, propagate_map_exceptions=True) return dict(mgr.map(lambda ext: (ext.entry_point.name, ext.obj))) def get_plugin_loader(name): """Retrieve a plugin class by its entrypoint name. :param str name: The name of the object to get. :returns: An auth plugin class. :rtype: :py:class:`keystoneauth1.loading.BaseLoader` :raises keystonauth.exceptions.NoMatchingPlugin: if a plugin cannot be created. """ try: mgr = stevedore.DriverManager(namespace=PLUGIN_NAMESPACE, invoke_on_load=True, name=name) except RuntimeError: raise exceptions.NoMatchingPlugin(name) return mgr.driver def get_plugin_options(name): """Get the options for a specific plugin. This will be the list of options that is registered and loaded by the specified plugin. :returns: A list of :py:class:`keystoneauth1.loading.Opt` options. :raises keystonauth.exceptions.NoMatchingPlugin: if a plugin cannot be created. """ return get_plugin_loader(name).get_options() @six.add_metaclass(abc.ABCMeta) class BaseLoader(object): @abc.abstractproperty def plugin_class(self): raise NotImplemented() @abc.abstractmethod def get_options(self): """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. :rtype: list """ return [] def load_from_options(self, **kwargs): """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. """ missing_required = [o for o in self.get_options() if o.required and kwargs.get(o.dest) is None] if missing_required: raise exceptions.MissingRequiredOptions(missing_required) return self.plugin_class(**kwargs)