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
- browse files at revision 88
- compare with another revision
- download diff
- download tarball
- view history from revision 88
- Committer: Tim Marston
- Date: 2021-07-05 19:14:32 UTC
- Revision ID: tim@ed.am-20210705191432-243ayb7s2nmussvi
python3ification
- files added:
- dev
- lib/stdhome/command
- lib/stdhome/vcs
- lib/stdhome/walker
- files renamed:
- version => VERSION
- lib/stdhome/command_init.py => lib/stdhome/command/init.py
- files modified:
- .bzrignore
added
removed
lib/stdhome/program.py
20
20
21
21
22
22
import os, sys, getopt
23
import the
23
from . import the
24
from .config import Config
25
from .vcs.vcs import Vcs
24
26
25
27
26
28
class Program:
33
35
34
36
def die( self, error_message ):
35
37
prefix = self.name + ( ' ' + the.command if the.command else '' )
36
print >> sys.stderr, '%s: %s' % ( prefix, error_message )
38
print('%s: %s' % ( prefix, error_message ), file=sys.stderr)
37
39
exit( 1 )
38
40
39
41
40
42
def print_usage( self, error_message ):
41
suffix = ' ' + the.command if the.command else ''
43
command = ' ' + the.command if the.command else ''
42
44
self.die( error_message + \
43
45
"\nTry '%s%s --help' for more information." % \
44
( self.name, suffix ) )
46
( self.name, command ) )
45
47
46
48
47
49
def print_help( self ):
48
print "Usage: " + self.name + " COMMAND [OPTION]..."
49
print
50
print("Usage: " + self.name + " COMMAND [OPTION]...")
51
print()
50
52
# 01234567890123456789012345678901234567890123456789012345678901234567890123456789
51
print "Manage your home directories, across multiple computers, similar to how you"
52
print "would software under version control."
53
print
54
print "Global options (for all commands):"
55
print " --help display help and exit"
56
print " --version output version information and exit"
57
print
58
print "Commands:"
59
print " init initialise a local copy of your repositories"
60
print " update update files in your home directory"
61
print " resolve try to finish an update (that had conflicts)"
62
print " add add local files/changes to the repository"
63
print " remove remove a local file from the repository"
64
print " revert undo changes made to a local file"
65
print " stage-add stage local files/changes"
66
print " stage-remove stage the removal of files"
67
print " stage-revert revert staged changes"
68
print " stage-status show status of staging area"
69
print " stage-commit commit staged changes to repository"
70
print
71
print "For help about a particular command (including the additional options that the"
72
print "command accepts) try typing:"
73
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 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")
74
80
exit( 0 )
75
81
76
82
77
83
def print_version( self ):
78
print "stdhome " + self.version
79
print
80
print "Copyright (C) 2013 Tim Marston"
81
print
84
print("stdhome " + self.version)
85
print()
86
print("Copyright (C) 2013 to 2014 Tim Marston")
87
print()
82
88
# 01234567890123456789012345678901234567890123456789012345678901234567890123456789
83
print "This program is free software, and you may use, modify and redistribute it"
84
print "under the terms of the GNU General Public License version 3 or later. This"
85
print "program comes with ABSOLUTELY NO WARRANTY, to the extent permitted by law."
86
print
87
print "For more information, including documentation, please see the project website"
88
print "at http://ed.am/dev/stdhome."
89
print
90
print "Please report bugs to <tim@ed.am>."
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
97
exit( 0 )
92
98
93
99
94
100
def check_command( self, command ):
95
"""
96
Check that the given command is valid and return the full name of the command.
97
98
Arguments:
99
- `command`: the given command
100
"""
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
101
107
# commands
102
if [ 'init', 'update', 'resolve', 'add', 'remove', 'revert',
103
'stage-add', 'stage-remove', 'stage-revert', 'stage-status',
104
'stage-commit' ].count( command ) == 1:
108
if [ 'init', 'update', 'resolve', 'add', 'remove', 'revert', 'status',
109
'diff', 'stage-add', 'stage-remove', 'stage-revert',
110
'stage-status', 'stage-diff', 'stage-commit'
111
].count( command ) == 1:
105
112
return command
106
113
107
114
# resolve aliases
108
elif command == 'up':
109
return 'update'
110
elif command == 'rm':
111
return 'remove'
115
alias = {
116
'up': 'update',
117
'rm': 'remove',
118
'st': 'status',
119
'co': 'init',
120
'ci': 'add',
121
}.get( command, False )
122
if alias: return alias
112
123
113
124
# invalid
114
else:
115
return None
125
return None
116
126
117
127
118
128
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
119
132
"""
120
Find the first program argument what isn't an option argument.
121
133
122
Arguments:
123
- `args`: the program arguments
124
"""
125
134
while args:
126
135
if args[ 0 ] == '--':
127
136
return args[ 1 ] if len( args ) > 1 else None
133
142
134
143
def run( self ):
135
144
# make an initial attempt to parse the command line, looking only for
136
# --help and --version, so that they have the chance to run without a
145
# --help and --version so that they have the chance to run without a
137
146
# command being specified
138
147
try:
139
148
opts, args = getopt.gnu_getopt(
153
162
# ignore errors -- we aren't parsing the command line properly yet
154
163
pass
155
164
156
# find the first non-option argument (the command)
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)
157
173
the.command = self.get_command_argument( sys.argv[ 1: ] )
158
174
if the.command == None:
159
175
self.print_usage( "missing command" )
163
179
if the.command == None:
164
180
self.print_usage( "bad command" )
165
181
166
# calculate class name
182
# calculate module and class name
183
class_name = module_name = ''
167
184
bits = the.command.split( '-' )
168
class_name = 'Command'
169
185
for bit in bits:
170
186
class_name += bit[ 0 ].upper() + bit[ 1 : ]
187
if module_name: module_name += '_'
188
module_name += bit
189
class_name += 'Command'
171
190
172
# instantiate the command class
173
module = __import__( 'stdhome.command_' + the.command,
191
# import module and instantiate the class
192
module = __import__( 'stdhome.command.' + module_name,
174
193
fromlist = [ class_name ] )
175
194
instance = getattr( module, class_name )()
176
195
177
# run it
196
# fully parse the command line, as per the command
178
197
try:
179
198
instance.parse_command_line()
199
except( getopt.GetoptError, self.UsageError ) as e:
200
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:
180
209
instance.run()
181
except ( getopt.GetoptError, self.UsageError ) as e:
182
self.print_usage( e.msg )
183
except self.FatalError as e:
184
message = e.msg
185
if the.verbose and e.output:
186
message += '\n\nOUTPUT:\n' + e.output
210
except Vcs.VcsError as e:
211
message = e.msg.rstrip() + '\n\nVCS OUTPUT:\n' + e.output.rstrip()
187
212
self.die( message )
213
except self.FatalError as e:
214
self.die( e.msg )
188
215
189
216
190
217
class UsageError( Exception ):
195
222
196
223
class FatalError( Exception ):
197
224
198
def __init__( self, message, output = None ):
225
def __init__( self, message ):
199
226
self.msg = message
200
self.output = output
Loggerhead is a web-based interface for Breezy
Version: 2.0.2.dev0