« back to all changes in this revision
Viewing changes to bzrlib/commands.py
- browse files at revision 225
- compare with another revision
- download diff
- download tarball
- view history from revision 225
- Committer: mbp at sourcefrog
- Date: 2005-04-09 06:21:44 UTC
- Revision ID: mbp@sourcefrog.net-20050409062144-e47a4b64106e4c21af99beaf
debug output
- files added:
- bzrlib/tests.py
- files removed:
- HACKING
- bzrlib/plugins
- bzrlib/selftest
- bzrlib/util
- bzrlib/util/effbot
- bzrlib/util/effbot/org
- contrib
- contrib/bash
- contrib/emacs
- contrib/zsh
- patches
- tools
- files renamed:
- bzrlib/util/elementtree/ => elementtree/
- bzrlib/util/urlgrabber/ => urlgrabber/
- 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 [FILE...]
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, time, types, shutil, tempfile, traceback, fnmatch, difflib, os.path
66
from sets import Set
67
from pprint import pprint
68
from stat import *
69
from glob import glob
40
70
41
71
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.revisionspec import RevisionSpec
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
each revision.
81
82
>>> _parse_revision_str('234')
83
[<RevisionSpec_int 234>]
84
>>> _parse_revision_str('234..567')
85
[<RevisionSpec_int 234>, <RevisionSpec_int 567>]
86
>>> _parse_revision_str('..')
87
[<RevisionSpec None>, <RevisionSpec None>]
88
>>> _parse_revision_str('..234')
89
[<RevisionSpec None>, <RevisionSpec_int 234>]
90
>>> _parse_revision_str('234..')
91
[<RevisionSpec_int 234>, <RevisionSpec None>]
92
>>> _parse_revision_str('234..456..789') # Maybe this should be an error
93
[<RevisionSpec_int 234>, <RevisionSpec_int 456>, <RevisionSpec_int 789>]
94
>>> _parse_revision_str('234....789') # Error?
95
[<RevisionSpec_int 234>, <RevisionSpec None>, <RevisionSpec_int 789>]
96
>>> _parse_revision_str('revid:test@other.com-234234')
97
[<RevisionSpec_revid revid:test@other.com-234234>]
98
>>> _parse_revision_str('revid:test@other.com-234234..revid:test@other.com-234235')
99
[<RevisionSpec_revid revid:test@other.com-234234>, <RevisionSpec_revid revid:test@other.com-234235>]
100
>>> _parse_revision_str('revid:test@other.com-234234..23')
101
[<RevisionSpec_revid revid:test@other.com-234234>, <RevisionSpec_int 23>]
102
>>> _parse_revision_str('date:2005-04-12')
103
[<RevisionSpec_date date:2005-04-12>]
104
>>> _parse_revision_str('date:2005-04-12 12:24:33')
105
[<RevisionSpec_date date:2005-04-12 12:24:33>]
106
>>> _parse_revision_str('date:2005-04-12T12:24:33')
107
[<RevisionSpec_date date:2005-04-12T12:24:33>]
108
>>> _parse_revision_str('date:2005-04-12,12:24:33')
109
[<RevisionSpec_date date:2005-04-12,12:24:33>]
110
>>> _parse_revision_str('-5..23')
111
[<RevisionSpec_int -5>, <RevisionSpec_int 23>]
112
>>> _parse_revision_str('-5')
113
[<RevisionSpec_int -5>]
114
>>> _parse_revision_str('123a')
115
Traceback (most recent call last):
116
...
117
BzrError: No namespace registered for string: '123a'
118
>>> _parse_revision_str('abc')
119
Traceback (most recent call last):
120
...
121
BzrError: No namespace registered for string: 'abc'
122
"""
123
import re
124
old_format_re = re.compile('\d*:\d*')
125
m = old_format_re.match(revstr)
126
revs = []
127
if m:
128
warning('Colon separator for revision numbers is deprecated.'
129
' Use .. instead')
130
for rev in revstr.split(':'):
131
if rev:
132
revs.append(RevisionSpec(int(rev)))
133
else:
134
revs.append(RevisionSpec(None))
135
else:
136
for x in revstr.split('..'):
137
if not x:
138
revs.append(RevisionSpec(None))
139
else:
140
revs.append(RevisionSpec(x))
141
return revs
142
143
144
def get_merge_type(typestring):
145
"""Attempt to find the merge class/factory associated with a string."""
146
from merge import merge_types
147
try:
148
return merge_types[typestring][0]
149
except KeyError:
150
templ = '%s%%7s: %%s' % (' '*12)
151
lines = [templ % (f[0], f[1][1]) for f in merge_types.iteritems()]
152
type_list = '\n'.join(lines)
153
msg = "No known merge type %s. Supported types are:\n%s" %\
154
(typestring, type_list)
155
raise BzrCommandError(msg)
156
157
158
def _builtin_commands():
159
import bzrlib.builtins
160
r = {}
161
builtins = bzrlib.builtins.__dict__
162
for name in builtins:
163
if name.startswith("cmd_"):
164
real_name = _unsquish_command_name(name)
165
r[real_name] = builtins[name]
166
return r
167
168
169
170
def builtin_command_names():
171
"""Return list of builtin command names."""
172
return _builtin_commands().keys()
173
174
175
def plugin_command_names():
176
return plugin_cmds.keys()
177
178
179
def _get_cmd_dict(plugins_override=True):
180
"""Return name->class mapping for all commands."""
181
d = _builtin_commands()
182
if plugins_override:
183
d.update(plugin_cmds)
184
return d
185
186
187
def get_all_cmds(plugins_override=True):
188
"""Return canonical name and class for all registered commands."""
189
for k, v in _get_cmd_dict(plugins_override=plugins_override).iteritems():
190
yield k,v
191
192
193
def get_cmd_object(cmd_name, plugins_override=True):
194
"""Return the canonical name and command class for a command.
195
196
plugins_override
197
If true, plugin commands can override builtins.
198
"""
199
from bzrlib.externalcommand import ExternalCommand
200
201
cmd_name = str(cmd_name) # not unicode
202
203
# first look up this command under the specified name
204
cmds = _get_cmd_dict(plugins_override=plugins_override)
205
try:
206
return cmds[cmd_name]()
207
except KeyError:
208
pass
209
210
# look for any command which claims this as an alias
211
for real_cmd_name, cmd_class in cmds.iteritems():
212
if cmd_name in cmd_class.aliases:
213
return cmd_class()
214
215
cmd_obj = ExternalCommand.find_command(cmd_name)
216
if cmd_obj:
217
return cmd_obj
218
219
raise BzrCommandError("unknown command %r" % cmd_name)
220
221
222
class Command(object):
223
"""Base class for commands.
224
225
Commands are the heart of the command-line bzr interface.
226
227
The command object mostly handles the mapping of command-line
228
parameters into one or more bzrlib operations, and of the results
229
into textual output.
230
231
Commands normally don't have any state. All their arguments are
232
passed in to the run method. (Subclasses may take a different
233
policy if the behaviour of the instance needs to depend on e.g. a
234
shell plugin and not just its Python class.)
235
236
The docstring for an actual command should give a single-line
237
summary, then a complete description of the command. A grammar
238
description will be inserted.
239
240
aliases
241
Other accepted names for this command.
242
243
takes_args
244
List of argument forms, marked with whether they are optional,
245
repeated, etc.
246
247
takes_options
248
List of options that may be given for this command.
249
250
hidden
251
If true, this command isn't advertised. This is typically
252
for commands intended for expert users.
253
"""
254
aliases = []
255
256
takes_args = []
257
takes_options = []
258
259
hidden = False
260
261
def __init__(self):
262
"""Construct an instance of this command."""
263
if self.__doc__ == Command.__doc__:
264
warn("No help message set for %r" % self)
265
266
267
def run_argv(self, argv):
268
"""Parse command line and run."""
269
args, opts = parse_args(argv)
270
271
if 'help' in opts: # e.g. bzr add --help
272
from bzrlib.help import help_on_command
273
help_on_command(self.name())
274
return 0
275
276
# check options are reasonable
277
allowed = self.takes_options
278
for oname in opts:
279
if oname not in allowed:
280
raise BzrCommandError("option '--%s' is not allowed for command %r"
281
% (oname, self.name()))
282
283
# mix arguments and options into one dictionary
284
cmdargs = _match_argform(self.name(), self.takes_args, args)
285
cmdopts = {}
286
for k, v in opts.items():
287
cmdopts[k.replace('-', '_')] = v
288
289
all_cmd_args = cmdargs.copy()
290
all_cmd_args.update(cmdopts)
291
292
return self.run(**all_cmd_args)
293
294
295
def run(self):
296
"""Actually run the command.
297
298
This is invoked with the options and arguments bound to
299
keyword parameters.
300
301
Return 0 or None if the command was successful, or a non-zero
302
shell error code if not. It's OK for this method to allow
303
an exception to raise up.
304
"""
305
raise NotImplementedError()
306
307
308
def help(self):
309
"""Return help message for this class."""
310
if self.__doc__ is Command.__doc__:
311
return None
312
return getdoc(self)
313
314
def name(self):
315
return _unsquish_command_name(self.__class__.__name__)
316
317
318
def parse_spec(spec):
319
"""
320
>>> parse_spec(None)
321
[None, None]
322
>>> parse_spec("./")
323
['./', None]
324
>>> parse_spec("../@")
325
['..', -1]
326
>>> parse_spec("../f/@35")
327
['../f', 35]
328
>>> parse_spec('./@revid:john@arbash-meinel.com-20050711044610-3ca0327c6a222f67')
329
['.', 'revid:john@arbash-meinel.com-20050711044610-3ca0327c6a222f67']
330
"""
331
if spec is None:
332
return [None, None]
333
if '/@' in spec:
334
parsed = spec.split('/@')
335
assert len(parsed) == 2
336
if parsed[1] == "":
337
parsed[1] = -1
338
else:
339
try:
340
parsed[1] = int(parsed[1])
341
except ValueError:
342
pass # We can allow stuff like ./@revid:blahblahblah
343
else:
344
assert parsed[1] >=0
345
else:
346
parsed = [spec, None]
347
return parsed
72
from bzrlib.store import ImmutableStore
73
from bzrlib.trace import mutter, note, log_error
74
from bzrlib.errors import bailout, BzrError, BzrCheckError
75
from bzrlib.osutils import quotefn, pumpfile, isdir, isfile
76
from bzrlib.tree import RevisionTree, EmptyTree, WorkingTree, Tree
77
from bzrlib.revision import Revision
78
from bzrlib import Branch, Inventory, InventoryEntry, ScratchBranch, BZRDIR, \
79
format_date
80
81
BZR_DIFF_FORMAT = "## Bazaar-NG diff, format 0 ##\n"
82
BZR_PATCHNAME_FORMAT = 'cset:sha1:%s'
83
84
## standard representation
85
NONE_STRING = '(none)'
86
EMPTY = 'empty'
87
88
89
## TODO: Perhaps a different version of inventory commands that
90
## returns iterators...
91
92
## TODO: Perhaps an AtomicFile class that writes to a temporary file and then renames.
93
94
## TODO: Some kind of locking on branches. Perhaps there should be a
95
## parameter to the branch object saying whether we want a read or
96
## write lock; release it from destructor. Perhaps don't even need a
97
## read lock to look at immutable objects?
98
99
## TODO: Perhaps make UUIDs predictable in test mode to make it easier
100
## to compare output?
101
102
## TODO: Some kind of global code to generate the right Branch object
103
## to work on. Almost, but not quite all, commands need one, and it
104
## can be taken either from their parameters or their working
105
## directory.
106
107
## TODO: rename command, needed soon: check destination doesn't exist
108
## either in working copy or tree; move working copy; update
109
## inventory; write out
110
111
## TODO: move command; check destination is a directory and will not
112
## clash; move it.
113
114
## TODO: command to show renames, one per line, as to->from
115
116
117
118
119
def cmd_status(all=False):
120
"""Display status summary.
121
122
For each file there is a single line giving its file state and name.
123
The name is that in the current revision unless it is deleted or
124
missing, in which case the old name is shown.
125
126
:todo: Don't show unchanged files unless ``--all`` is given?
127
"""
128
Branch('.').show_status(show_all=all)
129
130
131
132
######################################################################
133
# examining history
134
def cmd_get_revision(revision_id):
135
Branch('.').get_revision(revision_id).write_xml(sys.stdout)
136
137
138
def cmd_get_file_text(text_id):
139
"""Get contents of a file by hash."""
140
sf = Branch('.').text_store[text_id]
141
pumpfile(sf, sys.stdout)
142
143
144
145
######################################################################
146
# commands
147
148
149
def cmd_revno():
150
"""Show number of revisions on this branch"""
151
print Branch('.').revno()
152
153
154
155
def cmd_add(file_list, verbose=False):
156
"""Add specified files or directories.
157
158
In non-recursive mode, all the named items are added, regardless
159
of whether they were previously ignored. A warning is given if
160
any of the named files are already versioned.
161
162
In recursive mode (the default), files are treated the same way
163
but the behaviour for directories is different. Directories that
164
are already versioned do not give a warning. All directories,
165
whether already versioned or not, are searched for files or
166
subdirectories that are neither versioned or ignored, and these
167
are added. This search proceeds recursively into versioned
168
directories.
169
170
Therefore simply saying 'bzr add .' will version all files that
171
are currently unknown.
172
"""
173
bzrlib.add.smart_add(file_list, verbose)
174
175
176
def cmd_relpath(filename):
177
"""Show path of file relative to root"""
178
print Branch(filename).relpath(filename)
179
180
181
182
def cmd_inventory(revision=None):
183
"""Show inventory of the current working copy."""
184
## TODO: Also optionally show a previous inventory
185
## TODO: Format options
186
b = Branch('.')
187
if revision == None:
188
inv = b.read_working_inventory()
189
else:
190
inv = b.get_revision_inventory(b.lookup_revision(revision))
191
192
for path, entry in inv.iter_entries():
193
print '%-50s %s' % (entry.file_id, path)
194
195
196
197
# TODO: Maybe a 'mv' command that has the combined move/rename
198
# special behaviour of Unix?
199
200
def cmd_move(source_list, dest):
201
b = Branch('.')
202
203
b.move([b.relpath(s) for s in source_list], b.relpath(dest))
204
205
206
207
def cmd_rename(from_name, to_name):
208
"""Change the name of an entry.
209
210
usage: bzr rename FROM_NAME TO_NAME
211
212
examples:
213
bzr rename frob.c frobber.c
214
bzr rename src/frob.c lib/frob.c
215
216
It is an error if the destination name exists.
217
218
See also the 'move' command, which moves files into a different
219
directory without changing their name.
220
221
TODO: Some way to rename multiple files without invoking bzr for each
222
one?"""
223
b = Branch('.')
224
b.rename_one(b.relpath(from_name), b.relpath(to_name))
225
226
227
228
229
def cmd_renames(dir='.'):
230
"""Show list of renamed files.
231
232
usage: bzr renames [BRANCH]
233
234
TODO: Option to show renames between two historical versions.
235
236
TODO: Only show renames under dir, rather than in the whole branch.
237
"""
238
b = Branch(dir)
239
old_inv = b.basis_tree().inventory
240
new_inv = b.read_working_inventory()
241
242
renames = list(bzrlib.tree.find_renames(old_inv, new_inv))
243
renames.sort()
244
for old_name, new_name in renames:
245
print "%s => %s" % (old_name, new_name)
246
247
248
249
def cmd_info():
250
"""info: Show statistical information for this branch
251
252
usage: bzr info"""
253
import info
254
info.show_info(Branch('.'))
255
256
257
258
def cmd_remove(file_list, verbose=False):
259
b = Branch(file_list[0])
260
b.remove([b.relpath(f) for f in file_list], verbose=verbose)
261
262
263
264
def cmd_file_id(filename):
265
"""Print file_id of a particular file or directory.
266
267
usage: bzr file-id FILE
268
269
The file_id is assigned when the file is first added and remains the
270
same through all revisions where the file exists, even when it is
271
moved or renamed.
272
"""
273
b = Branch(filename)
274
i = b.inventory.path2id(b.relpath(filename))
275
if i == None:
276
bailout("%r is not a versioned file" % filename)
277
else:
278
print i
279
280
281
def cmd_file_id_path(filename):
282
"""Print path of file_ids to a file or directory.
283
284
usage: bzr file-id-path FILE
285
286
This prints one line for each directory down to the target,
287
starting at the branch root."""
288
b = Branch(filename)
289
inv = b.inventory
290
fid = inv.path2id(b.relpath(filename))
291
if fid == None:
292
bailout("%r is not a versioned file" % filename)
293
for fip in inv.get_idpath(fid):
294
print fip
295
296
297
def cmd_revision_history():
298
for patchid in Branch('.').revision_history():
299
print patchid
300
301
302
def cmd_directories():
303
for name, ie in Branch('.').read_working_inventory().directories():
304
if name == '':
305
print '.'
306
else:
307
print name
308
309
310
def cmd_missing():
311
for name, ie in Branch('.').working_tree().missing():
312
print name
313
314
315
def cmd_init():
316
# TODO: Check we're not already in a working directory? At the
317
# moment you'll get an ugly error.
318
319
# TODO: What if we're in a subdirectory of a branch? Would like
320
# to allow that, but then the parent may need to understand that
321
# the children have disappeared, or should they be versioned in
322
# both?
323
324
# TODO: Take an argument/option for branch name.
325
Branch('.', init=True)
326
327
328
def cmd_diff(revision=None, file_list=None):
329
"""bzr diff: Show differences in working tree.
330
331
usage: bzr diff [-r REV] [FILE...]
332
333
--revision REV
334
Show changes since REV, rather than predecessor.
335
336
If files are listed, only the changes in those files are listed.
337
Otherwise, all changes for the tree are listed.
338
339
TODO: Given two revision arguments, show the difference between them.
340
341
TODO: Allow diff across branches.
342
343
TODO: Option to use external diff command; could be GNU diff, wdiff,
344
or a graphical diff.
345
346
TODO: If a directory is given, diff everything under that.
347
348
TODO: Selected-file diff is inefficient and doesn't show you deleted files.
349
"""
350
351
## TODO: Shouldn't be in the cmd function.
352
353
b = Branch('.')
354
355
if revision == None:
356
old_tree = b.basis_tree()
357
else:
358
old_tree = b.revision_tree(b.lookup_revision(revision))
359
360
new_tree = b.working_tree()
361
362
# TODO: Options to control putting on a prefix or suffix, perhaps as a format string
363
old_label = ''
364
new_label = ''
365
366
DEVNULL = '/dev/null'
367
# Windows users, don't panic about this filename -- it is a
368
# special signal to GNU patch that the file should be created or
369
# deleted respectively.
370
371
# TODO: Generation of pseudo-diffs for added/deleted files could
372
# be usefully made into a much faster special case.
373
374
# TODO: Better to return them in sorted order I think.
375
376
# FIXME: If given a file list, compare only those files rather
377
# than comparing everything and then throwing stuff away.
378
379
for file_state, fid, old_name, new_name, kind in bzrlib.diff_trees(old_tree, new_tree):
380
381
if file_list and new_name not in file_list:
382
continue
383
384
# Don't show this by default; maybe do it if an option is passed
385
# idlabel = ' {%s}' % fid
386
idlabel = ''
387
388
# FIXME: Something about the diff format makes patch unhappy
389
# with newly-added files.
390
391
def diffit(oldlines, newlines, **kw):
392
# FIXME: difflib is wrong if there is no trailing newline.
393
394
# Special workaround for Python2.3, where difflib fails if
395
# both sequences are empty.
396
if oldlines or newlines:
397
sys.stdout.writelines(difflib.unified_diff(oldlines, newlines, **kw))
398
print
399
400
if file_state in ['.', '?', 'I']:
401
continue
402
elif file_state == 'A':
403
print '*** added %s %r' % (kind, new_name)
404
if kind == 'file':
405
diffit([],
406
new_tree.get_file(fid).readlines(),
407
fromfile=DEVNULL,
408
tofile=new_label + new_name + idlabel)
409
elif file_state == 'D':
410
assert isinstance(old_name, types.StringTypes)
411
print '*** deleted %s %r' % (kind, old_name)
412
if kind == 'file':
413
diffit(old_tree.get_file(fid).readlines(), [],
414
fromfile=old_label + old_name + idlabel,
415
tofile=DEVNULL)
416
elif file_state in ['M', 'R']:
417
if file_state == 'M':
418
assert kind == 'file'
419
assert old_name == new_name
420
print '*** modified %s %r' % (kind, new_name)
421
elif file_state == 'R':
422
print '*** renamed %s %r => %r' % (kind, old_name, new_name)
423
424
if kind == 'file':
425
diffit(old_tree.get_file(fid).readlines(),
426
new_tree.get_file(fid).readlines(),
427
fromfile=old_label + old_name + idlabel,
428
tofile=new_label + new_name)
429
else:
430
bailout("can't represent state %s {%s}" % (file_state, fid))
431
432
433
434
def cmd_deleted(show_ids=False):
435
"""List files deleted in the working tree.
436
437
TODO: Show files deleted since a previous revision, or between two revisions.
438
"""
439
b = Branch('.')
440
old = b.basis_tree()
441
new = b.working_tree()
442
443
## TODO: Much more efficient way to do this: read in new
444
## directories with readdir, rather than stating each one. Same
445
## level of effort but possibly much less IO. (Or possibly not,
446
## if the directories are very large...)
447
448
for path, ie in old.inventory.iter_entries():
449
if not new.has_id(ie.file_id):
450
if show_ids:
451
print '%-50s %s' % (path, ie.file_id)
452
else:
453
print path
454
455
456
457
def cmd_parse_inventory():
458
import cElementTree
459
460
cElementTree.ElementTree().parse(file('.bzr/inventory'))
461
462
463
464
def cmd_load_inventory():
465
"""Load inventory for timing purposes"""
466
Branch('.').basis_tree().inventory
467
468
469
def cmd_dump_inventory():
470
Branch('.').read_working_inventory().write_xml(sys.stdout)
471
472
473
def cmd_dump_new_inventory():
474
import bzrlib.newinventory
475
inv = Branch('.').basis_tree().inventory
476
bzrlib.newinventory.write_inventory(inv, sys.stdout)
477
478
479
def cmd_load_new_inventory():
480
import bzrlib.newinventory
481
bzrlib.newinventory.read_new_inventory(sys.stdin)
482
483
484
def cmd_dump_slacker_inventory():
485
import bzrlib.newinventory
486
inv = Branch('.').basis_tree().inventory
487
bzrlib.newinventory.write_slacker_inventory(inv, sys.stdout)
488
489
490
491
def cmd_root(filename=None):
492
"""Print the branch root."""
493
print bzrlib.branch.find_branch_root(filename)
494
495
496
def cmd_log(timezone='original'):
497
"""Show log of this branch.
498
499
:todo: Options for utc; to show ids; to limit range; etc.
500
"""
501
Branch('.').write_log(show_timezone=timezone)
502
503
504
def cmd_ls(revision=None, verbose=False):
505
"""List files in a tree.
506
507
:todo: Take a revision or remote path and list that tree instead.
508
"""
509
b = Branch('.')
510
if revision == None:
511
tree = b.working_tree()
512
else:
513
tree = b.revision_tree(b.lookup_revision(revision))
514
515
for fp, fc, kind, fid in tree.list_files():
516
if verbose:
517
if kind == 'directory':
518
kindch = '/'
519
elif kind == 'file':
520
kindch = ''
521
else:
522
kindch = '???'
523
524
print '%-8s %s%s' % (fc, fp, kindch)
525
else:
526
print fp
527
528
529
530
def cmd_unknowns():
531
"""List unknown files"""
532
for f in Branch('.').unknowns():
533
print quotefn(f)
534
535
536
537
def cmd_ignored():
538
"""List ignored files and the patterns that matched them.
539
"""
540
tree = Branch('.').working_tree()
541
for path, file_class, kind, file_id in tree.list_files():
542
if file_class != 'I':
543
continue
544
## XXX: Slightly inefficient since this was already calculated
545
pat = tree.is_ignored(path)
546
print '%-50s %s' % (path, pat)
547
548
549
def cmd_lookup_revision(revno):
550
try:
551
revno = int(revno)
552
except ValueError:
553
bailout("usage: lookup-revision REVNO",
554
["REVNO is a non-negative revision number for this branch"])
555
556
print Branch('.').lookup_revision(revno) or NONE_STRING
557
558
559
560
def cmd_export(revno, dest):
561
"""Export past revision to destination directory."""
562
b = Branch('.')
563
rh = b.lookup_revision(int(revno))
564
t = b.revision_tree(rh)
565
t.export(dest)
566
567
def cmd_cat(revision, filename):
568
"""Print file to stdout."""
569
b = Branch('.')
570
b.print_file(b.relpath(filename), int(revision))
571
572
573
######################################################################
574
# internal/test commands
575
576
577
def cmd_uuid():
578
"""Print a newly-generated UUID."""
579
print bzrlib.osutils.uuid()
580
581
582
583
def cmd_local_time_offset():
584
print bzrlib.osutils.local_time_offset()
585
586
587
588
def cmd_commit(message=None, verbose=False):
589
"""Commit changes to a new revision.
590
591
--message MESSAGE
592
Description of changes in this revision; free form text.
593
It is recommended that the first line be a single-sentence
594
summary.
595
--verbose
596
Show status of changed files,
597
598
TODO: Commit only selected files.
599
600
TODO: Run hooks on tree to-be-committed, and after commit.
601
602
TODO: Strict commit that fails if there are unknown or deleted files.
603
"""
604
605
if not message:
606
bailout("please specify a commit message")
607
Branch('.').commit(message, verbose=verbose)
608
609
610
def cmd_check(dir='.'):
611
"""check: Consistency check of branch history.
612
613
usage: bzr check [-v] [BRANCH]
614
615
options:
616
--verbose, -v Show progress of checking.
617
618
This command checks various invariants about the branch storage to
619
detect data corruption or bzr bugs.
620
"""
621
import bzrlib.check
622
bzrlib.check.check(Branch(dir, find_root=False))
623
624
625
def cmd_is(pred, *rest):
626
"""Test whether PREDICATE is true."""
627
try:
628
cmd_handler = globals()['assert_' + pred.replace('-', '_')]
629
except KeyError:
630
bailout("unknown predicate: %s" % quotefn(pred))
631
632
try:
633
cmd_handler(*rest)
634
except BzrCheckError:
635
# by default we don't print the message so that this can
636
# be used from shell scripts without producing noise
637
sys.exit(1)
638
639
640
def cmd_username():
641
print bzrlib.osutils.username()
642
643
644
def cmd_user_email():
645
print bzrlib.osutils.user_email()
646
647
648
def cmd_gen_revision_id():
649
print bzrlib.branch._gen_revision_id(time.time())
650
651
652
def cmd_selftest():
653
"""Run internal test suite"""
654
## -v, if present, is seen by doctest; the argument is just here
655
## so our parser doesn't complain
656
657
## TODO: --verbose option
658
659
failures, tests = 0, 0
660
661
import doctest, bzrlib.store, bzrlib.tests
662
bzrlib.trace.verbose = False
663
664
for m in bzrlib.store, bzrlib.inventory, bzrlib.branch, bzrlib.osutils, \
665
bzrlib.tree, bzrlib.tests, bzrlib.commands, bzrlib.add:
666
mf, mt = doctest.testmod(m)
667
failures += mf
668
tests += mt
669
print '%-40s %3d tests' % (m.__name__, mt),
670
if mf:
671
print '%3d FAILED!' % mf
672
else:
673
print
674
675
print '%-40s %3d tests' % ('total', tests),
676
if failures:
677
print '%3d FAILED!' % failures
678
else:
679
print
680
681
682
683
# deprecated
684
cmd_doctest = cmd_selftest
685
686
687
######################################################################
688
# help
689
690
691
def cmd_help(topic=None):
692
if topic == None:
693
print __doc__
694
return
695
696
# otherwise, maybe the name of a command?
697
try:
698
cmdfn = globals()['cmd_' + topic.replace('-', '_')]
699
except KeyError:
700
bailout("no help for %r" % topic)
701
702
doc = cmdfn.__doc__
703
if doc == None:
704
bailout("sorry, no detailed help yet for %r" % topic)
705
706
print doc
707
708
709
710
711
def cmd_version():
712
print "bzr (bazaar-ng) %s" % bzrlib.__version__
713
print bzrlib.__copyright__
714
print "http://bazaar-ng.org/"
715
print
716
print \
717
"""bzr comes with ABSOLUTELY NO WARRANTY. bzr is free software, and
718
you may use, modify and redistribute it under the terms of the GNU
719
General Public License version 2 or later."""
720
721
722
def cmd_rocks():
723
"""Statement of optimism."""
724
print "it sure does!"
725
726
727
728
######################################################################
729
# main routine
348
730
349
731
350
732
# list of all available options; the rhs can be either None for an
352
734
# the type.
353
735
OPTIONS = {
354
736
'all': None,
355
'diff-options': str,
356
737
'help': None,
357
'file': unicode,
358
'force': None,
359
'format': unicode,
360
'forward': None,
361
738
'message': unicode,
362
'no-recurse': None,
363
739
'profile': None,
364
'revision': _parse_revision_str,
365
'short': None,
740
'revision': int,
366
741
'show-ids': None,
367
742
'timezone': str,
368
743
'verbose': None,
369
744
'version': None,
370
'email': None,
371
'unchanged': None,
372
'update': None,
373
'long': None,
374
'root': str,
375
'no-backup': None,
376
'merge-type': get_merge_type,
377
'pattern': str,
378
745
}
379
746
380
747
SHORT_OPTIONS = {
381
'F': 'file',
382
'h': 'help',
383
748
'm': 'message',
384
749
'r': 'revision',
385
750
'v': 'verbose',
386
'l': 'long',
387
751
}
388
752
753
# List of options that apply to particular commands; commands not
754
# listed take none.
755
cmd_options = {
756
'add': ['verbose'],
757
'cat': ['revision'],
758
'commit': ['message', 'verbose'],
759
'deleted': ['show-ids'],
760
'diff': ['revision'],
761
'inventory': ['revision'],
762
'log': ['timezone'],
763
'ls': ['revision', 'verbose'],
764
'remove': ['verbose'],
765
'status': ['all'],
766
}
767
768
769
cmd_args = {
770
'add': ['file+'],
771
'cat': ['filename'],
772
'commit': [],
773
'diff': ['file*'],
774
'export': ['revno', 'dest'],
775
'file-id': ['filename'],
776
'file-id-path': ['filename'],
777
'get-file-text': ['text_id'],
778
'get-inventory': ['inventory_id'],
779
'get-revision': ['revision_id'],
780
'get-revision-inventory': ['revision_id'],
781
'help': ['topic?'],
782
'init': [],
783
'log': [],
784
'lookup-revision': ['revno'],
785
'move': ['source$', 'dest'],
786
'relpath': ['filename'],
787
'remove': ['file+'],
788
'rename': ['from_name', 'to_name'],
789
'renames': ['dir?'],
790
'root': ['filename?'],
791
'status': [],
792
}
793
389
794
390
795
def parse_args(argv):
391
796
"""Parse command line.
397
802
398
803
>>> parse_args('--help'.split())
399
804
([], {'help': True})
400
>>> parse_args('help -- --invalidcmd'.split())
401
(['help', '--invalidcmd'], {})
402
805
>>> parse_args('--version'.split())
403
806
([], {'version': True})
404
807
>>> parse_args('status --all'.split())
405
808
(['status'], {'all': True})
406
809
>>> parse_args('commit --message=biter'.split())
407
810
(['commit'], {'message': u'biter'})
408
>>> parse_args('log -r 500'.split())
409
(['log'], {'revision': [<RevisionSpec_int 500>]})
410
>>> parse_args('log -r500..600'.split())
411
(['log'], {'revision': [<RevisionSpec_int 500>, <RevisionSpec_int 600>]})
412
>>> parse_args('log -vr500..600'.split())
413
(['log'], {'verbose': True, 'revision': [<RevisionSpec_int 500>, <RevisionSpec_int 600>]})
414
>>> parse_args('log -rrevno:500..600'.split()) #the r takes an argument
415
(['log'], {'revision': [<RevisionSpec_revno revno:500>, <RevisionSpec_int 600>]})
416
811
"""
417
812
args = []
418
813
opts = {}
419
814
420
argsover = False
815
# TODO: Maybe handle '--' to end options?
816
421
817
while argv:
422
818
a = argv.pop(0)
423
if not argsover and a[0] == '-':
424
# option names must not be unicode
425
a = str(a)
819
if a[0] == '-':
426
820
optarg = None
427
821
if a[1] == '-':
428
if a == '--':
429
# We've received a standalone -- No more flags
430
argsover = True
431
continue
432
822
mutter(" got option %r" % a)
433
823
if '=' in a:
434
824
optname, optarg = a[2:].split('=', 1)
435
825
else:
436
826
optname = a[2:]
437
827
if optname not in OPTIONS:
438
raise BzrError('unknown long option %r' % a)
828
bailout('unknown long option %r' % a)
439
829
else:
440
830
shortopt = a[1:]
441
if shortopt in SHORT_OPTIONS:
442
# Multi-character options must have a space to delimit
443
# their value
444
optname = SHORT_OPTIONS[shortopt]
445
else:
446
# Single character short options, can be chained,
447
# and have their value appended to their name
448
shortopt = a[1:2]
449
if shortopt not in SHORT_OPTIONS:
450
# We didn't find the multi-character name, and we
451
# didn't find the single char name
452
raise BzrError('unknown short option %r' % a)
453
optname = SHORT_OPTIONS[shortopt]
454
455
if a[2:]:
456
# There are extra things on this option
457
# see if it is the value, or if it is another
458
# short option
459
optargfn = OPTIONS[optname]
460
if optargfn is None:
461
# This option does not take an argument, so the
462
# next entry is another short option, pack it back
463
# into the list
464
argv.insert(0, '-' + a[2:])
465
else:
466
# This option takes an argument, so pack it
467
# into the array
468
optarg = a[2:]
831
if shortopt not in SHORT_OPTIONS:
832
bailout('unknown short option %r' % a)
833
optname = SHORT_OPTIONS[shortopt]
469
834
470
835
if optname in opts:
471
836
# XXX: Do we ever want to support this, e.g. for -r?
472
raise BzrError('repeated option %r' % a)
837
bailout('repeated option %r' % a)
473
838
474
839
optargfn = OPTIONS[optname]
475
840
if optargfn:
476
841
if optarg == None:
477
842
if not argv:
478
raise BzrError('option %r needs an argument' % a)
843
bailout('option %r needs an argument' % a)
479
844
else:
480
845
optarg = argv.pop(0)
481
846
opts[optname] = optargfn(optarg)
482
847
else:
483
848
if optarg != None:
484
raise BzrError('option %r takes no argument' % optname)
849
bailout('option %r takes no argument' % optname)
485
850
opts[optname] = True
486
851
else:
487
852
args.append(a)
490
855
491
856
492
857
858
def _match_args(cmd, args):
859
"""Check non-option arguments match required pattern.
493
860
494
def _match_argform(cmd, takes_args, args):
861
>>> _match_args('status', ['asdasdsadasd'])
862
Traceback (most recent call last):
863
...
864
BzrError: ("extra arguments to command status: ['asdasdsadasd']", [])
865
>>> _match_args('add', ['asdasdsadasd'])
866
{'file_list': ['asdasdsadasd']}
867
>>> _match_args('add', 'abc def gj'.split())
868
{'file_list': ['abc', 'def', 'gj']}
869
"""
870
# match argument pattern
871
argform = cmd_args.get(cmd, [])
495
872
argdict = {}
873
# TODO: Need a way to express 'cp SRC... DEST', where it matches
874
# all but one.
496
875
497
# step through args and takes_args, allowing appropriate 0-many matches
498
for ap in takes_args:
876
# step through args and argform, allowing appropriate 0-many matches
877
for ap in argform:
499
878
argname = ap[:-1]
500
879
if ap[-1] == '?':
501
880
if args:
508
887
argdict[argname + '_list'] = None
509
888
elif ap[-1] == '+':
510
889
if not args:
511
raise BzrCommandError("command %r needs one or more %s"
890
bailout("command %r needs one or more %s"
512
891
% (cmd, argname.upper()))
513
892
else:
514
893
argdict[argname + '_list'] = args[:]
515
894
args = []
516
895
elif ap[-1] == '$': # all but one
517
896
if len(args) < 2:
518
raise BzrCommandError("command %r needs one or more %s"
897
bailout("command %r needs one or more %s"
519
898
% (cmd, argname.upper()))
520
899
argdict[argname + '_list'] = args[:-1]
521
900
args[:-1] = []
523
902
# just a plain arg
524
903
argname = ap
525
904
if not args:
526
raise BzrCommandError("command %r requires argument %s"
905
bailout("command %r requires argument %s"
527
906
% (cmd, argname.upper()))
528
907
else:
529
908
argdict[argname] = args.pop(0)
530
909
531
910
if args:
532
raise BzrCommandError("extra argument to command %s: %s"
533
% (cmd, args[0]))
911
bailout("extra arguments to command %s: %r"
912
% (cmd, args))
534
913
535
914
return argdict
536
915
537
916
538
917
539
def apply_profiled(the_callable, *args, **kwargs):
540
import hotshot
541
import tempfile
542
pffileno, pfname = tempfile.mkstemp()
543
try:
544
prof = hotshot.Profile(pfname)
545
try:
546
ret = prof.runcall(the_callable, *args, **kwargs) or 0
547
finally:
548
prof.close()
918
def run_bzr(argv):
919
"""Execute a command.
920
921
This is similar to main(), but without all the trappings for
922
logging and error handling.
923
"""
924
try:
925
args, opts = parse_args(argv[1:])
926
if 'help' in opts:
927
# TODO: pass down other arguments in case they asked for
928
# help on a command name?
929
if args:
930
cmd_help(args[0])
931
else:
932
cmd_help()
933
return 0
934
elif 'version' in opts:
935
cmd_version()
936
return 0
937
cmd = args.pop(0)
938
except IndexError:
939
log_error('usage: bzr COMMAND\n')
940
log_error(' try "bzr help"\n')
941
return 1
942
943
try:
944
cmd_handler = globals()['cmd_' + cmd.replace('-', '_')]
945
except KeyError:
946
bailout("unknown command " + `cmd`)
947
948
# global option
949
if 'profile' in opts:
950
profile = True
951
del opts['profile']
952
else:
953
profile = False
954
955
# check options are reasonable
956
allowed = cmd_options.get(cmd, [])
957
for oname in opts:
958
if oname not in allowed:
959
bailout("option %r is not allowed for command %r"
960
% (oname, cmd))
961
962
# TODO: give an error if there are any mandatory options which are
963
# not specified? Or maybe there shouldn't be any "mandatory
964
# options" (it is an oxymoron)
965
966
# mix arguments and options into one dictionary
967
cmdargs = _match_args(cmd, args)
968
for k, v in opts.items():
969
cmdargs[k.replace('-', '_')] = v
970
971
if profile:
972
import hotshot
973
prof = hotshot.Profile('.bzr.profile')
974
ret = prof.runcall(cmd_handler, **cmdargs) or 0
975
prof.close()
549
976
550
977
import hotshot.stats
551
stats = hotshot.stats.load(pfname)
978
stats = hotshot.stats.load('.bzr.profile')
552
979
#stats.strip_dirs()
553
980
stats.sort_stats('time')
554
## XXX: Might like to write to stderr or the trace file instead but
555
## print_stats seems hardcoded to stdout
556
981
stats.print_stats(20)
557
982
558
983
return ret
559
finally:
560
os.close(pffileno)
561
os.remove(pfname)
562
563
564
def run_bzr(argv):
565
"""Execute a command.
566
567
This is similar to main(), but without all the trappings for
568
logging and error handling.
569
570
argv
571
The command-line arguments, without the program name from argv[0]
572
573
Returns a command status or raises an exception.
574
575
Special master options: these must come before the command because
576
they control how the command is interpreted.
577
578
--no-plugins
579
Do not load plugin modules at all
580
581
--builtin
582
Only use builtin commands. (Plugins are still allowed to change
583
other behaviour.)
584
585
--profile
586
Run under the Python profiler.
587
"""
588
589
argv = [a.decode(bzrlib.user_encoding) for a in argv]
590
591
opt_profile = opt_no_plugins = opt_builtin = False
592
593
# --no-plugins is handled specially at a very early stage. We need
594
# to load plugins before doing other command parsing so that they
595
# can override commands, but this needs to happen first.
596
597
for a in argv:
598
if a == '--profile':
599
opt_profile = True
600
elif a == '--no-plugins':
601
opt_no_plugins = True
602
elif a == '--builtin':
603
opt_builtin = True
604
else:
605
break
606
argv.remove(a)
607
608
if (not argv) or (argv[0] == '--help'):
609
from bzrlib.help import help
610
if len(argv) > 1:
611
help(argv[1])
612
else:
613
help()
614
return 0
615
616
if argv[0] == '--version':
617
from bzrlib.builtins import show_version
618
show_version()
619
return 0
620
621
if not opt_no_plugins:
622
from bzrlib.plugin import load_plugins
623
load_plugins()
624
625
cmd = str(argv.pop(0))
626
627
cmd_obj = get_cmd_object(cmd, plugins_override=not opt_builtin)
628
629
if opt_profile:
630
ret = apply_profiled(cmd_obj.run_argv, argv)
631
984
else:
632
ret = cmd_obj.run_argv(argv)
633
return ret or 0
985
return cmd_handler(**cmdargs) or 0
986
634
987
635
988
636
989
def main(argv):
637
import bzrlib.ui
638
bzrlib.trace.log_startup(argv)
639
bzrlib.ui.ui_factory = bzrlib.ui.TextUIFactory()
640
990
## TODO: Handle command-line options; probably know what options are valid for
991
## each command
992
993
## TODO: If the arguments are wrong, give a usage message rather
994
## than just a backtrace.
995
996
bzrlib.trace.create_tracefile(argv)
997
641
998
try:
642
try:
643
try:
644
return run_bzr(argv[1:])
645
finally:
646
# do this here inside the exception wrappers to catch EPIPE
647
sys.stdout.flush()
648
#wrap common errors as CommandErrors.
649
except (NotBranchError,), e:
650
raise BzrCommandError(str(e))
651
except BzrCommandError, e:
652
# command line syntax error, etc
653
log_error(str(e))
654
return 1
999
ret = run_bzr(argv)
1000
return ret
655
1001
except BzrError, e:
656
bzrlib.trace.log_exception()
1002
log_error('bzr: error: ' + e.args[0] + '\n')
1003
if len(e.args) > 1:
1004
for h in e.args[1]:
1005
log_error(' ' + h + '\n')
1006
traceback.print_exc(None, bzrlib.trace._tracefile)
1007
log_error('(see $HOME/.bzr.log for debug information)\n')
657
1008
return 1
658
except AssertionError, e:
659
bzrlib.trace.log_exception('assertion failed: ' + str(e))
660
return 3
661
except KeyboardInterrupt, e:
662
bzrlib.trace.note('interrupted')
663
return 2
664
1009
except Exception, e:
665
import errno
666
if (isinstance(e, IOError)
667
and hasattr(e, 'errno')
668
and e.errno == errno.EPIPE):
669
bzrlib.trace.note('broken pipe')
670
return 2
671
else:
672
bzrlib.trace.log_exception()
673
return 2
1010
log_error('bzr: exception: %s\n' % e)
1011
log_error('(see $HOME/.bzr.log for debug information)\n')
1012
traceback.print_exc(None, bzrlib.trace._tracefile)
1013
## traceback.print_exc(None, sys.stderr)
1014
return 1
1015
1016
# TODO: Maybe nicer handling of IOError?
1017
674
1018
675
1019
676
1020
if __name__ == '__main__':
677
1021
sys.exit(main(sys.argv))
1022
##import profile
1023
##profile.run('main(sys.argv)')
1024
Loggerhead is a web-based interface for Breezy
Version: 2.0.1