aboutsummaryrefslogtreecommitdiff
path: root/brunch/lib/cli/climanager.py
blob: ca40944a8c87e379821f6571000347b00b1357b2 (plain)
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
96
97
98
99
100
101
102
103
104
105
106
107
#
# Copyright (C) 2015 The Android Open Source Project
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#      http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#

"""Brunch CLI managment"""

import argparse

import importutils
import clicommand

class CommandGroup(object):
  """A CLI Command Group"""

  def __init__(self, name, path, parent=None):
    self.name = name
    self.parent = parent
    self.path = path
    self.group_class = self.GetGroupClassType()

    if parent is None:
      self.parser = argparse.ArgumentParser(prog=name,
          description=self.group_class.__doc__)
    else:
      self.parser = parent.subparsers.add_parser(name,
          help=self.group_class.__doc__)
    self.subparsers = self.parser.add_subparsers()

    self.FindCommands()

  def AddCommandGroup(self, name, path):
    group = CommandGroup(name, path, parent=self)

  def AddCommand(self, command_type):
    name = command_type.__name__.lower()
    help_string = command_type.__doc__
    com_parser = self.subparsers.add_parser(name, description=help_string,
                                            help=help_string)
    com_parser.set_defaults(command_type=command_type)
    command_type.Args(com_parser)
    # Update the command with its parentage
    command_type.set_group(self)

  def FindTypes(self, module, find_type):
    class_types = []
    for item in module.__dict__.values():
      if issubclass(type(item), type):
        if issubclass(item, find_type):
          class_types.append(item)
    return class_types

  def FindCommands(self):
    count = 0
    # Iterate modules looking for commands
    for module in importutils.ModuleIter(self.path):
      class_types = self.FindTypes(module, clicommand.Command)
      for class_type in class_types:
        self.AddCommand(class_type)
        count = count + 1
    if count == 0:
      # TODO(leecam): Change to use metric reporting Exception
      raise

  def GetGroupClassType(self):
    package = importutils.LoadPackage(self.path)
    class_types = self.FindTypes(package, clicommand.Group)
    if len(class_types) != 1:
      # TODO(leecam): Change to use metric reporting Exceptions
      raise
    return class_types[0]

class Cli(object):
  """CLI managment"""

  def __init__(self, name, root_path):
    self.name = name
    self.root_path = root_path

    self.root_group = CommandGroup(name, root_path)

  def AddCommandGroup(self, name, path):
    self.root_group.AddCommandGroup(name, path)

  def Execute(self, args=None):
    args = self.root_group.parser.parse_args()

    command = args.command_type()
    result = command.Run(args)
    # Enforce the return type with a useful message.
    if type(result) != int:
      raise TypeError, 'Non-integer return code from "{0} {1}". ' \
                       'Please report this bug!'.format(
        args.command_type.group().name,
        args.command_type.__name__.lower())
    return result