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