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 90
- compare with another revision
- download diff
- download tarball
- view history from revision 90
- Committer: Tim Marston
- Date: 2021-07-05 21:01:29 UTC
- Revision ID: tim@ed.am-20210705210129-gc746mez1vhzobz7
add stage-status command; add common stage notice to helps
- files added:
- dev
- lib/stdhome/command
- 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
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 "Tool to manage a set of files in your home directory and distribute them across"
52
print "multiple computers, merging local changes (in the same way as you would manage"
53
print "source code under version control)."
54
print
55
print "Global options (for all commands):"
56
print " --help display help and exit"
57
print " --version output version information and exit"
58
print
59
print "Commands:"
60
print " init initialise a local copy of your repositories"
61
print " update update files in your home directory"
62
print " resolve try to finish an update (that had conflicts)"
63
print " add add local files/changes to the repository"
64
print " remove remove a local file from the repository"
65
print " status list files that have changed locally"
66
print " diff shows changes made to local files"
67
print " revert undo changes made to a local file"
68
print " stage-add stage local files/changes"
69
print " stage-remove stage the removal of files"
70
print " stage-revert revert staged changes"
71
print " stage-status show status of staging area"
72
print " stage-diff shows staged changes"
73
print " stage-commit commit staged changes to repository"
74
print
75
print "For help about a particular command (including the additional options that the"
76
print "command accepts) try typing:"
77
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")
78
82
exit( 0 )
79
83
80
84
81
85
def print_version( self ):
82
print "stdhome " + self.version
83
print
84
print "Copyright (C) 2013 Tim Marston"
85
print
86
print("stdhome " + self.version)
87
print()
88
print("Copyright (C) 2013 to 2014 Tim Marston")
89
print()
86
90
# 01234567890123456789012345678901234567890123456789012345678901234567890123456789
87
print "This program is free software, and you may use, modify and redistribute it"
88
print "under the terms of the GNU General Public License version 3 or later. This"
89
print "program comes with ABSOLUTELY NO WARRANTY, to the extent permitted by law."
90
print
91
print "For more information, including documentation, please see the project website"
92
print "at http://ed.am/dev/stdhome."
93
print
94
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>.")
95
99
exit( 0 )
96
100
97
101
98
102
def check_command( self, command ):
99
"""
100
Check that the given command is valid and return the full name of the command.
101
102
Arguments:
103
- `command`: the given command
104
"""
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
105
109
# commands
106
110
if [ 'init', 'update', 'resolve', 'add', 'remove', 'revert', 'status',
107
111
'diff', 'stage-add', 'stage-remove', 'stage-revert',
110
114
return command
111
115
112
116
# resolve aliases
113
elif command == 'up':
114
return 'update'
115
elif command == 'rm':
116
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
117
129
118
130
# invalid
119
else:
120
return None
131
return None
121
132
122
133
123
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
124
138
"""
125
Find the first program argument what isn't an option argument.
126
139
127
Arguments:
128
- `args`: the program arguments
129
"""
130
140
while args:
131
141
if args[ 0 ] == '--':
132
142
return args[ 1 ] if len( args ) > 1 else None
138
148
139
149
def run( self ):
140
150
# make an initial attempt to parse the command line, looking only for
141
# --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
142
152
# command being specified
143
153
try:
144
154
opts, args = getopt.gnu_getopt(
158
168
# ignore errors -- we aren't parsing the command line properly yet
159
169
pass
160
170
161
# 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)
162
179
the.command = self.get_command_argument( sys.argv[ 1: ] )
163
180
if the.command == None:
164
181
self.print_usage( "missing command" )
169
186
self.print_usage( "bad command" )
170
187
171
188
# calculate module and class name
189
class_name = module_name = ''
172
190
bits = the.command.split( '-' )
173
class_name = 'Command'
174
module_name = 'command'
175
191
for bit in bits:
176
192
class_name += bit[ 0 ].upper() + bit[ 1 : ]
177
module_name += '_' + bit
193
if module_name: module_name += '_'
194
module_name += bit
195
class_name += 'Command'
178
196
179
197
# import module and instantiate the class
180
module = __import__( 'stdhome.' + module_name,
198
module = __import__( 'stdhome.command.' + module_name,
181
199
fromlist = [ class_name ] )
182
200
instance = getattr( module, class_name )()
183
201
202
# fully parse the command line, as per the command
203
try:
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
184
213
# run the command
185
214
try:
186
instance.parse_command_line()
187
215
instance.run()
188
except ( getopt.GetoptError, self.UsageError ) as e:
189
self.print_usage( e.msg )
190
except self.FatalError as e:
191
message = e.msg.rstrip()
192
if the.verbose and hasattr( e, 'output' ) and e.output:
193
message += '\n\nOUTPUT:\n' + e.output.rstrip()
216
except Vcs.VcsError as e:
217
message = e.msg.rstrip() + '\n\nVCS OUTPUT:\n' + e.output.rstrip()
194
218
self.die( message )
219
except self.FatalError as e:
220
self.die( e.msg )
195
221
196
222
197
223
class UsageError( Exception ):
202
228
203
229
class FatalError( Exception ):
204
230
205
def __init__( self, message, output = None ):
231
def __init__( self, message ):
206
232
self.msg = message
207
self.output = output
Loggerhead is a web-based interface for Bazaar branches
Version: 1.18.2, Revision: 480