/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-01-05 11:51:35 UTC
  • Revision ID: tim@ed.am-20140105115135-6ses87ggwyjrxzfj
added global objects (the.repo, the.program), deployment object and implemented
init command

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
 
42
40
        def print_usage( self, error_message ):
43
 
                command = ' ' + the.command if the.command else ''
 
41
                suffix = ' ' + the.command if the.command else ''
44
42
                self.die( error_message + \
45
43
                                  "\nTry '%s%s --help' for more information." % \
46
 
                                  ( self.name, command ) )
 
44
                                  ( self.name, suffix ) )
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 "Manage your home directories, across multiple computers, similar to how you"
 
52
                print "would software under version control."
 
53
                print
 
54
                print "Global options (for all commands):"
 
55
                print "     --help     display help and exit"
 
56
                print "     --version  output version information and exit"
 
57
                print
 
58
                print "Commands:"
 
59
                print "  init          initialise a local copy of your repositories"
 
60
                print "  update        update files in your home directory"
 
61
                print "  resolve       try to finish an update (that had conflicts)"
 
62
                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"
 
70
                print
 
71
                print "For help about a particular command (including the additional options that the"
 
72
                print "command accepts) try typing:"
 
73
                print "  $ " + self.name + " COMMAND --help"
82
74
                exit( 0 )
83
75
 
84
76
 
85
77
        def print_version( self ):
86
 
                print("stdhome " + self.version)
87
 
                print()
88
 
                print("Copyright (C) 2013 to 2014 Tim Marston")
89
 
                print()
 
78
                print "stdhome " + self.version
 
79
                print
 
80
                print "Copyright (C) 2013 Tim Marston"
 
81
                print
90
82
                #      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>.")
 
83
                print "This program is free software, and you may use, modify and redistribute it"
 
84
                print "under the terms of the GNU General Public License version 3 or later.  This"
 
85
                print "program comes with ABSOLUTELY NO WARRANTY, to the extent permitted by law."
 
86
                print
 
87
                print "For more information, including documentation, please see the project website"
 
88
                print "at http://ed.am/dev/stdhome."
 
89
                print
 
90
                print "Please report bugs to <tim@ed.am>."
99
91
                exit( 0 )
100
92
 
101
93
 
102
94
        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
 
 
 
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
                """
109
101
                # commands
110
 
                if [ 'init', 'update', 'resolve', 'add', 'remove', 'revert', 'status',
111
 
                         'diff', 'stage-add', 'stage-remove', 'stage-revert',
112
 
                         'stage-status', 'stage-diff', 'stage-commit'
113
 
                ].count( command ) == 1:
 
102
                if [ 'init', 'update', 'resolve', 'add', 'remove', 'revert',
 
103
                         'stage-add', 'stage-remove', 'stage-revert', 'stage-status',
 
104
                         'stage-commit' ].count( command ) == 1:
114
105
                        return command
115
106
 
116
107
                # 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
 
108
                elif command == 'up':
 
109
                        return 'update'
 
110
                elif command == 'rm':
 
111
                        return 'remove'
129
112
 
130
113
                # invalid
131
 
                return None
 
114
                else:
 
115
                        return None
132
116
 
133
117
 
134
118
        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
119
                """
 
120
                Find the first program argument what isn't an option argument.
139
121
 
 
122
        Arguments:
 
123
        - `args`: the program arguments
 
124
        """
140
125
                while args:
141
126
                        if args[ 0 ] == '--':
142
127
                                return args[ 1 ] if len( args ) > 1 else None
148
133
 
149
134
        def run( self ):
150
135
                # 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
 
136
                # --help and --version, so that they have the chance to run without a
152
137
                # command being specified
153
138
                try:
154
139
                        opts, args = getopt.gnu_getopt(
168
153
                        # ignore errors -- we aren't parsing the command line properly yet
169
154
                        pass
170
155
 
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)
 
156
                # find the first non-option argument (the command)
179
157
                the.command = self.get_command_argument( sys.argv[ 1: ] )
180
158
                if the.command == None:
181
159
                        self.print_usage( "missing command" )
185
163
                if the.command == None:
186
164
                        self.print_usage( "bad command" )
187
165
 
188
 
                # calculate module and class name
189
 
                class_name = module_name = ''
 
166
                # calculate class name
190
167
                bits = the.command.split( '-' )
 
168
                class_name = 'Command'
191
169
                for bit in bits:
192
170
                        class_name += bit[ 0 ].upper() + bit[ 1 : ]
193
 
                        if module_name: module_name += '_'
194
 
                        module_name += bit
195
 
                class_name += 'Command'
196
171
 
197
 
                # import module and instantiate the class
198
 
                module = __import__( 'stdhome.command.' + module_name,
 
172
                # instantiate the command class
 
173
                module = __import__( 'stdhome.command_' + the.command,
199
174
                                                         fromlist = [ class_name ] )
200
175
                instance = getattr( module, class_name )()
201
176
 
202
 
                # fully parse the command line, as per the command
 
177
                # run it
203
178
                try:
204
179
                        instance.parse_command_line()
205
 
                except( getopt.GetoptError, self.UsageError ) as e:
 
180
                        instance.run()
 
181
                except ( getopt.GetoptError, self.UsageError ) as e:
206
182
                        self.print_usage( e.msg )
207
183
                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()
 
184
                        message = e.msg
 
185
                        if the.verbose and e.output:
 
186
                                message += '\n\nOUTPUT:\n' + e.output
218
187
                        self.die( message )
219
 
                except self.FatalError as e:
220
 
                        self.die( e.msg )
221
188
 
222
189
 
223
190
        class UsageError( Exception ):
228
195
 
229
196
        class FatalError( Exception ):
230
197
 
231
 
                def __init__( self, message ):
 
198
                def __init__( self, message, output = None ):
232
199
                        self.msg = message
 
200
                        self.output = output