root / kamaki / cli / commands / __init__.py @ 545c6c29
History | View | Annotate | Download (5.5 kB)
1 |
# Copyright 2011-2012 GRNET S.A. All rights reserved.
|
---|---|
2 |
#
|
3 |
# Redistribution and use in source and binary forms, with or
|
4 |
# without modification, are permitted provided that the following
|
5 |
# conditions are met:
|
6 |
#
|
7 |
# 1. Redistributions of source code must retain the above
|
8 |
# copyright notice, this list of conditions and the following
|
9 |
# disclaimer.
|
10 |
#
|
11 |
# 2. Redistributions in binary form must reproduce the above
|
12 |
# copyright notice, this list of conditions and the following
|
13 |
# disclaimer in the documentation and/or other materials
|
14 |
# provided with the distribution.
|
15 |
#
|
16 |
# THIS SOFTWARE IS PROVIDED BY GRNET S.A. ``AS IS'' AND ANY EXPRESS
|
17 |
# OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
|
18 |
# WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
19 |
# PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL GRNET S.A OR
|
20 |
# CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
|
21 |
# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
|
22 |
# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
|
23 |
# USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
|
24 |
# AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
|
25 |
# LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
|
26 |
# ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
|
27 |
# POSSIBILITY OF SUCH DAMAGE.
|
28 |
#
|
29 |
# The views and conclusions contained in the software and
|
30 |
# documentation are those of the authors and should not be
|
31 |
# interpreted as representing official policies, either expressed
|
32 |
# or implied, of GRNET S.A.command
|
33 |
|
34 |
from kamaki.logger import get_logger |
35 |
from kamaki.cli.utils import print_json, print_items |
36 |
from kamaki.cli.argument import FlagArgument |
37 |
|
38 |
log = get_logger(__name__) |
39 |
|
40 |
|
41 |
class _command_init(object): |
42 |
|
43 |
def __init__(self, arguments={}): |
44 |
if hasattr(self, 'arguments'): |
45 |
arguments.update(self.arguments)
|
46 |
if isinstance(self, _optional_output_cmd): |
47 |
arguments.update(self.oo_arguments)
|
48 |
if isinstance(self, _optional_json): |
49 |
arguments.update(self.oj_arguments)
|
50 |
self.arguments = dict(arguments) |
51 |
try:
|
52 |
self.config = self['config'] |
53 |
except KeyError: |
54 |
pass
|
55 |
|
56 |
def _set_log_params(self): |
57 |
try:
|
58 |
self.client.LOG_TOKEN, self.client.LOG_DATA = ( |
59 |
self['config'].get('global', 'log_token') == 'on', |
60 |
self['config'].get('global', 'log_data') == 'on') |
61 |
except Exception as e: |
62 |
log.warning('Failed to read custom log settings:'
|
63 |
'%s\n defaults for token and data logging are off' % e)
|
64 |
|
65 |
def _update_max_threads(self): |
66 |
try:
|
67 |
max_threads = int(self['config'].get('global', 'max_threads')) |
68 |
assert max_threads > 0 |
69 |
self.client.MAX_THREADS = max_threads
|
70 |
except Exception as e: |
71 |
log.warning('Failed to read custom thread settings: '
|
72 |
'%s, use default max threads (%s)' % (
|
73 |
e, self.client.MAX_THREADS))
|
74 |
|
75 |
def _safe_progress_bar(self, msg, arg='progress_bar'): |
76 |
"""Try to get a progress bar, but do not raise errors"""
|
77 |
try:
|
78 |
progress_bar = self.arguments[arg]
|
79 |
gen = progress_bar.get_generator(msg) |
80 |
except Exception: |
81 |
return (None, None) |
82 |
return (progress_bar, gen)
|
83 |
|
84 |
def _safe_progress_bar_finish(self, progress_bar): |
85 |
try:
|
86 |
progress_bar.finish() |
87 |
except Exception: |
88 |
pass
|
89 |
|
90 |
def __getitem__(self, argterm): |
91 |
"""
|
92 |
:param argterm: (str) the name/label of an argument in self.arguments
|
93 |
|
94 |
:returns: the value of the corresponding Argument (not the argument
|
95 |
object)
|
96 |
|
97 |
:raises KeyError: if argterm not in self.arguments of this object
|
98 |
"""
|
99 |
return self.arguments[argterm].value |
100 |
|
101 |
def __setitem__(self, argterm, arg): |
102 |
"""Install an argument as argterm
|
103 |
If argterm points to another argument, the other argument is lost
|
104 |
|
105 |
:param argterm: (str)
|
106 |
|
107 |
:param arg: (Argument)
|
108 |
"""
|
109 |
if not hasattr(self, 'arguments'): |
110 |
self.arguments = {}
|
111 |
self.arguments[argterm] = arg
|
112 |
|
113 |
def get_argument_object(self, argterm): |
114 |
"""
|
115 |
:param argterm: (str) the name/label of an argument in self.arguments
|
116 |
|
117 |
:returns: the arument object
|
118 |
|
119 |
:raises KeyError: if argterm not in self.arguments of this object
|
120 |
"""
|
121 |
return self.arguments[argterm] |
122 |
|
123 |
def get_argument(self, argterm): |
124 |
"""
|
125 |
:param argterm: (str) the name/label of an argument in self.arguments
|
126 |
|
127 |
:returns: the value of the arument object
|
128 |
|
129 |
:raises KeyError: if argterm not in self.arguments of this object
|
130 |
"""
|
131 |
return self[argterm] |
132 |
|
133 |
|
134 |
# feature classes - inherit them to get special features for your commands
|
135 |
|
136 |
|
137 |
class _optional_output_cmd(object): |
138 |
|
139 |
oo_arguments = dict(
|
140 |
with_output=FlagArgument('show response headers', ('--with-output')), |
141 |
json_output=FlagArgument('show headers in json', ('-j', '--json')) |
142 |
) |
143 |
|
144 |
def _optional_output(self, r): |
145 |
if self['json_output']: |
146 |
print_json(r) |
147 |
elif self['with_output']: |
148 |
print_items([r] if isinstance(r, dict) else r) |
149 |
|
150 |
|
151 |
class _optional_json(object): |
152 |
|
153 |
oj_arguments = dict(
|
154 |
json_output=FlagArgument('show headers in json', ('-j', '--json')) |
155 |
) |
156 |
|
157 |
def _print(self, output, print_method=print_items, **print_method_kwargs): |
158 |
if self['json_output']: |
159 |
print_json(output) |
160 |
else:
|
161 |
print_method(output, **print_method_kwargs) |