/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

20
20
 
21
21
 
22
22
import os, sys, getopt
23
 
import the
24
 
from config import Config
25
 
from vcs.vcs import Vcs
 
23
from . import the
 
24
from .config import Config
 
25
from .vcs.vcs import Vcs
26
26
 
27
27
 
28
28
class Program:
35
35
 
36
36
        def die( self, error_message ):
37
37
                prefix = self.name + ( ' ' + the.command if the.command else '' )
38
 
                print >> sys.stderr, '%s: %s' % ( prefix, error_message )
 
38
                print('%s: %s' % ( prefix, error_message ), file=sys.stderr)
39
39
                exit( 1 )
40
40
 
41
41
 
47
47
 
48
48
 
49
49
        def print_help( self ):
50
 
                print "Usage: " + self.name + " COMMAND [OPTION]..."
51
 
                print
 
50
                print("Usage: " + self.name + " COMMAND [OPTION]...")
 
51
                print()
52
52
                #      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"
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 "  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"
 
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")
80
82
                exit( 0 )
81
83
 
82
84
 
83
85
        def print_version( self ):
84
 
                print "stdhome " + self.version
85
 
                print
86
 
                print "Copyright (C) 2013 to 2014 Tim Marston"
87
 
                print
 
86
                print("stdhome " + self.version)
 
87
                print()
 
88
                print("Copyright (C) 2013 to 2014 Tim Marston")
 
89
                print()
88
90
                #      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>."
 
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>.")
97
99
                exit( 0 )
98
100
 
99
101
 
100
102
        def check_command( self, command ):
101
 
                """
102
 
                Check that the given command is valid and return the full name of the command.
103
 
        
104
 
                Arguments:
105
 
                - `command`: the given command
106
 
                """
 
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
 
107
109
                # commands
108
110
                if [ 'init', 'update', 'resolve', 'add', 'remove', 'revert', 'status',
109
111
                         'diff', 'stage-add', 'stage-remove', 'stage-revert',
117
119
                        'rm': 'remove',
118
120
                        'st': 'status',
119
121
                        'co': 'init',
 
122
                        'ci': 'add',
120
123
                }.get( command, False )
121
124
                if alias: return alias
122
125
 
124
127
                return None
125
128
 
126
129
 
 
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
 
134
                """
 
135
 
 
136
                while args:
 
137
                        if args[ 0 ] == '--':
 
138
                                return args[ 1 ] if len( args ) > 1 else None
 
139
                        if args[ 0 ][ 0 : 1 ] != '-':
 
140
                                return args[ 0 ]
 
141
                        args = args[ 1 : ]
 
142
                return None
 
143
 
 
144
 
127
145
        def run( self ):
128
146
                # make an initial attempt to parse the command line, looking only for
129
 
                # --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
130
148
                # command being specified
131
149
                try:
132
150
                        opts, args = getopt.gnu_getopt(
149
167
                # read program configuration
150
168
                the.config = Config()
151
169
 
152
 
                # the first argument should be the command
153
 
                the.command = sys.argv[ 1 ] if len( sys.argv ) > 1 else None
 
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)
 
175
                the.command = self.get_command_argument( sys.argv[ 1: ] )
154
176
                if the.command == None:
155
177
                        self.print_usage( "missing command" )
156
178
 
188
210
                try:
189
211
                        instance.run()
190
212
                except Vcs.VcsError as e:
191
 
                        message = e.msg.rstrip()
192
 
                        if the.verbose >= 1:
193
 
                                message += '\n\nOUTPUT:\n' + e.output.rstrip()
 
213
                        message = e.msg.rstrip() + '\n\nVCS OUTPUT:\n' + e.output.rstrip()
194
214
                        self.die( message )
195
215
                except self.FatalError as e:
196
216
                        self.die( e.msg )