« back to all changes in this revision
Viewing changes to bzrlib/commands.py
- browse files at revision 138
- compare with another revision
- download diff
- download tarball
- view history from revision 138
- Committer: mbp at sourcefrog
- Date: 2005-03-29 06:58:11 UTC
- Revision ID: mbp@sourcefrog.net-20050329065811-1a9363119ad79447
remove parallel tree from inventory;
store children directly in InventoryEntry
store children directly in InventoryEntry
- 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
29
import sys
30
import os
31
from warnings import warn
32
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
33
72
34
73
import bzrlib
35
import bzrlib.trace
36
from bzrlib.trace import mutter, note, log_error, warning
37
from bzrlib.errors import BzrError, BzrCheckError, BzrCommandError
38
from bzrlib.branch import find_branch
39
from bzrlib import BZRDIR
40
41
plugin_cmds = {}
42
43
44
def register_command(cmd):
45
"Utility function to help register a command"
46
global plugin_cmds
47
k = cmd.__name__
48
if k.startswith("cmd_"):
49
k_unsquished = _unsquish_command_name(k)
50
else:
51
k_unsquished = k
52
if not plugin_cmds.has_key(k_unsquished):
53
plugin_cmds[k_unsquished] = cmd
54
mutter('registered plugin command %s', k_unsquished)
55
else:
56
log_error('Two plugins defined the same command: %r' % k)
57
log_error('Not loading the one in %r' % sys.modules[cmd.__module__])
58
59
60
def _squish_command_name(cmd):
61
return 'cmd_' + cmd.replace('-', '_')
62
63
64
def _unsquish_command_name(cmd):
65
assert cmd.startswith("cmd_")
66
return cmd[4:].replace('_','-')
67
68
69
def _parse_revision_str(revstr):
70
"""This handles a revision string -> revno.
71
72
This always returns a list. The list will have one element for
73
74
It supports integers directly, but everything else it
75
defers for passing to Branch.get_revision_info()
76
77
>>> _parse_revision_str('234')
78
[234]
79
>>> _parse_revision_str('234..567')
80
[234, 567]
81
>>> _parse_revision_str('..')
82
[None, None]
83
>>> _parse_revision_str('..234')
84
[None, 234]
85
>>> _parse_revision_str('234..')
86
[234, None]
87
>>> _parse_revision_str('234..456..789') # Maybe this should be an error
88
[234, 456, 789]
89
>>> _parse_revision_str('234....789') # Error?
90
[234, None, 789]
91
>>> _parse_revision_str('revid:test@other.com-234234')
92
['revid:test@other.com-234234']
93
>>> _parse_revision_str('revid:test@other.com-234234..revid:test@other.com-234235')
94
['revid:test@other.com-234234', 'revid:test@other.com-234235']
95
>>> _parse_revision_str('revid:test@other.com-234234..23')
96
['revid:test@other.com-234234', 23]
97
>>> _parse_revision_str('date:2005-04-12')
98
['date:2005-04-12']
99
>>> _parse_revision_str('date:2005-04-12 12:24:33')
100
['date:2005-04-12 12:24:33']
101
>>> _parse_revision_str('date:2005-04-12T12:24:33')
102
['date:2005-04-12T12:24:33']
103
>>> _parse_revision_str('date:2005-04-12,12:24:33')
104
['date:2005-04-12,12:24:33']
105
>>> _parse_revision_str('-5..23')
106
[-5, 23]
107
>>> _parse_revision_str('-5')
108
[-5]
109
>>> _parse_revision_str('123a')
110
['123a']
111
>>> _parse_revision_str('abc')
112
['abc']
113
"""
114
import re
115
old_format_re = re.compile('\d*:\d*')
116
m = old_format_re.match(revstr)
117
if m:
118
warning('Colon separator for revision numbers is deprecated.'
119
' Use .. instead')
120
revs = []
121
for rev in revstr.split(':'):
122
if rev:
123
revs.append(int(rev))
124
else:
125
revs.append(None)
126
return revs
127
revs = []
128
for x in revstr.split('..'):
129
if not x:
130
revs.append(None)
131
else:
132
try:
133
revs.append(int(x))
134
except ValueError:
135
revs.append(x)
136
return revs
137
138
139
def get_merge_type(typestring):
140
"""Attempt to find the merge class/factory associated with a string."""
141
from merge import merge_types
142
try:
143
return merge_types[typestring][0]
144
except KeyError:
145
templ = '%s%%7s: %%s' % (' '*12)
146
lines = [templ % (f[0], f[1][1]) for f in merge_types.iteritems()]
147
type_list = '\n'.join(lines)
148
msg = "No known merge type %s. Supported types are:\n%s" %\
149
(typestring, type_list)
150
raise BzrCommandError(msg)
151
152
153
def _builtin_commands():
154
import bzrlib.builtins
155
r = {}
156
builtins = bzrlib.builtins.__dict__
157
for name in builtins:
158
if name.startswith("cmd_"):
159
real_name = _unsquish_command_name(name)
160
r[real_name] = builtins[name]
161
return r
162
163
164
165
def builtin_command_names():
166
"""Return list of builtin command names."""
167
return _builtin_commands().keys()
168
169
170
def plugin_command_names():
171
return plugin_cmds.keys()
172
173
174
def _get_cmd_dict(plugins_override=True):
175
"""Return name->class mapping for all commands."""
176
d = _builtin_commands()
177
if plugins_override:
178
d.update(plugin_cmds)
179
return d
180
181
182
def get_all_cmds(plugins_override=True):
183
"""Return canonical name and class for all registered commands."""
184
for k, v in _get_cmd_dict(plugins_override=plugins_override).iteritems():
185
yield k,v
186
187
188
def get_cmd_object(cmd_name, plugins_override=True):
189
"""Return the canonical name and command class for a command.
190
191
plugins_override
192
If true, plugin commands can override builtins.
193
"""
194
from bzrlib.externalcommand import ExternalCommand
195
196
cmd_name = str(cmd_name) # not unicode
197
198
# first look up this command under the specified name
199
cmds = _get_cmd_dict(plugins_override=plugins_override)
200
try:
201
return cmds[cmd_name]()
202
except KeyError:
203
pass
204
205
# look for any command which claims this as an alias
206
for real_cmd_name, cmd_class in cmds.iteritems():
207
if cmd_name in cmd_class.aliases:
208
return cmd_class()
209
210
cmd_obj = ExternalCommand.find_command(cmd_name)
211
if cmd_obj:
212
return cmd_obj
213
214
raise BzrCommandError("unknown command %r" % cmd_name)
215
216
217
class Command(object):
218
"""Base class for commands.
219
220
Commands are the heart of the command-line bzr interface.
221
222
The command object mostly handles the mapping of command-line
223
parameters into one or more bzrlib operations, and of the results
224
into textual output.
225
226
Commands normally don't have any state. All their arguments are
227
passed in to the run method. (Subclasses may take a different
228
policy if the behaviour of the instance needs to depend on e.g. a
229
shell plugin and not just its Python class.)
230
231
The docstring for an actual command should give a single-line
232
summary, then a complete description of the command. A grammar
233
description will be inserted.
234
235
aliases
236
Other accepted names for this command.
237
238
takes_args
239
List of argument forms, marked with whether they are optional,
240
repeated, etc.
241
242
takes_options
243
List of options that may be given for this command.
244
245
hidden
246
If true, this command isn't advertised. This is typically
247
for commands intended for expert users.
248
"""
249
aliases = []
250
251
takes_args = []
252
takes_options = []
253
254
hidden = False
255
256
def __init__(self):
257
"""Construct an instance of this command."""
258
if self.__doc__ == Command.__doc__:
259
warn("No help message set for %r" % self)
260
261
262
def run_argv(self, argv):
263
"""Parse command line and run."""
264
args, opts = parse_args(argv)
265
266
if 'help' in opts: # e.g. bzr add --help
267
from bzrlib.help import help_on_command
268
help_on_command(self.name())
269
return 0
270
271
# check options are reasonable
272
allowed = self.takes_options
273
for oname in opts:
274
if oname not in allowed:
275
raise BzrCommandError("option '--%s' is not allowed for command %r"
276
% (oname, self.name()))
277
278
# mix arguments and options into one dictionary
279
cmdargs = _match_argform(self.name(), self.takes_args, args)
280
cmdopts = {}
281
for k, v in opts.items():
282
cmdopts[k.replace('-', '_')] = v
283
284
all_cmd_args = cmdargs.copy()
285
all_cmd_args.update(cmdopts)
286
287
return self.run(**all_cmd_args)
288
289
290
def run(self):
291
"""Actually run the command.
292
293
This is invoked with the options and arguments bound to
294
keyword parameters.
295
296
Return 0 or None if the command was successful, or a non-zero
297
shell error code if not. It's OK for this method to allow
298
an exception to raise up.
299
"""
300
raise NotImplementedError()
301
302
303
def help(self):
304
"""Return help message for this class."""
305
if self.__doc__ is Command.__doc__:
306
return None
307
return getdoc(self)
308
309
def name(self):
310
return _unsquish_command_name(self.__class__.__name__)
311
312
313
def parse_spec(spec):
314
"""
315
>>> parse_spec(None)
316
[None, None]
317
>>> parse_spec("./")
318
['./', None]
319
>>> parse_spec("../@")
320
['..', -1]
321
>>> parse_spec("../f/@35")
322
['../f', 35]
323
>>> parse_spec('./@revid:john@arbash-meinel.com-20050711044610-3ca0327c6a222f67')
324
['.', 'revid:john@arbash-meinel.com-20050711044610-3ca0327c6a222f67']
325
"""
326
if spec is None:
327
return [None, None]
328
if '/@' in spec:
329
parsed = spec.split('/@')
330
assert len(parsed) == 2
331
if parsed[1] == "":
332
parsed[1] = -1
333
else:
334
try:
335
parsed[1] = int(parsed[1])
336
except ValueError:
337
pass # We can allow stuff like ./@revid:blahblahblah
338
else:
339
assert parsed[1] >=0
340
else:
341
parsed = [spec, None]
342
return parsed
343
344
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
"""info: Show statistical information for this branch
200
201
usage: bzr info"""
202
import info
203
info.show_info(Branch('.'))
204
205
206
207
def cmd_remove(file_list, verbose=False):
208
b = Branch(file_list[0])
209
b.remove([b.relpath(f) for f in file_list], verbose=verbose)
210
211
212
213
def cmd_file_id(filename):
214
b = Branch(filename)
215
i = b.inventory.path2id(b.relpath(filename))
216
if i is None:
217
bailout("%s is not a versioned file" % filename)
218
else:
219
print i
220
221
222
def cmd_find_filename(fileid):
223
n = find_filename(fileid)
224
if n is None:
225
bailout("%s is not a live file id" % fileid)
226
else:
227
print n
228
229
230
def cmd_revision_history():
231
for patchid in Branch('.').revision_history():
232
print patchid
233
234
235
236
def cmd_init():
237
# TODO: Check we're not already in a working directory? At the
238
# moment you'll get an ugly error.
239
240
# TODO: What if we're in a subdirectory of a branch? Would like
241
# to allow that, but then the parent may need to understand that
242
# the children have disappeared, or should they be versioned in
243
# both?
244
245
# TODO: Take an argument/option for branch name.
246
Branch('.', init=True)
247
248
249
def cmd_diff(revision=None):
250
"""bzr diff: Show differences in working tree.
251
252
usage: bzr diff [-r REV]
253
254
--revision REV
255
Show changes since REV, rather than predecessor.
256
257
TODO: Given two revision arguments, show the difference between them.
258
259
TODO: Allow diff across branches.
260
261
TODO: Option to use external diff command; could be GNU diff, wdiff,
262
or a graphical diff.
263
264
TODO: Diff selected files.
265
"""
266
267
## TODO: Shouldn't be in the cmd function.
268
269
b = Branch('.')
270
271
if revision == None:
272
old_tree = b.basis_tree()
273
else:
274
old_tree = b.revision_tree(b.lookup_revision(revision))
275
276
new_tree = b.working_tree()
277
old_inv = old_tree.inventory
278
new_inv = new_tree.inventory
279
280
# TODO: Options to control putting on a prefix or suffix, perhaps as a format string
281
old_label = ''
282
new_label = ''
283
284
DEVNULL = '/dev/null'
285
# Windows users, don't panic about this filename -- it is a
286
# special signal to GNU patch that the file should be created or
287
# deleted respectively.
288
289
# TODO: Generation of pseudo-diffs for added/deleted files could
290
# be usefully made into a much faster special case.
291
292
# TODO: Better to return them in sorted order I think.
293
294
for file_state, fid, old_name, new_name, kind in bzrlib.diff_trees(old_tree, new_tree):
295
d = None
296
297
# Don't show this by default; maybe do it if an option is passed
298
# idlabel = ' {%s}' % fid
299
idlabel = ''
300
301
# FIXME: Something about the diff format makes patch unhappy
302
# with newly-added files.
303
304
def diffit(*a, **kw):
305
sys.stdout.writelines(difflib.unified_diff(*a, **kw))
306
print
307
308
if file_state in ['.', '?', 'I']:
309
continue
310
elif file_state == 'A':
311
print '*** added %s %r' % (kind, new_name)
312
if kind == 'file':
313
diffit([],
314
new_tree.get_file(fid).readlines(),
315
fromfile=DEVNULL,
316
tofile=new_label + new_name + idlabel)
317
elif file_state == 'D':
318
assert isinstance(old_name, types.StringTypes)
319
print '*** deleted %s %r' % (kind, old_name)
320
if kind == 'file':
321
diffit(old_tree.get_file(fid).readlines(), [],
322
fromfile=old_label + old_name + idlabel,
323
tofile=DEVNULL)
324
elif file_state in ['M', 'R']:
325
if file_state == 'M':
326
assert kind == 'file'
327
assert old_name == new_name
328
print '*** modified %s %r' % (kind, new_name)
329
elif file_state == 'R':
330
print '*** renamed %s %r => %r' % (kind, old_name, new_name)
331
332
if kind == 'file':
333
diffit(old_tree.get_file(fid).readlines(),
334
new_tree.get_file(fid).readlines(),
335
fromfile=old_label + old_name + idlabel,
336
tofile=new_label + new_name)
337
else:
338
bailout("can't represent state %s {%s}" % (file_state, fid))
339
340
341
342
def cmd_deleted(show_ids=False):
343
"""List files deleted in the working tree.
344
345
TODO: Show files deleted since a previous revision, or between two revisions.
346
"""
347
b = Branch('.')
348
old = b.basis_tree()
349
new = b.working_tree()
350
351
for path, ie in old.inventory.iter_entries():
352
if not new.has_id(ie.file_id):
353
if show_ids:
354
print '%-50s %s' % (path, ie.file_id)
355
else:
356
print path
357
358
359
360
361
def cmd_root(filename=None):
362
"""Print the branch root."""
363
print bzrlib.branch.find_branch_root(filename)
364
365
366
def cmd_log(timezone='original'):
367
"""Show log of this branch.
368
369
:todo: Options for utc; to show ids; to limit range; etc.
370
"""
371
Branch('.').write_log(show_timezone=timezone)
372
373
374
def cmd_ls(revision=None, verbose=False):
375
"""List files in a tree.
376
377
:todo: Take a revision or remote path and list that tree instead.
378
"""
379
b = Branch('.')
380
if revision == None:
381
tree = b.working_tree()
382
else:
383
tree = b.revision_tree(b.lookup_revision(revision))
384
385
for fp, fc, kind, fid in tree.list_files():
386
if verbose:
387
if kind == 'directory':
388
kindch = '/'
389
elif kind == 'file':
390
kindch = ''
391
else:
392
kindch = '???'
393
394
print '%-8s %s%s' % (fc, fp, kindch)
395
else:
396
print fp
397
398
399
400
def cmd_unknowns():
401
"""List unknown files"""
402
for f in Branch('.').unknowns():
403
print quotefn(f)
404
405
406
407
def cmd_ignored(verbose=True):
408
"""List ignored files and the patterns that matched them.
409
"""
410
tree = Branch('.').working_tree()
411
for path, file_class, kind, id in tree.list_files():
412
if file_class != 'I':
413
continue
414
## XXX: Slightly inefficient since this was already calculated
415
pat = tree.is_ignored(path)
416
print '%-50s %s' % (path, pat)
417
418
419
420
def cmd_lookup_revision(revno):
421
try:
422
revno = int(revno)
423
except ValueError:
424
bailout("usage: lookup-revision REVNO",
425
["REVNO is a non-negative revision number for this branch"])
426
427
print Branch('.').lookup_revision(revno) or NONE_STRING
428
429
430
431
def cmd_export(revno, dest):
432
"""Export past revision to destination directory."""
433
b = Branch('.')
434
rh = b.lookup_revision(int(revno))
435
t = b.revision_tree(rh)
436
t.export(dest)
437
438
439
440
######################################################################
441
# internal/test commands
442
443
444
def cmd_uuid():
445
"""Print a newly-generated UUID."""
446
print bzrlib.osutils.uuid()
447
448
449
450
def cmd_local_time_offset():
451
print bzrlib.osutils.local_time_offset()
452
453
454
455
def cmd_commit(message=None, verbose=False):
456
"""Commit changes to a new revision.
457
458
--message MESSAGE
459
Description of changes in this revision; free form text.
460
It is recommended that the first line be a single-sentence
461
summary.
462
--verbose
463
Show status of changed files,
464
465
TODO: Commit only selected files.
466
467
TODO: Run hooks on tree to-be-committed, and after commit.
468
469
TODO: Strict commit that fails if there are unknown or deleted files.
470
"""
471
472
if not message:
473
bailout("please specify a commit message")
474
Branch('.').commit(message, verbose=verbose)
475
476
477
def cmd_check(dir='.'):
478
"""check: Consistency check of branch history.
479
480
usage: bzr check [-v] [BRANCH]
481
482
options:
483
--verbose, -v Show progress of checking.
484
485
This command checks various invariants about the branch storage to
486
detect data corruption or bzr bugs.
487
"""
488
import bzrlib.check
489
bzrlib.check.check(Branch(dir, find_root=False))
490
491
492
def cmd_is(pred, *rest):
493
"""Test whether PREDICATE is true."""
494
try:
495
cmd_handler = globals()['assert_' + pred.replace('-', '_')]
496
except KeyError:
497
bailout("unknown predicate: %s" % quotefn(pred))
498
499
try:
500
cmd_handler(*rest)
501
except BzrCheckError:
502
# by default we don't print the message so that this can
503
# be used from shell scripts without producing noise
504
sys.exit(1)
505
506
507
def cmd_username():
508
print bzrlib.osutils.username()
509
510
511
def cmd_user_email():
512
print bzrlib.osutils.user_email()
513
514
515
def cmd_gen_revision_id():
516
import time
517
print bzrlib.branch._gen_revision_id(time.time())
518
519
520
def cmd_selftest(verbose=False):
521
"""Run internal test suite"""
522
## -v, if present, is seen by doctest; the argument is just here
523
## so our parser doesn't complain
524
525
## TODO: --verbose option
526
527
failures, tests = 0, 0
528
529
import doctest, bzrlib.store, bzrlib.tests
530
bzrlib.trace.verbose = False
531
532
for m in bzrlib.store, bzrlib.inventory, bzrlib.branch, bzrlib.osutils, \
533
bzrlib.tree, bzrlib.tests, bzrlib.commands, bzrlib.add:
534
mf, mt = doctest.testmod(m)
535
failures += mf
536
tests += mt
537
print '%-40s %3d tests' % (m.__name__, mt),
538
if mf:
539
print '%3d FAILED!' % mf
540
else:
541
print
542
543
print '%-40s %3d tests' % ('total', tests),
544
if failures:
545
print '%3d FAILED!' % failures
546
else:
547
print
548
549
550
551
# deprecated
552
cmd_doctest = cmd_selftest
553
554
555
######################################################################
556
# help
557
558
559
def cmd_help(topic=None):
560
if topic == None:
561
print __doc__
562
return
563
564
# otherwise, maybe the name of a command?
565
try:
566
cmdfn = globals()['cmd_' + topic.replace('-', '_')]
567
except KeyError:
568
bailout("no help for %r" % topic)
569
570
doc = cmdfn.__doc__
571
if doc == None:
572
bailout("sorry, no detailed help yet for %r" % topic)
573
574
print doc
575
576
577
578
579
def cmd_version():
580
print "bzr (bazaar-ng) %s" % bzrlib.__version__
581
print bzrlib.__copyright__
582
print "http://bazaar-ng.org/"
583
print
584
print \
585
"""bzr comes with ABSOLUTELY NO WARRANTY. bzr is free software, and
586
you may use, modify and redistribute it under the terms of the GNU
587
General Public License version 2 or later."""
588
589
590
def cmd_rocks():
591
"""Statement of optimism."""
592
print "it sure does!"
593
594
595
596
######################################################################
597
# main routine
345
598
346
599
347
600
# list of all available options; the rhs can be either None for an
349
602
# the type.
350
603
OPTIONS = {
351
604
'all': None,
352
'diff-options': str,
353
605
'help': None,
354
'file': unicode,
355
'force': None,
356
'format': unicode,
357
'forward': None,
358
606
'message': unicode,
359
'no-recurse': None,
360
607
'profile': None,
361
'revision': _parse_revision_str,
362
'short': None,
608
'revision': int,
363
609
'show-ids': None,
364
610
'timezone': str,
365
611
'verbose': None,
366
612
'version': None,
367
'email': None,
368
'unchanged': None,
369
'update': None,
370
'long': None,
371
'root': str,
372
'no-backup': None,
373
'merge-type': get_merge_type,
374
'pattern': str,
375
613
}
376
614
377
615
SHORT_OPTIONS = {
378
'F': 'file',
379
'h': 'help',
380
616
'm': 'message',
381
617
'r': 'revision',
382
618
'v': 'verbose',
383
'l': 'long',
384
619
}
385
620
621
# List of options that apply to particular commands; commands not
622
# listed take none.
623
cmd_options = {
624
'add': ['verbose'],
625
'commit': ['message', 'verbose'],
626
'deleted': ['show-ids'],
627
'diff': ['revision'],
628
'inventory': ['revision'],
629
'log': ['timezone'],
630
'ls': ['revision', 'verbose'],
631
'remove': ['verbose'],
632
'status': ['all'],
633
}
634
635
636
cmd_args = {
637
'add': ['file+'],
638
'commit': [],
639
'diff': [],
640
'export': ['revno', 'dest'],
641
'file-id': ['filename'],
642
'get-file-text': ['text_id'],
643
'get-inventory': ['inventory_id'],
644
'get-revision': ['revision_id'],
645
'get-revision-inventory': ['revision_id'],
646
'help': ['topic?'],
647
'init': [],
648
'log': [],
649
'lookup-revision': ['revno'],
650
'relpath': ['filename'],
651
'remove': ['file+'],
652
'root': ['filename?'],
653
'status': [],
654
}
655
386
656
387
657
def parse_args(argv):
388
658
"""Parse command line.
394
664
395
665
>>> parse_args('--help'.split())
396
666
([], {'help': True})
397
>>> parse_args('help -- --invalidcmd'.split())
398
(['help', '--invalidcmd'], {})
399
667
>>> parse_args('--version'.split())
400
668
([], {'version': True})
401
669
>>> parse_args('status --all'.split())
402
670
(['status'], {'all': True})
403
671
>>> parse_args('commit --message=biter'.split())
404
672
(['commit'], {'message': u'biter'})
405
>>> parse_args('log -r 500'.split())
406
(['log'], {'revision': [500]})
407
>>> parse_args('log -r500..600'.split())
408
(['log'], {'revision': [500, 600]})
409
>>> parse_args('log -vr500..600'.split())
410
(['log'], {'verbose': True, 'revision': [500, 600]})
411
>>> parse_args('log -rv500..600'.split()) #the r takes an argument
412
(['log'], {'revision': ['v500', 600]})
413
673
"""
414
674
args = []
415
675
opts = {}
416
676
417
argsover = False
677
# TODO: Maybe handle '--' to end options?
678
418
679
while argv:
419
680
a = argv.pop(0)
420
if not argsover and a[0] == '-':
421
# option names must not be unicode
422
a = str(a)
681
if a[0] == '-':
423
682
optarg = None
424
683
if a[1] == '-':
425
if a == '--':
426
# We've received a standalone -- No more flags
427
argsover = True
428
continue
429
684
mutter(" got option %r" % a)
430
685
if '=' in a:
431
686
optname, optarg = a[2:].split('=', 1)
432
687
else:
433
688
optname = a[2:]
434
689
if optname not in OPTIONS:
435
raise BzrError('unknown long option %r' % a)
690
bailout('unknown long option %r' % a)
436
691
else:
437
692
shortopt = a[1:]
438
if shortopt in SHORT_OPTIONS:
439
# Multi-character options must have a space to delimit
440
# their value
441
optname = SHORT_OPTIONS[shortopt]
442
else:
443
# Single character short options, can be chained,
444
# and have their value appended to their name
445
shortopt = a[1:2]
446
if shortopt not in SHORT_OPTIONS:
447
# We didn't find the multi-character name, and we
448
# didn't find the single char name
449
raise BzrError('unknown short option %r' % a)
450
optname = SHORT_OPTIONS[shortopt]
451
452
if a[2:]:
453
# There are extra things on this option
454
# see if it is the value, or if it is another
455
# short option
456
optargfn = OPTIONS[optname]
457
if optargfn is None:
458
# This option does not take an argument, so the
459
# next entry is another short option, pack it back
460
# into the list
461
argv.insert(0, '-' + a[2:])
462
else:
463
# This option takes an argument, so pack it
464
# into the array
465
optarg = a[2:]
693
if shortopt not in SHORT_OPTIONS:
694
bailout('unknown short option %r' % a)
695
optname = SHORT_OPTIONS[shortopt]
466
696
467
697
if optname in opts:
468
698
# XXX: Do we ever want to support this, e.g. for -r?
469
raise BzrError('repeated option %r' % a)
699
bailout('repeated option %r' % a)
470
700
471
701
optargfn = OPTIONS[optname]
472
702
if optargfn:
473
703
if optarg == None:
474
704
if not argv:
475
raise BzrError('option %r needs an argument' % a)
705
bailout('option %r needs an argument' % a)
476
706
else:
477
707
optarg = argv.pop(0)
478
708
opts[optname] = optargfn(optarg)
479
709
else:
480
710
if optarg != None:
481
raise BzrError('option %r takes no argument' % optname)
711
bailout('option %r takes no argument' % optname)
482
712
opts[optname] = True
483
713
else:
484
714
args.append(a)
487
717
488
718
489
719
720
def _match_args(cmd, args):
721
"""Check non-option arguments match required pattern.
490
722
491
def _match_argform(cmd, takes_args, args):
723
>>> _match_args('status', ['asdasdsadasd'])
724
Traceback (most recent call last):
725
...
726
BzrError: ("extra arguments to command status: ['asdasdsadasd']", [])
727
>>> _match_args('add', ['asdasdsadasd'])
728
{'file_list': ['asdasdsadasd']}
729
>>> _match_args('add', 'abc def gj'.split())
730
{'file_list': ['abc', 'def', 'gj']}
731
"""
732
# match argument pattern
733
argform = cmd_args.get(cmd, [])
492
734
argdict = {}
735
# TODO: Need a way to express 'cp SRC... DEST', where it matches
736
# all but one.
493
737
494
# step through args and takes_args, allowing appropriate 0-many matches
495
for ap in takes_args:
738
# step through args and argform, allowing appropriate 0-many matches
739
for ap in argform:
496
740
argname = ap[:-1]
497
741
if ap[-1] == '?':
498
742
if args:
499
743
argdict[argname] = args.pop(0)
500
elif ap[-1] == '*': # all remaining arguments
501
if args:
502
argdict[argname + '_list'] = args[:]
503
args = []
504
else:
505
argdict[argname + '_list'] = None
744
elif ap[-1] == '*':
745
assert 0
506
746
elif ap[-1] == '+':
507
747
if not args:
508
raise BzrCommandError("command %r needs one or more %s"
748
bailout("command %r needs one or more %s"
509
749
% (cmd, argname.upper()))
510
750
else:
511
751
argdict[argname + '_list'] = args[:]
512
752
args = []
513
elif ap[-1] == '$': # all but one
514
if len(args) < 2:
515
raise BzrCommandError("command %r needs one or more %s"
516
% (cmd, argname.upper()))
517
argdict[argname + '_list'] = args[:-1]
518
args[:-1] = []
519
753
else:
520
754
# just a plain arg
521
755
argname = ap
522
756
if not args:
523
raise BzrCommandError("command %r requires argument %s"
757
bailout("command %r requires argument %s"
524
758
% (cmd, argname.upper()))
525
759
else:
526
760
argdict[argname] = args.pop(0)
527
761
528
762
if args:
529
raise BzrCommandError("extra argument to command %s: %s"
530
% (cmd, args[0]))
763
bailout("extra arguments to command %s: %r"
764
% (cmd, args))
531
765
532
766
return argdict
533
767
534
768
535
769
536
def apply_profiled(the_callable, *args, **kwargs):
537
import hotshot
538
import tempfile
539
pffileno, pfname = tempfile.mkstemp()
540
try:
541
prof = hotshot.Profile(pfname)
542
try:
543
ret = prof.runcall(the_callable, *args, **kwargs) or 0
544
finally:
545
prof.close()
770
def run_bzr(argv):
771
"""Execute a command.
772
773
This is similar to main(), but without all the trappings for
774
logging and error handling.
775
"""
776
try:
777
args, opts = parse_args(argv[1:])
778
if 'help' in opts:
779
# TODO: pass down other arguments in case they asked for
780
# help on a command name?
781
cmd_help()
782
return 0
783
elif 'version' in opts:
784
cmd_version()
785
return 0
786
cmd = args.pop(0)
787
except IndexError:
788
log_error('usage: bzr COMMAND\n')
789
log_error(' try "bzr help"\n')
790
return 1
791
792
try:
793
cmd_handler = globals()['cmd_' + cmd.replace('-', '_')]
794
except KeyError:
795
bailout("unknown command " + `cmd`)
796
797
# global option
798
if 'profile' in opts:
799
profile = True
800
del opts['profile']
801
else:
802
profile = False
803
804
# check options are reasonable
805
allowed = cmd_options.get(cmd, [])
806
for oname in opts:
807
if oname not in allowed:
808
bailout("option %r is not allowed for command %r"
809
% (oname, cmd))
810
811
# mix arguments and options into one dictionary
812
cmdargs = _match_args(cmd, args)
813
for k, v in opts.items():
814
cmdargs[k.replace('-', '_')] = v
815
816
if profile:
817
import hotshot
818
prof = hotshot.Profile('.bzr.profile')
819
ret = prof.runcall(cmd_handler, **cmdargs) or 0
820
prof.close()
546
821
547
822
import hotshot.stats
548
stats = hotshot.stats.load(pfname)
823
stats = hotshot.stats.load('.bzr.profile')
549
824
#stats.strip_dirs()
550
stats.sort_stats('time')
551
## XXX: Might like to write to stderr or the trace file instead but
552
## print_stats seems hardcoded to stdout
825
stats.sort_stats('cumulative', 'calls')
553
826
stats.print_stats(20)
554
827
else:
828
return cmd_handler(**cmdargs) or 0
829
830
831
832
def main(argv):
833
## TODO: Handle command-line options; probably know what options are valid for
834
## each command
835
836
## TODO: If the arguments are wrong, give a usage message rather
837
## than just a backtrace.
838
839
bzrlib.trace.create_tracefile(argv)
840
841
try:
842
ret = run_bzr(argv)
555
843
return ret
556
finally:
557
os.close(pffileno)
558
os.remove(pfname)
559
560
561
def run_bzr(argv):
562
"""Execute a command.
563
564
This is similar to main(), but without all the trappings for
565
logging and error handling.
566
567
argv
568
The command-line arguments, without the program name from argv[0]
569
570
Returns a command status or raises an exception.
571
572
Special master options: these must come before the command because
573
they control how the command is interpreted.
574
575
--no-plugins
576
Do not load plugin modules at all
577
578
--builtin
579
Only use builtin commands. (Plugins are still allowed to change
580
other behaviour.)
581
582
--profile
583
Run under the Python profiler.
584
"""
585
586
argv = [a.decode(bzrlib.user_encoding) for a in argv]
587
588
opt_profile = opt_no_plugins = opt_builtin = False
589
590
# --no-plugins is handled specially at a very early stage. We need
591
# to load plugins before doing other command parsing so that they
592
# can override commands, but this needs to happen first.
593
594
for a in argv:
595
if a == '--profile':
596
opt_profile = True
597
elif a == '--no-plugins':
598
opt_no_plugins = True
599
elif a == '--builtin':
600
opt_builtin = True
601
else:
602
break
603
argv.remove(a)
604
605
if (not argv) or (argv[0] == '--help'):
606
from bzrlib.help import help
607
if len(argv) > 1:
608
help(argv[1])
609
else:
610
help()
611
return 0
612
613
if argv[0] == '--version':
614
from bzrlib.builtins import show_version
615
show_version()
616
return 0
617
618
if not opt_no_plugins:
619
from bzrlib.plugin import load_plugins
620
load_plugins()
621
622
cmd = str(argv.pop(0))
623
624
cmd_obj = get_cmd_object(cmd, plugins_override=not opt_builtin)
625
626
if opt_profile:
627
ret = apply_profiled(cmd_obj.run_argv, argv)
628
else:
629
ret = cmd_obj.run_argv(argv)
630
return ret or 0
631
632
633
def main(argv):
634
import bzrlib.ui
635
bzrlib.trace.log_startup(argv)
636
bzrlib.ui.ui_factory = bzrlib.ui.TextUIFactory()
637
638
try:
639
try:
640
return run_bzr(argv[1:])
641
finally:
642
# do this here inside the exception wrappers to catch EPIPE
643
sys.stdout.flush()
644
except BzrCommandError, e:
645
# command line syntax error, etc
646
log_error(str(e))
647
return 1
648
844
except BzrError, e:
649
bzrlib.trace.log_exception()
845
log_error('bzr: error: ' + e.args[0] + '\n')
846
if len(e.args) > 1:
847
for h in e.args[1]:
848
log_error(' ' + h + '\n')
650
849
return 1
651
except AssertionError, e:
652
bzrlib.trace.log_exception('assertion failed: ' + str(e))
653
return 3
654
except KeyboardInterrupt, e:
655
bzrlib.trace.note('interrupted')
656
return 2
657
850
except Exception, e:
658
import errno
659
if (isinstance(e, IOError)
660
and hasattr(e, 'errno')
661
and e.errno == errno.EPIPE):
662
bzrlib.trace.note('broken pipe')
663
return 2
664
else:
665
bzrlib.trace.log_exception()
666
return 2
851
log_error('bzr: exception: %s\n' % e)
852
log_error(' see .bzr.log for details\n')
853
traceback.print_exc(None, bzrlib.trace._tracefile)
854
traceback.print_exc(None, sys.stderr)
855
return 1
856
857
# TODO: Maybe nicer handling of IOError?
858
667
859
668
860
669
861
if __name__ == '__main__':
670
862
sys.exit(main(sys.argv))
863
##import profile
864
##profile.run('main(sys.argv)')
865
Loggerhead is a web-based interface for Breezy
Version: 2.0.1