/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

lib/stdhome/program.py
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, --version and --verbose, so that they have the chance to run
145
 
                # without a command being specified
 
136
                # --help and --version, so that they have the chance to run without a
 
137
                # command being specified
146
138
                try:
147
139
                        opts, args = getopt.gnu_getopt(
148
 
                                sys.argv[ 1: ], "v",
149
 
                                [ "verbose", "help", "version" ] )
 
140
                                sys.argv[ 1: ], "",
 
141
                                [ "help", "version" ] )
150
142
 
151
143
                        for opt, optarg in opts:
152
144
                                # we only show help if there are no non-option arguments (e.g.,
153
145
                                # a command) specified.  If a command has been specified it will
154
146
                                # have to be parsed and --help will be handled by it, instead)
155
 
                                if opt in [ '--verbose', '-v' ]:
156
 
                                        the.verbose += 1
157
 
                                elif opt == "--help" and len( args ) == 0:
 
147
                                if opt == "--help" and len( args ) == 0:
158
148
                                        self.print_help()
159
149
                                elif opt == "--version":
160
150
                                        self.print_version()
163
153
                        # ignore errors -- we aren't parsing the command line properly yet
164
154
                        pass
165
155
 
166
 
                # read program configuration
167
 
                the.config = Config()
168
 
 
169
 
                # find the command by grabbing the first program argument that doesn't
170
 
                # look like an option (note: the first argument that doesn't look like
171
 
                # an option may actually be an argument to an option, so this is far
172
 
                # from perfect, but, provided the user is mindful, this is preferable to
173
 
                # forcing the user to always specify options after the command)
 
156
                # find the first non-option argument (the command)
174
157
                the.command = self.get_command_argument( sys.argv[ 1: ] )
175
158
                if the.command == None:
176
159
                        self.print_usage( "missing command" )
180
163
                if the.command == None:
181
164
                        self.print_usage( "bad command" )
182
165
 
183
 
                # calculate module and class name
184
 
                class_name = module_name = ''
 
166
                # calculate class name
185
167
                bits = the.command.split( '-' )
 
168
                class_name = 'Command'
186
169
                for bit in bits:
187
170
                        class_name += bit[ 0 ].upper() + bit[ 1 : ]
188
 
                        if module_name: module_name += '_'
189
 
                        module_name += bit
190
 
                class_name += 'Command'
191
171
 
192
 
                # import module and instantiate the class
193
 
                module = __import__( 'stdhome.command.' + module_name,
 
172
                # instantiate the command class
 
173
                module = __import__( 'stdhome.command_' + the.command,
194
174
                                                         fromlist = [ class_name ] )
195
175
                instance = getattr( module, class_name )()
196
176
 
197
 
                # fully parse the command line, as per the command
 
177
                # run it
198
178
                try:
199
179
                        instance.parse_command_line()
200
 
                except( getopt.GetoptError, self.UsageError ) as e:
 
180
                        instance.run()
 
181
                except ( getopt.GetoptError, self.UsageError ) as e:
201
182
                        self.print_usage( e.msg )
202
183
                except self.FatalError as e:
203
 
                        self.die( e.msg )
204
 
 
205
 
                # do late initialisation
206
 
                the.late_init()
207
 
 
208
 
                # run the command
209
 
                try:
210
 
                        instance.run()
211
 
                except Vcs.VcsError as e:
212
 
                        message = e.msg.rstrip()
213
 
                        if the.verbose >= 1:
214
 
                                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
215
187
                        self.die( message )
216
 
                except self.FatalError as e:
217
 
                        self.die( e.msg )
218
188
 
219
189
 
220
190
        class UsageError( Exception ):
225
195
 
226
196
        class FatalError( Exception ):
227
197
 
228
 
                def __init__( self, message ):
 
198
                def __init__( self, message, output = None ):
229
199
                        self.msg = message
 
200
                        self.output = output