/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-03-09 01:57:23 UTC
  • Revision ID: tim@ed.am-20140309015723-kwd7kklc76jq0idr
reduced set of available commands to those implemented

Show diffs side-by-side

added added

removed removed

Lines of Context:
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 repositories")
63
 
                print("  update        update files in your home directory")
64
 
                print("  resolve       try to finish an update (that had conflicts)")
65
 
                print("  add           add local files/changes to the repository")
 
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"
66
65
#               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"
76
 
                print()
77
 
                print("For help about a particular command (including the additional options that the")
78
 
                print("command accepts) try typing:")
79
 
                print("  $ " + self.name + " COMMAND --help")
 
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"
80
79
                exit( 0 )
81
80
 
82
81
 
83
82
        def print_version( self ):
84
 
                print("stdhome " + self.version)
85
 
                print()
86
 
                print("Copyright (C) 2013 to 2014 Tim Marston")
87
 
                print()
 
83
                print "stdhome " + self.version
 
84
                print
 
85
                print "Copyright (C) 2013 to 2014 Tim Marston"
 
86
                print
88
87
                #      01234567890123456789012345678901234567890123456789012345678901234567890123456789
89
 
                print("This program is free software, and you may use, modify and redistribute it")
90
 
                print("under the terms of the GNU General Public License version 3 or later.  This")
91
 
                print("program comes with ABSOLUTELY NO WARRANTY, to the extent permitted by law.")
92
 
                print()
93
 
                print("For more information, including documentation, please see the project website")
94
 
                print("at http://ed.am/dev/stdhome.")
95
 
                print()
96
 
                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>."
97
96
                exit( 0 )
98
97
 
99
98
 
100
99
        def check_command( self, command ):
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
 
 
 
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
                """
107
106
                # commands
108
107
                if [ 'init', 'update', 'resolve', 'add', 'remove', 'revert', 'status',
109
108
                         'diff', 'stage-add', 'stage-remove', 'stage-revert',
117
116
                        'rm': 'remove',
118
117
                        'st': 'status',
119
118
                        'co': 'init',
120
 
                        'ci': 'add',
121
119
                }.get( command, False )
122
120
                if alias: return alias
123
121
 
126
124
 
127
125
 
128
126
        def get_command_argument( self, args ):
129
 
                """Find the first program argument what isn't an option argument.
130
 
 
131
 
                @param args the program arguments
132
127
                """
 
128
                Find the first program argument what isn't an option argument.
133
129
 
 
130
        Arguments:
 
131
        - `args`: the program arguments
 
132
        """
134
133
                while args:
135
134
                        if args[ 0 ] == '--':
136
135
                                return args[ 1 ] if len( args ) > 1 else None
142
141
 
143
142
        def run( self ):
144
143
                # make an initial attempt to parse the command line, looking only for
145
 
                # --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
146
145
                # command being specified
147
146
                try:
148
147
                        opts, args = getopt.gnu_getopt(
162
161
                        # ignore errors -- we aren't parsing the command line properly yet
163
162
                        pass
164
163
 
165
 
                # read program configuration
166
 
                the.config = Config()
167
 
 
168
 
                # find the command by grabbing the first program argument that doesn't
169
 
                # look like an option (note: the first argument that doesn't look like
170
 
                # an option may actually be an argument to an option, so this is far
171
 
                # from perfect, but, provided the user is mindful, this is preferable to
172
 
                # forcing the user to always specify options after the command)
 
164
                # find the first non-option argument (the command)
173
165
                the.command = self.get_command_argument( sys.argv[ 1: ] )
174
166
                if the.command == None:
175
167
                        self.print_usage( "missing command" )
193
185
                                                         fromlist = [ class_name ] )
194
186
                instance = getattr( module, class_name )()
195
187
 
196
 
                # fully parse the command line, as per the command
 
188
                # run the command
197
189
                try:
198
190
                        instance.parse_command_line()
 
191
                        instance.run()
199
192
                except( getopt.GetoptError, self.UsageError ) as e:
200
193
                        self.print_usage( e.msg )
201
 
                except self.FatalError as e:
202
 
                        self.die( e.msg )
203
 
 
204
 
                # do late initialisation
205
 
                the.late_init()
206
 
 
207
 
                # run the command
208
 
                try:
209
 
                        instance.run()
210
194
                except Vcs.VcsError as e:
211
 
                        message = e.msg.rstrip() + '\n\nVCS OUTPUT:\n' + e.output.rstrip()
 
195
                        message = e.msg.rstrip()
 
196
                        if the.verbose:
 
197
                                message += '\n\nOUTPUT:\n' + e.output.rstrip()
212
198
                        self.die( message )
213
199
                except self.FatalError as e:
214
200
                        self.die( e.msg )