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
- lib/stdhome/stdhome.py => lib/stdhome/program.py
- files modified:
- .bzrignore
added
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 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")
67
80
exit( 0 )
68
81
69
82
70
83
def print_version( self ):
71
print "stdhome " + self.version
72
print
73
print "Copyright (C) 2013 Tim Marston"
74
print
84
print("stdhome " + self.version)
85
print()
86
print("Copyright (C) 2013 to 2014 Tim Marston")
87
print()
75
88
# 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>."
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>.")
84
97
exit( 0 )
85
98
86
99
87
100
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
"""
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
94
107
# commands
95
if [ 'init', 'update', 'resolve', 'add', 'remove', 'revert',
96
'stage-add', 'stage-remove', 'stage-revert', 'stage-status',
97
'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:
98
112
return command
99
113
100
# aliases
101
elif command == 'up':
102
return 'update'
103
elif command == 'rm':
104
return 'remove'
114
# resolve aliases
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
105
123
106
124
# invalid
107
else:
108
return None
125
return None
109
126
110
127
111
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
112
132
"""
113
Find the first program argument what isn't an option argument.
114
133
115
Arguments:
116
- `args`: the program arguments
117
"""
118
134
while args:
119
135
if args[ 0 ] == '--':
120
136
return args[ 1 ] if len( args ) > 1 else None
123
139
args = args[ 1 : ]
124
140
return None
125
141
142
126
143
def run( self ):
127
144
# 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
145
# --help and --version so that they have the chance to run without a
129
146
# command being specified
130
147
try:
131
148
opts, args = getopt.gnu_getopt(
132
149
sys.argv[ 1: ], "",
133
150
[ "help", "version" ] )
134
151
135
for opt, optargs in opts:
152
for opt, optarg in opts:
136
153
# we only show help if there are no non-option arguments (e.g.,
137
154
# a command) specified. If a command has been specified it will
138
155
# have to be parsed and --help will be handled by it, instead)
142
159
self.print_version()
143
160
144
161
except getopt.GetoptError as e:
145
# ignore any errors -- we aren't parsing the command line properly
162
# ignore errors -- we aren't parsing the command line properly yet
146
163
pass
147
164
148
# find the first non-option argument (the command)
149
self.command = self.get_command_argument( sys.argv[ 1: ] )
150
if self.command == None:
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)
173
the.command = self.get_command_argument( sys.argv[ 1: ] )
174
if the.command == None:
151
175
self.print_usage( "missing command" )
152
176
153
177
# check command is valid
154
self.command = self.check_command( self.command )
155
if self.command == None:
178
the.command = self.check_command( the.command )
179
if the.command == None:
156
180
self.print_usage( "bad command" )
157
181
158
# calculate class name
159
bits = self.command.split( '-' )
160
class_name = 'Command'
182
# calculate module and class name
183
class_name = module_name = ''
184
bits = the.command.split( '-' )
161
185
for bit in bits:
162
186
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 )
187
if module_name: module_name += '_'
188
module_name += bit
189
class_name += 'Command'
190
191
# import module and instantiate the class
192
module = __import__( 'stdhome.command.' + module_name,
193
fromlist = [ class_name ] )
194
instance = getattr( module, class_name )()
195
196
# fully parse the command line, as per the command
197
try:
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:
209
instance.run()
210
except Vcs.VcsError as e:
211
message = e.msg.rstrip() + '\n\nVCS OUTPUT:\n' + e.output.rstrip()
212
self.die( message )
213
except self.FatalError as e:
214
self.die( e.msg )
215
216
217
class UsageError( Exception ):
218
219
def __init__( self, error_message ):
220
self.msg = error_message
221
222
223
class FatalError( Exception ):
224
225
def __init__( self, message ):
226
self.msg = message
Loggerhead is a web-based interface for Breezy
Version: 2.0.2.dev0