/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: 2016-02-23 19:35:21 UTC
  • Revision ID: tim@ed.am-20160223193521-2vgtxbfos50rrpku
renamed version -> VERSION

Show diffs side-by-side

added added

removed removed

Lines of Context:
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
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"
60
63
                print "  update        update files in your home directory"
61
64
                print "  resolve       try to finish an update (that had conflicts)"
62
65
                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"
 
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"
92
98
 
93
99
 
94
100
        def check_command( self, command ):
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
 
                """
 
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
 
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
 
124
                return None
116
125
 
117
126
 
118
127
        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
119
131
                """
120
 
                Find the first program argument what isn't an option argument.
121
132
 
122
 
        Arguments:
123
 
        - `args`: the program arguments
124
 
        """
125
133
                while args:
126
134
                        if args[ 0 ] == '--':
127
135
                                return args[ 1 ] if len( args ) > 1 else None
133
141
 
134
142
        def run( self ):
135
143
                # make an initial attempt to parse the command line, looking only for
136
 
                # --help and --version, so that they have the chance to run without a
137
 
                # command being specified
 
144
                # --help, --version and --verbose, so that they have the chance to run
 
145
                # without a command being specified
138
146
                try:
139
147
                        opts, args = getopt.gnu_getopt(
140
 
                                sys.argv[ 1: ], "",
141
 
                                [ "help", "version" ] )
 
148
                                sys.argv[ 1: ], "v",
 
149
                                [ "verbose", "help", "version" ] )
142
150
 
143
151
                        for opt, optarg in opts:
144
152
                                # we only show help if there are no non-option arguments (e.g.,
145
153
                                # a command) specified.  If a command has been specified it will
146
154
                                # have to be parsed and --help will be handled by it, instead)
147
 
                                if opt == "--help" and len( args ) == 0:
 
155
                                if opt in [ '--verbose', '-v' ]:
 
156
                                        the.verbose += 1
 
157
                                elif opt == "--help" and len( args ) == 0:
148
158
                                        self.print_help()
149
159
                                elif opt == "--version":
150
160
                                        self.print_version()
153
163
                        # ignore errors -- we aren't parsing the command line properly yet
154
164
                        pass
155
165
 
156
 
                # find the first non-option argument (the command)
 
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)
157
174
                the.command = self.get_command_argument( sys.argv[ 1: ] )
158
175
                if the.command == None:
159
176
                        self.print_usage( "missing command" )
163
180
                if the.command == None:
164
181
                        self.print_usage( "bad command" )
165
182
 
166
 
                # calculate class name
 
183
                # calculate module and class name
 
184
                class_name = module_name = ''
167
185
                bits = the.command.split( '-' )
168
 
                class_name = 'Command'
169
186
                for bit in bits:
170
187
                        class_name += bit[ 0 ].upper() + bit[ 1 : ]
 
188
                        if module_name: module_name += '_'
 
189
                        module_name += bit
 
190
                class_name += 'Command'
171
191
 
172
 
                # instantiate the command class
173
 
                module = __import__( 'stdhome.command_' + the.command,
 
192
                # import module and instantiate the class
 
193
                module = __import__( 'stdhome.command.' + module_name,
174
194
                                                         fromlist = [ class_name ] )
175
195
                instance = getattr( module, class_name )()
176
196
 
177
 
                # run it
 
197
                # fully parse the command line, as per the command
178
198
                try:
179
199
                        instance.parse_command_line()
 
200
                except( getopt.GetoptError, self.UsageError ) as e:
 
201
                        self.print_usage( e.msg )
 
202
                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:
180
210
                        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
 
211
                except Vcs.VcsError as e:
 
212
                        message = e.msg.rstrip()
 
213
                        if the.verbose >= 1:
 
214
                                message += '\n\nOUTPUT:\n' + e.output.rstrip()
187
215
                        self.die( message )
 
216
                except self.FatalError as e:
 
217
                        self.die( e.msg )
188
218
 
189
219
 
190
220
        class UsageError( Exception ):
195
225
 
196
226
        class FatalError( Exception ):
197
227
 
198
 
                def __init__( self, message, output = None ):
 
228
                def __init__( self, message ):
199
229
                        self.msg = message
200
 
                        self.output = output