« back to all changes in this revision
Viewing changes to bzrlib/commands.py
- browse files at revision 185
- compare with another revision
- download diff
- download tarball
- view history from revision 185
- Committer: mbp at sourcefrog
- Date: 2005-04-07 02:40:18 UTC
- Revision ID: mbp@sourcefrog.net-20050407024018-cf7130ea991f4ebc0c353ed2
more notes on svk
- 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, 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
33
70
34
71
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
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):
329
"""bzr diff: Show differences in working tree.
330
331
usage: bzr diff [-r REV]
332
333
--revision REV
334
Show changes since REV, rather than predecessor.
335
336
TODO: Given two revision arguments, show the difference between them.
337
338
TODO: Allow diff across branches.
339
340
TODO: Option to use external diff command; could be GNU diff, wdiff,
341
or a graphical diff.
342
343
TODO: Diff selected files.
344
"""
345
346
## TODO: Shouldn't be in the cmd function.
347
348
b = Branch('.')
349
350
if revision == None:
351
old_tree = b.basis_tree()
352
else:
353
old_tree = b.revision_tree(b.lookup_revision(revision))
354
355
new_tree = b.working_tree()
356
357
# TODO: Options to control putting on a prefix or suffix, perhaps as a format string
358
old_label = ''
359
new_label = ''
360
361
DEVNULL = '/dev/null'
362
# Windows users, don't panic about this filename -- it is a
363
# special signal to GNU patch that the file should be created or
364
# deleted respectively.
365
366
# TODO: Generation of pseudo-diffs for added/deleted files could
367
# be usefully made into a much faster special case.
368
369
# TODO: Better to return them in sorted order I think.
370
371
for file_state, fid, old_name, new_name, kind in bzrlib.diff_trees(old_tree, new_tree):
372
# Don't show this by default; maybe do it if an option is passed
373
# idlabel = ' {%s}' % fid
374
idlabel = ''
375
376
# FIXME: Something about the diff format makes patch unhappy
377
# with newly-added files.
378
379
def diffit(oldlines, newlines, **kw):
380
# FIXME: difflib is wrong if there is no trailing newline.
381
382
# Special workaround for Python2.3, where difflib fails if
383
# both sequences are empty.
384
if oldlines or newlines:
385
sys.stdout.writelines(difflib.unified_diff(oldlines, newlines, **kw))
386
print
387
388
if file_state in ['.', '?', 'I']:
389
continue
390
elif file_state == 'A':
391
print '*** added %s %r' % (kind, new_name)
392
if kind == 'file':
393
diffit([],
394
new_tree.get_file(fid).readlines(),
395
fromfile=DEVNULL,
396
tofile=new_label + new_name + idlabel)
397
elif file_state == 'D':
398
assert isinstance(old_name, types.StringTypes)
399
print '*** deleted %s %r' % (kind, old_name)
400
if kind == 'file':
401
diffit(old_tree.get_file(fid).readlines(), [],
402
fromfile=old_label + old_name + idlabel,
403
tofile=DEVNULL)
404
elif file_state in ['M', 'R']:
405
if file_state == 'M':
406
assert kind == 'file'
407
assert old_name == new_name
408
print '*** modified %s %r' % (kind, new_name)
409
elif file_state == 'R':
410
print '*** renamed %s %r => %r' % (kind, old_name, new_name)
411
412
if kind == 'file':
413
diffit(old_tree.get_file(fid).readlines(),
414
new_tree.get_file(fid).readlines(),
415
fromfile=old_label + old_name + idlabel,
416
tofile=new_label + new_name)
417
else:
418
bailout("can't represent state %s {%s}" % (file_state, fid))
419
420
421
422
def cmd_deleted(show_ids=False):
423
"""List files deleted in the working tree.
424
425
TODO: Show files deleted since a previous revision, or between two revisions.
426
"""
427
b = Branch('.')
428
old = b.basis_tree()
429
new = b.working_tree()
430
431
## TODO: Much more efficient way to do this: read in new
432
## directories with readdir, rather than stating each one. Same
433
## level of effort but possibly much less IO. (Or possibly not,
434
## if the directories are very large...)
435
436
for path, ie in old.inventory.iter_entries():
437
if not new.has_id(ie.file_id):
438
if show_ids:
439
print '%-50s %s' % (path, ie.file_id)
440
else:
441
print path
442
443
444
445
def cmd_parse_inventory():
446
import cElementTree
447
448
cElementTree.ElementTree().parse(file('.bzr/inventory'))
449
450
451
452
def cmd_load_inventory():
453
"""Load inventory for timing purposes"""
454
Branch('.').basis_tree().inventory
455
456
457
458
def cmd_dump_new_inventory():
459
import bzrlib.newinventory
460
inv = Branch('.').basis_tree().inventory
461
bzrlib.newinventory.write_inventory(inv, sys.stdout)
462
463
464
def cmd_load_new_inventory():
465
import bzrlib.newinventory
466
bzrlib.newinventory.read_new_inventory(sys.stdin)
467
468
469
def cmd_dump_slacker_inventory():
470
import bzrlib.newinventory
471
inv = Branch('.').basis_tree().inventory
472
bzrlib.newinventory.write_slacker_inventory(inv, sys.stdout)
473
474
475
476
def cmd_root(filename=None):
477
"""Print the branch root."""
478
print bzrlib.branch.find_branch_root(filename)
479
480
481
def cmd_log(timezone='original'):
482
"""Show log of this branch.
483
484
:todo: Options for utc; to show ids; to limit range; etc.
485
"""
486
Branch('.').write_log(show_timezone=timezone)
487
488
489
def cmd_ls(revision=None, verbose=False):
490
"""List files in a tree.
491
492
:todo: Take a revision or remote path and list that tree instead.
493
"""
494
b = Branch('.')
495
if revision == None:
496
tree = b.working_tree()
497
else:
498
tree = b.revision_tree(b.lookup_revision(revision))
499
500
for fp, fc, kind, fid in tree.list_files():
501
if verbose:
502
if kind == 'directory':
503
kindch = '/'
504
elif kind == 'file':
505
kindch = ''
506
else:
507
kindch = '???'
508
509
print '%-8s %s%s' % (fc, fp, kindch)
510
else:
511
print fp
512
513
514
515
def cmd_unknowns():
516
"""List unknown files"""
517
for f in Branch('.').unknowns():
518
print quotefn(f)
519
520
521
522
def cmd_ignored():
523
"""List ignored files and the patterns that matched them.
524
"""
525
tree = Branch('.').working_tree()
526
for path, file_class, kind, file_id in tree.list_files():
527
if file_class != 'I':
528
continue
529
## XXX: Slightly inefficient since this was already calculated
530
pat = tree.is_ignored(path)
531
print '%-50s %s' % (path, pat)
532
533
534
def cmd_lookup_revision(revno):
535
try:
536
revno = int(revno)
537
except ValueError:
538
bailout("usage: lookup-revision REVNO",
539
["REVNO is a non-negative revision number for this branch"])
540
541
print Branch('.').lookup_revision(revno) or NONE_STRING
542
543
544
545
def cmd_export(revno, dest):
546
"""Export past revision to destination directory."""
547
b = Branch('.')
548
rh = b.lookup_revision(int(revno))
549
t = b.revision_tree(rh)
550
t.export(dest)
551
552
def cmd_cat(revision, filename):
553
"""Print file to stdout."""
554
b = Branch('.')
555
b.print_file(b.relpath(filename), int(revision))
556
557
558
######################################################################
559
# internal/test commands
560
561
562
def cmd_uuid():
563
"""Print a newly-generated UUID."""
564
print bzrlib.osutils.uuid()
565
566
567
568
def cmd_local_time_offset():
569
print bzrlib.osutils.local_time_offset()
570
571
572
573
def cmd_commit(message=None, verbose=False):
574
"""Commit changes to a new revision.
575
576
--message MESSAGE
577
Description of changes in this revision; free form text.
578
It is recommended that the first line be a single-sentence
579
summary.
580
--verbose
581
Show status of changed files,
582
583
TODO: Commit only selected files.
584
585
TODO: Run hooks on tree to-be-committed, and after commit.
586
587
TODO: Strict commit that fails if there are unknown or deleted files.
588
"""
589
590
if not message:
591
bailout("please specify a commit message")
592
Branch('.').commit(message, verbose=verbose)
593
594
595
def cmd_check(dir='.'):
596
"""check: Consistency check of branch history.
597
598
usage: bzr check [-v] [BRANCH]
599
600
options:
601
--verbose, -v Show progress of checking.
602
603
This command checks various invariants about the branch storage to
604
detect data corruption or bzr bugs.
605
"""
606
import bzrlib.check
607
bzrlib.check.check(Branch(dir, find_root=False))
608
609
610
def cmd_is(pred, *rest):
611
"""Test whether PREDICATE is true."""
612
try:
613
cmd_handler = globals()['assert_' + pred.replace('-', '_')]
614
except KeyError:
615
bailout("unknown predicate: %s" % quotefn(pred))
616
617
try:
618
cmd_handler(*rest)
619
except BzrCheckError:
620
# by default we don't print the message so that this can
621
# be used from shell scripts without producing noise
622
sys.exit(1)
623
624
625
def cmd_username():
626
print bzrlib.osutils.username()
627
628
629
def cmd_user_email():
630
print bzrlib.osutils.user_email()
631
632
633
def cmd_gen_revision_id():
634
print bzrlib.branch._gen_revision_id(time.time())
635
636
637
def cmd_selftest():
638
"""Run internal test suite"""
639
## -v, if present, is seen by doctest; the argument is just here
640
## so our parser doesn't complain
641
642
## TODO: --verbose option
643
644
failures, tests = 0, 0
645
646
import doctest, bzrlib.store, bzrlib.tests
647
bzrlib.trace.verbose = False
648
649
for m in bzrlib.store, bzrlib.inventory, bzrlib.branch, bzrlib.osutils, \
650
bzrlib.tree, bzrlib.tests, bzrlib.commands, bzrlib.add:
651
mf, mt = doctest.testmod(m)
652
failures += mf
653
tests += mt
654
print '%-40s %3d tests' % (m.__name__, mt),
655
if mf:
656
print '%3d FAILED!' % mf
657
else:
658
print
659
660
print '%-40s %3d tests' % ('total', tests),
661
if failures:
662
print '%3d FAILED!' % failures
663
else:
664
print
665
666
667
668
# deprecated
669
cmd_doctest = cmd_selftest
670
671
672
######################################################################
673
# help
674
675
676
def cmd_help(topic=None):
677
if topic == None:
678
print __doc__
679
return
680
681
# otherwise, maybe the name of a command?
682
try:
683
cmdfn = globals()['cmd_' + topic.replace('-', '_')]
684
except KeyError:
685
bailout("no help for %r" % topic)
686
687
doc = cmdfn.__doc__
688
if doc == None:
689
bailout("sorry, no detailed help yet for %r" % topic)
690
691
print doc
692
693
694
695
696
def cmd_version():
697
print "bzr (bazaar-ng) %s" % bzrlib.__version__
698
print bzrlib.__copyright__
699
print "http://bazaar-ng.org/"
700
print
701
print \
702
"""bzr comes with ABSOLUTELY NO WARRANTY. bzr is free software, and
703
you may use, modify and redistribute it under the terms of the GNU
704
General Public License version 2 or later."""
705
706
707
def cmd_rocks():
708
"""Statement of optimism."""
709
print "it sure does!"
710
711
712
713
######################################################################
714
# main routine
359
715
360
716
361
717
# list of all available options; the rhs can be either None for an
363
719
# the type.
364
720
OPTIONS = {
365
721
'all': None,
366
'diff-options': str,
367
722
'help': None,
368
'file': unicode,
369
'force': None,
370
'format': unicode,
371
'forward': None,
372
723
'message': unicode,
373
'no-recurse': None,
374
724
'profile': None,
375
'revision': _parse_revision_str,
376
'short': None,
725
'revision': int,
377
726
'show-ids': None,
378
727
'timezone': str,
379
728
'verbose': None,
380
729
'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
730
}
390
731
391
732
SHORT_OPTIONS = {
392
'F': 'file',
393
'h': 'help',
394
733
'm': 'message',
395
734
'r': 'revision',
396
735
'v': 'verbose',
397
'l': 'long',
398
736
}
399
737
738
# List of options that apply to particular commands; commands not
739
# listed take none.
740
cmd_options = {
741
'add': ['verbose'],
742
'cat': ['revision'],
743
'commit': ['message', 'verbose'],
744
'deleted': ['show-ids'],
745
'diff': ['revision'],
746
'inventory': ['revision'],
747
'log': ['timezone'],
748
'ls': ['revision', 'verbose'],
749
'remove': ['verbose'],
750
'status': ['all'],
751
}
752
753
754
cmd_args = {
755
'add': ['file+'],
756
'cat': ['filename'],
757
'commit': [],
758
'diff': [],
759
'export': ['revno', 'dest'],
760
'file-id': ['filename'],
761
'file-id-path': ['filename'],
762
'get-file-text': ['text_id'],
763
'get-inventory': ['inventory_id'],
764
'get-revision': ['revision_id'],
765
'get-revision-inventory': ['revision_id'],
766
'help': ['topic?'],
767
'init': [],
768
'log': [],
769
'lookup-revision': ['revno'],
770
'move': ['source$', 'dest'],
771
'relpath': ['filename'],
772
'remove': ['file+'],
773
'rename': ['from_name', 'to_name'],
774
'renames': ['dir?'],
775
'root': ['filename?'],
776
'status': [],
777
}
778
400
779
401
780
def parse_args(argv):
402
781
"""Parse command line.
408
787
409
788
>>> parse_args('--help'.split())
410
789
([], {'help': True})
411
>>> parse_args('help -- --invalidcmd'.split())
412
(['help', '--invalidcmd'], {})
413
790
>>> parse_args('--version'.split())
414
791
([], {'version': True})
415
792
>>> parse_args('status --all'.split())
416
793
(['status'], {'all': True})
417
794
>>> parse_args('commit --message=biter'.split())
418
795
(['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
796
"""
428
797
args = []
429
798
opts = {}
430
799
431
argsover = False
800
# TODO: Maybe handle '--' to end options?
801
432
802
while argv:
433
803
a = argv.pop(0)
434
if not argsover and a[0] == '-':
435
# option names must not be unicode
436
a = str(a)
804
if a[0] == '-':
437
805
optarg = None
438
806
if a[1] == '-':
439
if a == '--':
440
# We've received a standalone -- No more flags
441
argsover = True
442
continue
443
807
mutter(" got option %r" % a)
444
808
if '=' in a:
445
809
optname, optarg = a[2:].split('=', 1)
446
810
else:
447
811
optname = a[2:]
448
812
if optname not in OPTIONS:
449
raise BzrError('unknown long option %r' % a)
813
bailout('unknown long option %r' % a)
450
814
else:
451
815
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:]
816
if shortopt not in SHORT_OPTIONS:
817
bailout('unknown short option %r' % a)
818
optname = SHORT_OPTIONS[shortopt]
480
819
481
820
if optname in opts:
482
821
# XXX: Do we ever want to support this, e.g. for -r?
483
raise BzrError('repeated option %r' % a)
822
bailout('repeated option %r' % a)
484
823
485
824
optargfn = OPTIONS[optname]
486
825
if optargfn:
487
826
if optarg == None:
488
827
if not argv:
489
raise BzrError('option %r needs an argument' % a)
828
bailout('option %r needs an argument' % a)
490
829
else:
491
830
optarg = argv.pop(0)
492
831
opts[optname] = optargfn(optarg)
493
832
else:
494
833
if optarg != None:
495
raise BzrError('option %r takes no argument' % optname)
834
bailout('option %r takes no argument' % optname)
496
835
opts[optname] = True
497
836
else:
498
837
args.append(a)
501
840
502
841
503
842
843
def _match_args(cmd, args):
844
"""Check non-option arguments match required pattern.
504
845
505
def _match_argform(cmd, takes_args, args):
846
>>> _match_args('status', ['asdasdsadasd'])
847
Traceback (most recent call last):
848
...
849
BzrError: ("extra arguments to command status: ['asdasdsadasd']", [])
850
>>> _match_args('add', ['asdasdsadasd'])
851
{'file_list': ['asdasdsadasd']}
852
>>> _match_args('add', 'abc def gj'.split())
853
{'file_list': ['abc', 'def', 'gj']}
854
"""
855
# match argument pattern
856
argform = cmd_args.get(cmd, [])
506
857
argdict = {}
858
# TODO: Need a way to express 'cp SRC... DEST', where it matches
859
# all but one.
507
860
508
# step through args and takes_args, allowing appropriate 0-many matches
509
for ap in takes_args:
861
# step through args and argform, allowing appropriate 0-many matches
862
for ap in argform:
510
863
argname = ap[:-1]
511
864
if ap[-1] == '?':
512
865
if args:
513
866
argdict[argname] = args.pop(0)
514
elif ap[-1] == '*': # all remaining arguments
515
if args:
516
argdict[argname + '_list'] = args[:]
517
args = []
518
else:
519
argdict[argname + '_list'] = None
867
elif ap[-1] == '*':
868
raise BzrError("arg form %r not implemented yet" % ap)
520
869
elif ap[-1] == '+':
521
870
if not args:
522
raise BzrCommandError("command %r needs one or more %s"
871
bailout("command %r needs one or more %s"
523
872
% (cmd, argname.upper()))
524
873
else:
525
874
argdict[argname + '_list'] = args[:]
526
875
args = []
527
876
elif ap[-1] == '$': # all but one
528
877
if len(args) < 2:
529
raise BzrCommandError("command %r needs one or more %s"
878
bailout("command %r needs one or more %s"
530
879
% (cmd, argname.upper()))
531
880
argdict[argname + '_list'] = args[:-1]
532
881
args[:-1] = []
534
883
# just a plain arg
535
884
argname = ap
536
885
if not args:
537
raise BzrCommandError("command %r requires argument %s"
886
bailout("command %r requires argument %s"
538
887
% (cmd, argname.upper()))
539
888
else:
540
889
argdict[argname] = args.pop(0)
541
890
542
891
if args:
543
raise BzrCommandError("extra argument to command %s: %s"
544
% (cmd, args[0]))
892
bailout("extra arguments to command %s: %r"
893
% (cmd, args))
545
894
546
895
return argdict
547
896
548
897
549
898
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()
899
def run_bzr(argv):
900
"""Execute a command.
901
902
This is similar to main(), but without all the trappings for
903
logging and error handling.
904
"""
905
try:
906
args, opts = parse_args(argv[1:])
907
if 'help' in opts:
908
# TODO: pass down other arguments in case they asked for
909
# help on a command name?
910
if args:
911
cmd_help(args[0])
912
else:
913
cmd_help()
914
return 0
915
elif 'version' in opts:
916
cmd_version()
917
return 0
918
cmd = args.pop(0)
919
except IndexError:
920
log_error('usage: bzr COMMAND\n')
921
log_error(' try "bzr help"\n')
922
return 1
923
924
try:
925
cmd_handler = globals()['cmd_' + cmd.replace('-', '_')]
926
except KeyError:
927
bailout("unknown command " + `cmd`)
928
929
# global option
930
if 'profile' in opts:
931
profile = True
932
del opts['profile']
933
else:
934
profile = False
935
936
# check options are reasonable
937
allowed = cmd_options.get(cmd, [])
938
for oname in opts:
939
if oname not in allowed:
940
bailout("option %r is not allowed for command %r"
941
% (oname, cmd))
942
943
# TODO: give an error if there are any mandatory options which are
944
# not specified? Or maybe there shouldn't be any "mandatory
945
# options" (it is an oxymoron)
946
947
# mix arguments and options into one dictionary
948
cmdargs = _match_args(cmd, args)
949
for k, v in opts.items():
950
cmdargs[k.replace('-', '_')] = v
951
952
if profile:
953
import hotshot
954
prof = hotshot.Profile('.bzr.profile')
955
ret = prof.runcall(cmd_handler, **cmdargs) or 0
956
prof.close()
560
957
561
958
import hotshot.stats
562
stats = hotshot.stats.load(pfname)
959
stats = hotshot.stats.load('.bzr.profile')
563
960
#stats.strip_dirs()
564
961
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
962
stats.print_stats(20)
568
963
569
964
return ret
570
finally:
571
os.close(pffileno)
572
os.remove(pfname)
573
574
575
def run_bzr(argv):
576
"""Execute a command.
577
578
This is similar to main(), but without all the trappings for
579
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
"""
599
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
965
else:
643
ret = cmd_obj.run_argv(argv)
644
return ret or 0
966
return cmd_handler(**cmdargs) or 0
967
645
968
646
969
647
970
def main(argv):
648
import bzrlib.ui
649
bzrlib.trace.log_startup(argv)
650
bzrlib.ui.ui_factory = bzrlib.ui.TextUIFactory()
651
971
## TODO: Handle command-line options; probably know what options are valid for
972
## each command
973
974
## TODO: If the arguments are wrong, give a usage message rather
975
## than just a backtrace.
976
977
bzrlib.trace.create_tracefile(argv)
978
652
979
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
980
ret = run_bzr(argv)
981
return ret
662
982
except BzrError, e:
663
bzrlib.trace.log_exception()
983
log_error('bzr: error: ' + e.args[0] + '\n')
984
if len(e.args) > 1:
985
for h in e.args[1]:
986
log_error(' ' + h + '\n')
987
traceback.print_exc(None, bzrlib.trace._tracefile)
988
log_error('(see $HOME/.bzr.log for debug information)\n')
664
989
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
990
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
991
log_error('bzr: exception: %s\n' % e)
992
log_error('(see $HOME/.bzr.log for debug information)\n')
993
traceback.print_exc(None, bzrlib.trace._tracefile)
994
## traceback.print_exc(None, sys.stderr)
995
return 1
996
997
# TODO: Maybe nicer handling of IOError?
998
681
999
682
1000
683
1001
if __name__ == '__main__':
684
1002
sys.exit(main(sys.argv))
1003
##import profile
1004
##profile.run('main(sys.argv)')
1005
Loggerhead is a web-based interface for Breezy
Version: 2.0.1