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