/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-09-01 12:55:42 UTC
  • Revision ID: tim@ed.am-20210901125542-zbuzpswfo7mmm5br
fix broken use of self in @staticmethod

Show diffs side-by-side

added added

removed removed

lib/stdhome/program.py
19
19
# along with this program.  If not, see <http://www.gnu.org/licenses/>.
20
20
 
21
21
 
22
 
import os, sys, getopt, ConfigParser
23
 
import the
24
 
from vcs.vcs import Vcs
 
22
import os, sys, getopt
 
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 local files"
69
 
#               print "  stage-add     add (but don't commit) files/changes to local repository"
70
 
#               print "  stage-remove  delete *but don't comit) files from the local repository"
71
 
                print "  stage-revert  revert changes in the local repository"
72
 
#               print "  stage-status  show status of local repository"
73
 
#               print "  stage-diff    shows changes in local repository"
74
 
#               print "  stage-commit  commit changes in the local 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',
 
123
                        'stst': 'stage-status',
 
124
                        'stadd': 'stage-add',
 
125
                        'strm': 'stage-remove',
 
126
                        'stci': 'stage-commit',
119
127
                }.get( command, False )
120
128
                if alias: return alias
121
129
 
123
131
                return None
124
132
 
125
133
 
 
134
        def get_command_argument( self, args ):
 
135
                """Find the first program argument what isn't an option argument.
 
136
 
 
137
                @param args the program arguments
 
138
                """
 
139
 
 
140
                while args:
 
141
                        if args[ 0 ] == '--':
 
142
                                return args[ 1 ] if len( args ) > 1 else None
 
143
                        if args[ 0 ][ 0 : 1 ] != '-':
 
144
                                return args[ 0 ]
 
145
                        args = args[ 1 : ]
 
146
                return None
 
147
 
 
148
 
126
149
        def run( self ):
127
150
                # 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
 
151
                # --help and --version so that they have the chance to run without a
129
152
                # command being specified
130
153
                try:
131
154
                        opts, args = getopt.gnu_getopt(
146
169
                        pass
147
170
 
148
171
                # read program configuration
149
 
                self.read_config()
 
172
                the.config = Config()
150
173
 
151
 
                # the first argument should be the command
152
 
                the.command = sys.argv[ 1 ] if len( sys.argv ) > 1 else None
 
174
                # find the command by grabbing the first program argument that doesn't
 
175
                # look like an option (note: the first argument that doesn't look like
 
176
                # an option may actually be an argument to an option, so this is far
 
177
                # from perfect, but, provided the user is mindful, this is preferable to
 
178
                # forcing the user to always specify options after the command)
 
179
                the.command = self.get_command_argument( sys.argv[ 1: ] )
153
180
                if the.command == None:
154
181
                        self.print_usage( "missing command" )
155
182
 
187
214
                try:
188
215
                        instance.run()
189
216
                except Vcs.VcsError as e:
190
 
                        message = e.msg.rstrip()
191
 
                        if the.verbose:
192
 
                                message += '\n\nOUTPUT:\n' + e.output.rstrip()
 
217
                        message = e.msg.rstrip() + '\n\nVCS OUTPUT:\n' + e.output.rstrip()
193
218
                        self.die( message )
194
219
                except self.FatalError as e:
195
220
                        self.die( e.msg )
196
221
 
197
222
 
198
 
        def read_config( self ):
199
 
                config = ConfigParser.SafeConfigParser( allow_no_value = True )
200
 
                config.read( the.config_file )
201
 
                if config.has_option( 'stdhome', 'home-dir' ):
202
 
                        the.home_dir = config.get( 'stdhome', 'home-dir' )
203
 
 
204
 
 
205
223
        class UsageError( Exception ):
206
224
 
207
225
                def __init__( self, error_message ):