4a43aa02b8
The positional decorator results in poorly maintainable code in a misguided effort to emulate python3's key-word-arg only notation and functionality. This patch removes keystoneclient's dependance on the positional decorator. Change-Id: I9e691cc8b0c04992f4a8dabd67e1b413d3220d23
96 lines
3.4 KiB
Python
96 lines
3.4 KiB
Python
# 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 argparse
|
|
import os
|
|
|
|
from debtcollector import removals
|
|
|
|
from keystoneclient.auth import base
|
|
|
|
|
|
@removals.remove(
|
|
message='keystoneclient auth plugins are deprecated. Use keystoneauth.',
|
|
version='2.1.0',
|
|
removal_version='3.0.0'
|
|
)
|
|
def register_argparse_arguments(parser, argv, default=None):
|
|
"""Register CLI options needed to create a plugin.
|
|
|
|
The function inspects the provided arguments so that it can also register
|
|
the options required for that specific plugin if available.
|
|
|
|
:param argparse.ArgumentParser: the parser to attach argparse options to.
|
|
:param List argv: the arguments provided to the application.
|
|
:param str/class default: a default plugin name or a plugin object to use
|
|
if one isn't specified by the CLI. default: None.
|
|
|
|
:returns: The plugin class that will be loaded or None if not provided.
|
|
:rtype: :py:class:`keystoneclient.auth.BaseAuthPlugin`
|
|
|
|
:raises keystoneclient.exceptions.NoMatchingPlugin: if a plugin cannot be
|
|
created.
|
|
"""
|
|
in_parser = argparse.ArgumentParser(add_help=False)
|
|
env_plugin = os.environ.get('OS_AUTH_PLUGIN', default)
|
|
for p in (in_parser, parser):
|
|
p.add_argument('--os-auth-plugin',
|
|
metavar='<name>',
|
|
default=env_plugin,
|
|
help='The auth plugin to load')
|
|
|
|
options, _args = in_parser.parse_known_args(argv)
|
|
|
|
if not options.os_auth_plugin:
|
|
return None
|
|
|
|
if isinstance(options.os_auth_plugin, type):
|
|
msg = 'Default Authentication options'
|
|
plugin = options.os_auth_plugin
|
|
else:
|
|
msg = 'Options specific to the %s plugin.' % options.os_auth_plugin
|
|
plugin = base.get_plugin_class(options.os_auth_plugin)
|
|
|
|
group = parser.add_argument_group('Authentication Options', msg)
|
|
plugin.register_argparse_arguments(group)
|
|
return plugin
|
|
|
|
|
|
@removals.remove(
|
|
message='keystoneclient auth plugins are deprecated. Use keystoneauth.',
|
|
version='2.1.0',
|
|
removal_version='3.0.0'
|
|
)
|
|
def load_from_argparse_arguments(namespace, **kwargs):
|
|
"""Retrieve the created plugin from the completed argparse results.
|
|
|
|
Loads and creates the auth plugin from the information parsed from the
|
|
command line by argparse.
|
|
|
|
:param Namespace namespace: The result from CLI parsing.
|
|
|
|
:returns: An auth plugin, or None if a name is not provided.
|
|
:rtype: :py:class:`keystoneclient.auth.BaseAuthPlugin`
|
|
|
|
:raises keystoneclient.exceptions.NoMatchingPlugin: if a plugin cannot be
|
|
created.
|
|
"""
|
|
if not namespace.os_auth_plugin:
|
|
return None
|
|
|
|
if isinstance(namespace.os_auth_plugin, type):
|
|
plugin = namespace.os_auth_plugin
|
|
else:
|
|
plugin = base.get_plugin_class(namespace.os_auth_plugin)
|
|
|
|
return plugin.load_from_argparse_arguments(namespace, **kwargs)
|