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