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