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 92
- compare with another revision
- download diff
- download tarball
- view history from revision 92
- Committer: Tim Marston
- Date: 2021-09-01 12:22:39 UTC
- Revision ID: tim@ed.am-20210901122239-u3c96zhkl5rdrwqn
main script uses @PYTHON@ from configure
- 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 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")
74
82
exit( 0 )
75
83
76
84
77
85
def print_version( self ):
78
print "stdhome " + self.version
79
print
80
print "Copyright (C) 2013 Tim Marston"
81
print
86
print("stdhome " + self.version)
87
print()
88
print("Copyright (C) 2013 to 2014 Tim Marston")
89
print()
82
90
# 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>."
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>.")
91
99
exit( 0 )
92
100
93
101
94
102
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
"""
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
101
109
# commands
102
if [ 'init', 'update', 'resolve', 'add', 'remove', 'revert',
103
'stage-add', 'stage-remove', 'stage-revert', 'stage-status',
104
'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:
105
114
return command
106
115
107
116
# resolve aliases
108
elif command == 'up':
109
return 'update'
110
elif command == 'rm':
111
return 'remove'
117
alias = {
118
'up': 'update',
119
'rm': 'remove',
120
'st': 'status',
121
'co': 'init',
122
'ci': 'add',
123
'stst': 'stage-status',
124
'stadd': 'stage-add',
125
'strm': 'stage-remove',
126
'stci': 'stage-commit',
127
}.get( command, False )
128
if alias: return alias
112
129
113
130
# invalid
114
else:
115
return None
131
return None
116
132
117
133
118
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
119
138
"""
120
Find the first program argument what isn't an option argument.
121
139
122
Arguments:
123
- `args`: the program arguments
124
"""
125
140
while args:
126
141
if args[ 0 ] == '--':
127
142
return args[ 1 ] if len( args ) > 1 else None
133
148
134
149
def run( self ):
135
150
# 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
151
# --help and --version so that they have the chance to run without a
137
152
# command being specified
138
153
try:
139
154
opts, args = getopt.gnu_getopt(
153
168
# ignore errors -- we aren't parsing the command line properly yet
154
169
pass
155
170
156
# find the first non-option argument (the command)
171
# read program configuration
172
the.config = Config()
173
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)
157
179
the.command = self.get_command_argument( sys.argv[ 1: ] )
158
180
if the.command == None:
159
181
self.print_usage( "missing command" )
163
185
if the.command == None:
164
186
self.print_usage( "bad command" )
165
187
166
# calculate class name
188
# calculate module and class name
189
class_name = module_name = ''
167
190
bits = the.command.split( '-' )
168
class_name = 'Command'
169
191
for bit in bits:
170
192
class_name += bit[ 0 ].upper() + bit[ 1 : ]
193
if module_name: module_name += '_'
194
module_name += bit
195
class_name += 'Command'
171
196
172
# instantiate the command class
173
module = __import__( 'stdhome.command_' + the.command,
197
# import module and instantiate the class
198
module = __import__( 'stdhome.command.' + module_name,
174
199
fromlist = [ class_name ] )
175
200
instance = getattr( module, class_name )()
176
201
177
# run it
202
# fully parse the command line, as per the command
178
203
try:
179
204
instance.parse_command_line()
205
except( getopt.GetoptError, self.UsageError ) as e:
206
self.print_usage( e.msg )
207
except self.FatalError as e:
208
self.die( e.msg )
209
210
# do late initialisation
211
the.late_init()
212
213
# run the command
214
try:
180
215
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
216
except Vcs.VcsError as e:
217
message = e.msg.rstrip() + '\n\nVCS OUTPUT:\n' + e.output.rstrip()
187
218
self.die( message )
219
except self.FatalError as e:
220
self.die( e.msg )
188
221
189
222
190
223
class UsageError( Exception ):
195
228
196
229
class FatalError( Exception ):
197
230
198
def __init__( self, message, output = None ):
231
def __init__( self, message ):
199
232
self.msg = message
200
self.output = output
Loggerhead is a web-based interface for Bazaar branches
Version: 1.18.2, Revision: 480