/stdhome

To get this branch, use:
bzr branch http://bzr.ed.am/stdhome

« back to all changes in this revision

Viewing changes to lib/stdhome/program.py

  • Committer: Tim Marston
  • Date: 2014-01-05 11:51:35 UTC
  • Revision ID: tim@ed.am-20140105115135-6ses87ggwyjrxzfj
added global objects (the.repo, the.program), deployment object and implemented
init command

Show diffs side-by-side

added added

removed removed

21
21
 
22
22
import os, sys, getopt
23
23
import the
24
 
from config import Config
25
 
from vcs.vcs import Vcs
26
24
 
27
25
 
28
26
class Program:
40
38
 
41
39
 
42
40
        def print_usage( self, error_message ):
43
 
                command = ' ' + the.command if the.command else ''
 
41
                suffix = ' ' + the.command if the.command else ''
44
42
                self.die( error_message + \
45
43
                                  "\nTry '%s%s --help' for more information." % \
46
 
                                  ( self.name, command ) )
 
44
                                  ( self.name, suffix ) )
47
45
 
48
46
 
49
47
        def print_help( self ):
50
48
                print "Usage: " + self.name + " COMMAND [OPTION]..."
51
49
                print
52
50
                #      01234567890123456789012345678901234567890123456789012345678901234567890123456789
53
 
                print "Tool to manage a set of files in your home directory and distribute them across"
54
 
                print "multiple computers, merging local changes (in the same way as you would manage"
55
 
                print "source code under version control)."
 
51
                print "Manage your home directories, across multiple computers, similar to how you"
 
52
                print "would software under version control."
56
53
                print
57
54
                print "Global options (for all commands):"
58
55
                print "     --help     display help and exit"
63
60
                print "  update        update files in your home directory"
64
61
                print "  resolve       try to finish an update (that had conflicts)"
65
62
                print "  add           add local files/changes to the repository"
66
 
#               print "  remove        remove a local file from the repository"
67
 
                print "  status        list files that have changed locally"
68
 
                print "  diff          shows changes made to local files"
69
 
                print "  revert        undo changes made to local files"
70
 
#               print "  stage-add     add (but don't commit) files/changes to local repository"
71
 
#               print "  stage-remove  delete *but don't comit) files from the local repository"
72
 
                print "  stage-revert  revert changes in the local repository"
73
 
#               print "  stage-status  show status of local repository"
74
 
#               print "  stage-diff    shows changes in local repository"
75
 
#               print "  stage-commit  commit changes in the local repository"
 
63
                print "  remove        remove a local file from the repository"
 
64
                print "  revert        undo changes made to a local file"
 
65
                print "  stage-add     stage local files/changes"
 
66
                print "  stage-remove  stage the removal of files"
 
67
                print "  stage-revert  revert staged changes"
 
68
                print "  stage-status  show status of staging area"
 
69
                print "  stage-commit  commit staged changes to repository"
76
70
                print
77
71
                print "For help about a particular command (including the additional options that the"
78
72
                print "command accepts) try typing:"
83
77
        def print_version( self ):
84
78
                print "stdhome " + self.version
85
79
                print
86
 
                print "Copyright (C) 2013 to 2014 Tim Marston"
 
80
                print "Copyright (C) 2013 Tim Marston"
87
81
                print
88
82
                #      01234567890123456789012345678901234567890123456789012345678901234567890123456789
89
83
                print "This program is free software, and you may use, modify and redistribute it"
98
92
 
99
93
 
100
94
        def check_command( self, command ):
101
 
                """Check that the given command is valid and return the full name of the
102
 
                command.
103
 
 
104
 
                @param command the given command
105
 
                """
106
 
 
 
95
                """
 
96
                Check that the given command is valid and return the full name of the command.
 
97
        
 
98
                Arguments:
 
99
                - `command`: the given command
 
100
                """
107
101
                # commands
108
 
                if [ 'init', 'update', 'resolve', 'add', 'remove', 'revert', 'status',
109
 
                         'diff', 'stage-add', 'stage-remove', 'stage-revert',
110
 
                         'stage-status', 'stage-diff', 'stage-commit'
111
 
                ].count( command ) == 1:
 
102
                if [ 'init', 'update', 'resolve', 'add', 'remove', 'revert',
 
103
                         'stage-add', 'stage-remove', 'stage-revert', 'stage-status',
 
104
                         'stage-commit' ].count( command ) == 1:
112
105
                        return command
113
106
 
114
107
                # resolve aliases
115
 
                alias = {
116
 
                        'up': 'update',
117
 
                        'rm': 'remove',
118
 
                        'st': 'status',
119
 
                        'co': 'init',
120
 
                }.get( command, False )
121
 
                if alias: return alias
 
108
                elif command == 'up':
 
109
                        return 'update'
 
110
                elif command == 'rm':
 
111
                        return 'remove'
122
112
 
123
113
                # invalid
124
 
                return None
 
114
                else:
 
115
                        return None
125
116
 
126
117
 
127
118
        def get_command_argument( self, args ):
128
 
                """Find the first program argument what isn't an option argument.
129
 
 
130
 
                @param args the program arguments
131
119
                """
 
120
                Find the first program argument what isn't an option argument.
132
121
 
 
122
        Arguments:
 
123
        - `args`: the program arguments
 
124
        """
133
125
                while args:
134
126
                        if args[ 0 ] == '--':
135
127
                                return args[ 1 ] if len( args ) > 1 else None
141
133
 
142
134
        def run( self ):
143
135
                # make an initial attempt to parse the command line, looking only for
144
 
                # --help and --version so that they have the chance to run without a
 
136
                # --help and --version, so that they have the chance to run without a
145
137
                # command being specified
146
138
                try:
147
139
                        opts, args = getopt.gnu_getopt(
161
153
                        # ignore errors -- we aren't parsing the command line properly yet
162
154
                        pass
163
155
 
164
 
                # read program configuration
165
 
                the.config = Config()
166
 
 
167
 
                # find the command by grabbing the first program argument that doesn't
168
 
                # look like an option (note: the first argument that doesn't look like
169
 
                # an option may actually be an argument to an option, so this is far
170
 
                # from perfect, but, provided the user is mindful, this is preferable to
171
 
                # forcing the user to always specify options after the command)
 
156
                # find the first non-option argument (the command)
172
157
                the.command = self.get_command_argument( sys.argv[ 1: ] )
173
158
                if the.command == None:
174
159
                        self.print_usage( "missing command" )
178
163
                if the.command == None:
179
164
                        self.print_usage( "bad command" )
180
165
 
181
 
                # calculate module and class name
182
 
                class_name = module_name = ''
 
166
                # calculate class name
183
167
                bits = the.command.split( '-' )
 
168
                class_name = 'Command'
184
169
                for bit in bits:
185
170
                        class_name += bit[ 0 ].upper() + bit[ 1 : ]
186
 
                        if module_name: module_name += '_'
187
 
                        module_name += bit
188
 
                class_name += 'Command'
189
171
 
190
 
                # import module and instantiate the class
191
 
                module = __import__( 'stdhome.command.' + module_name,
 
172
                # instantiate the command class
 
173
                module = __import__( 'stdhome.command_' + the.command,
192
174
                                                         fromlist = [ class_name ] )
193
175
                instance = getattr( module, class_name )()
194
176
 
195
 
                # fully parse the command line, as per the command
 
177
                # run it
196
178
                try:
197
179
                        instance.parse_command_line()
198
 
                except( getopt.GetoptError, self.UsageError ) as e:
 
180
                        instance.run()
 
181
                except ( getopt.GetoptError, self.UsageError ) as e:
199
182
                        self.print_usage( e.msg )
200
183
                except self.FatalError as e:
201
 
                        self.die( e.msg )
202
 
 
203
 
                # do late initialisation
204
 
                the.late_init()
205
 
 
206
 
                # run the command
207
 
                try:
208
 
                        instance.run()
209
 
                except Vcs.VcsError as e:
210
 
                        message = e.msg.rstrip()
211
 
                        if the.verbose >= 1:
212
 
                                message += '\n\nOUTPUT:\n' + e.output.rstrip()
 
184
                        message = e.msg
 
185
                        if the.verbose and e.output:
 
186
                                message += '\n\nOUTPUT:\n' + e.output
213
187
                        self.die( message )
214
 
                except self.FatalError as e:
215
 
                        self.die( e.msg )
216
188
 
217
189
 
218
190
        class UsageError( Exception ):
223
195
 
224
196
        class FatalError( Exception ):
225
197
 
226
 
                def __init__( self, message ):
 
198
                def __init__( self, message, output = None ):
227
199
                        self.msg = message
 
200
                        self.output = output