1

"""

     2

    Command implementations

     3

"""

     4

     5

import inspect, logging, traceback

     6

     7

class CommandList (object) :

     8

    """

     9

        A list of available Commands

    10

    11

        XXX: not yet used

    12

    """

    13

    14

    def __init__ (self, commands) :

    15

        """

    16

            Store with given initial commands

    17

        """

    18

    19

        self.list = commands

    20

        self.dict = dict((cmd.name, cmd) for cmd in commands)

    21

    22

    def lookup (self, name) :

    23

        """

    24

            Lookup a command by name

    25

        """

    26

    27

        return self.dict[name]

    28

    29

class Command (object) :

    30

    """

    31

        A Command is simply a function that can be executed from the command line with some options/arguments

    32

    """

    33

    34

    def __init__ (self, name, func, doc=None) :

    35

        """

    36

            Create a new Command

    37

    38

             name       - the name of the command

    39

             func       - the callable python function

    40

             doc        - descriptive help text

    41

        """

    42

    43

        self.name = name

    44

        self.func = func

    45

        self.doc = doc

    46

    47

    def setup (self, config, gallery) :

    48

        """

    49

            Run the command with the given context

    50

        """

    51

    52

        return CommandContext(self, config, gallery)

    53

    54

class CommandContext (object) :

    55

    """

    56

        A CommandContext is the context that a Command executes in

    57

    58

        It is bound to a Configuration and a Gallery.

    59

    """

    60

    61

    def __init__ (self, command, config, gallery) :

    62

        """

    63

            Create the execution environment

    64

        """

    65

    66

        self.command = command

    67

        self.config = config

    68

        self.gallery = gallery

    69

    70

    def execute (self, *args, **kwargs) :

    71

        """

    72

            Run the command in this context

    73

        """

    74

    75

        return self.command.func(self, *args, **kwargs)

    76

    77

    def run (self, *args, **kwargs) :

    78

        """

    79

            Run the command with error handling

    80

        """

    81

    82

        try :

    83

            # run it

    84

            return self.execute(*args, **kwargs)

    85

    86

        except KeyboardInterrupt :

    87

            self.log_error("Interrupted")

    88

    89

        except :

    92

    93

    def log_msg (self, level, msg, *args, **kwargs) :

    94

        """

    95

            Output a log message with the given level

    96

    97

            XXX: unicode

    98

        """

    99

   100

        # control level of output

   101

        if level < self.config.log_level :

   102

            return

   103

   104

        # format?

   105

        if args or kwargs :

   106

            if args and not kwargs :

   107

                msg = msg % args

   108

   109

            elif kwargs and not args :

   110

                msg = msg % kwargs

   111

   112

            else :

   113

                raise Exception("log_msg called with both args and kwargs")

   114

   115

        # output

   116

        # XXX: stdout/err?

   117

        print msg

   118

   119

    def log_debug (self, msg, *args, **kwargs) :

   120

        self.log_msg(logging.DEBUG, msg, *args, **kwargs)

   121

   122

    def log_info (self, msg, *args, **kwargs) :

   123

        self.log_msg(logging.INFO, msg, *args, **kwargs)

   124

   125

    def log_warning (self, msg, *args, **kwargs) :

   126

        self.log_msg(logging.WARNING, msg, *args, **kwargs)

   127

   128

    def log_error (self, msg, *args, **kwargs) :

   129

        self.log_msg(logging.ERROR, msg, *args, **kwargs)

   130

   131

    def handle_error (self, exc_info=None) :

   132

        """

   133

            Do something to handle an error that occured

   134

        """

   135

   136

        if exc_info :

   137

            traceback.print_execption(*exc_info)

   138

   139

        else :

   140

            traceback.print_exc()

   141

   142

def command (func) :

   143

    """

   144

        A function decorator used to define Commands automatically

   145

    """

   146

   147

    return Command(func.__name__, func, inspect.getdoc(func))

   148