/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
1
 
# stdhome.py
 
1
# program.py
2
2
#
3
3
# Copyright (C) 2013 Tim Marston <tim@edm.am>
4
4
#
19
19
# along with this program.  If not, see <http://www.gnu.org/licenses/>.
20
20
 
21
21
 
22
 
import sys, os
23
 
import getopt
24
 
 
25
 
 
26
 
class Stdhome:
 
22
import os, sys, getopt
 
23
from . import the
 
24
from .config import Config
 
25
from .vcs.vcs import Vcs
 
26
 
 
27
 
 
28
class Program:
27
29
 
28
30
 
29
31
        def __init__( self, version ):
 
32
                self.name = os.path.basename( sys.argv[ 0 ] )
30
33
                self.version = version
31
 
                self.program = os.path.basename( sys.argv[ 0 ] )
 
34
 
 
35
 
 
36
        def die( self, error_message ):
 
37
                prefix = self.name + ( ' ' + the.command if the.command else '' )
 
38
                print('%s: %s' % ( prefix, error_message ), file=sys.stderr)
 
39
                exit( 1 )
32
40
 
33
41
 
34
42
        def print_usage( self, error_message ):
35
 
                print >> sys.stderr, self.program + ": " + error_message
36
 
                print >> sys.stderr, "Try '" + self.program + " --help' for more information."
37
 
                exit( 1 )
 
43
                command = ' ' + the.command if the.command else ''
 
44
                self.die( error_message + \
 
45
                                  "\nTry '%s%s --help' for more information." % \
 
46
                                  ( self.name, command ) )
38
47
 
39
48
 
40
49
        def print_help( self ):
41
 
                print "Usage: " + self.program + " COMMAND [OPTION]..."
42
 
                print
 
50
                print("Usage: " + self.name + " COMMAND [OPTION]...")
 
51
                print()
43
52
                #      01234567890123456789012345678901234567890123456789012345678901234567890123456789
44
 
                print "Manage your home directories, across multiple computers, similar to how you"
45
 
                print "would software under version control."
46
 
                print
47
 
                print "Global options (for all commands):"
48
 
                print "     --help     display help and exit"
49
 
                print "     --version  output version information and exit"
50
 
                print
51
 
                print "Commands:"
52
 
                print "  init          initialise a local copy of your repositories"
53
 
                print "  update        update files in your home directory"
54
 
                print "  resolve       try to finish an update (that had conflicts)"
55
 
                print "  add           add local files/changes to the repository"
56
 
                print "  remove        remove a local file from the repository"
57
 
                print "  revert        undo changes made to a local file"
58
 
                print "  stage-add     stage local files/changes"
59
 
                print "  stage-remove  stage the removal of files"
60
 
                print "  stage-revert  revert staged changes"
61
 
                print "  stage-status  show status of staging area"
62
 
                print "  stage-commit  commit staged changes to repository"
63
 
                print
64
 
                print "For help about a particular command (including the additional options that the"
65
 
                print "command accepts) try typing:"
66
 
                print "  $ " + self.program + " 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")
67
82
                exit( 0 )
68
83
 
69
84
 
70
85
        def print_version( self ):
71
 
                print "stdhome " + self.version
72
 
                print
73
 
                print "Copyright (C) 2013 Tim Marston"
74
 
                print
 
86
                print("stdhome " + self.version)
 
87
                print()
 
88
                print("Copyright (C) 2013 to 2014 Tim Marston")
 
89
                print()
75
90
                #      01234567890123456789012345678901234567890123456789012345678901234567890123456789
76
 
                print "This program is free software, and you may use, modify and redistribute it"
77
 
                print "under the terms of the GNU General Public License version 3 or later.  This"
78
 
                print "program comes with ABSOLUTELY NO WARRANTY, to the extent permitted by law."
79
 
                print
80
 
                print "For more information, including documentation, please see the project website"
81
 
                print "at http://ed.am/dev/stdhome."
82
 
                print
83
 
                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>.")
84
99
                exit( 0 )
85
100
 
86
101
 
87
102
        def check_command( self, command ):
88
 
                """
89
 
                Check that the given command is valid and return the full name of the command.
90
 
        
91
 
                Arguments:
92
 
                - `command`: the given command
93
 
                """
 
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
 
94
109
                # commands
95
 
                if [ 'init', 'update', 'resolve', 'add', 'remove', 'revert',
96
 
                         'stage-add', 'stage-remove', 'stage-revert', 'stage-status',
97
 
                         'stage-commit' ].count( command ) == 1:
 
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:
98
114
                        return command
99
115
 
100
 
                # aliases
101
 
                elif command == 'up':
102
 
                        return 'update'
103
 
                elif command == 'rm':
104
 
                        return 'remove'
 
116
                # 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
105
125
 
106
126
                # invalid
107
 
                else:
108
 
                        return None
 
127
                return None
109
128
 
110
129
 
111
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
112
134
                """
113
 
                Find the first program argument what isn't an option argument.
114
135
 
115
 
        Arguments:
116
 
        - `args`: the program arguments
117
 
        """
118
136
                while args:
119
137
                        if args[ 0 ] == '--':
120
138
                                return args[ 1 ] if len( args ) > 1 else None
123
141
                        args = args[ 1 : ]
124
142
                return None
125
143
 
 
144
 
126
145
        def run( self ):
127
146
                # make an initial attempt to parse the command line, looking only for
128
 
                # --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
129
148
                # command being specified
130
149
                try:
131
150
                        opts, args = getopt.gnu_getopt(
132
151
                                sys.argv[ 1: ], "",
133
152
                                [ "help", "version" ] )
134
153
 
135
 
                        for opt, optargs in opts:
 
154
                        for opt, optarg in opts:
136
155
                                # we only show help if there are no non-option arguments (e.g.,
137
156
                                # a command) specified.  If a command has been specified it will
138
157
                                # have to be parsed and --help will be handled by it, instead)
142
161
                                        self.print_version()
143
162
 
144
163
                except getopt.GetoptError as e:
145
 
                        # ignore any errors -- we aren't parsing the command line properly
 
164
                        # ignore errors -- we aren't parsing the command line properly yet
146
165
                        pass
147
166
 
148
 
                # find the first non-option argument (the command)
149
 
                self.command = self.get_command_argument( sys.argv[ 1: ] )
150
 
                if self.command == None:
 
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)
 
175
                the.command = self.get_command_argument( sys.argv[ 1: ] )
 
176
                if the.command == None:
151
177
                        self.print_usage( "missing command" )
152
178
 
153
179
                # check command is valid
154
 
                self.command = self.check_command( self.command )
155
 
                if self.command == None:
 
180
                the.command = self.check_command( the.command )
 
181
                if the.command == None:
156
182
                        self.print_usage( "bad command" )
157
183
 
158
 
                # calculate class name
159
 
                bits = self.command.split( '-' )
160
 
                class_name = 'Command'
 
184
                # calculate module and class name
 
185
                class_name = module_name = ''
 
186
                bits = the.command.split( '-' )
161
187
                for bit in bits:
162
188
                        class_name += bit[ 0 ].upper() + bit[ 1 : ]
163
 
 
164
 
                # instantiate and run the command class
165
 
                module = __import__( 'stdhome.command_' + self.command )
166
 
                the_class = getattr( module, class_name )
167
 
                instance = the_class()
168
 
                instance.run( self )
 
189
                        if module_name: module_name += '_'
 
190
                        module_name += bit
 
191
                class_name += 'Command'
 
192
 
 
193
                # import module and instantiate the class
 
194
                module = __import__( 'stdhome.command.' + module_name,
 
195
                                                         fromlist = [ class_name ] )
 
196
                instance = getattr( module, class_name )()
 
197
 
 
198
                # fully parse the command line, as per the command
 
199
                try:
 
200
                        instance.parse_command_line()
 
201
                except( getopt.GetoptError, self.UsageError ) as e:
 
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()
 
212
                except Vcs.VcsError as e:
 
213
                        message = e.msg.rstrip() + '\n\nVCS OUTPUT:\n' + e.output.rstrip()
 
214
                        self.die( message )
 
215
                except self.FatalError as e:
 
216
                        self.die( e.msg )
 
217
 
 
218
 
 
219
        class UsageError( Exception ):
 
220
 
 
221
                def __init__( self, error_message ):
 
222
                        self.msg = error_message
 
223
 
 
224
 
 
225
        class FatalError( Exception ):
 
226
 
 
227
                def __init__( self, message ):
 
228
                        self.msg = message