/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:
61
63
                print "  update        update files in your home directory"
62
64
                print "  resolve       try to finish an update (that had conflicts)"
63
65
                print "  add           add local files/changes to the repository"
64
 
                print "  remove        remove a local file from the repository"
 
66
#               print "  remove        remove a local file from the repository"
65
67
                print "  status        list files that have changed locally"
66
68
                print "  diff          shows changes made to local files"
67
 
                print "  revert        undo changes made to a local file"
68
 
                print "  stage-add     stage local files/changes"
69
 
                print "  stage-remove  stage the removal of files"
70
 
                print "  stage-revert  revert staged changes"
71
 
                print "  stage-status  show status of staging area"
72
 
                print "  stage-diff    shows staged changes"
73
 
                print "  stage-commit  commit staged changes to repository"
 
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"
74
76
                print
75
77
                print "For help about a particular command (including the additional options that the"
76
78
                print "command accepts) try typing:"
81
83
        def print_version( self ):
82
84
                print "stdhome " + self.version
83
85
                print
84
 
                print "Copyright (C) 2013 Tim Marston"
 
86
                print "Copyright (C) 2013 to 2014 Tim Marston"
85
87
                print
86
88
                #      01234567890123456789012345678901234567890123456789012345678901234567890123456789
87
89
                print "This program is free software, and you may use, modify and redistribute it"
96
98
 
97
99
 
98
100
        def check_command( self, command ):
99
 
                """
100
 
                Check that the given command is valid and return the full name of the command.
101
 
        
102
 
                Arguments:
103
 
                - `command`: the given command
104
 
                """
 
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
 
105
107
                # commands
106
108
                if [ 'init', 'update', 'resolve', 'add', 'remove', 'revert', 'status',
107
109
                         'diff', 'stage-add', 'stage-remove', 'stage-revert',
110
112
                        return command
111
113
 
112
114
                # resolve aliases
113
 
                elif command == 'up':
114
 
                        return 'update'
115
 
                elif command == 'rm':
116
 
                        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
117
122
 
118
123
                # invalid
119
 
                else:
120
 
                        return None
 
124
                return None
121
125
 
122
126
 
123
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
124
131
                """
125
 
                Find the first program argument what isn't an option argument.
126
132
 
127
 
        Arguments:
128
 
        - `args`: the program arguments
129
 
        """
130
133
                while args:
131
134
                        if args[ 0 ] == '--':
132
135
                                return args[ 1 ] if len( args ) > 1 else None
138
141
 
139
142
        def run( self ):
140
143
                # make an initial attempt to parse the command line, looking only for
141
 
                # --help and --version, so that they have the chance to run without a
142
 
                # command being specified
 
144
                # --help, --version and --verbose, so that they have the chance to run
 
145
                # without a command being specified
143
146
                try:
144
147
                        opts, args = getopt.gnu_getopt(
145
 
                                sys.argv[ 1: ], "",
146
 
                                [ "help", "version" ] )
 
148
                                sys.argv[ 1: ], "v",
 
149
                                [ "verbose", "help", "version" ] )
147
150
 
148
151
                        for opt, optarg in opts:
149
152
                                # we only show help if there are no non-option arguments (e.g.,
150
153
                                # a command) specified.  If a command has been specified it will
151
154
                                # have to be parsed and --help will be handled by it, instead)
152
 
                                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:
153
158
                                        self.print_help()
154
159
                                elif opt == "--version":
155
160
                                        self.print_version()
158
163
                        # ignore errors -- we aren't parsing the command line properly yet
159
164
                        pass
160
165
 
161
 
                # 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)
162
174
                the.command = self.get_command_argument( sys.argv[ 1: ] )
163
175
                if the.command == None:
164
176
                        self.print_usage( "missing command" )
169
181
                        self.print_usage( "bad command" )
170
182
 
171
183
                # calculate module and class name
 
184
                class_name = module_name = ''
172
185
                bits = the.command.split( '-' )
173
 
                class_name = 'Command'
174
 
                module_name = 'command'
175
186
                for bit in bits:
176
187
                        class_name += bit[ 0 ].upper() + bit[ 1 : ]
177
 
                        module_name += '_' + bit
 
188
                        if module_name: module_name += '_'
 
189
                        module_name += bit
 
190
                class_name += 'Command'
178
191
 
179
192
                # import module and instantiate the class
180
 
                module = __import__( 'stdhome.' + module_name,
 
193
                module = __import__( 'stdhome.command.' + module_name,
181
194
                                                         fromlist = [ class_name ] )
182
195
                instance = getattr( module, class_name )()
183
196
 
 
197
                # fully parse the command line, as per the command
 
198
                try:
 
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
 
184
208
                # run the command
185
209
                try:
186
 
                        instance.parse_command_line()
187
210
                        instance.run()
188
 
                except ( getopt.GetoptError, self.UsageError ) as e:
189
 
                        self.print_usage( e.msg )
190
 
                except self.FatalError as e:
 
211
                except Vcs.VcsError as e:
191
212
                        message = e.msg.rstrip()
192
 
                        if the.verbose and hasattr( e, 'output' ) and e.output:
 
213
                        if the.verbose >= 1:
193
214
                                message += '\n\nOUTPUT:\n' + e.output.rstrip()
194
215
                        self.die( message )
 
216
                except self.FatalError as e:
 
217
                        self.die( e.msg )
195
218
 
196
219
 
197
220
        class UsageError( Exception ):
202
225
 
203
226
        class FatalError( Exception ):
204
227
 
205
 
                def __init__( self, message, output = None ):
 
228
                def __init__( self, message ):
206
229
                        self.msg = message
207
 
                        self.output = output