Files
python-keystoneclient/keystoneclient/utils.py
jakedahn 2a1c94a753 Improve usability of CLI.
* Fixes bug #936422
  * Fixes bug #932223
  * Depends on bcwaldon's review: https://review.openstack.org/#change,4305
  * This review proposes making changes outlined in this spreadsheet:
    https://docs.google.com/spreadsheet/ccc?key=0Ak6TA47h_6fwdGZwRE5WWEJBdEhnckpMTG5RcWFjY3c#gid=0
    This cleans up the CLI, normalizing commands and arguments, correcting
    optional and required arguments and flags.
  * included https://review.openstack.org/4270 here per Brian's request

  Note that some commands have changed names to conform to noun-verb form:
  user-update-password  ->  user-password-update
  add-user-role  ->  user-role-add
  remove-user-role  ->  user-role-remove
  ec2-create-credentials  ->  ec2-credentials-create
  ec2-list-credentials  ->  ec2-credentials-list
  ec2-delete-credentials  ->  ec2-credentials-delete
  token  ->  token-get

Change-Id: I8128fa105a1b8002199211f9e475b1a7a6229b8c
2012-02-23 16:28:38 -06:00

95 lines
2.5 KiB
Python

import uuid
import prettytable
from keystoneclient import exceptions
# Decorator for cli-args
def arg(*args, **kwargs):
def _decorator(func):
# Because of the sematics of decorator composition if we just append
# to the options list positional options will appear to be backwards.
func.__dict__.setdefault('arguments', []).insert(0, (args, kwargs))
return func
return _decorator
def pretty_choice_list(l):
return ', '.join("'%s'" % i for i in l)
def print_list(objs, fields, formatters={}):
pt = prettytable.PrettyTable([f for f in fields], caching=False)
pt.aligns = ['l' for f in fields]
for o in objs:
row = []
for field in fields:
if field in formatters:
row.append(formatters[field](o))
else:
field_name = field.lower().replace(' ', '_')
data = getattr(o, field_name, '')
row.append(data)
pt.add_row(row)
pt.printt(sortby=fields[0])
def print_dict(d):
pt = prettytable.PrettyTable(['Property', 'Value'], caching=False)
pt.aligns = ['l', 'l']
[pt.add_row(list(r)) for r in d.iteritems()]
pt.printt(sortby='Property')
def find_resource(manager, name_or_id):
"""Helper for the _find_* methods."""
# first try to get entity as integer id
try:
if isinstance(name_or_id, int) or name_or_id.isdigit():
return manager.get(int(name_or_id))
except exceptions.NotFound:
pass
# now try to get entity as uuid
try:
uuid.UUID(str(name_or_id))
return manager.get(name_or_id)
except (ValueError, exceptions.NotFound):
pass
# finally try to find entity by name
try:
return manager.find(name=name_or_id)
except exceptions.NotFound:
msg = "No %s with a name or ID of '%s' exists." % \
(manager.resource_class.__name__.lower(), name_or_id)
raise exceptions.CommandError(msg)
def unauthenticated(f):
""" Adds 'unauthenticated' attribute to decorated function.
Usage:
@unauthenticated
def mymethod(f):
...
"""
f.unauthenticated = True
return f
def isunauthenticated(f):
"""
Checks to see if the function is marked as not requiring authentication
with the @unauthenticated decorator. Returns True if decorator is
set to True, False otherwise.
"""
return getattr(f, 'unauthenticated', False)
def string_to_bool(arg):
return arg.strip().lower() in ('t', 'true', 'yes', '1')