/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-02-12 21:51:08 UTC
  • Revision ID: tim@ed.am-20140212215108-stk5z0nlvgpi4oa8
added bzr as a vcs backend; finished init command; implemented deployment

Show diffs side-by-side

added added

removed removed

lib/stdhome/program.py
20
20
 
21
21
 
22
22
import os, sys, getopt
23
 
from . import the
24
 
from .config import Config
25
 
from .vcs.vcs import Vcs
 
23
import the
26
24
 
27
25
 
28
26
class Program:
35
33
 
36
34
        def die( self, error_message ):
37
35
                prefix = self.name + ( ' ' + the.command if the.command else '' )
38
 
                print('%s: %s' % ( prefix, error_message ), file=sys.stderr)
 
36
                print >> sys.stderr, '%s: %s' % ( prefix, error_message )
39
37
                exit( 1 )
40
38
 
41
39
 
47
45
 
48
46
 
49
47
        def print_help( self ):
50
 
                print("Usage: " + self.name + " COMMAND [OPTION]...")
51
 
                print()
 
48
                print "Usage: " + self.name + " COMMAND [OPTION]..."
 
49
                print
52
50
                #      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).")
56
 
                print()
57
 
                print("Global options (for all commands):")
58
 
                print("     --help     display help and exit")
59
 
                print("     --version  output version information and exit")
60
 
                print()
61
 
                print("Commands:")
62
 
                print("  init          initialise a local copy of your repository")
63
 
                print("  update        merge remote changes in to your home directory")
64
 
                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()
71
 
                print("Manual staging commands:")
72
 
                print("  stage-add     add (but don't commit) files/changes to local repository")
73
 
#               print("  stage-remove  delete *but don't comit) files from the local repository")
74
 
                print("  stage-revert  revert changes in the local repository")
75
 
                print("  stage-status  show status of local repository")
76
 
#               print("  stage-diff    shows changes in local repository")
77
 
                print("  stage-commit  commit changes in the local repository")
78
 
                print()
79
 
                print("For help about a particular command (including the additional options that the")
80
 
                print("command accepts) try typing:")
81
 
                print("  $ " + self.name + " COMMAND --help")
 
51
                print "Tool to manage a set of files in your home directory and distribute them across"
 
52
                print "multiple computers, merging local changes (in the same way as you would manage"
 
53
                print "source code under version control)."
 
54
                print
 
55
                print "Global options (for all commands):"
 
56
                print "     --help     display help and exit"
 
57
                print "     --version  output version information and exit"
 
58
                print
 
59
                print "Commands:"
 
60
                print "  init          initialise a local copy of your repositories"
 
61
                print "  update        update files in your home directory"
 
62
                print "  resolve       try to finish an update (that had conflicts)"
 
63
                print "  add           add local files/changes to the repository"
 
64
                print "  remove        remove a local file from the repository"
 
65
                print "  status        list files that have changed locally"
 
66
                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"
 
74
                print
 
75
                print "For help about a particular command (including the additional options that the"
 
76
                print "command accepts) try typing:"
 
77
                print "  $ " + self.name + " COMMAND --help"
82
78
                exit( 0 )
83
79
 
84
80
 
85
81
        def print_version( self ):
86
 
                print("stdhome " + self.version)
87
 
                print()
88
 
                print("Copyright (C) 2013 to 2014 Tim Marston")
89
 
                print()
 
82
                print "stdhome " + self.version
 
83
                print
 
84
                print "Copyright (C) 2013 Tim Marston"
 
85
                print
90
86
                #      01234567890123456789012345678901234567890123456789012345678901234567890123456789
91
 
                print("This program is free software, and you may use, modify and redistribute it")
92
 
                print("under the terms of the GNU General Public License version 3 or later.  This")
93
 
                print("program comes with ABSOLUTELY NO WARRANTY, to the extent permitted by law.")
94
 
                print()
95
 
                print("For more information, including documentation, please see the project website")
96
 
                print("at http://ed.am/dev/stdhome.")
97
 
                print()
98
 
                print("Please report bugs to <tim@ed.am>.")
 
87
                print "This program is free software, and you may use, modify and redistribute it"
 
88
                print "under the terms of the GNU General Public License version 3 or later.  This"
 
89
                print "program comes with ABSOLUTELY NO WARRANTY, to the extent permitted by law."
 
90
                print
 
91
                print "For more information, including documentation, please see the project website"
 
92
                print "at http://ed.am/dev/stdhome."
 
93
                print
 
94
                print "Please report bugs to <tim@ed.am>."
99
95
                exit( 0 )
100
96
 
101
97
 
102
98
        def check_command( self, command ):
103
 
                """Check that the given command is valid and return the full name of the
104
 
                command.
105
 
 
106
 
                @param command the given command
107
 
                """
108
 
 
 
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
                """
109
105
                # commands
110
106
                if [ 'init', 'update', 'resolve', 'add', 'remove', 'revert', 'status',
111
107
                         'diff', 'stage-add', 'stage-remove', 'stage-revert',
114
110
                        return command
115
111
 
116
112
                # resolve aliases
117
 
                alias = {
118
 
                        'up': 'update',
119
 
                        'rm': 'remove',
120
 
                        'st': 'status',
121
 
                        'co': 'init',
122
 
                        'ci': 'add',
123
 
                        'stst': 'stage-status',
124
 
                        'stadd': 'stage-add',
125
 
                        'strm': 'stage-remove',
126
 
                        'stci': 'stage-commit',
127
 
                }.get( command, False )
128
 
                if alias: return alias
 
113
                elif command == 'up':
 
114
                        return 'update'
 
115
                elif command == 'rm':
 
116
                        return 'remove'
129
117
 
130
118
                # invalid
131
 
                return None
 
119
                else:
 
120
                        return None
132
121
 
133
122
 
134
123
        def get_command_argument( self, args ):
135
 
                """Find the first program argument what isn't an option argument.
136
 
 
137
 
                @param args the program arguments
138
124
                """
 
125
                Find the first program argument what isn't an option argument.
139
126
 
 
127
        Arguments:
 
128
        - `args`: the program arguments
 
129
        """
140
130
                while args:
141
131
                        if args[ 0 ] == '--':
142
132
                                return args[ 1 ] if len( args ) > 1 else None
148
138
 
149
139
        def run( self ):
150
140
                # make an initial attempt to parse the command line, looking only for
151
 
                # --help and --version so that they have the chance to run without a
 
141
                # --help and --version, so that they have the chance to run without a
152
142
                # command being specified
153
143
                try:
154
144
                        opts, args = getopt.gnu_getopt(
168
158
                        # ignore errors -- we aren't parsing the command line properly yet
169
159
                        pass
170
160
 
171
 
                # read program configuration
172
 
                the.config = Config()
173
 
 
174
 
                # find the command by grabbing the first program argument that doesn't
175
 
                # look like an option (note: the first argument that doesn't look like
176
 
                # an option may actually be an argument to an option, so this is far
177
 
                # from perfect, but, provided the user is mindful, this is preferable to
178
 
                # forcing the user to always specify options after the command)
 
161
                # find the first non-option argument (the command)
179
162
                the.command = self.get_command_argument( sys.argv[ 1: ] )
180
163
                if the.command == None:
181
164
                        self.print_usage( "missing command" )
186
169
                        self.print_usage( "bad command" )
187
170
 
188
171
                # calculate module and class name
189
 
                class_name = module_name = ''
190
172
                bits = the.command.split( '-' )
 
173
                class_name = 'Command'
 
174
                module_name = 'command'
191
175
                for bit in bits:
192
176
                        class_name += bit[ 0 ].upper() + bit[ 1 : ]
193
 
                        if module_name: module_name += '_'
194
 
                        module_name += bit
195
 
                class_name += 'Command'
 
177
                        module_name += '_' + bit
196
178
 
197
179
                # import module and instantiate the class
198
 
                module = __import__( 'stdhome.command.' + module_name,
 
180
                module = __import__( 'stdhome.' + module_name,
199
181
                                                         fromlist = [ class_name ] )
200
182
                instance = getattr( module, class_name )()
201
183
 
202
 
                # fully parse the command line, as per the command
 
184
                # run the command
203
185
                try:
204
186
                        instance.parse_command_line()
205
 
                except( getopt.GetoptError, self.UsageError ) as e:
 
187
                        instance.run()
 
188
                except ( getopt.GetoptError, self.UsageError ) as e:
206
189
                        self.print_usage( e.msg )
207
190
                except self.FatalError as e:
208
 
                        self.die( e.msg )
209
 
 
210
 
                # do late initialisation
211
 
                the.late_init()
212
 
 
213
 
                # run the command
214
 
                try:
215
 
                        instance.run()
216
 
                except Vcs.VcsError as e:
217
 
                        message = e.msg.rstrip() + '\n\nVCS OUTPUT:\n' + e.output.rstrip()
 
191
                        message = e.msg.rstrip()
 
192
                        if the.verbose and hasattr( e, 'output' ) and e.output:
 
193
                                message += '\n\nOUTPUT:\n' + e.output.rstrip()
218
194
                        self.die( message )
219
 
                except self.FatalError as e:
220
 
                        self.die( e.msg )
221
195
 
222
196
 
223
197
        class UsageError( Exception ):
228
202
 
229
203
        class FatalError( Exception ):
230
204
 
231
 
                def __init__( self, message ):
 
205
                def __init__( self, message, output = None ):
232
206
                        self.msg = message
 
207
                        self.output = output