/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: 2021-07-05 20:27:11 UTC
  • Revision ID: tim@ed.am-20210705202711-vklvsctrh5yhgjj7
added staging commands; updated command helps

Show diffs side-by-side

added added

removed removed

lib/stdhome/program.py
20
20
 
21
21
 
22
22
import os, sys, getopt
23
 
import the
24
 
from vcs.vcs import Vcs
 
23
from . import the
 
24
from .config import Config
 
25
from .vcs.vcs import Vcs
25
26
 
26
27
 
27
28
class Program:
34
35
 
35
36
        def die( self, error_message ):
36
37
                prefix = self.name + ( ' ' + the.command if the.command else '' )
37
 
                print >> sys.stderr, '%s: %s' % ( prefix, error_message )
 
38
                print('%s: %s' % ( prefix, error_message ), file=sys.stderr)
38
39
                exit( 1 )
39
40
 
40
41
 
46
47
 
47
48
 
48
49
        def print_help( self ):
49
 
                print "Usage: " + self.name + " COMMAND [OPTION]..."
50
 
                print
 
50
                print("Usage: " + self.name + " COMMAND [OPTION]...")
 
51
                print()
51
52
                #      01234567890123456789012345678901234567890123456789012345678901234567890123456789
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"
 
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")
79
82
                exit( 0 )
80
83
 
81
84
 
82
85
        def print_version( self ):
83
 
                print "stdhome " + self.version
84
 
                print
85
 
                print "Copyright (C) 2013 to 2014 Tim Marston"
86
 
                print
 
86
                print("stdhome " + self.version)
 
87
                print()
 
88
                print("Copyright (C) 2013 to 2014 Tim Marston")
 
89
                print()
87
90
                #      01234567890123456789012345678901234567890123456789012345678901234567890123456789
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>."
 
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>.")
96
99
                exit( 0 )
97
100
 
98
101
 
99
102
        def check_command( self, command ):
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
 
                """
 
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
 
106
109
                # commands
107
110
                if [ 'init', 'update', 'resolve', 'add', 'remove', 'revert', 'status',
108
111
                         'diff', 'stage-add', 'stage-remove', 'stage-revert',
116
119
                        'rm': 'remove',
117
120
                        'st': 'status',
118
121
                        'co': 'init',
 
122
                        'ci': 'add',
119
123
                }.get( command, False )
120
124
                if alias: return alias
121
125
 
124
128
 
125
129
 
126
130
        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
127
134
                """
128
 
                Find the first program argument what isn't an option argument.
129
135
 
130
 
        Arguments:
131
 
        - `args`: the program arguments
132
 
        """
133
136
                while args:
134
137
                        if args[ 0 ] == '--':
135
138
                                return args[ 1 ] if len( args ) > 1 else None
141
144
 
142
145
        def run( self ):
143
146
                # make an initial attempt to parse the command line, looking only for
144
 
                # --help and --version, so that they have the chance to run without a
 
147
                # --help and --version so that they have the chance to run without a
145
148
                # command being specified
146
149
                try:
147
150
                        opts, args = getopt.gnu_getopt(
161
164
                        # ignore errors -- we aren't parsing the command line properly yet
162
165
                        pass
163
166
 
164
 
                # find the first non-option argument (the command)
 
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)
165
175
                the.command = self.get_command_argument( sys.argv[ 1: ] )
166
176
                if the.command == None:
167
177
                        self.print_usage( "missing command" )
185
195
                                                         fromlist = [ class_name ] )
186
196
                instance = getattr( module, class_name )()
187
197
 
188
 
                # run the command
 
198
                # fully parse the command line, as per the command
189
199
                try:
190
200
                        instance.parse_command_line()
191
 
                        instance.run()
192
201
                except( getopt.GetoptError, self.UsageError ) as e:
193
202
                        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()
194
212
                except Vcs.VcsError as e:
195
 
                        message = e.msg.rstrip()
196
 
                        if the.verbose:
197
 
                                message += '\n\nOUTPUT:\n' + e.output.rstrip()
 
213
                        message = e.msg.rstrip() + '\n\nVCS OUTPUT:\n' + e.output.rstrip()
198
214
                        self.die( message )
199
215
                except self.FatalError as e:
200
216
                        self.die( e.msg )