/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-26 19:10:31 UTC
  • Revision ID: tim@ed.am-20140226191031-elcqy5j09h2syn2j
moved copy-in, copy-out and deployment conflict checking to a set of "walkers";
bzr vcs back-end now parses affected files during update; deployment state now
includes affected files

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