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
|
# Copyright (c) 2013, 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>
#
"""
Utility functions for command inspection.
"""
from lmi.scripts.common import errors
from lmi.scripts.common.command import LmiBaseCommand
from lmi.scripts.common.command import LmiCommandMultiplexer
def get_subcommand_names(command):
"""
:param command: Either a multiplexer command or top-level one.
:returns: Names of children commands.
:rtype: list
"""
if not isinstance(command, LmiBaseCommand):
raise TypeError("command must be an instance of LmiBaseCommand")
if isinstance(command, LmiCommandMultiplexer):
return command.child_commands().keys()
if command.parent is None: # top level command
return command.app.command_manager.command_names
raise ValueError("command must be either multiplexer or top-level command")
def get_subcommand_factory(command, name):
"""
:param command: Either a multiplexer command or top-level one.
:returns: Callable returning an instance of
:py:class:`~lmi.scripts.common.command.multiplexer.LmiCommandMultiplexer`
:rtype: callable
"""
if isinstance(command, LmiCommandMultiplexer):
try:
return command.child_commands()[name]
except KeyError:
cmd_path = command.cmd_name_parts
cmd_path.append(name)
raise errors.LmiCommandNotFound(" ".join(cmd_path))
if command.parent is None: # top level command
return command.app.command_manager.find_command(name)
raise ValueError("command must be either multiplexer or top-level command")
|