702 lines
27 KiB
Python
702 lines
27 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.
|
|
|
|
|
|
###
|
|
# This code is taken from python-zunclient. Goal is minimal modification.
|
|
###
|
|
|
|
"""
|
|
Command-line interface to the OpenStack Gyan API.
|
|
"""
|
|
|
|
from __future__ import print_function
|
|
import argparse
|
|
import getpass
|
|
import logging
|
|
import os
|
|
import sys
|
|
|
|
from oslo_utils import encodeutils
|
|
from oslo_utils import importutils
|
|
from oslo_utils import strutils
|
|
import six
|
|
|
|
profiler = importutils.try_import("osprofiler.profiler")
|
|
|
|
HAS_KEYRING = False
|
|
all_errors = ValueError
|
|
try:
|
|
import keyring
|
|
HAS_KEYRING = True
|
|
try:
|
|
if isinstance(keyring.get_keyring(), keyring.backend.GnomeKeyring):
|
|
import gnomekeyring
|
|
all_errors = (ValueError,
|
|
gnomekeyring.IOError,
|
|
gnomekeyring.NoKeyringDaemonError)
|
|
except Exception:
|
|
pass
|
|
except ImportError:
|
|
pass
|
|
|
|
from gyanclient import api_versions
|
|
from gyanclient import client as base_client
|
|
from gyanclient.common.apiclient import auth
|
|
from gyanclient.common import cliutils
|
|
from gyanclient import exceptions as exc
|
|
from gyanclient.i18n import _
|
|
from gyanclient.v1 import shell as shell_v1
|
|
from gyanclient import version
|
|
|
|
DEFAULT_API_VERSION = api_versions.DEFAULT_API_VERSION
|
|
DEFAULT_ENDPOINT_TYPE = 'publicURL'
|
|
DEFAULT_SERVICE_TYPE = 'ml-infra'
|
|
|
|
logger = logging.getLogger(__name__)
|
|
|
|
|
|
def positive_non_zero_float(text):
|
|
if text is None:
|
|
return None
|
|
try:
|
|
value = float(text)
|
|
except ValueError:
|
|
msg = "%s must be a float" % text
|
|
raise argparse.ArgumentTypeError(msg)
|
|
if value <= 0:
|
|
msg = "%s must be greater than 0" % text
|
|
raise argparse.ArgumentTypeError(msg)
|
|
return value
|
|
|
|
|
|
class SecretsHelper(object):
|
|
def __init__(self, args, client):
|
|
self.args = args
|
|
self.client = client
|
|
self.key = None
|
|
|
|
def _validate_string(self, text):
|
|
if text is None or len(text) == 0:
|
|
return False
|
|
return True
|
|
|
|
def _make_key(self):
|
|
if self.key is not None:
|
|
return self.key
|
|
keys = [
|
|
self.client.auth_url,
|
|
self.client.projectid,
|
|
self.client.user,
|
|
self.client.region_name,
|
|
self.client.endpoint_type,
|
|
self.client.service_type,
|
|
self.client.service_name,
|
|
self.client.volume_service_name,
|
|
]
|
|
for (index, key) in enumerate(keys):
|
|
if key is None:
|
|
keys[index] = '?'
|
|
else:
|
|
keys[index] = str(keys[index])
|
|
self.key = "/".join(keys)
|
|
return self.key
|
|
|
|
def _prompt_password(self, verify=True):
|
|
pw = None
|
|
if hasattr(sys.stdin, 'isatty') and sys.stdin.isatty():
|
|
# Check for Ctl-D
|
|
try:
|
|
while True:
|
|
pw1 = getpass.getpass('OS Password: ')
|
|
if verify:
|
|
pw2 = getpass.getpass('Please verify: ')
|
|
else:
|
|
pw2 = pw1
|
|
if pw1 == pw2 and self._validate_string(pw1):
|
|
pw = pw1
|
|
break
|
|
except EOFError:
|
|
pass
|
|
return pw
|
|
|
|
def save(self, auth_token, management_url, tenant_id):
|
|
if not HAS_KEYRING or not self.args.os_cache:
|
|
return
|
|
if (auth_token == self.auth_token and
|
|
management_url == self.management_url):
|
|
# Nothing changed....
|
|
return
|
|
if not all([management_url, auth_token, tenant_id]):
|
|
raise ValueError("Unable to save empty management url/auth token")
|
|
value = "|".join([str(auth_token),
|
|
str(management_url),
|
|
str(tenant_id)])
|
|
keyring.set_password("gyanclient_auth", self._make_key(), value)
|
|
|
|
@property
|
|
def password(self):
|
|
if self._validate_string(self.args.os_password):
|
|
return self.args.os_password
|
|
verify_pass = (
|
|
strutils.bool_from_string(cliutils.env("OS_VERIFY_PASSWORD"))
|
|
)
|
|
return self._prompt_password(verify_pass)
|
|
|
|
@property
|
|
def management_url(self):
|
|
if not HAS_KEYRING or not self.args.os_cache:
|
|
return None
|
|
management_url = None
|
|
try:
|
|
block = keyring.get_password('gyanclient_auth',
|
|
self._make_key())
|
|
if block:
|
|
_token, management_url, _tenant_id = block.split('|', 2)
|
|
except all_errors:
|
|
pass
|
|
return management_url
|
|
|
|
@property
|
|
def auth_token(self):
|
|
# Now is where it gets complicated since we
|
|
# want to look into the keyring module, if it
|
|
# exists and see if anything was provided in that
|
|
# file that we can use.
|
|
if not HAS_KEYRING or not self.args.os_cache:
|
|
return None
|
|
token = None
|
|
try:
|
|
block = keyring.get_password('gyanclient_auth',
|
|
self._make_key())
|
|
if block:
|
|
token, _management_url, _tenant_id = block.split('|', 2)
|
|
except all_errors:
|
|
pass
|
|
return token
|
|
|
|
@property
|
|
def tenant_id(self):
|
|
if not HAS_KEYRING or not self.args.os_cache:
|
|
return None
|
|
tenant_id = None
|
|
try:
|
|
block = keyring.get_password('gyanclient_auth',
|
|
self._make_key())
|
|
if block:
|
|
_token, _management_url, tenant_id = block.split('|', 2)
|
|
except all_errors:
|
|
pass
|
|
return tenant_id
|
|
|
|
|
|
class GyanClientArgumentParser(argparse.ArgumentParser):
|
|
|
|
def __init__(self, *args, **kwargs):
|
|
super(GyanClientArgumentParser, self).__init__(*args, **kwargs)
|
|
|
|
def error(self, message):
|
|
"""error(message: string)
|
|
|
|
Prints a usage message incorporating the message to stderr and
|
|
exits.
|
|
"""
|
|
self.print_usage(sys.stderr)
|
|
# FIXME(lzyeval): if changes occur in argparse.ArgParser._check_value
|
|
choose_from = ' (choose from'
|
|
progparts = self.prog.partition(' ')
|
|
self.exit(2, "error: %(errmsg)s\nTry '%(mainp)s help %(subp)s'"
|
|
" for more information.\n" %
|
|
{'errmsg': message.split(choose_from)[0],
|
|
'mainp': progparts[0],
|
|
'subp': progparts[2]})
|
|
|
|
|
|
class OpenStackGyanShell(object):
|
|
|
|
def get_base_parser(self):
|
|
parser = GyanClientArgumentParser(
|
|
prog='gyan',
|
|
description=__doc__.strip(),
|
|
epilog='See "gyan help COMMAND" '
|
|
'for help on a specific command.',
|
|
add_help=False,
|
|
formatter_class=OpenStackHelpFormatter,
|
|
)
|
|
|
|
# Global arguments
|
|
parser.add_argument('-h', '--help',
|
|
action='store_true',
|
|
help=argparse.SUPPRESS)
|
|
|
|
parser.add_argument('--version',
|
|
action='version',
|
|
version=version.version_info.version_string())
|
|
|
|
parser.add_argument('--debug',
|
|
default=False,
|
|
action='store_true',
|
|
help="Print debugging output.")
|
|
|
|
parser.add_argument('--os-cache',
|
|
default=strutils.bool_from_string(
|
|
cliutils.env('OS_CACHE', default=False)),
|
|
action='store_true',
|
|
help="Use the auth token cache. Defaults to False "
|
|
"if env[OS_CACHE] is not set.")
|
|
|
|
parser.add_argument('--os-region-name',
|
|
metavar='<region-name>',
|
|
default=os.environ.get('OS_REGION_NAME'),
|
|
help='Region name. Default=env[OS_REGION_NAME].')
|
|
|
|
|
|
# TODO(mattf) - add get_timings support to Client
|
|
# parser.add_argument('--timings',
|
|
# default=False,
|
|
# action='store_true',
|
|
# help="Print call timing info")
|
|
|
|
# TODO(mattf) - use timeout
|
|
# parser.add_argument('--timeout',
|
|
# default=600,
|
|
# metavar='<seconds>',
|
|
# type=positive_non_zero_float,
|
|
# help="Set HTTP call timeout (in seconds)")
|
|
|
|
parser.add_argument('--os-project-id',
|
|
metavar='<auth-project-id>',
|
|
default=cliutils.env('OS_PROJECT_ID',
|
|
default=None),
|
|
help='Defaults to env[OS_PROJECT_ID].')
|
|
|
|
parser.add_argument('--os-project-name',
|
|
metavar='<auth-project-name>',
|
|
default=cliutils.env('OS_PROJECT_NAME',
|
|
default=None),
|
|
help='Defaults to env[OS_PROJECT_NAME].')
|
|
|
|
parser.add_argument('--os-user-domain-id',
|
|
metavar='<auth-user-domain-id>',
|
|
default=cliutils.env('OS_USER_DOMAIN_ID'),
|
|
help='Defaults to env[OS_USER_DOMAIN_ID].')
|
|
|
|
parser.add_argument('--os-user-domain-name',
|
|
metavar='<auth-user-domain-name>',
|
|
default=cliutils.env('OS_USER_DOMAIN_NAME'),
|
|
help='Defaults to env[OS_USER_DOMAIN_NAME].')
|
|
|
|
parser.add_argument('--os-project-domain-id',
|
|
metavar='<auth-project-domain-id>',
|
|
default=cliutils.env('OS_PROJECT_DOMAIN_ID'),
|
|
help='Defaults to env[OS_PROJECT_DOMAIN_ID].')
|
|
|
|
parser.add_argument('--os-project-domain-name',
|
|
metavar='<auth-project-domain-name>',
|
|
default=cliutils.env('OS_PROJECT_DOMAIN_NAME'),
|
|
help='Defaults to env[OS_PROJECT_DOMAIN_NAME].')
|
|
|
|
parser.add_argument('--service-type',
|
|
metavar='<service-type>',
|
|
help='Defaults to container for all '
|
|
'actions.')
|
|
parser.add_argument('--service_type',
|
|
help=argparse.SUPPRESS)
|
|
|
|
parser.add_argument('--endpoint-type',
|
|
metavar='<endpoint-type>',
|
|
default=cliutils.env(
|
|
'OS_ENDPOINT_TYPE',
|
|
default=DEFAULT_ENDPOINT_TYPE),
|
|
help='Defaults to env[OS_ENDPOINT_TYPE] or '
|
|
+ DEFAULT_ENDPOINT_TYPE + '.')
|
|
|
|
parser.add_argument('--gyan-api-version',
|
|
metavar='<gyan-api-ver>',
|
|
default=cliutils.env(
|
|
'GYAN_API_VERSION',
|
|
default=DEFAULT_API_VERSION),
|
|
help='Accepts X, X.Y (where X is major, Y is minor'
|
|
' part), defaults to env[GYAN_API_VERSION].')
|
|
parser.add_argument('--gyan_api_version',
|
|
help=argparse.SUPPRESS)
|
|
|
|
parser.add_argument('--os-cacert',
|
|
metavar='<ca-certificate>',
|
|
default=cliutils.env('OS_CACERT', default=None),
|
|
help='Specify a CA bundle file to use in '
|
|
'verifying a TLS (https) server certificate. '
|
|
'Defaults to env[OS_CACERT].')
|
|
|
|
parser.add_argument('--bypass-url',
|
|
metavar='<bypass-url>',
|
|
default=cliutils.env('BYPASS_URL', default=None),
|
|
dest='bypass_url',
|
|
help="Use this API endpoint instead of the "
|
|
"Service Catalog.")
|
|
parser.add_argument('--bypass_url',
|
|
help=argparse.SUPPRESS)
|
|
|
|
parser.add_argument('--insecure',
|
|
default=cliutils.env('GYANCLIENT_INSECURE',
|
|
default=False),
|
|
action='store_true',
|
|
help="Do not verify https connections")
|
|
|
|
if profiler:
|
|
parser.add_argument('--profile',
|
|
metavar='HMAC_KEY',
|
|
default=cliutils.env('OS_PROFILE',
|
|
default=None),
|
|
help='HMAC key to use for encrypting context '
|
|
'data for performance profiling of '
|
|
'operation. This key should be the '
|
|
'value of the HMAC key configured for '
|
|
'the OSprofiler middleware in gyan; it '
|
|
'is specified in the Gyan configuration '
|
|
'file at "/etc/gyan/gyan.conf". Without '
|
|
'the key, profiling functions will not '
|
|
'be triggered even if OSprofiler is '
|
|
'enabled on the server side.')
|
|
|
|
# The auth-system-plugins might require some extra options
|
|
auth.load_auth_system_opts(parser)
|
|
|
|
return parser
|
|
|
|
def get_subcommand_parser(self, version, do_help=False):
|
|
parser = self.get_base_parser()
|
|
|
|
self.subcommands = {}
|
|
subparsers = parser.add_subparsers(metavar='<subcommand>')
|
|
|
|
actions_modules = shell_v1.COMMAND_MODULES
|
|
|
|
for action_modules in actions_modules:
|
|
self._find_actions(subparsers, action_modules, version, do_help)
|
|
self._find_actions(subparsers, self, version, do_help)
|
|
|
|
self._add_bash_completion_subparser(subparsers)
|
|
|
|
return parser
|
|
|
|
def _add_bash_completion_subparser(self, subparsers):
|
|
subparser = (
|
|
subparsers.add_parser('bash_completion',
|
|
add_help=False,
|
|
formatter_class=OpenStackHelpFormatter)
|
|
)
|
|
self.subcommands['bash_completion'] = subparser
|
|
subparser.set_defaults(func=self.do_bash_completion)
|
|
|
|
def _find_actions(self, subparsers, actions_module, version, do_help):
|
|
msg = _(" (Supported by API versions '%(start)s' - '%(end)s')")
|
|
for attr in (a for a in dir(actions_module) if a.startswith('do_')):
|
|
# I prefer to be hyphen-separated instead of underscores.
|
|
command = attr[3:].replace('_', '-')
|
|
callback = getattr(actions_module, attr)
|
|
desc = callback.__doc__ or ''
|
|
if hasattr(callback, "versioned"):
|
|
subs = api_versions.get_substitutions(callback)
|
|
if do_help:
|
|
desc += msg % {'start': subs[0].start_version.get_string(),
|
|
'end': subs[-1].end_version.get_string()}
|
|
else:
|
|
for versioned_method in subs:
|
|
if version.matches(versioned_method.start_version,
|
|
versioned_method.end_version):
|
|
callback = versioned_method.func
|
|
break
|
|
else:
|
|
continue
|
|
|
|
action_help = desc.strip()
|
|
exclusive_args = getattr(callback, 'exclusive_args', {})
|
|
arguments = getattr(callback, 'arguments', [])
|
|
|
|
subparser = (
|
|
subparsers.add_parser(command,
|
|
help=action_help,
|
|
description=desc,
|
|
add_help=False,
|
|
formatter_class=OpenStackHelpFormatter)
|
|
)
|
|
subparser.add_argument('-h', '--help',
|
|
action='help',
|
|
help=argparse.SUPPRESS,)
|
|
self.subcommands[command] = subparser
|
|
|
|
self._add_subparser_args(subparser, arguments, version, do_help,
|
|
msg)
|
|
self._add_subparser_exclusive_args(subparser, exclusive_args,
|
|
version, do_help, msg)
|
|
subparser.set_defaults(func=callback)
|
|
|
|
def _add_subparser_exclusive_args(self, subparser, exclusive_args,
|
|
version, do_help, msg):
|
|
for group_name, arguments in exclusive_args.items():
|
|
if group_name == '__required__':
|
|
continue
|
|
required = exclusive_args['__required__'][group_name]
|
|
exclusive_group = subparser.add_mutually_exclusive_group(
|
|
required=required)
|
|
self._add_subparser_args(exclusive_group, arguments,
|
|
version, do_help, msg)
|
|
|
|
def _add_subparser_args(self, subparser, arguments, version, do_help, msg):
|
|
for (args, kwargs) in arguments:
|
|
start_version = kwargs.get("start_version", None)
|
|
if start_version:
|
|
start_version = api_versions.APIVersion(start_version)
|
|
end_version = kwargs.get("end_version", None)
|
|
if end_version:
|
|
end_version = api_versions.APIVersion(end_version)
|
|
else:
|
|
end_version = api_versions.APIVersion(
|
|
"%s.latest" % start_version.ver_major)
|
|
if do_help:
|
|
kwargs["help"] = kwargs.get("help", "") + (msg % {
|
|
"start": start_version.get_string(),
|
|
"end": end_version.get_string()})
|
|
else:
|
|
if not version.matches(start_version, end_version):
|
|
continue
|
|
kw = kwargs.copy()
|
|
kw.pop("start_version", None)
|
|
kw.pop("end_version", None)
|
|
subparser.add_argument(*args, **kwargs)
|
|
|
|
def setup_debugging(self, debug):
|
|
if debug:
|
|
streamformat = "%(levelname)s (%(module)s:%(lineno)d) %(message)s"
|
|
# Set up the root logger to debug so that the submodules can
|
|
# print debug messages
|
|
logging.basicConfig(level=logging.DEBUG,
|
|
format=streamformat)
|
|
else:
|
|
streamformat = "%(levelname)s %(message)s"
|
|
logging.basicConfig(level=logging.CRITICAL,
|
|
format=streamformat)
|
|
|
|
def main(self, argv):
|
|
|
|
argv = list(argv)
|
|
|
|
# Parse args once to find version and debug settings
|
|
parser = self.get_base_parser()
|
|
(options, args) = parser.parse_known_args(argv)
|
|
self.setup_debugging(options.debug)
|
|
|
|
api_version = api_versions.get_api_version(options.gyan_api_version)
|
|
|
|
if '--endpoint_type' in argv:
|
|
spot = argv.index('--endpoint_type')
|
|
argv[spot] = '--endpoint-type'
|
|
|
|
subcommand_parser = self.get_subcommand_parser(
|
|
api_version, do_help=("help" in args))
|
|
|
|
self.parser = subcommand_parser
|
|
|
|
if options.help or not argv:
|
|
subcommand_parser.print_help()
|
|
return 0
|
|
|
|
args = subcommand_parser.parse_args(argv)
|
|
|
|
# Short-circuit and deal with help right away.
|
|
if not hasattr(args, 'func') or args.func == self.do_help:
|
|
self.do_help(args)
|
|
return 0
|
|
elif args.func == self.do_bash_completion:
|
|
self.do_bash_completion(args)
|
|
return 0
|
|
|
|
(os_username, os_project_name, os_project_id,
|
|
os_user_domain_id, os_user_domain_name,
|
|
os_project_domain_id, os_project_domain_name,
|
|
os_auth_url, os_auth_system, endpoint_type,
|
|
service_type, bypass_url, insecure, os_cacert) = (
|
|
(args.os_username, args.os_project_name, args.os_project_id,
|
|
args.os_user_domain_id, args.os_user_domain_name,
|
|
args.os_project_domain_id, args.os_project_domain_name,
|
|
args.os_auth_url, args.os_auth_system, args.endpoint_type,
|
|
args.service_type, args.bypass_url, args.insecure,
|
|
args.os_cacert)
|
|
)
|
|
|
|
if os_auth_system and os_auth_system != "keystone":
|
|
auth_plugin = auth.load_plugin(os_auth_system)
|
|
else:
|
|
auth_plugin = None
|
|
|
|
# Fetched and set later as needed
|
|
os_password = None
|
|
|
|
if not endpoint_type:
|
|
endpoint_type = DEFAULT_ENDPOINT_TYPE
|
|
|
|
if not service_type:
|
|
service_type = DEFAULT_SERVICE_TYPE
|
|
|
|
# NA - there is only one service this CLI accesses
|
|
# service_type = utils.get_service_type(args.func) or service_type
|
|
|
|
# FIXME(usrleon): Here should be restrict for project id same as
|
|
# for os_username or os_password but for compatibility it is not.
|
|
if not cliutils.isunauthenticated(args.func):
|
|
if auth_plugin:
|
|
auth_plugin.parse_opts(args)
|
|
|
|
if not auth_plugin or not auth_plugin.opts:
|
|
if not os_username:
|
|
raise exc.CommandError("You must provide a username "
|
|
"via either --os-username or "
|
|
"env[OS_USERNAME]")
|
|
|
|
if not os_project_name and not os_project_id:
|
|
raise exc.CommandError("You must provide a project name "
|
|
"or project id via --os-project-name, "
|
|
"--os-project-id, env[OS_PROJECT_NAME] "
|
|
"or env[OS_PROJECT_ID]")
|
|
|
|
if not os_auth_url:
|
|
if os_auth_system and os_auth_system != 'keystone':
|
|
os_auth_url = auth_plugin.get_auth_url()
|
|
|
|
if not os_auth_url:
|
|
raise exc.CommandError("You must provide an auth url "
|
|
"via either --os-auth-url or "
|
|
"env[OS_AUTH_URL] or specify an "
|
|
"auth_system which defines a "
|
|
"default url with --os-auth-system "
|
|
"or env[OS_AUTH_SYSTEM]")
|
|
|
|
# Now check for the password/token of which pieces of the
|
|
# identifying keyring key can come from the underlying client
|
|
if not cliutils.isunauthenticated(args.func):
|
|
# NA - Client can't be used with SecretsHelper
|
|
if (auth_plugin and auth_plugin.opts and
|
|
"os_password" not in auth_plugin.opts):
|
|
use_pw = False
|
|
else:
|
|
use_pw = True
|
|
|
|
if use_pw:
|
|
# Auth using token must have failed or not happened
|
|
# at all, so now switch to password mode and save
|
|
# the token when its gotten... using our keyring
|
|
# saver
|
|
os_password = args.os_password
|
|
if not os_password:
|
|
raise exc.CommandError(
|
|
'Expecting a password provided via either '
|
|
'--os-password, env[OS_PASSWORD], or '
|
|
'prompted response')
|
|
|
|
client = base_client
|
|
|
|
kwargs = {}
|
|
if profiler:
|
|
kwargs["profile"] = args.profile
|
|
|
|
self.cs = client.Client(version=api_version,
|
|
username=os_username,
|
|
password=os_password,
|
|
project_id=os_project_id,
|
|
project_name=os_project_name,
|
|
user_domain_id=os_user_domain_id,
|
|
user_domain_name=os_user_domain_name,
|
|
project_domain_id=os_project_domain_id,
|
|
project_domain_name=os_project_domain_name,
|
|
auth_url=os_auth_url,
|
|
service_type=service_type,
|
|
region_name=args.os_region_name,
|
|
endpoint_override=bypass_url,
|
|
interface=endpoint_type,
|
|
insecure=insecure,
|
|
cacert=os_cacert,
|
|
**kwargs)
|
|
|
|
args.func(self.cs, args)
|
|
|
|
if profiler and args.profile:
|
|
trace_id = profiler.get().get_base_id()
|
|
print("To display trace use the command:\n\n"
|
|
" osprofiler trace show --html %s " % trace_id)
|
|
|
|
def _dump_timings(self, timings):
|
|
class Tyme(object):
|
|
def __init__(self, url, seconds):
|
|
self.url = url
|
|
self.seconds = seconds
|
|
results = [Tyme(url, end - start) for url, start, end in timings]
|
|
total = 0.0
|
|
for tyme in results:
|
|
total += tyme.seconds
|
|
results.append(Tyme("Total", total))
|
|
cliutils.print_list(results, ["url", "seconds"], sortby_index=None)
|
|
|
|
def do_bash_completion(self, _args):
|
|
"""Prints arguments for bash-completion.
|
|
|
|
Prints all of the commands and options to stdout so that the
|
|
gyan.bash_completion script doesn't have to hard code them.
|
|
"""
|
|
commands = set()
|
|
options = set()
|
|
for sc_str, sc in self.subcommands.items():
|
|
commands.add(sc_str)
|
|
for option in sc._optionals._option_string_actions.keys():
|
|
options.add(option)
|
|
|
|
commands.remove('bash-completion')
|
|
commands.remove('bash_completion')
|
|
print(' '.join(commands | options))
|
|
|
|
@cliutils.arg('command', metavar='<subcommand>', nargs='?',
|
|
help='Display help for <subcommand>.')
|
|
def do_help(self, args):
|
|
"""Display help about this program or one of its subcommands."""
|
|
command = getattr(args, 'command', '')
|
|
if command:
|
|
if args.command in self.subcommands:
|
|
self.subcommands[args.command].print_help()
|
|
else:
|
|
raise exc.CommandError("'%s' is not a valid subcommand" %
|
|
args.command)
|
|
else:
|
|
self.parser.print_help()
|
|
|
|
|
|
# I'm picky about my shell help.
|
|
class OpenStackHelpFormatter(argparse.HelpFormatter):
|
|
def start_section(self, heading):
|
|
# Title-case the headings
|
|
heading = '%s%s' % (heading[0].upper(), heading[1:])
|
|
super(OpenStackHelpFormatter, self).start_section(heading)
|
|
|
|
|
|
def main():
|
|
try:
|
|
return OpenStackGyanShell().main(
|
|
map(encodeutils.safe_decode, sys.argv[1:]))
|
|
except Exception as e:
|
|
logger.debug(e, exc_info=1)
|
|
print("ERROR: %s" % encodeutils.safe_encode(six.text_type(e)),
|
|
file=sys.stderr)
|
|
sys.exit(1)
|
|
|
|
|
|
if __name__ == "__main__":
|
|
sys.exit(main())
|