1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
|
# Copyright (C) 2013-2014 Red Hat, Inc. All rights reserved.
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
# 1. Redistributions of source code must retain the above copyright notice,
# this list of conditions and the following disclaimer.
# 2. Redistributions in binary form must reproduce the above copyright notice,
# this list of conditions and the following disclaimer in the documentation
# and/or other materials provided with the distribution.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
# POSSIBILITY OF SUCH DAMAGE.
#
# The views and conclusions contained in the software and documentation are
# those of the authors and should not be interpreted as representing official
# policies, either expressed or implied, of the FreeBSD Project.
#
# Authors: Michal Minar <miminar@redhat.com>
#
"""
Module with convenient function for defining user commands.
"""
from lmi.scripts.common.command import LmiLister
from lmi.scripts.common.command import LmiCommandMultiplexer
def make_list_command(func,
name=None,
columns=None,
verify_func=None,
transform_func=None):
"""
Create a command subclassed from :py:class:`~.lister.LmiLister`. Please
refer to this class for detailed usage.
:param func: Contents of ``CALLABLE`` property.
:type func: string or callable
:param string name: Optional name of resulting class. If not given,
it will be made from the name of associated function.
:param tuple columns: Contents of ``COLUMNS`` property.
:param callable verify_func: Callable overriding
py:meth:`~.endpoint.LmiEndPointCommand.verify_options` method.
:param callable transform_func: Callable overriding
:py:meth:`~.endpoint.LmiEndPointCommand.transform_options` method.
:returns: Subclass of :py:class:`~.lister.LmiLister`.
:rtype: type
"""
if name is None:
if isinstance(func, basestring):
name = func.split('.')[-1]
else:
name = func.__name__
if not name.startswith('_'):
name = '_' + name.capitalize()
props = { 'COLUMNS' : columns, 'CALLABLE' : func }
if verify_func:
props['verify_options'] = verify_func
if transform_func:
props['transform_options'] = transform_func
return LmiLister.__metaclass__(name, (LmiLister, ), props)
def register_subcommands(command_name, usage, command_map,
fallback_command=None):
"""
Create a multiplexer command (a node in a tree of commands).
:param string command_name: Name of created command. The same as will
be given on a command line.
:param string usage: Usage string parseable by ``docopt``.
:param dictionary command_map: Dictionary of subcommands. Associates
command names to their factories. It's assigned to ``COMMANDS``
property.
:param fallback_command: Command factory used when no command is given
on command line.
:type fallback_command: :py:class:`~.endpoint.LmiEndPointCommand`
:returns: Subclass of :py:class:`~.multiplexer.LmiCommandMultiplexer`.
:rtype: type
"""
props = { 'COMMANDS' : command_map
, 'OWN_USAGE' : True
, '__doc__' : usage
, 'FALLBACK_COMMAND' : fallback_command }
return LmiCommandMultiplexer.__metaclass__(command_name,
(LmiCommandMultiplexer, ), props)
|
