Statistics
| Branch: | Tag: | Revision:

root / kamaki / cli / command_tree.py @ 451a7992

History | View | Annotate | Download (7.5 kB)

1 b9331a9f Stavros Sachtouris
# Copyright 2012 GRNET S.A. All rights reserved.
2 00af4193 Stavros Sachtouris
#
3 00af4193 Stavros Sachtouris
# Redistribution and use in source and binary forms, with or
4 00af4193 Stavros Sachtouris
# without modification, are permitted provided that the following
5 00af4193 Stavros Sachtouris
# conditions are met:
6 00af4193 Stavros Sachtouris
#
7 00af4193 Stavros Sachtouris
#   1. Redistributions of source code must retain the above
8 fd5db045 Stavros Sachtouris
#      copyright notice, this list of conditions and the following
9 fd5db045 Stavros Sachtouris
#      disclaimer.
10 00af4193 Stavros Sachtouris
#
11 00af4193 Stavros Sachtouris
#   2. Redistributions in binary form must reproduce the above
12 fd5db045 Stavros Sachtouris
#      copyright notice, this list of conditions and the following
13 fd5db045 Stavros Sachtouris
#      disclaimer in the documentation and/or other materials
14 fd5db045 Stavros Sachtouris
#      provided with the distribution.
15 00af4193 Stavros Sachtouris
#
16 00af4193 Stavros Sachtouris
# THIS SOFTWARE IS PROVIDED BY GRNET S.A. ``AS IS'' AND ANY EXPRESS
17 00af4193 Stavros Sachtouris
# OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
18 00af4193 Stavros Sachtouris
# WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
19 00af4193 Stavros Sachtouris
# PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL GRNET S.A OR
20 00af4193 Stavros Sachtouris
# CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
21 00af4193 Stavros Sachtouris
# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
22 00af4193 Stavros Sachtouris
# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
23 00af4193 Stavros Sachtouris
# USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
24 00af4193 Stavros Sachtouris
# AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25 00af4193 Stavros Sachtouris
# LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
26 00af4193 Stavros Sachtouris
# ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
27 00af4193 Stavros Sachtouris
# POSSIBILITY OF SUCH DAMAGE.
28 00af4193 Stavros Sachtouris
#
29 00af4193 Stavros Sachtouris
# The views and conclusions contained in the software and
30 00af4193 Stavros Sachtouris
# documentation are those of the authors and should not be
31 00af4193 Stavros Sachtouris
# interpreted as representing official policies, either expressed
32 00af4193 Stavros Sachtouris
# or implied, of GRNET S.A.
33 00af4193 Stavros Sachtouris
34 fd5db045 Stavros Sachtouris
35 00af4193 Stavros Sachtouris
class Command(object):
36 fd5db045 Stavros Sachtouris
    """Store a command and the next-level (2 levels)"""
37 fd5db045 Stavros Sachtouris
    _name = None
38 fd5db045 Stavros Sachtouris
    path = None
39 fd5db045 Stavros Sachtouris
    cmd_class = None
40 fd5db045 Stavros Sachtouris
    subcommands = {}
41 fd5db045 Stavros Sachtouris
    help = ' '
42 fd5db045 Stavros Sachtouris
43 fd5db045 Stavros Sachtouris
    def __init__(self, path, help=' ', subcommands={}, cmd_class=None):
44 fd5db045 Stavros Sachtouris
        self.path = path
45 fd5db045 Stavros Sachtouris
        self.help = help
46 fd5db045 Stavros Sachtouris
        self.subcommands = dict(subcommands)
47 fd5db045 Stavros Sachtouris
        self.cmd_class = cmd_class
48 fd5db045 Stavros Sachtouris
49 fd5db045 Stavros Sachtouris
    @property
50 fd5db045 Stavros Sachtouris
    def name(self):
51 fd5db045 Stavros Sachtouris
        if self._name is None:
52 fd5db045 Stavros Sachtouris
            self._name = self.path.split('_')[-1]
53 fd5db045 Stavros Sachtouris
        return str(self._name)
54 fd5db045 Stavros Sachtouris
55 fd5db045 Stavros Sachtouris
    def add_subcmd(self, subcmd):
56 fd5db045 Stavros Sachtouris
        if subcmd.path == '%s_%s' % (self.path, subcmd.name):
57 fd5db045 Stavros Sachtouris
            self.subcommands[subcmd.name] = subcmd
58 fd5db045 Stavros Sachtouris
            return True
59 fd5db045 Stavros Sachtouris
        return False
60 fd5db045 Stavros Sachtouris
61 fd5db045 Stavros Sachtouris
    def get_subcmd(self, name):
62 fd5db045 Stavros Sachtouris
        try:
63 fd5db045 Stavros Sachtouris
            return self.subcommands[name]
64 fd5db045 Stavros Sachtouris
        except KeyError:
65 fd5db045 Stavros Sachtouris
            return None
66 fd5db045 Stavros Sachtouris
67 fd5db045 Stavros Sachtouris
    def contains(self, name):
68 fd5db045 Stavros Sachtouris
        """Check if a name is a direct child of self"""
69 fd5db045 Stavros Sachtouris
        return name in self.subcommands
70 fd5db045 Stavros Sachtouris
71 fd5db045 Stavros Sachtouris
    @property
72 fd5db045 Stavros Sachtouris
    def is_command(self):
73 fd5db045 Stavros Sachtouris
        return self.cmd_class is not None
74 fd5db045 Stavros Sachtouris
75 fd5db045 Stavros Sachtouris
    @property
76 fd5db045 Stavros Sachtouris
    def has_description(self):
77 fd5db045 Stavros Sachtouris
        return len(self.help.strip()) > 0
78 fd5db045 Stavros Sachtouris
79 fd5db045 Stavros Sachtouris
    @property
80 fd5db045 Stavros Sachtouris
    def description(self):
81 fd5db045 Stavros Sachtouris
        return self.help
82 fd5db045 Stavros Sachtouris
83 fd5db045 Stavros Sachtouris
    @property
84 fd5db045 Stavros Sachtouris
    def parent_path(self):
85 fd5db045 Stavros Sachtouris
        parentpath, sep, name = self.path.rpartition('_')
86 fd5db045 Stavros Sachtouris
        return parentpath
87 fd5db045 Stavros Sachtouris
88 fd5db045 Stavros Sachtouris
    def set_class(self, cmd_class):
89 fd5db045 Stavros Sachtouris
        self.cmd_class = cmd_class
90 fd5db045 Stavros Sachtouris
91 fd5db045 Stavros Sachtouris
    def get_class(self):
92 fd5db045 Stavros Sachtouris
        return self.cmd_class
93 fd5db045 Stavros Sachtouris
94 fd5db045 Stavros Sachtouris
    def has_subname(self, subname):
95 fd5db045 Stavros Sachtouris
        return subname in self.subcommands
96 fd5db045 Stavros Sachtouris
97 fd5db045 Stavros Sachtouris
    def get_subnames(self):
98 fd5db045 Stavros Sachtouris
        return self.subcommands.keys()
99 fd5db045 Stavros Sachtouris
100 fd5db045 Stavros Sachtouris
    def get_subcommands(self):
101 fd5db045 Stavros Sachtouris
        return self.subcommands.values()
102 fd5db045 Stavros Sachtouris
103 fd5db045 Stavros Sachtouris
    def sublen(self):
104 fd5db045 Stavros Sachtouris
        return len(self.subcommands)
105 fd5db045 Stavros Sachtouris
106 fd5db045 Stavros Sachtouris
    def parse_out(self, args):
107 fd5db045 Stavros Sachtouris
        cmd = self
108 fd5db045 Stavros Sachtouris
        index = 0
109 fd5db045 Stavros Sachtouris
        for term in args:
110 fd5db045 Stavros Sachtouris
            try:
111 fd5db045 Stavros Sachtouris
                cmd = cmd.subcommands[term]
112 fd5db045 Stavros Sachtouris
            except KeyError:
113 fd5db045 Stavros Sachtouris
                break
114 fd5db045 Stavros Sachtouris
            index += 1
115 fd5db045 Stavros Sachtouris
        return cmd, args[index:]
116 fd5db045 Stavros Sachtouris
117 fd5db045 Stavros Sachtouris
    def pretty_print(self, recursive=False):
118 fd5db045 Stavros Sachtouris
        print('Path: %s (Name: %s) is_cmd: %s\n\thelp: %s'\
119 fd5db045 Stavros Sachtouris
            % (self.path, self.name, self.is_command, self.help))
120 fd5db045 Stavros Sachtouris
        for cmd in self.get_subcommands():
121 fd5db045 Stavros Sachtouris
            cmd.pretty_print(recursive)
122 fd5db045 Stavros Sachtouris
123 00af4193 Stavros Sachtouris
124 d9325478 Stavros Sachtouris
class CommandTree(object):
125 d9325478 Stavros Sachtouris
126 fd5db045 Stavros Sachtouris
    groups = {}
127 fd5db045 Stavros Sachtouris
    _all_commands = {}
128 fd5db045 Stavros Sachtouris
    name = None
129 fd5db045 Stavros Sachtouris
    description = None
130 fd5db045 Stavros Sachtouris
131 fd5db045 Stavros Sachtouris
    def __init__(self, name, description=''):
132 fd5db045 Stavros Sachtouris
        self.name = name
133 fd5db045 Stavros Sachtouris
        self.description = description
134 fd5db045 Stavros Sachtouris
135 fd5db045 Stavros Sachtouris
    def add_command(self, command_path, description=None, cmd_class=None):
136 fd5db045 Stavros Sachtouris
        terms = command_path.split('_')
137 fd5db045 Stavros Sachtouris
        try:
138 fd5db045 Stavros Sachtouris
            cmd = self.groups[terms[0]]
139 fd5db045 Stavros Sachtouris
        except KeyError:
140 fd5db045 Stavros Sachtouris
            cmd = Command(terms[0])
141 fd5db045 Stavros Sachtouris
            self.groups[terms[0]] = cmd
142 fd5db045 Stavros Sachtouris
            self._all_commands[terms[0]] = cmd
143 fd5db045 Stavros Sachtouris
        path = terms[0]
144 fd5db045 Stavros Sachtouris
        for term in terms[1:]:
145 fd5db045 Stavros Sachtouris
            path += '_' + term
146 fd5db045 Stavros Sachtouris
            try:
147 fd5db045 Stavros Sachtouris
                cmd = cmd.subcommands[term]
148 fd5db045 Stavros Sachtouris
            except KeyError:
149 fd5db045 Stavros Sachtouris
                new_cmd = Command(path)
150 fd5db045 Stavros Sachtouris
                self._all_commands[path] = new_cmd
151 fd5db045 Stavros Sachtouris
                cmd.add_subcmd(new_cmd)
152 fd5db045 Stavros Sachtouris
                cmd = new_cmd
153 fd5db045 Stavros Sachtouris
        if cmd_class is not None:
154 fd5db045 Stavros Sachtouris
            cmd.set_class(cmd_class)
155 fd5db045 Stavros Sachtouris
        if description is not None:
156 fd5db045 Stavros Sachtouris
            cmd.help = description
157 fd5db045 Stavros Sachtouris
158 fce93ff6 Stavros Sachtouris
    def find_best_match(self, terms):
159 fce93ff6 Stavros Sachtouris
        """Find a command that best matches a given list of terms
160 fce93ff6 Stavros Sachtouris

161 fce93ff6 Stavros Sachtouris
        :param terms: (list of str) match them against paths in cmd_tree
162 fce93ff6 Stavros Sachtouris

163 fce93ff6 Stavros Sachtouris
        :returns: (Command, list) the matching command, the remaining terms
164 fce93ff6 Stavros Sachtouris
        """
165 fce93ff6 Stavros Sachtouris
        path = []
166 fce93ff6 Stavros Sachtouris
        for term in terms:
167 fce93ff6 Stavros Sachtouris
            check_path = path + [term]
168 fce93ff6 Stavros Sachtouris
            if '_'.join(check_path) not in self._all_commands:
169 fce93ff6 Stavros Sachtouris
                break
170 fce93ff6 Stavros Sachtouris
            path = check_path
171 fce93ff6 Stavros Sachtouris
        if path:
172 fce93ff6 Stavros Sachtouris
            return (self._all_commands['_'.join(path)], terms[len(path):])
173 fce93ff6 Stavros Sachtouris
        return (None, terms)
174 fce93ff6 Stavros Sachtouris
175 6514457a Stavros Sachtouris
    def add_tree(self, new_tree):
176 6514457a Stavros Sachtouris
        tname = new_tree.name
177 6514457a Stavros Sachtouris
        tdesc = new_tree.description
178 6514457a Stavros Sachtouris
        self.groups.update(new_tree.groups)
179 6514457a Stavros Sachtouris
        self._all_commands.update(new_tree._all_commands)
180 6514457a Stavros Sachtouris
        self.set_description(tname, tdesc)
181 6514457a Stavros Sachtouris
182 0d249b3e Stavros Sachtouris
    def has_command(self, path):
183 0d249b3e Stavros Sachtouris
        return path in self._all_commands
184 0d249b3e Stavros Sachtouris
185 fd5db045 Stavros Sachtouris
    def get_command(self, path):
186 fd5db045 Stavros Sachtouris
        return self._all_commands[path]
187 fd5db045 Stavros Sachtouris
188 fd5db045 Stavros Sachtouris
    def get_groups(self):
189 fd5db045 Stavros Sachtouris
        return self.groups.values()
190 fd5db045 Stavros Sachtouris
191 fd5db045 Stavros Sachtouris
    def get_group_names(self):
192 fd5db045 Stavros Sachtouris
        return self.groups.keys()
193 fd5db045 Stavros Sachtouris
194 fd5db045 Stavros Sachtouris
    def set_description(self, path, description):
195 fd5db045 Stavros Sachtouris
        self._all_commands[path].help = description
196 fd5db045 Stavros Sachtouris
197 d07b3796 Stavros Sachtouris
    def get_description(self, path):
198 fd5db045 Stavros Sachtouris
        return self._all_commands[path].help
199 fd5db045 Stavros Sachtouris
200 fd5db045 Stavros Sachtouris
    def set_class(self, path, cmd_class):
201 fd5db045 Stavros Sachtouris
        self._all_commands[path].set_class(cmd_class)
202 fd5db045 Stavros Sachtouris
203 fd5db045 Stavros Sachtouris
    def get_class(self, path):
204 fd5db045 Stavros Sachtouris
        return self._all_commands[path].get_class()
205 fd5db045 Stavros Sachtouris
206 fd5db045 Stavros Sachtouris
    def get_subnames(self, path=None):
207 fd5db045 Stavros Sachtouris
        return self.get_group_names() if path in (None, '') \
208 fd5db045 Stavros Sachtouris
        else self._all_commands[path].get_subnames()
209 fd5db045 Stavros Sachtouris
210 fd5db045 Stavros Sachtouris
    def get_subcommands(self, path=None):
211 fd5db045 Stavros Sachtouris
        return self.get_groups() if path in (None, '') \
212 fd5db045 Stavros Sachtouris
        else self._all_commands[path].get_subcommands()
213 fd5db045 Stavros Sachtouris
214 fd5db045 Stavros Sachtouris
    def get_parent(self, path):
215 fd5db045 Stavros Sachtouris
        if '_' not in path:
216 fd5db045 Stavros Sachtouris
            return None
217 fd5db045 Stavros Sachtouris
        terms = path.split('_')
218 fd5db045 Stavros Sachtouris
        parent_path = '_'.join(terms[:-1])
219 fd5db045 Stavros Sachtouris
        return self._all_commands[parent_path]
220 fd5db045 Stavros Sachtouris
221 fd5db045 Stavros Sachtouris
    def get_closest_ancestor_command(self, path):
222 fd5db045 Stavros Sachtouris
        path, sep, name = path.rpartition('_')
223 fd5db045 Stavros Sachtouris
        while len(path) > 0:
224 fd5db045 Stavros Sachtouris
            cmd = self._all_commands[path]
225 fd5db045 Stavros Sachtouris
            if cmd.is_command:
226 fd5db045 Stavros Sachtouris
                return cmd
227 fd5db045 Stavros Sachtouris
            path, sep, name = path.rpartition('_')
228 fd5db045 Stavros Sachtouris
        return None
229 fd5db045 Stavros Sachtouris
230 fd5db045 Stavros Sachtouris
        if '_' not in path:
231 fd5db045 Stavros Sachtouris
            return None
232 3dabe5d2 Stavros Sachtouris
        terms = path.split()[:-1]
233 fd5db045 Stavros Sachtouris
        while len(terms) > 0:
234 fd5db045 Stavros Sachtouris
            tmp_path = '_'.join(terms)
235 fd5db045 Stavros Sachtouris
            cmd = self._all_commands[tmp_path]
236 fd5db045 Stavros Sachtouris
            if cmd.is_command:
237 fd5db045 Stavros Sachtouris
                return cmd
238 fd5db045 Stavros Sachtouris
            terms = terms[:-1]
239 fd5db045 Stavros Sachtouris
        raise KeyError('No ancestor commands')
240 fd5db045 Stavros Sachtouris
241 fd5db045 Stavros Sachtouris
    def pretty_print(self, group=None):
242 fd5db045 Stavros Sachtouris
        if group is None:
243 fd5db045 Stavros Sachtouris
            for group in self.groups:
244 fd5db045 Stavros Sachtouris
                self.pretty_print(group)
245 fd5db045 Stavros Sachtouris
        else:
246 fd5db045 Stavros Sachtouris
            self.groups[group].pretty_print(recursive=True)