« back to all changes in this revision
Viewing changes to bzr.py
- browse files at revision 10
- compare with another revision
- download diff
- download tarball
- view history from revision 10
- Committer: mbp at sourcefrog
- Date: 2005-03-09 06:49:00 UTC
- Revision ID: mbp@sourcefrog.net-20050309064900-74935ffb7350b24b
import more files from baz
- files added:
- bzrlib/tests.py
- files removed:
- .bzrignore
- bzrlib/plugins
- bzrlib/selftest
- bzrlib/util
- bzrlib/util/effbot
- bzrlib/util/effbot/org
- bzrlib/util/elementtree
- bzrlib/util/urlgrabber
- contrib
- contrib/bash
- contrib/emacs
- contrib/zsh
- patches
- tools
- files renamed:
- bzrlib/commands.py => bzr.py
- files modified:
- README
added
removed
bzr.py
1
# Copyright (C) 2004, 2005 by Canonical Ltd
1
#! /usr/bin/python
2
3
4
# Copyright (C) 2004, 2005 by Martin Pool
5
# Copyright (C) 2005 by Canonical Ltd
6
2
7
3
8
# This program is free software; you can redistribute it and/or modify
4
9
# it under the terms of the GNU General Public License as published by
14
19
# along with this program; if not, write to the Free Software
15
20
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
16
21
17
18
# TODO: probably should say which arguments are candidates for glob
19
# expansion on windows and do that at the command level.
20
21
# TODO: Help messages for options.
22
23
# TODO: Define arguments by objects, rather than just using names.
24
# Those objects can specify the expected type of the argument, which
25
# would help with validation and shell completion.
26
27
28
# TODO: Help messages for options.
29
30
# TODO: Define arguments by objects, rather than just using names.
31
# Those objects can specify the expected type of the argument, which
32
# would help with validation and shell completion.
33
34
35
36
import sys
37
import os
38
from warnings import warn
39
from inspect import getdoc
22
"""Bazaar-NG -- a free distributed version-control tool
23
24
**WARNING: THIS IS AN UNSTABLE DEVELOPMENT VERSION**
25
26
Current limitation include:
27
28
* Metadata format is not stable yet -- you may need to
29
discard history in the future.
30
31
* No handling of subdirectories, symlinks or any non-text files.
32
33
* Insufficient error handling.
34
35
* Many commands unimplemented or partially implemented.
36
37
* Space-inefficient storage.
38
39
* No merge operators yet.
40
41
Interesting commands::
42
43
bzr help
44
Show summary help screen
45
bzr version
46
Show software version/licence/non-warranty.
47
bzr init
48
Start versioning the current directory
49
bzr add FILE...
50
Make files versioned.
51
bzr log
52
Show revision history.
53
bzr diff
54
Show changes from last revision to working copy.
55
bzr commit -m 'MESSAGE'
56
Store current state as new revision.
57
bzr export REVNO DESTINATION
58
Export the branch state at a previous version.
59
bzr status
60
Show summary of pending changes.
61
bzr remove FILE...
62
Make a file not versioned.
63
"""
64
65
# not currently working:
66
# bzr check
67
# Run internal consistency checks.
68
# bzr info
69
# Show some information about this branch.
70
71
72
73
__copyright__ = "Copyright 2005 Canonical Development Ltd."
74
__author__ = "Martin Pool <mbp@canonical.com>"
75
__docformat__ = "restructuredtext en"
76
__version__ = '0.0.0'
77
78
79
import sys, os, random, time, sha, sets, types, re, shutil, tempfile
80
import traceback, socket, fnmatch, difflib
81
from os import path
82
from sets import Set
83
from pprint import pprint
84
from stat import *
85
from glob import glob
40
86
41
87
import bzrlib
42
import bzrlib.trace
43
from bzrlib.trace import mutter, note, log_error, warning
44
from bzrlib.errors import BzrError, BzrCheckError, BzrCommandError
45
from bzrlib.branch import find_branch
46
from bzrlib import BZRDIR
47
48
plugin_cmds = {}
49
50
51
def register_command(cmd):
52
"Utility function to help register a command"
53
global plugin_cmds
54
k = cmd.__name__
55
if k.startswith("cmd_"):
56
k_unsquished = _unsquish_command_name(k)
57
else:
58
k_unsquished = k
59
if not plugin_cmds.has_key(k_unsquished):
60
plugin_cmds[k_unsquished] = cmd
61
mutter('registered plugin command %s', k_unsquished)
62
else:
63
log_error('Two plugins defined the same command: %r' % k)
64
log_error('Not loading the one in %r' % sys.modules[cmd.__module__])
65
66
67
def _squish_command_name(cmd):
68
return 'cmd_' + cmd.replace('-', '_')
69
70
71
def _unsquish_command_name(cmd):
72
assert cmd.startswith("cmd_")
73
return cmd[4:].replace('_','-')
74
75
76
def _parse_revision_str(revstr):
77
"""This handles a revision string -> revno.
78
79
This always returns a list. The list will have one element for
80
81
It supports integers directly, but everything else it
82
defers for passing to Branch.get_revision_info()
83
84
>>> _parse_revision_str('234')
85
[234]
86
>>> _parse_revision_str('234..567')
87
[234, 567]
88
>>> _parse_revision_str('..')
89
[None, None]
90
>>> _parse_revision_str('..234')
91
[None, 234]
92
>>> _parse_revision_str('234..')
93
[234, None]
94
>>> _parse_revision_str('234..456..789') # Maybe this should be an error
95
[234, 456, 789]
96
>>> _parse_revision_str('234....789') # Error?
97
[234, None, 789]
98
>>> _parse_revision_str('revid:test@other.com-234234')
99
['revid:test@other.com-234234']
100
>>> _parse_revision_str('revid:test@other.com-234234..revid:test@other.com-234235')
101
['revid:test@other.com-234234', 'revid:test@other.com-234235']
102
>>> _parse_revision_str('revid:test@other.com-234234..23')
103
['revid:test@other.com-234234', 23]
104
>>> _parse_revision_str('date:2005-04-12')
105
['date:2005-04-12']
106
>>> _parse_revision_str('date:2005-04-12 12:24:33')
107
['date:2005-04-12 12:24:33']
108
>>> _parse_revision_str('date:2005-04-12T12:24:33')
109
['date:2005-04-12T12:24:33']
110
>>> _parse_revision_str('date:2005-04-12,12:24:33')
111
['date:2005-04-12,12:24:33']
112
>>> _parse_revision_str('-5..23')
113
[-5, 23]
114
>>> _parse_revision_str('-5')
115
[-5]
116
>>> _parse_revision_str('123a')
117
['123a']
118
>>> _parse_revision_str('abc')
119
['abc']
120
"""
121
import re
122
old_format_re = re.compile('\d*:\d*')
123
m = old_format_re.match(revstr)
124
if m:
125
warning('Colon separator for revision numbers is deprecated.'
126
' Use .. instead')
127
revs = []
128
for rev in revstr.split(':'):
129
if rev:
130
revs.append(int(rev))
131
else:
132
revs.append(None)
133
return revs
134
revs = []
135
for x in revstr.split('..'):
136
if not x:
137
revs.append(None)
138
else:
139
try:
140
revs.append(int(x))
141
except ValueError:
142
revs.append(x)
143
return revs
144
145
146
def get_merge_type(typestring):
147
"""Attempt to find the merge class/factory associated with a string."""
148
from merge import merge_types
149
try:
150
return merge_types[typestring][0]
151
except KeyError:
152
templ = '%s%%7s: %%s' % (' '*12)
153
lines = [templ % (f[0], f[1][1]) for f in merge_types.iteritems()]
154
type_list = '\n'.join(lines)
155
msg = "No known merge type %s. Supported types are:\n%s" %\
156
(typestring, type_list)
157
raise BzrCommandError(msg)
158
159
160
def get_merge_type(typestring):
161
"""Attempt to find the merge class/factory associated with a string."""
162
from merge import merge_types
163
try:
164
return merge_types[typestring][0]
165
except KeyError:
166
templ = '%s%%7s: %%s' % (' '*12)
167
lines = [templ % (f[0], f[1][1]) for f in merge_types.iteritems()]
168
type_list = '\n'.join(lines)
169
msg = "No known merge type %s. Supported types are:\n%s" %\
170
(typestring, type_list)
171
raise BzrCommandError(msg)
172
173
174
def _builtin_commands():
175
import bzrlib.builtins
176
r = {}
177
builtins = bzrlib.builtins.__dict__
178
for name in builtins:
179
if name.startswith("cmd_"):
180
real_name = _unsquish_command_name(name)
181
r[real_name] = builtins[name]
182
return r
183
184
185
186
def builtin_command_names():
187
"""Return list of builtin command names."""
188
return _builtin_commands().keys()
189
190
191
def plugin_command_names():
192
return plugin_cmds.keys()
193
194
195
def _get_cmd_dict(plugins_override=True):
196
"""Return name->class mapping for all commands."""
197
d = _builtin_commands()
198
if plugins_override:
199
d.update(plugin_cmds)
200
return d
201
202
203
def get_all_cmds(plugins_override=True):
204
"""Return canonical name and class for all registered commands."""
205
for k, v in _get_cmd_dict(plugins_override=plugins_override).iteritems():
206
yield k,v
207
208
209
def get_cmd_object(cmd_name, plugins_override=True):
210
"""Return the canonical name and command class for a command.
211
212
plugins_override
213
If true, plugin commands can override builtins.
214
"""
215
from bzrlib.externalcommand import ExternalCommand
216
217
cmd_name = str(cmd_name) # not unicode
218
219
# first look up this command under the specified name
220
cmds = _get_cmd_dict(plugins_override=plugins_override)
221
try:
222
return cmds[cmd_name]()
223
except KeyError:
224
pass
225
226
# look for any command which claims this as an alias
227
for real_cmd_name, cmd_class in cmds.iteritems():
228
if cmd_name in cmd_class.aliases:
229
return cmd_class()
230
231
cmd_obj = ExternalCommand.find_command(cmd_name)
232
if cmd_obj:
233
return cmd_obj
234
235
raise BzrCommandError("unknown command %r" % cmd_name)
236
237
238
class Command(object):
239
"""Base class for commands.
240
241
Commands are the heart of the command-line bzr interface.
242
243
The command object mostly handles the mapping of command-line
244
parameters into one or more bzrlib operations, and of the results
245
into textual output.
246
247
Commands normally don't have any state. All their arguments are
248
passed in to the run method. (Subclasses may take a different
249
policy if the behaviour of the instance needs to depend on e.g. a
250
shell plugin and not just its Python class.)
251
252
The docstring for an actual command should give a single-line
253
summary, then a complete description of the command. A grammar
254
description will be inserted.
255
256
aliases
257
Other accepted names for this command.
258
259
takes_args
260
List of argument forms, marked with whether they are optional,
261
repeated, etc.
262
263
takes_options
264
List of options that may be given for this command.
265
266
hidden
267
If true, this command isn't advertised. This is typically
268
for commands intended for expert users.
269
"""
270
aliases = []
271
272
takes_args = []
273
takes_options = []
274
275
hidden = False
276
277
def __init__(self):
278
"""Construct an instance of this command."""
279
if self.__doc__ == Command.__doc__:
280
warn("No help message set for %r" % self)
281
282
283
def run_argv(self, argv):
284
"""Parse command line and run."""
285
args, opts = parse_args(argv)
286
287
if 'help' in opts: # e.g. bzr add --help
288
from bzrlib.help import help_on_command
289
help_on_command(self.name())
290
return 0
291
292
# check options are reasonable
293
allowed = self.takes_options
294
for oname in opts:
295
if oname not in allowed:
296
raise BzrCommandError("option '--%s' is not allowed for command %r"
297
% (oname, self.name()))
298
299
# mix arguments and options into one dictionary
300
cmdargs = _match_argform(self.name(), self.takes_args, args)
301
cmdopts = {}
302
for k, v in opts.items():
303
cmdopts[k.replace('-', '_')] = v
304
305
all_cmd_args = cmdargs.copy()
306
all_cmd_args.update(cmdopts)
307
308
return self.run(**all_cmd_args)
309
310
311
def run(self):
312
"""Actually run the command.
313
314
This is invoked with the options and arguments bound to
315
keyword parameters.
316
317
Return 0 or None if the command was successful, or a non-zero
318
shell error code if not. It's OK for this method to allow
319
an exception to raise up.
320
"""
321
raise NotImplementedError()
322
323
324
def help(self):
325
"""Return help message for this class."""
326
if self.__doc__ is Command.__doc__:
327
return None
328
return getdoc(self)
329
330
def name(self):
331
return _unsquish_command_name(self.__class__.__name__)
332
333
334
def parse_spec(spec):
335
"""
336
>>> parse_spec(None)
337
[None, None]
338
>>> parse_spec("./")
339
['./', None]
340
>>> parse_spec("../@")
341
['..', -1]
342
>>> parse_spec("../f/@35")
343
['../f', 35]
344
>>> parse_spec('./@revid:john@arbash-meinel.com-20050711044610-3ca0327c6a222f67')
345
['.', 'revid:john@arbash-meinel.com-20050711044610-3ca0327c6a222f67']
346
"""
347
if spec is None:
348
return [None, None]
349
if '/@' in spec:
350
parsed = spec.split('/@')
351
assert len(parsed) == 2
352
if parsed[1] == "":
353
parsed[1] = -1
354
else:
355
try:
356
parsed[1] = int(parsed[1])
357
except ValueError:
358
pass # We can allow stuff like ./@revid:blahblahblah
359
else:
360
assert parsed[1] >=0
361
else:
362
parsed = [spec, None]
363
return parsed
88
from bzrlib.store import ImmutableStore
89
from bzrlib.trace import mutter, note, log_error
90
from bzrlib.errors import bailout, BzrError
91
from bzrlib.osutils import quotefn, pumpfile, isdir, isfile
92
from bzrlib.tree import RevisionTree, EmptyTree, WorkingTree, Tree
93
from bzrlib.revision import Revision
94
from bzrlib import Branch, Inventory, InventoryEntry, ScratchBranch, BZRDIR, \
95
format_date
96
97
BZR_DIFF_FORMAT = "## Bazaar-NG diff, format 0 ##\n"
98
BZR_PATCHNAME_FORMAT = 'cset:sha1:%s'
99
100
## standard representation
101
NONE_STRING = '(none)'
102
EMPTY = 'empty'
103
104
105
## TODO: Perhaps a different version of inventory commands that
106
## returns iterators...
107
108
## TODO: Perhaps an AtomicFile class that writes to a temporary file and then renames.
109
110
## TODO: Some kind of locking on branches. Perhaps there should be a
111
## parameter to the branch object saying whether we want a read or
112
## write lock; release it from destructor. Perhaps don't even need a
113
## read lock to look at immutable objects?
114
115
## TODO: Perhaps make UUIDs predictable in test mode to make it easier
116
## to compare output?
117
118
119
120
121
######################################################################
122
# check status
123
124
125
def cmd_status(all=False):
126
"""Display status summary.
127
128
For each file there is a single line giving its file state and name.
129
The name is that in the current revision unless it is deleted or
130
missing, in which case the old name is shown.
131
132
:todo: Don't show unchanged files unless ``--all`` is given?
133
"""
134
Branch('.').show_status(show_all=all)
135
136
137
138
######################################################################
139
# examining history
140
def cmd_get_revision(revision_id):
141
Branch('.').get_revision(revision_id).write_xml(sys.stdout)
142
143
144
def cmd_get_inventory(inventory_id):
145
"""Return inventory in XML by hash"""
146
Branch('.').get_inventory(inventory_hash).write_xml(sys.stdout)
147
148
149
def cmd_get_revision_inventory(revision_id):
150
"""Output inventory for a revision."""
151
b = Branch('.')
152
b.get_revision_inventory(revision_id).write_xml(sys.stdout)
153
154
155
def cmd_get_file_text(text_id):
156
"""Get contents of a file by hash."""
157
sf = Branch('.').text_store[text_id]
158
pumpfile(sf, sys.stdout)
159
160
161
162
######################################################################
163
# commands
164
165
166
def cmd_revno():
167
"""Show number of revisions on this branch"""
168
print Branch('.').revno()
169
170
171
def cmd_add(file_list, verbose=False):
172
"""Add specified files.
173
174
Fails if the files are already added.
175
"""
176
Branch('.').add(file_list, verbose=verbose)
177
178
179
def cmd_inventory(revision=None):
180
"""Show inventory of the current working copy."""
181
## TODO: Also optionally show a previous inventory
182
## TODO: Format options
183
b = Branch('.')
184
if revision == None:
185
inv = b.read_working_inventory()
186
else:
187
inv = b.get_revision_inventory(b.lookup_revision(revision))
188
189
for path, entry in inv.iter_entries():
190
print '%-50s %s' % (entry.file_id, path)
191
192
193
194
def cmd_info():
195
b = Branch('.')
196
print 'branch format:', b.controlfile('branch-format', 'r').readline().rstrip('\n')
197
print 'revision number:', b.revno()
198
print 'number of versioned files:', len(b.read_working_inventory())
199
200
201
def cmd_remove(file_list, verbose=False):
202
Branch('.').remove(file_list, verbose=verbose)
203
204
205
206
def cmd_file_id(filename):
207
i = Branch('.').read_working_inventory().path2id(filename)
208
if i is None:
209
bailout("%s is not a versioned file" % filename)
210
else:
211
print i
212
213
214
def cmd_find_filename(fileid):
215
n = find_filename(fileid)
216
if n is None:
217
bailout("%s is not a live file id" % fileid)
218
else:
219
print n
220
221
222
def cmd_revision_history():
223
for patchid in Branch('.').revision_history():
224
print patchid
225
226
227
228
def cmd_init():
229
# TODO: Check we're not already in a working directory? At the
230
# moment you'll get an ugly error.
231
232
# TODO: What if we're in a subdirectory of a branch? Would like
233
# to allow that, but then the parent may need to understand that
234
# the children have disappeared, or should they be versioned in
235
# both?
236
237
# TODO: Take an argument/option for branch name.
238
Branch('.', init=True)
239
240
241
def cmd_diff(revision=None):
242
"""Show diff from basis to working copy.
243
244
:todo: Take one or two revision arguments, look up those trees,
245
and diff them.
246
247
:todo: Allow diff across branches.
248
249
:todo: Mangle filenames in diff to be more relevant.
250
251
:todo: Shouldn't be in the cmd function.
252
"""
253
254
b = Branch('.')
255
256
if revision == None:
257
old_tree = b.basis_tree()
258
else:
259
old_tree = b.revision_tree(b.lookup_revision(revision))
260
261
new_tree = b.working_tree()
262
old_inv = old_tree.inventory
263
new_inv = new_tree.inventory
264
265
# TODO: Options to control putting on a prefix or suffix, perhaps as a format string
266
old_label = ''
267
new_label = ''
268
269
DEVNULL = '/dev/null'
270
# Windows users, don't panic about this filename -- it is a
271
# special signal to GNU patch that the file should be created or
272
# deleted respectively.
273
274
# TODO: Generation of pseudo-diffs for added/deleted files could
275
# be usefully made into a much faster special case.
276
277
# TODO: Better to return them in sorted order I think.
278
279
for file_state, fid, old_name, new_name, kind in bzrlib.diff_trees(old_tree, new_tree):
280
d = None
281
282
# Don't show this by default; maybe do it if an option is passed
283
# idlabel = ' {%s}' % fid
284
idlabel = ''
285
286
# FIXME: Something about the diff format makes patch unhappy
287
# with newly-added files.
288
289
def diffit(*a, **kw):
290
sys.stdout.writelines(difflib.unified_diff(*a, **kw))
291
print
292
293
if file_state in ['.', '?', 'I']:
294
continue
295
elif file_state == 'A':
296
print '*** added %s %r' % (kind, new_name)
297
if kind == 'file':
298
diffit([],
299
new_tree.get_file(fid).readlines(),
300
fromfile=DEVNULL,
301
tofile=new_label + new_name + idlabel)
302
elif file_state == 'D':
303
assert isinstance(old_name, types.StringTypes)
304
print '*** deleted %s %r' % (kind, old_name)
305
if kind == 'file':
306
diffit(old_tree.get_file(fid).readlines(), [],
307
fromfile=old_label + old_name + idlabel,
308
tofile=DEVNULL)
309
elif file_state in ['M', 'R']:
310
if file_state == 'M':
311
assert kind == 'file'
312
assert old_name == new_name
313
print '*** modified %s %r' % (kind, new_name)
314
elif file_state == 'R':
315
print '*** renamed %s %r => %r' % (kind, old_name, new_name)
316
317
if kind == 'file':
318
diffit(old_tree.get_file(fid).readlines(),
319
new_tree.get_file(fid).readlines(),
320
fromfile=old_label + old_name + idlabel,
321
tofile=new_label + new_name)
322
else:
323
bailout("can't represent state %s {%s}" % (file_state, fid))
324
325
326
327
def cmd_log():
328
"""Show log of this branch.
329
330
:todo: Options for utc; to show ids; to limit range; etc.
331
"""
332
Branch('.').write_log()
333
334
335
def cmd_ls(revision=None, verbose=False):
336
"""List files in a tree.
337
338
:todo: Take a revision or remote path and list that tree instead.
339
"""
340
b = Branch('.')
341
if revision == None:
342
tree = b.working_tree()
343
else:
344
tree = b.revision_tree(b.lookup_revision(revision))
345
346
for fp, fc, kind, fid in tree.list_files():
347
if verbose:
348
if kind == 'directory':
349
kindch = '/'
350
elif kind == 'file':
351
kindch = ''
352
else:
353
kindch = '???'
354
355
print '%-8s %s%s' % (fc, fp, kindch)
356
else:
357
print fp
358
359
360
361
def cmd_unknowns():
362
"""List unknown files"""
363
for f in Branch('.').unknowns():
364
print quotefn(f)
365
366
367
def cmd_lookup_revision(revno):
368
try:
369
revno = int(revno)
370
except ValueError:
371
bailout("usage: lookup-revision REVNO",
372
["REVNO is a non-negative revision number for this branch"])
373
374
print Branch('.').lookup_revision(revno) or NONE_STRING
375
376
377
378
def cmd_export(revno, dest):
379
"""Export past revision to destination directory."""
380
b = Branch('.')
381
rh = b.lookup_revision(int(revno))
382
t = b.revision_tree(rh)
383
t.export(dest)
384
385
386
387
######################################################################
388
# internal/test commands
389
390
391
def cmd_uuid():
392
"""Print a newly-generated UUID."""
393
print uuid()
394
395
396
397
def cmd_local_time_offset():
398
print bzrlib.osutils.local_time_offset()
399
400
401
402
def cmd_commit(message, verbose=False):
403
Branch('.').commit(message, verbose=verbose)
404
405
406
def cmd_check():
407
"""Check consistency of the branch."""
408
check()
409
410
411
def cmd_is(pred, *rest):
412
"""Test whether PREDICATE is true."""
413
try:
414
cmd_handler = globals()['assert_' + pred.replace('-', '_')]
415
except KeyError:
416
bailout("unknown predicate: %s" % quotefn(pred))
417
418
try:
419
cmd_handler(*rest)
420
except BzrCheckError:
421
# by default we don't print the message so that this can
422
# be used from shell scripts without producing noise
423
sys.exit(1)
424
425
426
def cmd_username():
427
print bzrlib.osutils.username()
428
429
430
def cmd_user_email():
431
print bzrlib.osutils.user_email()
432
433
434
def cmd_gen_revision_id():
435
import time
436
print bzrlib.branch._gen_revision_id(time.time())
437
438
439
def cmd_doctest():
440
"""Run internal doctest suite"""
441
## -v, if present, is seen by doctest; the argument is just here
442
## so our parser doesn't complain
443
444
## TODO: --verbose option
445
446
import bzr, doctest, bzrlib.store
447
bzrlib.trace.verbose = False
448
doctest.testmod(bzr)
449
doctest.testmod(bzrlib.store)
450
doctest.testmod(bzrlib.inventory)
451
doctest.testmod(bzrlib.branch)
452
doctest.testmod(bzrlib.osutils)
453
doctest.testmod(bzrlib.tree)
454
455
# more strenuous tests;
456
import bzrlib.tests
457
doctest.testmod(bzrlib.tests)
458
459
460
######################################################################
461
# help
462
463
464
def cmd_help():
465
# TODO: Specific help for particular commands
466
print __doc__
467
468
469
def cmd_version():
470
print "bzr (bazaar-ng) %s" % __version__
471
print __copyright__
472
print "http://bazaar-ng.org/"
473
print
474
print \
475
"""bzr comes with ABSOLUTELY NO WARRANTY. bzr is free software, and
476
you may use, modify and redistribute it under the terms of the GNU
477
General Public License version 2 or later."""
478
479
480
def cmd_rocks():
481
"""Statement of optimism."""
482
print "it sure does!"
483
484
485
486
######################################################################
487
# main routine
364
488
365
489
366
490
# list of all available options; the rhs can be either None for an
368
492
# the type.
369
493
OPTIONS = {
370
494
'all': None,
371
'diff-options': str,
372
495
'help': None,
373
'file': unicode,
374
'force': None,
375
'format': unicode,
376
'forward': None,
377
496
'message': unicode,
378
'no-recurse': None,
379
'profile': None,
380
'revision': _parse_revision_str,
381
'short': None,
497
'revision': int,
382
498
'show-ids': None,
383
'timezone': str,
384
499
'verbose': None,
385
500
'version': None,
386
'email': None,
387
'unchanged': None,
388
'update': None,
389
'long': None,
390
'root': str,
391
'no-backup': None,
392
'merge-type': get_merge_type,
393
'pattern': str,
394
501
}
395
502
396
503
SHORT_OPTIONS = {
397
'F': 'file',
398
'h': 'help',
399
504
'm': 'message',
400
505
'r': 'revision',
401
506
'v': 'verbose',
402
'l': 'long',
403
507
}
404
508
509
# List of options that apply to particular commands; commands not
510
# listed take none.
511
cmd_options = {
512
'add': ['verbose'],
513
'commit': ['message', 'verbose'],
514
'diff': ['revision'],
515
'inventory': ['revision'],
516
'ls': ['revision', 'verbose'],
517
'status': ['all'],
518
'log': ['show-ids'],
519
'remove': ['verbose'],
520
}
521
522
523
cmd_args = {
524
'init': [],
525
'add': ['file+'],
526
'commit': [],
527
'diff': [],
528
'file-id': ['filename'],
529
'get-file-text': ['text_id'],
530
'get-inventory': ['inventory_id'],
531
'get-revision': ['revision_id'],
532
'get-revision-inventory': ['revision_id'],
533
'log': [],
534
'lookup-revision': ['revno'],
535
'export': ['revno', 'dest'],
536
'remove': ['file+'],
537
'status': [],
538
}
539
405
540
406
541
def parse_args(argv):
407
542
"""Parse command line.
411
546
lookup table, something about the available options, what optargs
412
547
they take, and which commands will accept them.
413
548
414
>>> parse_args('--help'.split())
549
>>> parse_args('bzr --help'.split())
415
550
([], {'help': True})
416
>>> parse_args('help -- --invalidcmd'.split())
417
(['help', '--invalidcmd'], {})
418
>>> parse_args('--version'.split())
551
>>> parse_args('bzr --version'.split())
419
552
([], {'version': True})
420
>>> parse_args('status --all'.split())
553
>>> parse_args('bzr status --all'.split())
421
554
(['status'], {'all': True})
422
>>> parse_args('commit --message=biter'.split())
423
(['commit'], {'message': u'biter'})
424
>>> parse_args('log -r 500'.split())
425
(['log'], {'revision': [500]})
426
>>> parse_args('log -r500..600'.split())
427
(['log'], {'revision': [500, 600]})
428
>>> parse_args('log -vr500..600'.split())
429
(['log'], {'verbose': True, 'revision': [500, 600]})
430
>>> parse_args('log -rv500..600'.split()) #the r takes an argument
431
(['log'], {'revision': ['v500', 600]})
432
555
"""
433
556
args = []
434
557
opts = {}
435
558
436
argsover = False
437
while argv:
438
a = argv.pop(0)
439
if not argsover and a[0] == '-':
440
# option names must not be unicode
441
a = str(a)
442
optarg = None
559
# TODO: Maybe handle '--' to end options?
560
561
it = iter(argv[1:])
562
while it:
563
a = it.next()
564
if a[0] == '-':
443
565
if a[1] == '-':
444
if a == '--':
445
# We've received a standalone -- No more flags
446
argsover = True
447
continue
448
566
mutter(" got option %r" % a)
449
if '=' in a:
450
optname, optarg = a[2:].split('=', 1)
451
else:
452
optname = a[2:]
567
optname = a[2:]
453
568
if optname not in OPTIONS:
454
raise BzrError('unknown long option %r' % a)
569
bailout('unknown long option %r' % a)
455
570
else:
456
571
shortopt = a[1:]
457
if shortopt in SHORT_OPTIONS:
458
# Multi-character options must have a space to delimit
459
# their value
460
optname = SHORT_OPTIONS[shortopt]
461
else:
462
# Single character short options, can be chained,
463
# and have their value appended to their name
464
shortopt = a[1:2]
465
if shortopt not in SHORT_OPTIONS:
466
# We didn't find the multi-character name, and we
467
# didn't find the single char name
468
raise BzrError('unknown short option %r' % a)
469
optname = SHORT_OPTIONS[shortopt]
470
471
if a[2:]:
472
# There are extra things on this option
473
# see if it is the value, or if it is another
474
# short option
475
optargfn = OPTIONS[optname]
476
if optargfn is None:
477
# This option does not take an argument, so the
478
# next entry is another short option, pack it back
479
# into the list
480
argv.insert(0, '-' + a[2:])
481
else:
482
# This option takes an argument, so pack it
483
# into the array
484
optarg = a[2:]
572
if shortopt not in SHORT_OPTIONS:
573
bailout('unknown short option %r' % a)
574
optname = SHORT_OPTIONS[shortopt]
485
575
486
576
if optname in opts:
487
577
# XXX: Do we ever want to support this, e.g. for -r?
488
raise BzrError('repeated option %r' % a)
489
578
bailout('repeated option %r' % a)
490
579
optargfn = OPTIONS[optname]
491
580
if optargfn:
492
if optarg == None:
493
if not argv:
494
raise BzrError('option %r needs an argument' % a)
495
else:
496
optarg = argv.pop(0)
497
opts[optname] = optargfn(optarg)
581
if not it:
582
bailout('option %r needs an argument' % a)
583
opts[optname] = optargfn(it.next())
584
mutter(" option argument %r" % opts[optname])
498
585
else:
499
if optarg != None:
500
raise BzrError('option %r takes no argument' % optname)
586
# takes no option argument
501
587
opts[optname] = True
588
elif a[:1] == '-':
589
bailout('unknown short option %r' % a)
502
590
else:
503
591
args.append(a)
504
592
506
594
507
595
508
596
597
def _match_args(cmd, args):
598
"""Check non-option arguments match required pattern.
509
599
510
def _match_argform(cmd, takes_args, args):
600
>>> _match_args('status', ['asdasdsadasd'])
601
Traceback (most recent call last):
602
...
603
BzrError: ("extra arguments to command status: ['asdasdsadasd']", [])
604
>>> _match_args('add', ['asdasdsadasd'])
605
{'file_list': ['asdasdsadasd']}
606
>>> _match_args('add', 'abc def gj'.split())
607
{'file_list': ['abc', 'def', 'gj']}
608
"""
609
# match argument pattern
610
argform = cmd_args.get(cmd, [])
511
611
argdict = {}
512
513
# step through args and takes_args, allowing appropriate 0-many matches
514
for ap in takes_args:
612
# TODO: Need a way to express 'cp SRC... DEST', where it matches
613
# all but one.
614
for ap in argform:
515
615
argname = ap[:-1]
516
616
if ap[-1] == '?':
517
if args:
518
argdict[argname] = args.pop(0)
519
elif ap[-1] == '*': # all remaining arguments
520
if args:
521
argdict[argname + '_list'] = args[:]
522
args = []
523
else:
524
argdict[argname + '_list'] = None
617
assert 0
618
elif ap[-1] == '*':
619
assert 0
525
620
elif ap[-1] == '+':
526
621
if not args:
527
raise BzrCommandError("command %r needs one or more %s"
622
bailout("command %r needs one or more %s"
528
623
% (cmd, argname.upper()))
529
624
else:
530
625
argdict[argname + '_list'] = args[:]
531
626
args = []
532
elif ap[-1] == '$': # all but one
533
if len(args) < 2:
534
raise BzrCommandError("command %r needs one or more %s"
535
% (cmd, argname.upper()))
536
argdict[argname + '_list'] = args[:-1]
537
args[:-1] = []
538
627
else:
539
628
# just a plain arg
540
629
argname = ap
541
630
if not args:
542
raise BzrCommandError("command %r requires argument %s"
631
bailout("command %r requires argument %s"
543
632
% (cmd, argname.upper()))
544
633
else:
545
634
argdict[argname] = args.pop(0)
546
635
547
636
if args:
548
raise BzrCommandError("extra argument to command %s: %s"
549
% (cmd, args[0]))
637
bailout("extra arguments to command %s: %r"
638
% (cmd, args))
550
639
551
640
return argdict
552
641
553
642
554
643
555
def apply_profiled(the_callable, *args, **kwargs):
556
import hotshot
557
import tempfile
558
pffileno, pfname = tempfile.mkstemp()
559
try:
560
prof = hotshot.Profile(pfname)
561
try:
562
ret = prof.runcall(the_callable, *args, **kwargs) or 0
563
finally:
564
prof.close()
565
566
import hotshot.stats
567
stats = hotshot.stats.load(pfname)
568
#stats.strip_dirs()
569
stats.sort_stats('time')
570
## XXX: Might like to write to stderr or the trace file instead but
571
## print_stats seems hardcoded to stdout
572
stats.print_stats(20)
573
574
return ret
575
finally:
576
os.close(pffileno)
577
os.remove(pfname)
578
579
580
644
def run_bzr(argv):
581
645
"""Execute a command.
582
646
583
647
This is similar to main(), but without all the trappings for
584
logging and error handling.
585
586
argv
587
The command-line arguments, without the program name from argv[0]
588
589
Returns a command status or raises an exception.
590
591
Special master options: these must come before the command because
592
they control how the command is interpreted.
593
594
--no-plugins
595
Do not load plugin modules at all
596
597
--builtin
598
Only use builtin commands. (Plugins are still allowed to change
599
other behaviour.)
600
601
--profile
602
Run under the Python profiler.
648
logging and error handling.
603
649
"""
604
605
argv = [a.decode(bzrlib.user_encoding) for a in argv]
606
607
opt_profile = opt_no_plugins = opt_builtin = False
608
609
# --no-plugins is handled specially at a very early stage. We need
610
# to load plugins before doing other command parsing so that they
611
# can override commands, but this needs to happen first.
612
613
for a in argv:
614
if a == '--profile':
615
opt_profile = True
616
elif a == '--no-plugins':
617
opt_no_plugins = True
618
elif a == '--builtin':
619
opt_builtin = True
620
else:
621
break
622
argv.remove(a)
623
624
if (not argv) or (argv[0] == '--help'):
625
from bzrlib.help import help
626
if len(argv) > 1:
627
help(argv[1])
628
else:
629
help()
630
return 0
631
632
if argv[0] == '--version':
633
from bzrlib.builtins import show_version
634
show_version()
635
return 0
636
637
if not opt_no_plugins:
638
from bzrlib.plugin import load_plugins
639
load_plugins()
640
641
cmd = str(argv.pop(0))
642
643
cmd_obj = get_cmd_object(cmd, plugins_override=not opt_builtin)
644
645
if opt_profile:
646
ret = apply_profiled(cmd_obj.run_argv, argv)
647
else:
648
ret = cmd_obj.run_argv(argv)
649
return ret or 0
650
try:
651
args, opts = parse_args(argv)
652
if 'help' in opts:
653
# TODO: pass down other arguments in case they asked for
654
# help on a command name?
655
cmd_help()
656
return 0
657
elif 'version' in opts:
658
cmd_version()
659
return 0
660
cmd = args.pop(0)
661
except IndexError:
662
log_error('usage: bzr COMMAND\n')
663
log_error(' try "bzr help"\n')
664
return 1
665
666
try:
667
cmd_handler = globals()['cmd_' + cmd.replace('-', '_')]
668
except KeyError:
669
bailout("unknown command " + `cmd`)
670
671
# TODO: special --profile option to turn on the Python profiler
672
673
# check options are reasonable
674
allowed = cmd_options.get(cmd, [])
675
for oname in opts:
676
if oname not in allowed:
677
bailout("option %r is not allowed for command %r"
678
% (oname, cmd))
679
680
cmdargs = _match_args(cmd, args)
681
cmdargs.update(opts)
682
683
ret = cmd_handler(**cmdargs) or 0
684
650
685
651
686
652
687
def main(argv):
653
import bzrlib.ui
654
bzrlib.trace.log_startup(argv)
655
bzrlib.ui.ui_factory = bzrlib.ui.TextUIFactory()
688
## TODO: Handle command-line options; probably know what options are valid for
689
## each command
690
691
## TODO: If the arguments are wrong, give a usage message rather
692
## than just a backtrace.
656
693
657
694
try:
658
try:
659
return run_bzr(argv[1:])
660
finally:
661
# do this here inside the exception wrappers to catch EPIPE
662
sys.stdout.flush()
663
except BzrCommandError, e:
664
# command line syntax error, etc
665
log_error(str(e))
666
return 1
695
t = bzrlib.trace._tracefile
696
t.write('-' * 60 + '\n')
697
t.write('bzr invoked at %s\n' % format_date(time.time()))
698
t.write(' by %s on %s\n' % (bzrlib.osutils.username(), socket.gethostname()))
699
t.write(' arguments: %r\n' % argv)
700
701
starttime = os.times()[4]
702
703
import platform
704
t.write(' platform: %s\n' % platform.platform())
705
t.write(' python: %s\n' % platform.python_version())
706
707
ret = run_bzr(argv)
708
709
times = os.times()
710
mutter("finished, %.3fu/%.3fs cpu, %.3fu/%.3fs cum"
711
% times[:4])
712
mutter(" %.3f elapsed" % (times[4] - starttime))
713
714
return ret
667
715
except BzrError, e:
668
bzrlib.trace.log_exception()
716
log_error('bzr: error: ' + e.args[0] + '\n')
717
if len(e.args) > 1:
718
for h in e.args[1]:
719
log_error(' ' + h + '\n')
669
720
return 1
670
except AssertionError, e:
671
bzrlib.trace.log_exception('assertion failed: ' + str(e))
672
return 3
673
except KeyboardInterrupt, e:
674
bzrlib.trace.note('interrupted')
675
return 2
676
721
except Exception, e:
677
import errno
678
if (isinstance(e, IOError)
679
and hasattr(e, 'errno')
680
and e.errno == errno.EPIPE):
681
bzrlib.trace.note('broken pipe')
682
return 2
683
else:
684
bzrlib.trace.log_exception()
685
return 2
722
log_error('bzr: exception: %s\n' % e)
723
log_error(' see .bzr.log for details\n')
724
traceback.print_exc(None, bzrlib.trace._tracefile)
725
traceback.print_exc(None, sys.stderr)
726
return 1
727
728
# TODO: Maybe nicer handling of IOError?
729
686
730
687
731
688
732
if __name__ == '__main__':
689
733
sys.exit(main(sys.argv))
734
##import profile
735
##profile.run('main(sys.argv)')
736
Loggerhead is a web-based interface for Breezy
Version: 2.0.1