/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-04-12 12:53:54 UTC
  • Revision ID: tim@ed.am-20140412125354-64aysxvaz7nnk8hm
make verbose levels clearer

Show diffs side-by-side

added added

removed removed

lib/stdhome/program.py
1
 
# stdhome.py
 
1
# program.py
2
2
#
3
3
# Copyright (C) 2013 Tim Marston <tim@edm.am>
4
4
#
19
19
# along with this program.  If not, see <http://www.gnu.org/licenses/>.
20
20
 
21
21
 
22
 
import sys, os
23
 
import getopt
24
 
 
25
 
 
26
 
class Stdhome:
 
22
import os, sys, getopt, ConfigParser
 
23
import the
 
24
from vcs.vcs import Vcs
 
25
 
 
26
 
 
27
class Program:
27
28
 
28
29
 
29
30
        def __init__( self, version ):
 
31
                self.name = os.path.basename( sys.argv[ 0 ] )
30
32
                self.version = version
31
 
                self.program = os.path.basename( sys.argv[ 0 ] )
 
33
 
 
34
 
 
35
        def die( self, error_message ):
 
36
                prefix = self.name + ( ' ' + the.command if the.command else '' )
 
37
                print >> sys.stderr, '%s: %s' % ( prefix, error_message )
 
38
                exit( 1 )
32
39
 
33
40
 
34
41
        def print_usage( self, error_message ):
35
 
                print >> sys.stderr, self.program + ": " + error_message
36
 
                print >> sys.stderr, "Try '" + self.program + " --help' for more information."
37
 
                exit( 1 )
 
42
                command = ' ' + the.command if the.command else ''
 
43
                self.die( error_message + \
 
44
                                  "\nTry '%s%s --help' for more information." % \
 
45
                                  ( self.name, command ) )
38
46
 
39
47
 
40
48
        def print_help( self ):
41
 
                print "Usage: " + self.program + " COMMAND [OPTION]..."
 
49
                print "Usage: " + self.name + " COMMAND [OPTION]..."
42
50
                print
43
51
                #      01234567890123456789012345678901234567890123456789012345678901234567890123456789
44
 
                print "Manage your home directories, across multiple computers, similar to how you"
45
 
                print "would software under version control."
 
52
                print "Tool to manage a set of files in your home directory and distribute them across"
 
53
                print "multiple computers, merging local changes (in the same way as you would manage"
 
54
                print "source code under version control)."
46
55
                print
47
56
                print "Global options (for all commands):"
48
57
                print "     --help     display help and exit"
52
61
                print "  init          initialise a local copy of your repositories"
53
62
                print "  update        update files in your home directory"
54
63
                print "  resolve       try to finish an update (that had conflicts)"
55
 
                print "  add           add local files/changes to the repository"
56
 
                print "  remove        remove a local file from the repository"
57
 
                print "  revert        undo changes made to a local file"
58
 
                print "  stage-add     stage local files/changes"
59
 
                print "  stage-remove  stage the removal of files"
60
 
                print "  stage-revert  revert staged changes"
61
 
                print "  stage-status  show status of staging area"
62
 
                print "  stage-commit  commit staged changes to repository"
 
64
#               print "  add           add local files/changes to the repository"
 
65
#               print "  remove        remove a local file from the repository"
 
66
                print "  status        list files that have changed locally"
 
67
                print "  diff          shows changes made to local files"
 
68
                print "  revert        undo changes made to local files"
 
69
#               print "  stage-add     add (but don't commit) files/changes to local repository"
 
70
#               print "  stage-remove  delete *but don't comit) files from the local repository"
 
71
                print "  stage-revert  revert changes in the local repository"
 
72
#               print "  stage-status  show status of local repository"
 
73
#               print "  stage-diff    shows changes in local repository"
 
74
#               print "  stage-commit  commit changes in the local repository"
63
75
                print
64
76
                print "For help about a particular command (including the additional options that the"
65
77
                print "command accepts) try typing:"
66
 
                print "  $ " + self.program + " COMMAND --help"
 
78
                print "  $ " + self.name + " COMMAND --help"
67
79
                exit( 0 )
68
80
 
69
81
 
70
82
        def print_version( self ):
71
83
                print "stdhome " + self.version
72
84
                print
73
 
                print "Copyright (C) 2013 Tim Marston"
 
85
                print "Copyright (C) 2013 to 2014 Tim Marston"
74
86
                print
75
87
                #      01234567890123456789012345678901234567890123456789012345678901234567890123456789
76
88
                print "This program is free software, and you may use, modify and redistribute it"
92
104
                - `command`: the given command
93
105
                """
94
106
                # commands
95
 
                if [ 'init', 'update', 'resolve', 'add', 'remove', 'revert',
96
 
                         'stage-add', 'stage-remove', 'stage-revert', 'stage-status',
97
 
                         'stage-commit' ].count( command ) == 1:
 
107
                if [ 'init', 'update', 'resolve', 'add', 'remove', 'revert', 'status',
 
108
                         'diff', 'stage-add', 'stage-remove', 'stage-revert',
 
109
                         'stage-status', 'stage-diff', 'stage-commit'
 
110
                ].count( command ) == 1:
98
111
                        return command
99
112
 
100
 
                # aliases
101
 
                elif command == 'up':
102
 
                        return 'update'
103
 
                elif command == 'rm':
104
 
                        return 'remove'
 
113
                # resolve aliases
 
114
                alias = {
 
115
                        'up': 'update',
 
116
                        'rm': 'remove',
 
117
                        'st': 'status',
 
118
                        'co': 'init',
 
119
                }.get( command, False )
 
120
                if alias: return alias
105
121
 
106
122
                # invalid
107
 
                else:
108
 
                        return None
 
123
                return None
109
124
 
110
125
 
111
126
        def get_command_argument( self, args ):
123
138
                        args = args[ 1 : ]
124
139
                return None
125
140
 
 
141
 
126
142
        def run( self ):
127
143
                # make an initial attempt to parse the command line, looking only for
128
144
                # --help and --version, so that they have the chance to run without a
132
148
                                sys.argv[ 1: ], "",
133
149
                                [ "help", "version" ] )
134
150
 
135
 
                        for opt, optargs in opts:
 
151
                        for opt, optarg in opts:
136
152
                                # we only show help if there are no non-option arguments (e.g.,
137
153
                                # a command) specified.  If a command has been specified it will
138
154
                                # have to be parsed and --help will be handled by it, instead)
142
158
                                        self.print_version()
143
159
 
144
160
                except getopt.GetoptError as e:
145
 
                        # ignore any errors -- we aren't parsing the command line properly
 
161
                        # ignore errors -- we aren't parsing the command line properly yet
146
162
                        pass
147
163
 
 
164
                # read program configuration
 
165
                self.read_config()
 
166
 
148
167
                # find the first non-option argument (the command)
149
 
                self.command = self.get_command_argument( sys.argv[ 1: ] )
150
 
                if self.command == None:
 
168
                the.command = self.get_command_argument( sys.argv[ 1: ] )
 
169
                if the.command == None:
151
170
                        self.print_usage( "missing command" )
152
171
 
153
172
                # check command is valid
154
 
                self.command = self.check_command( self.command )
155
 
                if self.command == None:
 
173
                the.command = self.check_command( the.command )
 
174
                if the.command == None:
156
175
                        self.print_usage( "bad command" )
157
176
 
158
 
                # calculate class name
159
 
                bits = self.command.split( '-' )
160
 
                class_name = 'Command'
 
177
                # calculate module and class name
 
178
                class_name = module_name = ''
 
179
                bits = the.command.split( '-' )
161
180
                for bit in bits:
162
181
                        class_name += bit[ 0 ].upper() + bit[ 1 : ]
163
 
 
164
 
                # instantiate and run the command class
165
 
                module = __import__( 'stdhome.command_' + self.command )
166
 
                the_class = getattr( module, class_name )
167
 
                instance = the_class()
168
 
                instance.run( self )
 
182
                        if module_name: module_name += '_'
 
183
                        module_name += bit
 
184
                class_name += 'Command'
 
185
 
 
186
                # import module and instantiate the class
 
187
                module = __import__( 'stdhome.command.' + module_name,
 
188
                                                         fromlist = [ class_name ] )
 
189
                instance = getattr( module, class_name )()
 
190
 
 
191
                # fully parse the command line, as per the command
 
192
                try:
 
193
                        instance.parse_command_line()
 
194
                except( getopt.GetoptError, self.UsageError ) as e:
 
195
                        self.print_usage( e.msg )
 
196
                except self.FatalError as e:
 
197
                        self.die( e.msg )
 
198
 
 
199
                # do late initialisation
 
200
                the.late_init()
 
201
 
 
202
                # run the command
 
203
                try:
 
204
                        instance.run()
 
205
                except Vcs.VcsError as e:
 
206
                        message = e.msg.rstrip()
 
207
                        if the.verbose:
 
208
                                message += '\n\nOUTPUT:\n' + e.output.rstrip()
 
209
                        self.die( message )
 
210
                except self.FatalError as e:
 
211
                        self.die( e.msg )
 
212
 
 
213
 
 
214
        def read_config( self ):
 
215
                config = ConfigParser.SafeConfigParser( allow_no_value = True )
 
216
                config.read( the.config_file )
 
217
                if config.has_option( 'stdhome', 'home-dir' ):
 
218
                        the.home_dir = config.get( 'stdhome', 'home-dir' )
 
219
 
 
220
 
 
221
        class UsageError( Exception ):
 
222
 
 
223
                def __init__( self, error_message ):
 
224
                        self.msg = error_message
 
225
 
 
226
 
 
227
        class FatalError( Exception ):
 
228
 
 
229
                def __init__( self, message ):
 
230
                        self.msg = message