/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/stdhome.py

  • Committer: Tim Marston
  • Date: 2013-12-08 19:28:11 UTC
  • Revision ID: tim@ed.am-20131208192811-r20qj7cgmn4duw11
initial commit; basic app startup and initial command-line processing

Show diffs side-by-side

added added

removed removed

lib/stdhome/stdhome.py
1
 
# program.py
 
1
# stdhome.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 os, sys, getopt
23
 
import the
24
 
from config import Config
25
 
from vcs.vcs import Vcs
26
 
 
27
 
 
28
 
class Program:
 
22
import sys, os
 
23
import getopt
 
24
 
 
25
 
 
26
class Stdhome:
29
27
 
30
28
 
31
29
        def __init__( self, version ):
32
 
                self.name = os.path.basename( sys.argv[ 0 ] )
33
30
                self.version = version
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 )
 
31
                self.program = os.path.basename( sys.argv[ 0 ] )
 
32
 
 
33
 
 
34
        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."
39
37
                exit( 1 )
40
38
 
41
39
 
42
 
        def print_usage( self, error_message ):
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 ) )
47
 
 
48
 
 
49
40
        def print_help( self ):
50
 
                print "Usage: " + self.name + " COMMAND [OPTION]..."
 
41
                print "Usage: " + self.program + " COMMAND [OPTION]..."
51
42
                print
52
43
                #      01234567890123456789012345678901234567890123456789012345678901234567890123456789
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)."
 
44
                print "Manage your home directories, across multiple computers, similar to how you"
 
45
                print "would software under version control."
56
46
                print
57
47
                print "Global options (for all commands):"
58
48
                print "     --help     display help and exit"
62
52
                print "  init          initialise a local copy of your repositories"
63
53
                print "  update        update files in your home directory"
64
54
                print "  resolve       try to finish an update (that had conflicts)"
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"
 
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"
76
63
                print
77
64
                print "For help about a particular command (including the additional options that the"
78
65
                print "command accepts) try typing:"
79
 
                print "  $ " + self.name + " COMMAND --help"
 
66
                print "  $ " + self.program + " COMMAND --help"
80
67
                exit( 0 )
81
68
 
82
69
 
83
70
        def print_version( self ):
84
71
                print "stdhome " + self.version
85
72
                print
86
 
                print "Copyright (C) 2013 to 2014 Tim Marston"
 
73
                print "Copyright (C) 2013 Tim Marston"
87
74
                print
88
75
                #      01234567890123456789012345678901234567890123456789012345678901234567890123456789
89
76
                print "This program is free software, and you may use, modify and redistribute it"
105
92
                - `command`: the given command
106
93
                """
107
94
                # commands
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:
 
95
                if [ 'init', 'update', 'resolve', 'add', 'remove', 'revert',
 
96
                         'stage-add', 'stage-remove', 'stage-revert', 'stage-status',
 
97
                         'stage-commit' ].count( command ) == 1:
112
98
                        return command
113
99
 
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
 
100
                # aliases
 
101
                elif command == 'up':
 
102
                        return 'update'
 
103
                elif command == 'rm':
 
104
                        return 'remove'
122
105
 
123
106
                # invalid
 
107
                else:
 
108
                        return None
 
109
 
 
110
 
 
111
        def get_command_argument( self, args ):
 
112
                """
 
113
                Find the first program argument what isn't an option argument.
 
114
 
 
115
        Arguments:
 
116
        - `args`: the program arguments
 
117
        """
 
118
                while args:
 
119
                        if args[ 0 ] == '--':
 
120
                                return args[ 1 ] if len( args ) > 1 else None
 
121
                        if args[ 0 ][ 0 : 1 ] != '-':
 
122
                                return args[ 0 ]
 
123
                        args = args[ 1 : ]
124
124
                return None
125
125
 
126
 
 
127
126
        def run( self ):
128
127
                # make an initial attempt to parse the command line, looking only for
129
128
                # --help and --version, so that they have the chance to run without a
133
132
                                sys.argv[ 1: ], "",
134
133
                                [ "help", "version" ] )
135
134
 
136
 
                        for opt, optarg in opts:
 
135
                        for opt, optargs in opts:
137
136
                                # we only show help if there are no non-option arguments (e.g.,
138
137
                                # a command) specified.  If a command has been specified it will
139
138
                                # have to be parsed and --help will be handled by it, instead)
143
142
                                        self.print_version()
144
143
 
145
144
                except getopt.GetoptError as e:
146
 
                        # ignore errors -- we aren't parsing the command line properly yet
 
145
                        # ignore any errors -- we aren't parsing the command line properly
147
146
                        pass
148
147
 
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
154
 
                if the.command == None:
 
148
                # find the first non-option argument (the command)
 
149
                self.command = self.get_command_argument( sys.argv[ 1: ] )
 
150
                if self.command == None:
155
151
                        self.print_usage( "missing command" )
156
152
 
157
153
                # check command is valid
158
 
                the.command = self.check_command( the.command )
159
 
                if the.command == None:
 
154
                self.command = self.check_command( self.command )
 
155
                if self.command == None:
160
156
                        self.print_usage( "bad command" )
161
157
 
162
 
                # calculate module and class name
163
 
                class_name = module_name = ''
164
 
                bits = the.command.split( '-' )
 
158
                # calculate class name
 
159
                bits = self.command.split( '-' )
 
160
                class_name = 'Command'
165
161
                for bit in bits:
166
162
                        class_name += bit[ 0 ].upper() + bit[ 1 : ]
167
 
                        if module_name: module_name += '_'
168
 
                        module_name += bit
169
 
                class_name += 'Command'
170
 
 
171
 
                # import module and instantiate the class
172
 
                module = __import__( 'stdhome.command.' + module_name,
173
 
                                                         fromlist = [ class_name ] )
174
 
                instance = getattr( module, class_name )()
175
 
 
176
 
                # fully parse the command line, as per the command
177
 
                try:
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:
189
 
                        instance.run()
190
 
                except Vcs.VcsError as e:
191
 
                        message = e.msg.rstrip()
192
 
                        if the.verbose >= 1:
193
 
                                message += '\n\nOUTPUT:\n' + e.output.rstrip()
194
 
                        self.die( message )
195
 
                except self.FatalError as e:
196
 
                        self.die( e.msg )
197
 
 
198
 
 
199
 
        class UsageError( Exception ):
200
 
 
201
 
                def __init__( self, error_message ):
202
 
                        self.msg = error_message
203
 
 
204
 
 
205
 
        class FatalError( Exception ):
206
 
 
207
 
                def __init__( self, message ):
208
 
                        self.msg = message
 
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 )