/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-18 14:41:07 UTC
  • Revision ID: tim@ed.am-20140418144107-rl879gdqybbc6ria
moved config to its own file and read-in ignore lists

Show diffs side-by-side

added added

removed removed

Lines of Context:
21
21
 
22
22
import os, sys, getopt
23
23
import the
 
24
from config import Config
 
25
from vcs.vcs import Vcs
24
26
 
25
27
 
26
28
class Program:
38
40
 
39
41
 
40
42
        def print_usage( self, error_message ):
41
 
                suffix = ' ' + the.command if the.command else ''
 
43
                command = ' ' + the.command if the.command else ''
42
44
                self.die( error_message + \
43
45
                                  "\nTry '%s%s --help' for more information." % \
44
 
                                  ( self.name, suffix ) )
 
46
                                  ( self.name, command ) )
45
47
 
46
48
 
47
49
        def print_help( self ):
48
50
                print "Usage: " + self.name + " COMMAND [OPTION]..."
49
51
                print
50
52
                #      01234567890123456789012345678901234567890123456789012345678901234567890123456789
51
 
                print "Manage your home directories, across multiple computers, similar to how you"
52
 
                print "would software under version control."
 
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)."
53
56
                print
54
57
                print "Global options (for all commands):"
55
58
                print "     --help     display help and exit"
59
62
                print "  init          initialise a local copy of your repositories"
60
63
                print "  update        update files in your home directory"
61
64
                print "  resolve       try to finish an update (that had conflicts)"
62
 
                print "  add           add local files/changes to the 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"
 
65
#               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"
70
76
                print
71
77
                print "For help about a particular command (including the additional options that the"
72
78
                print "command accepts) try typing:"
77
83
        def print_version( self ):
78
84
                print "stdhome " + self.version
79
85
                print
80
 
                print "Copyright (C) 2013 Tim Marston"
 
86
                print "Copyright (C) 2013 to 2014 Tim Marston"
81
87
                print
82
88
                #      01234567890123456789012345678901234567890123456789012345678901234567890123456789
83
89
                print "This program is free software, and you may use, modify and redistribute it"
99
105
                - `command`: the given command
100
106
                """
101
107
                # commands
102
 
                if [ 'init', 'update', 'resolve', 'add', 'remove', 'revert',
103
 
                         'stage-add', 'stage-remove', 'stage-revert', 'stage-status',
104
 
                         'stage-commit' ].count( command ) == 1:
 
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:
105
112
                        return command
106
113
 
107
114
                # resolve aliases
108
 
                elif command == 'up':
109
 
                        return 'update'
110
 
                elif command == 'rm':
111
 
                        return 'remove'
 
115
                alias = {
 
116
                        'up': 'update',
 
117
                        'rm': 'remove',
 
118
                        'st': 'status',
 
119
                        'co': 'init',
 
120
                }.get( command, False )
 
121
                if alias: return alias
112
122
 
113
123
                # invalid
114
 
                else:
115
 
                        return None
116
 
 
117
 
 
118
 
        def get_command_argument( self, args ):
119
 
                """
120
 
                Find the first program argument what isn't an option argument.
121
 
 
122
 
        Arguments:
123
 
        - `args`: the program arguments
124
 
        """
125
 
                while args:
126
 
                        if args[ 0 ] == '--':
127
 
                                return args[ 1 ] if len( args ) > 1 else None
128
 
                        if args[ 0 ][ 0 : 1 ] != '-':
129
 
                                return args[ 0 ]
130
 
                        args = args[ 1 : ]
131
124
                return None
132
125
 
133
126
 
153
146
                        # ignore errors -- we aren't parsing the command line properly yet
154
147
                        pass
155
148
 
156
 
                # find the first non-option argument (the command)
157
 
                the.command = self.get_command_argument( sys.argv[ 1: ] )
 
149
                # read program configuration
 
150
                the.config = Config()
 
151
 
 
152
                # the first argument should be the command
 
153
                the.command = sys.argv[ 1 ] if len( sys.argv ) > 1 else None
158
154
                if the.command == None:
159
155
                        self.print_usage( "missing command" )
160
156
 
163
159
                if the.command == None:
164
160
                        self.print_usage( "bad command" )
165
161
 
166
 
                # calculate class name
 
162
                # calculate module and class name
 
163
                class_name = module_name = ''
167
164
                bits = the.command.split( '-' )
168
 
                class_name = 'Command'
169
165
                for bit in bits:
170
166
                        class_name += bit[ 0 ].upper() + bit[ 1 : ]
 
167
                        if module_name: module_name += '_'
 
168
                        module_name += bit
 
169
                class_name += 'Command'
171
170
 
172
 
                # instantiate the command class
173
 
                module = __import__( 'stdhome.command_' + the.command,
 
171
                # import module and instantiate the class
 
172
                module = __import__( 'stdhome.command.' + module_name,
174
173
                                                         fromlist = [ class_name ] )
175
174
                instance = getattr( module, class_name )()
176
175
 
177
 
                # run it
 
176
                # fully parse the command line, as per the command
178
177
                try:
179
178
                        instance.parse_command_line()
 
179
                except( getopt.GetoptError, self.UsageError ) as e:
 
180
                        self.print_usage( e.msg )
 
181
                except self.FatalError as e:
 
182
                        self.die( e.msg )
 
183
 
 
184
                # do late initialisation
 
185
                the.late_init()
 
186
 
 
187
                # run the command
 
188
                try:
180
189
                        instance.run()
181
 
                except ( getopt.GetoptError, self.UsageError ) as e:
182
 
                        self.print_usage( e.msg )
183
 
                except self.FatalError as e:
184
 
                        message = e.msg
185
 
                        if the.verbose and e.output:
186
 
                                message += '\n\nOUTPUT:\n' + e.output
 
190
                except Vcs.VcsError as e:
 
191
                        message = e.msg.rstrip()
 
192
                        if the.verbose >= 1:
 
193
                                message += '\n\nOUTPUT:\n' + e.output.rstrip()
187
194
                        self.die( message )
 
195
                except self.FatalError as e:
 
196
                        self.die( e.msg )
188
197
 
189
198
 
190
199
        class UsageError( Exception ):
195
204
 
196
205
        class FatalError( Exception ):
197
206
 
198
 
                def __init__( self, message, output = None ):
 
207
                def __init__( self, message ):
199
208
                        self.msg = message
200
 
                        self.output = output