/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-04-10 17:42:36 UTC
  • Revision ID: tim@ed.am-20160410174236-708ckdxils6m2ndv
added tools

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
 
23
import the
 
24
from config import Config
 
25
from vcs.vcs import Vcs
 
26
 
 
27
 
 
28
class Program:
27
29
 
28
30
 
29
31
        def __init__( self, version ):
 
32
                self.name = os.path.basename( sys.argv[ 0 ] )
30
33
                self.version = version
31
 
                self.program = os.path.basename( sys.argv[ 0 ] )
 
34
 
 
35
 
 
36
        def die( self, error_message ):
 
37
                prefix = self.name + ( ' ' + the.command if the.command else '' )
 
38
                print >> sys.stderr, '%s: %s' % ( prefix, error_message )
 
39
                exit( 1 )
32
40
 
33
41
 
34
42
        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 )
 
43
                command = ' ' + the.command if the.command else ''
 
44
                self.die( error_message + \
 
45
                                  "\nTry '%s%s --help' for more information." % \
 
46
                                  ( self.name, command ) )
38
47
 
39
48
 
40
49
        def print_help( self ):
41
 
                print "Usage: " + self.program + " COMMAND [OPTION]..."
 
50
                print "Usage: " + self.name + " COMMAND [OPTION]..."
42
51
                print
43
52
                #      01234567890123456789012345678901234567890123456789012345678901234567890123456789
44
 
                print "Manage your home directories, across multiple computers, similar to how you"
45
 
                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)."
46
56
                print
47
57
                print "Global options (for all commands):"
48
58
                print "     --help     display help and exit"
53
63
                print "  update        update files in your home directory"
54
64
                print "  resolve       try to finish an update (that had conflicts)"
55
65
                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"
 
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
76
                print
64
77
                print "For help about a particular command (including the additional options that the"
65
78
                print "command accepts) try typing:"
66
 
                print "  $ " + self.program + " COMMAND --help"
 
79
                print "  $ " + self.name + " COMMAND --help"
67
80
                exit( 0 )
68
81
 
69
82
 
70
83
        def print_version( self ):
71
84
                print "stdhome " + self.version
72
85
                print
73
 
                print "Copyright (C) 2013 Tim Marston"
 
86
                print "Copyright (C) 2013 to 2014 Tim Marston"
74
87
                print
75
88
                #      01234567890123456789012345678901234567890123456789012345678901234567890123456789
76
89
                print "This program is free software, and you may use, modify and redistribute it"
85
98
 
86
99
 
87
100
        def check_command( self, command ):
88
 
                """
89
 
                Check that the given command is valid and return the full name of the command.
90
 
        
91
 
                Arguments:
92
 
                - `command`: the given command
93
 
                """
 
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
 
94
107
                # commands
95
 
                if [ 'init', 'update', 'resolve', 'add', 'remove', 'revert',
96
 
                         'stage-add', 'stage-remove', 'stage-revert', 'stage-status',
97
 
                         '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:
98
112
                        return command
99
113
 
100
 
                # aliases
101
 
                elif command == 'up':
102
 
                        return 'update'
103
 
                elif command == 'rm':
104
 
                        return 'remove'
 
114
                # 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
105
122
 
106
123
                # invalid
107
 
                else:
108
 
                        return None
 
124
                return None
109
125
 
110
126
 
111
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
112
131
                """
113
 
                Find the first program argument what isn't an option argument.
114
132
 
115
 
        Arguments:
116
 
        - `args`: the program arguments
117
 
        """
118
133
                while args:
119
134
                        if args[ 0 ] == '--':
120
135
                                return args[ 1 ] if len( args ) > 1 else None
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
 
                # --help and --version, so that they have the chance to run without a
 
144
                # --help and --version so that they have the chance to run without a
129
145
                # command being specified
130
146
                try:
131
147
                        opts, args = getopt.gnu_getopt(
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
 
148
 
                # find the first non-option argument (the command)
149
 
                self.command = self.get_command_argument( sys.argv[ 1: ] )
150
 
                if self.command == None:
 
164
                # read program configuration
 
165
                the.config = Config()
 
166
 
 
167
                # find the command by grabbing the first program argument that doesn't
 
168
                # look like an option (note: the first argument that doesn't look like
 
169
                # an option may actually be an argument to an option, so this is far
 
170
                # from perfect, but, provided the user is mindful, this is preferable to
 
171
                # forcing the user to always specify options after the command)
 
172
                the.command = self.get_command_argument( sys.argv[ 1: ] )
 
173
                if the.command == None:
151
174
                        self.print_usage( "missing command" )
152
175
 
153
176
                # check command is valid
154
 
                self.command = self.check_command( self.command )
155
 
                if self.command == None:
 
177
                the.command = self.check_command( the.command )
 
178
                if the.command == None:
156
179
                        self.print_usage( "bad command" )
157
180
 
158
 
                # calculate class name
159
 
                bits = self.command.split( '-' )
160
 
                class_name = 'Command'
 
181
                # calculate module and class name
 
182
                class_name = module_name = ''
 
183
                bits = the.command.split( '-' )
161
184
                for bit in bits:
162
185
                        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 )
 
186
                        if module_name: module_name += '_'
 
187
                        module_name += bit
 
188
                class_name += 'Command'
 
189
 
 
190
                # import module and instantiate the class
 
191
                module = __import__( 'stdhome.command.' + module_name,
 
192
                                                         fromlist = [ class_name ] )
 
193
                instance = getattr( module, class_name )()
 
194
 
 
195
                # fully parse the command line, as per the command
 
196
                try:
 
197
                        instance.parse_command_line()
 
198
                except( getopt.GetoptError, self.UsageError ) as e:
 
199
                        self.print_usage( e.msg )
 
200
                except self.FatalError as e:
 
201
                        self.die( e.msg )
 
202
 
 
203
                # do late initialisation
 
204
                the.late_init()
 
205
 
 
206
                # run the command
 
207
                try:
 
208
                        instance.run()
 
209
                except Vcs.VcsError as e:
 
210
                        message = e.msg.rstrip()
 
211
                        if the.verbose >= 1:
 
212
                                message += '\n\nVCS OUTPUT:\n' + e.output.rstrip()
 
213
                        self.die( message )
 
214
                except self.FatalError as e:
 
215
                        self.die( e.msg )
 
216
 
 
217
 
 
218
        class UsageError( Exception ):
 
219
 
 
220
                def __init__( self, error_message ):
 
221
                        self.msg = error_message
 
222
 
 
223
 
 
224
        class FatalError( Exception ):
 
225
 
 
226
                def __init__( self, message ):
 
227
                        self.msg = message