« back to all changes in this revision
Viewing changes to bzrlib/commands.py
- browse files at revision 731
- compare with another revision
- download diff
- download tarball
- view history from revision 731
- Committer: Martin Pool
- Date: 2005-06-22 06:04:43 UTC
- Revision ID: mbp@sourcefrog.net-20050622060443-12fe7e3443dde3bb
- merge plugin patch from john
- files added:
- .rsyncexclude
- bzrlib/selftest
- contrib
- contrib/bash
- contrib/zsh
- patches
- urlgrabber
- files removed:
- bzrlib/tests.py
- files modified:
- .bzrignore
added
removed
bzrlib/commands.py
1
# Copyright (C) 2004, 2005 by Martin Pool
2
# Copyright (C) 2005 by Canonical Ltd
3
1
# Copyright (C) 2004, 2005 by Canonical Ltd
4
2
5
3
# This program is free software; you can redistribute it and/or modify
6
4
# it under the terms of the GNU General Public License as published by
16
14
# along with this program; if not, write to the Free Software
17
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18
16
19
"""Bazaar-NG -- a free distributed version-control tool
20
21
**WARNING: THIS IS AN UNSTABLE DEVELOPMENT VERSION**
22
23
Current limitation include:
24
25
* Metadata format is not stable yet -- you may need to
26
discard history in the future.
27
28
* Insufficient error handling.
29
30
* Many commands unimplemented or partially implemented.
31
32
* Space-inefficient storage.
33
34
* No merge operators yet.
35
36
Interesting commands::
37
38
bzr help [COMMAND]
39
Show help screen
40
bzr version
41
Show software version/licence/non-warranty.
42
bzr init
43
Start versioning the current directory
44
bzr add FILE...
45
Make files versioned.
46
bzr log
47
Show revision history.
48
bzr diff
49
Show changes from last revision to working copy.
50
bzr commit -m 'MESSAGE'
51
Store current state as new revision.
52
bzr export REVNO DESTINATION
53
Export the branch state at a previous version.
54
bzr status
55
Show summary of pending changes.
56
bzr remove FILE...
57
Make a file not versioned.
58
bzr info
59
Show statistics about this branch.
60
"""
61
62
63
64
65
import sys, os, random, time, sha, sets, types, re, shutil, tempfile
66
import traceback, socket, fnmatch, difflib
67
from os import path
68
from sets import Set
69
from pprint import pprint
70
from stat import *
71
from glob import glob
17
18
19
import sys, os
72
20
73
21
import bzrlib
74
from bzrlib.store import ImmutableStore
75
22
from bzrlib.trace import mutter, note, log_error
76
from bzrlib.errors import bailout, BzrError
77
from bzrlib.osutils import quotefn, pumpfile, isdir, isfile
78
from bzrlib.tree import RevisionTree, EmptyTree, WorkingTree, Tree
79
from bzrlib.revision import Revision
80
from bzrlib import Branch, Inventory, InventoryEntry, ScratchBranch, BZRDIR, \
23
from bzrlib.errors import BzrError, BzrCheckError, BzrCommandError
24
from bzrlib.osutils import quotefn
25
from bzrlib import Branch, Inventory, InventoryEntry, BZRDIR, \
81
26
format_date
82
27
83
BZR_DIFF_FORMAT = "## Bazaar-NG diff, format 0 ##\n"
84
BZR_PATCHNAME_FORMAT = 'cset:sha1:%s'
85
86
## standard representation
87
NONE_STRING = '(none)'
88
EMPTY = 'empty'
89
90
91
## TODO: Perhaps a different version of inventory commands that
92
## returns iterators...
93
94
## TODO: Perhaps an AtomicFile class that writes to a temporary file and then renames.
95
96
## TODO: Some kind of locking on branches. Perhaps there should be a
97
## parameter to the branch object saying whether we want a read or
98
## write lock; release it from destructor. Perhaps don't even need a
99
## read lock to look at immutable objects?
100
101
## TODO: Perhaps make UUIDs predictable in test mode to make it easier
102
## to compare output?
103
104
## TODO: Some kind of global code to generate the right Branch object
105
## to work on. Almost, but not quite all, commands need one, and it
106
## can be taken either from their parameters or their working
107
## directory.
108
109
## TODO: rename command, needed soon: check destination doesn't exist
110
## either in working copy or tree; move working copy; update
111
## inventory; write out
112
113
## TODO: move command; check destination is a directory and will not
114
## clash; move it.
115
116
## TODO: command to show renames, one per line, as to->from
117
118
119
120
121
def cmd_status(all=False):
28
29
plugin_cmds = {}
30
31
32
def register_plugin_command(cmd):
33
"Utility function to help register a command"
34
global plugin_cmds
35
k = cmd.__name__
36
if k.startswith("cmd_"):
37
k_unsquished = _unsquish_command_name(k)
38
else:
39
k_unsquished = k
40
if not plugin_cmds.has_key(k_unsquished):
41
plugin_cmds[k_unsquished] = cmd
42
else:
43
log_error('Two plugins defined the same command: %r' % k)
44
log_error('Not loading the one in %r' % sys.modules[cmd.__module__])
45
46
47
def _squish_command_name(cmd):
48
return 'cmd_' + cmd.replace('-', '_')
49
50
51
def _unsquish_command_name(cmd):
52
assert cmd.startswith("cmd_")
53
return cmd[4:].replace('_','-')
54
55
def _parse_revision_str(revstr):
56
"""This handles a revision string -> revno.
57
58
There are several possibilities:
59
60
'234' -> 234
61
'234:345' -> [234, 345]
62
':234' -> [None, 234]
63
'234:' -> [234, None]
64
65
In the future we will also support:
66
'uuid:blah-blah-blah' -> ?
67
'hash:blahblahblah' -> ?
68
potentially:
69
'tag:mytag' -> ?
70
"""
71
if revstr.find(':') != -1:
72
revs = revstr.split(':')
73
if len(revs) > 2:
74
raise ValueError('More than 2 pieces not supported for --revision: %r' % revstr)
75
76
if not revs[0]:
77
revs[0] = None
78
else:
79
revs[0] = int(revs[0])
80
81
if not revs[1]:
82
revs[1] = None
83
else:
84
revs[1] = int(revs[1])
85
else:
86
revs = int(revstr)
87
return revs
88
89
90
91
def _get_cmd_dict(plugins_override=True):
92
d = {}
93
for k, v in globals().iteritems():
94
if k.startswith("cmd_"):
95
d[_unsquish_command_name(k)] = v
96
# If we didn't load plugins, the plugin_cmds dict will be empty
97
if plugins_override:
98
d.update(plugin_cmds)
99
else:
100
d2 = plugin_cmds.copy()
101
d2.update(d)
102
d = d2
103
return d
104
105
106
def get_all_cmds(plugins_override=True):
107
"""Return canonical name and class for all registered commands."""
108
for k, v in _get_cmd_dict(plugins_override=plugins_override).iteritems():
109
yield k,v
110
111
112
def get_cmd_class(cmd, plugins_override=True):
113
"""Return the canonical name and command class for a command.
114
"""
115
cmd = str(cmd) # not unicode
116
117
# first look up this command under the specified name
118
cmds = _get_cmd_dict(plugins_override=plugins_override)
119
try:
120
return cmd, cmds[cmd]
121
except KeyError:
122
pass
123
124
# look for any command which claims this as an alias
125
for cmdname, cmdclass in cmds.iteritems():
126
if cmd in cmdclass.aliases:
127
return cmdname, cmdclass
128
129
cmdclass = ExternalCommand.find_command(cmd)
130
if cmdclass:
131
return cmd, cmdclass
132
133
raise BzrCommandError("unknown command %r" % cmd)
134
135
136
class Command(object):
137
"""Base class for commands.
138
139
The docstring for an actual command should give a single-line
140
summary, then a complete description of the command. A grammar
141
description will be inserted.
142
143
takes_args
144
List of argument forms, marked with whether they are optional,
145
repeated, etc.
146
147
takes_options
148
List of options that may be given for this command.
149
150
hidden
151
If true, this command isn't advertised.
152
"""
153
aliases = []
154
155
takes_args = []
156
takes_options = []
157
158
hidden = False
159
160
def __init__(self, options, arguments):
161
"""Construct and run the command.
162
163
Sets self.status to the return value of run()."""
164
assert isinstance(options, dict)
165
assert isinstance(arguments, dict)
166
cmdargs = options.copy()
167
cmdargs.update(arguments)
168
assert self.__doc__ != Command.__doc__, \
169
("No help message set for %r" % self)
170
self.status = self.run(**cmdargs)
171
172
173
def run(self):
174
"""Override this in sub-classes.
175
176
This is invoked with the options and arguments bound to
177
keyword parameters.
178
179
Return 0 or None if the command was successful, or a shell
180
error code if not.
181
"""
182
return 0
183
184
185
class ExternalCommand(Command):
186
"""Class to wrap external commands.
187
188
We cheat a little here, when get_cmd_class() calls us we actually give it back
189
an object we construct that has the appropriate path, help, options etc for the
190
specified command.
191
192
When run_bzr() tries to instantiate that 'class' it gets caught by the __call__
193
method, which we override to call the Command.__init__ method. That then calls
194
our run method which is pretty straight forward.
195
196
The only wrinkle is that we have to map bzr's dictionary of options and arguments
197
back into command line options and arguments for the script.
198
"""
199
200
def find_command(cls, cmd):
201
import os.path
202
bzrpath = os.environ.get('BZRPATH', '')
203
204
for dir in bzrpath.split(os.pathsep):
205
path = os.path.join(dir, cmd)
206
if os.path.isfile(path):
207
return ExternalCommand(path)
208
209
return None
210
211
find_command = classmethod(find_command)
212
213
def __init__(self, path):
214
self.path = path
215
216
pipe = os.popen('%s --bzr-usage' % path, 'r')
217
self.takes_options = pipe.readline().split()
218
219
for opt in self.takes_options:
220
if not opt in OPTIONS:
221
raise BzrError("Unknown option '%s' returned by external command %s"
222
% (opt, path))
223
224
# TODO: Is there any way to check takes_args is valid here?
225
self.takes_args = pipe.readline().split()
226
227
if pipe.close() is not None:
228
raise BzrError("Failed funning '%s --bzr-usage'" % path)
229
230
pipe = os.popen('%s --bzr-help' % path, 'r')
231
self.__doc__ = pipe.read()
232
if pipe.close() is not None:
233
raise BzrError("Failed funning '%s --bzr-help'" % path)
234
235
def __call__(self, options, arguments):
236
Command.__init__(self, options, arguments)
237
return self
238
239
def run(self, **kargs):
240
opts = []
241
args = []
242
243
keys = kargs.keys()
244
keys.sort()
245
for name in keys:
246
optname = name.replace('_','-')
247
value = kargs[name]
248
if OPTIONS.has_key(optname):
249
# it's an option
250
opts.append('--%s' % optname)
251
if value is not None and value is not True:
252
opts.append(str(value))
253
else:
254
# it's an arg, or arg list
255
if type(value) is not list:
256
value = [value]
257
for v in value:
258
if v is not None:
259
args.append(str(v))
260
261
self.status = os.spawnv(os.P_WAIT, self.path, [self.path] + opts + args)
262
return self.status
263
264
265
class cmd_status(Command):
122
266
"""Display status summary.
123
267
124
For each file there is a single line giving its file state and name.
125
The name is that in the current revision unless it is deleted or
126
missing, in which case the old name is shown.
127
128
:todo: Don't show unchanged files unless ``--all`` is given?
268
This reports on versioned and unknown files, reporting them
269
grouped by state. Possible states are:
270
271
added
272
Versioned in the working copy but not in the previous revision.
273
274
removed
275
Versioned in the previous revision but removed or deleted
276
in the working copy.
277
278
renamed
279
Path of this file changed from the previous revision;
280
the text may also have changed. This includes files whose
281
parent directory was renamed.
282
283
modified
284
Text has changed since the previous revision.
285
286
unchanged
287
Nothing about this file has changed since the previous revision.
288
Only shown with --all.
289
290
unknown
291
Not versioned and not matching an ignore pattern.
292
293
To see ignored files use 'bzr ignored'. For details in the
294
changes to file texts, use 'bzr diff'.
295
296
If no arguments are specified, the status of the entire working
297
directory is shown. Otherwise, only the status of the specified
298
files or directories is reported. If a directory is given, status
299
is reported for everything inside that directory.
129
300
"""
130
Branch('.').show_status(show_all=all)
131
132
133
134
######################################################################
135
# examining history
136
def cmd_get_revision(revision_id):
137
Branch('.').get_revision(revision_id).write_xml(sys.stdout)
138
139
140
def cmd_get_file_text(text_id):
141
"""Get contents of a file by hash."""
142
sf = Branch('.').text_store[text_id]
143
pumpfile(sf, sys.stdout)
144
145
146
147
######################################################################
148
# commands
149
150
151
def cmd_revno():
152
"""Show number of revisions on this branch"""
153
print Branch('.').revno()
154
155
156
157
def cmd_add(file_list, verbose=False):
301
takes_args = ['file*']
302
takes_options = ['all', 'show-ids']
303
aliases = ['st', 'stat']
304
305
def run(self, all=False, show_ids=False, file_list=None):
306
if file_list:
307
b = Branch(file_list[0])
308
file_list = [b.relpath(x) for x in file_list]
309
# special case: only one path was given and it's the root
310
# of the branch
311
if file_list == ['']:
312
file_list = None
313
else:
314
b = Branch('.')
315
import status
316
status.show_status(b, show_unchanged=all, show_ids=show_ids,
317
specific_files=file_list)
318
319
320
class cmd_cat_revision(Command):
321
"""Write out metadata for a revision."""
322
323
hidden = True
324
takes_args = ['revision_id']
325
326
def run(self, revision_id):
327
Branch('.').get_revision(revision_id).write_xml(sys.stdout)
328
329
330
class cmd_revno(Command):
331
"""Show current revision number.
332
333
This is equal to the number of revisions on this branch."""
334
def run(self):
335
print Branch('.').revno()
336
337
338
class cmd_add(Command):
158
339
"""Add specified files or directories.
159
340
160
341
In non-recursive mode, all the named items are added, regardless
171
352
172
353
Therefore simply saying 'bzr add .' will version all files that
173
354
are currently unknown.
174
"""
175
bzrlib.add.smart_add(file_list, verbose)
176
177
178
def cmd_relpath(filename):
179
"""Show path of file relative to root"""
180
print Branch(filename).relpath(filename)
181
182
183
def cmd_inventory(revision=None):
184
"""Show inventory of the current working copy."""
185
## TODO: Also optionally show a previous inventory
186
## TODO: Format options
187
b = Branch('.')
188
if revision == None:
189
inv = b.read_working_inventory()
190
else:
191
inv = b.get_revision_inventory(b.lookup_revision(revision))
192
193
for path, entry in inv.iter_entries():
194
print '%-50s %s' % (entry.file_id, path)
195
196
197
198
def cmd_info():
199
"""info: Show statistical information for this branch
200
201
usage: bzr info"""
202
import info
203
info.show_info(Branch('.'))
204
205
206
207
def cmd_remove(file_list, verbose=False):
208
b = Branch(file_list[0])
209
b.remove([b.relpath(f) for f in file_list], verbose=verbose)
210
211
212
213
def cmd_file_id(filename):
214
b = Branch(filename)
215
i = b.inventory.path2id(b.relpath(filename))
216
if i is None:
217
bailout("%s is not a versioned file" % filename)
218
else:
219
print i
220
221
222
def cmd_find_filename(fileid):
223
n = find_filename(fileid)
224
if n is None:
225
bailout("%s is not a live file id" % fileid)
226
else:
227
print n
228
229
230
def cmd_revision_history():
231
for patchid in Branch('.').revision_history():
232
print patchid
233
234
235
236
def cmd_init():
237
# TODO: Check we're not already in a working directory? At the
238
# moment you'll get an ugly error.
239
240
# TODO: What if we're in a subdirectory of a branch? Would like
241
# to allow that, but then the parent may need to understand that
242
# the children have disappeared, or should they be versioned in
243
# both?
244
245
# TODO: Take an argument/option for branch name.
246
Branch('.', init=True)
247
248
249
def cmd_diff(revision=None):
250
"""bzr diff: Show differences in working tree.
251
252
usage: bzr diff [-r REV]
253
254
--revision REV
255
Show changes since REV, rather than predecessor.
256
257
TODO: Given two revision arguments, show the difference between them.
258
259
TODO: Allow diff across branches.
260
261
TODO: Option to use external diff command; could be GNU diff, wdiff,
262
or a graphical diff.
263
264
TODO: Diff selected files.
265
"""
266
267
## TODO: Shouldn't be in the cmd function.
268
269
b = Branch('.')
270
271
if revision == None:
272
old_tree = b.basis_tree()
273
else:
274
old_tree = b.revision_tree(b.lookup_revision(revision))
275
276
new_tree = b.working_tree()
277
old_inv = old_tree.inventory
278
new_inv = new_tree.inventory
279
280
# TODO: Options to control putting on a prefix or suffix, perhaps as a format string
281
old_label = ''
282
new_label = ''
283
284
DEVNULL = '/dev/null'
285
# Windows users, don't panic about this filename -- it is a
286
# special signal to GNU patch that the file should be created or
287
# deleted respectively.
288
289
# TODO: Generation of pseudo-diffs for added/deleted files could
290
# be usefully made into a much faster special case.
291
292
# TODO: Better to return them in sorted order I think.
293
294
for file_state, fid, old_name, new_name, kind in bzrlib.diff_trees(old_tree, new_tree):
295
d = None
296
297
# Don't show this by default; maybe do it if an option is passed
298
# idlabel = ' {%s}' % fid
299
idlabel = ''
300
301
# FIXME: Something about the diff format makes patch unhappy
302
# with newly-added files.
303
304
def diffit(*a, **kw):
305
sys.stdout.writelines(difflib.unified_diff(*a, **kw))
306
print
307
308
if file_state in ['.', '?', 'I']:
309
continue
310
elif file_state == 'A':
311
print '*** added %s %r' % (kind, new_name)
312
if kind == 'file':
313
diffit([],
314
new_tree.get_file(fid).readlines(),
315
fromfile=DEVNULL,
316
tofile=new_label + new_name + idlabel)
317
elif file_state == 'D':
318
assert isinstance(old_name, types.StringTypes)
319
print '*** deleted %s %r' % (kind, old_name)
320
if kind == 'file':
321
diffit(old_tree.get_file(fid).readlines(), [],
322
fromfile=old_label + old_name + idlabel,
323
tofile=DEVNULL)
324
elif file_state in ['M', 'R']:
325
if file_state == 'M':
326
assert kind == 'file'
327
assert old_name == new_name
328
print '*** modified %s %r' % (kind, new_name)
329
elif file_state == 'R':
330
print '*** renamed %s %r => %r' % (kind, old_name, new_name)
331
332
if kind == 'file':
333
diffit(old_tree.get_file(fid).readlines(),
334
new_tree.get_file(fid).readlines(),
335
fromfile=old_label + old_name + idlabel,
336
tofile=new_label + new_name)
337
else:
338
bailout("can't represent state %s {%s}" % (file_state, fid))
339
340
341
342
def cmd_deleted(show_ids=False):
355
356
TODO: Perhaps adding a file whose directly is not versioned should
357
recursively add that parent, rather than giving an error?
358
"""
359
takes_args = ['file+']
360
takes_options = ['verbose', 'no-recurse']
361
362
def run(self, file_list, verbose=False, no_recurse=False):
363
bzrlib.add.smart_add(file_list, verbose, not no_recurse)
364
365
366
class cmd_relpath(Command):
367
"""Show path of a file relative to root"""
368
takes_args = ['filename']
369
hidden = True
370
371
def run(self, filename):
372
print Branch(filename).relpath(filename)
373
374
375
376
class cmd_inventory(Command):
377
"""Show inventory of the current working copy or a revision."""
378
takes_options = ['revision', 'show-ids']
379
380
def run(self, revision=None, show_ids=False):
381
b = Branch('.')
382
if revision == None:
383
inv = b.read_working_inventory()
384
else:
385
inv = b.get_revision_inventory(b.lookup_revision(revision))
386
387
for path, entry in inv.entries():
388
if show_ids:
389
print '%-50s %s' % (path, entry.file_id)
390
else:
391
print path
392
393
394
class cmd_move(Command):
395
"""Move files to a different directory.
396
397
examples:
398
bzr move *.txt doc
399
400
The destination must be a versioned directory in the same branch.
401
"""
402
takes_args = ['source$', 'dest']
403
def run(self, source_list, dest):
404
b = Branch('.')
405
406
b.move([b.relpath(s) for s in source_list], b.relpath(dest))
407
408
409
class cmd_rename(Command):
410
"""Change the name of an entry.
411
412
examples:
413
bzr rename frob.c frobber.c
414
bzr rename src/frob.c lib/frob.c
415
416
It is an error if the destination name exists.
417
418
See also the 'move' command, which moves files into a different
419
directory without changing their name.
420
421
TODO: Some way to rename multiple files without invoking bzr for each
422
one?"""
423
takes_args = ['from_name', 'to_name']
424
425
def run(self, from_name, to_name):
426
b = Branch('.')
427
b.rename_one(b.relpath(from_name), b.relpath(to_name))
428
429
430
431
432
433
class cmd_pull(Command):
434
"""Pull any changes from another branch into the current one.
435
436
If the location is omitted, the last-used location will be used.
437
Both the revision history and the working directory will be
438
updated.
439
440
This command only works on branches that have not diverged. Branches are
441
considered diverged if both branches have had commits without first
442
pulling from the other.
443
444
If branches have diverged, you can use 'bzr merge' to pull the text changes
445
from one into the other.
446
"""
447
takes_args = ['location?']
448
449
def run(self, location=None):
450
from bzrlib.merge import merge
451
import errno
452
453
br_to = Branch('.')
454
stored_loc = None
455
try:
456
stored_loc = br_to.controlfile("x-pull", "rb").read().rstrip('\n')
457
except IOError, e:
458
if errno == errno.ENOENT:
459
raise
460
if location is None:
461
if stored_loc is None:
462
raise BzrCommandError("No pull location known or specified.")
463
else:
464
print "Using last location: %s" % stored_loc
465
location = stored_loc
466
from branch import find_branch, DivergedBranches
467
br_from = find_branch(location)
468
location = pull_loc(br_from)
469
old_revno = br_to.revno()
470
try:
471
br_to.update_revisions(br_from)
472
except DivergedBranches:
473
raise BzrCommandError("These branches have diverged. Try merge.")
474
475
merge(('.', -1), ('.', old_revno), check_clean=False)
476
if location != stored_loc:
477
br_to.controlfile("x-pull", "wb").write(location + "\n")
478
479
480
481
class cmd_branch(Command):
482
"""Create a new copy of a branch.
483
484
If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
485
be used. In other words, "branch ../foo/bar" will attempt to create ./bar.
486
487
To retrieve the branch as of a particular revision, supply the --revision
488
parameter, as in "branch foo/bar -r 5".
489
"""
490
takes_args = ['from_location', 'to_location?']
491
takes_options = ['revision']
492
493
def run(self, from_location, to_location=None, revision=None):
494
import errno
495
from bzrlib.merge import merge
496
from branch import find_branch, DivergedBranches, NoSuchRevision
497
from shutil import rmtree
498
try:
499
br_from = find_branch(from_location)
500
except OSError, e:
501
if e.errno == errno.ENOENT:
502
raise BzrCommandError('Source location "%s" does not exist.' %
503
to_location)
504
else:
505
raise
506
507
if to_location is None:
508
to_location = os.path.basename(from_location.rstrip("/\\"))
509
510
try:
511
os.mkdir(to_location)
512
except OSError, e:
513
if e.errno == errno.EEXIST:
514
raise BzrCommandError('Target directory "%s" already exists.' %
515
to_location)
516
if e.errno == errno.ENOENT:
517
raise BzrCommandError('Parent of "%s" does not exist.' %
518
to_location)
519
else:
520
raise
521
br_to = Branch(to_location, init=True)
522
523
try:
524
br_to.update_revisions(br_from, stop_revision=revision)
525
except NoSuchRevision:
526
rmtree(to_location)
527
msg = "The branch %s has no revision %d." % (from_location,
528
revision)
529
raise BzrCommandError(msg)
530
merge((to_location, -1), (to_location, 0), this_dir=to_location,
531
check_clean=False, ignore_zero=True)
532
from_location = pull_loc(br_from)
533
br_to.controlfile("x-pull", "wb").write(from_location + "\n")
534
535
536
def pull_loc(branch):
537
# TODO: Should perhaps just make attribute be 'base' in
538
# RemoteBranch and Branch?
539
if hasattr(branch, "baseurl"):
540
return branch.baseurl
541
else:
542
return branch.base
543
544
545
546
class cmd_renames(Command):
547
"""Show list of renamed files.
548
549
TODO: Option to show renames between two historical versions.
550
551
TODO: Only show renames under dir, rather than in the whole branch.
552
"""
553
takes_args = ['dir?']
554
555
def run(self, dir='.'):
556
b = Branch(dir)
557
old_inv = b.basis_tree().inventory
558
new_inv = b.read_working_inventory()
559
560
renames = list(bzrlib.tree.find_renames(old_inv, new_inv))
561
renames.sort()
562
for old_name, new_name in renames:
563
print "%s => %s" % (old_name, new_name)
564
565
566
class cmd_info(Command):
567
"""Show statistical information about a branch."""
568
takes_args = ['branch?']
569
570
def run(self, branch=None):
571
import info
572
573
from branch import find_branch
574
b = find_branch(branch)
575
info.show_info(b)
576
577
578
class cmd_remove(Command):
579
"""Make a file unversioned.
580
581
This makes bzr stop tracking changes to a versioned file. It does
582
not delete the working copy.
583
"""
584
takes_args = ['file+']
585
takes_options = ['verbose']
586
587
def run(self, file_list, verbose=False):
588
b = Branch(file_list[0])
589
b.remove([b.relpath(f) for f in file_list], verbose=verbose)
590
591
592
class cmd_file_id(Command):
593
"""Print file_id of a particular file or directory.
594
595
The file_id is assigned when the file is first added and remains the
596
same through all revisions where the file exists, even when it is
597
moved or renamed.
598
"""
599
hidden = True
600
takes_args = ['filename']
601
def run(self, filename):
602
b = Branch(filename)
603
i = b.inventory.path2id(b.relpath(filename))
604
if i == None:
605
raise BzrError("%r is not a versioned file" % filename)
606
else:
607
print i
608
609
610
class cmd_file_path(Command):
611
"""Print path of file_ids to a file or directory.
612
613
This prints one line for each directory down to the target,
614
starting at the branch root."""
615
hidden = True
616
takes_args = ['filename']
617
def run(self, filename):
618
b = Branch(filename)
619
inv = b.inventory
620
fid = inv.path2id(b.relpath(filename))
621
if fid == None:
622
raise BzrError("%r is not a versioned file" % filename)
623
for fip in inv.get_idpath(fid):
624
print fip
625
626
627
class cmd_revision_history(Command):
628
"""Display list of revision ids on this branch."""
629
hidden = True
630
def run(self):
631
for patchid in Branch('.').revision_history():
632
print patchid
633
634
635
class cmd_directories(Command):
636
"""Display list of versioned directories in this branch."""
637
def run(self):
638
for name, ie in Branch('.').read_working_inventory().directories():
639
if name == '':
640
print '.'
641
else:
642
print name
643
644
645
class cmd_init(Command):
646
"""Make a directory into a versioned branch.
647
648
Use this to create an empty branch, or before importing an
649
existing project.
650
651
Recipe for importing a tree of files:
652
cd ~/project
653
bzr init
654
bzr add -v .
655
bzr status
656
bzr commit -m 'imported project'
657
"""
658
def run(self):
659
Branch('.', init=True)
660
661
662
class cmd_diff(Command):
663
"""Show differences in working tree.
664
665
If files are listed, only the changes in those files are listed.
666
Otherwise, all changes for the tree are listed.
667
668
TODO: Given two revision arguments, show the difference between them.
669
670
TODO: Allow diff across branches.
671
672
TODO: Option to use external diff command; could be GNU diff, wdiff,
673
or a graphical diff.
674
675
TODO: Python difflib is not exactly the same as unidiff; should
676
either fix it up or prefer to use an external diff.
677
678
TODO: If a directory is given, diff everything under that.
679
680
TODO: Selected-file diff is inefficient and doesn't show you
681
deleted files.
682
683
TODO: This probably handles non-Unix newlines poorly.
684
"""
685
686
takes_args = ['file*']
687
takes_options = ['revision', 'diff-options']
688
aliases = ['di', 'dif']
689
690
def run(self, revision=None, file_list=None, diff_options=None):
691
from bzrlib.diff import show_diff
692
from bzrlib import find_branch
693
694
if file_list:
695
b = find_branch(file_list[0])
696
file_list = [b.relpath(f) for f in file_list]
697
if file_list == ['']:
698
# just pointing to top-of-tree
699
file_list = None
700
else:
701
b = Branch('.')
702
703
show_diff(b, revision, specific_files=file_list,
704
external_diff_options=diff_options)
705
706
707
708
709
710
class cmd_deleted(Command):
343
711
"""List files deleted in the working tree.
344
712
345
TODO: Show files deleted since a previous revision, or between two revisions.
713
TODO: Show files deleted since a previous revision, or between two revisions.
346
714
"""
347
b = Branch('.')
348
old = b.basis_tree()
349
new = b.working_tree()
350
351
for path, ie in old.inventory.iter_entries():
352
if not new.has_id(ie.file_id):
353
if show_ids:
354
print '%-50s %s' % (path, ie.file_id)
355
else:
715
def run(self, show_ids=False):
716
b = Branch('.')
717
old = b.basis_tree()
718
new = b.working_tree()
719
720
## TODO: Much more efficient way to do this: read in new
721
## directories with readdir, rather than stating each one. Same
722
## level of effort but possibly much less IO. (Or possibly not,
723
## if the directories are very large...)
724
725
for path, ie in old.inventory.iter_entries():
726
if not new.has_id(ie.file_id):
727
if show_ids:
728
print '%-50s %s' % (path, ie.file_id)
729
else:
730
print path
731
732
733
class cmd_modified(Command):
734
"""List files modified in working tree."""
735
hidden = True
736
def run(self):
737
import statcache
738
b = Branch('.')
739
inv = b.read_working_inventory()
740
sc = statcache.update_cache(b, inv)
741
basis = b.basis_tree()
742
basis_inv = basis.inventory
743
744
# We used to do this through iter_entries(), but that's slow
745
# when most of the files are unmodified, as is usually the
746
# case. So instead we iterate by inventory entry, and only
747
# calculate paths as necessary.
748
749
for file_id in basis_inv:
750
cacheentry = sc.get(file_id)
751
if not cacheentry: # deleted
752
continue
753
ie = basis_inv[file_id]
754
if cacheentry[statcache.SC_SHA1] != ie.text_sha1:
755
path = inv.id2path(file_id)
356
756
print path
757
758
759
760
class cmd_added(Command):
761
"""List files added in working tree."""
762
hidden = True
763
def run(self):
764
b = Branch('.')
765
wt = b.working_tree()
766
basis_inv = b.basis_tree().inventory
767
inv = wt.inventory
768
for file_id in inv:
769
if file_id in basis_inv:
770
continue
771
path = inv.id2path(file_id)
772
if not os.access(b.abspath(path), os.F_OK):
773
continue
774
print path
357
775
358
359
360
361
def cmd_root(filename=None):
362
"""Print the branch root."""
363
print bzrlib.branch.find_branch_root(filename)
364
365
366
def cmd_log(timezone='original'):
776
777
778
class cmd_root(Command):
779
"""Show the tree root directory.
780
781
The root is the nearest enclosing directory with a .bzr control
782
directory."""
783
takes_args = ['filename?']
784
def run(self, filename=None):
785
"""Print the branch root."""
786
from branch import find_branch
787
b = find_branch(filename)
788
print getattr(b, 'base', None) or getattr(b, 'baseurl')
789
790
791
class cmd_log(Command):
367
792
"""Show log of this branch.
368
793
369
:todo: Options for utc; to show ids; to limit range; etc.
794
To request a range of logs, you can use the command -r begin:end
795
-r revision requests a specific revision, -r :end or -r begin: are
796
also valid.
797
798
TODO: Make --revision support uuid: and hash: [future tag:] notation.
799
370
800
"""
371
Branch('.').write_log(show_timezone=timezone)
372
373
374
def cmd_ls(revision=None, verbose=False):
801
802
takes_args = ['filename?']
803
takes_options = ['forward', 'timezone', 'verbose', 'show-ids', 'revision']
804
805
def run(self, filename=None, timezone='original',
806
verbose=False,
807
show_ids=False,
808
forward=False,
809
revision=None):
810
from bzrlib import show_log, find_branch
811
import codecs
812
813
direction = (forward and 'forward') or 'reverse'
814
815
if filename:
816
b = find_branch(filename)
817
fp = b.relpath(filename)
818
if fp:
819
file_id = b.read_working_inventory().path2id(fp)
820
else:
821
file_id = None # points to branch root
822
else:
823
b = find_branch('.')
824
file_id = None
825
826
if revision == None:
827
revision = [None, None]
828
elif isinstance(revision, int):
829
revision = [revision, revision]
830
else:
831
# pair of revisions?
832
pass
833
834
assert len(revision) == 2
835
836
mutter('encoding log as %r' % bzrlib.user_encoding)
837
838
# use 'replace' so that we don't abort if trying to write out
839
# in e.g. the default C locale.
840
outf = codecs.getwriter(bzrlib.user_encoding)(sys.stdout, errors='replace')
841
842
show_log(b, file_id,
843
show_timezone=timezone,
844
verbose=verbose,
845
show_ids=show_ids,
846
to_file=outf,
847
direction=direction,
848
start_revision=revision[0],
849
end_revision=revision[1])
850
851
852
853
class cmd_touching_revisions(Command):
854
"""Return revision-ids which affected a particular file.
855
856
A more user-friendly interface is "bzr log FILE"."""
857
hidden = True
858
takes_args = ["filename"]
859
def run(self, filename):
860
b = Branch(filename)
861
inv = b.read_working_inventory()
862
file_id = inv.path2id(b.relpath(filename))
863
for revno, revision_id, what in bzrlib.log.find_touching_revisions(b, file_id):
864
print "%6d %s" % (revno, what)
865
866
867
class cmd_ls(Command):
375
868
"""List files in a tree.
376
869
377
:todo: Take a revision or remote path and list that tree instead.
870
TODO: Take a revision or remote path and list that tree instead.
378
871
"""
379
b = Branch('.')
380
if revision == None:
381
tree = b.working_tree()
382
else:
383
tree = b.revision_tree(b.lookup_revision(revision))
384
385
for fp, fc, kind, fid in tree.list_files():
386
if verbose:
387
if kind == 'directory':
388
kindch = '/'
389
elif kind == 'file':
390
kindch = ''
872
hidden = True
873
def run(self, revision=None, verbose=False):
874
b = Branch('.')
875
if revision == None:
876
tree = b.working_tree()
877
else:
878
tree = b.revision_tree(b.lookup_revision(revision))
879
880
for fp, fc, kind, fid in tree.list_files():
881
if verbose:
882
if kind == 'directory':
883
kindch = '/'
884
elif kind == 'file':
885
kindch = ''
886
else:
887
kindch = '???'
888
889
print '%-8s %s%s' % (fc, fp, kindch)
391
890
else:
392
kindch = '???'
393
394
print '%-8s %s%s' % (fc, fp, kindch)
395
else:
396
print fp
397
398
399
400
def cmd_unknowns():
401
"""List unknown files"""
402
for f in Branch('.').unknowns():
403
print quotefn(f)
404
405
406
407
def cmd_ignored(verbose=True):
891
print fp
892
893
894
895
class cmd_unknowns(Command):
896
"""List unknown files."""
897
def run(self):
898
for f in Branch('.').unknowns():
899
print quotefn(f)
900
901
902
903
class cmd_ignore(Command):
904
"""Ignore a command or pattern.
905
906
To remove patterns from the ignore list, edit the .bzrignore file.
907
908
If the pattern contains a slash, it is compared to the whole path
909
from the branch root. Otherwise, it is comapred to only the last
910
component of the path.
911
912
Ignore patterns are case-insensitive on case-insensitive systems.
913
914
Note: wildcards must be quoted from the shell on Unix.
915
916
examples:
917
bzr ignore ./Makefile
918
bzr ignore '*.class'
919
"""
920
takes_args = ['name_pattern']
921
922
def run(self, name_pattern):
923
from bzrlib.atomicfile import AtomicFile
924
import os.path
925
926
b = Branch('.')
927
ifn = b.abspath('.bzrignore')
928
929
if os.path.exists(ifn):
930
f = open(ifn, 'rt')
931
try:
932
igns = f.read().decode('utf-8')
933
finally:
934
f.close()
935
else:
936
igns = ''
937
938
# TODO: If the file already uses crlf-style termination, maybe
939
# we should use that for the newly added lines?
940
941
if igns and igns[-1] != '\n':
942
igns += '\n'
943
igns += name_pattern + '\n'
944
945
try:
946
f = AtomicFile(ifn, 'wt')
947
f.write(igns.encode('utf-8'))
948
f.commit()
949
finally:
950
f.close()
951
952
inv = b.working_tree().inventory
953
if inv.path2id('.bzrignore'):
954
mutter('.bzrignore is already versioned')
955
else:
956
mutter('need to make new .bzrignore file versioned')
957
b.add(['.bzrignore'])
958
959
960
961
class cmd_ignored(Command):
408
962
"""List ignored files and the patterns that matched them.
409
"""
410
tree = Branch('.').working_tree()
411
for path, file_class, kind, id in tree.list_files():
412
if file_class != 'I':
413
continue
414
## XXX: Slightly inefficient since this was already calculated
415
pat = tree.is_ignored(path)
416
print '%-50s %s' % (path, pat)
417
418
419
def cmd_lookup_revision(revno):
420
try:
421
revno = int(revno)
422
except ValueError:
423
bailout("usage: lookup-revision REVNO",
424
["REVNO is a non-negative revision number for this branch"])
425
426
print Branch('.').lookup_revision(revno) or NONE_STRING
427
428
429
430
def cmd_export(revno, dest):
431
"""Export past revision to destination directory."""
432
b = Branch('.')
433
rh = b.lookup_revision(int(revno))
434
t = b.revision_tree(rh)
435
t.export(dest)
436
437
438
439
######################################################################
440
# internal/test commands
441
442
443
def cmd_uuid():
444
"""Print a newly-generated UUID."""
445
print bzrlib.osutils.uuid()
446
447
448
449
def cmd_local_time_offset():
450
print bzrlib.osutils.local_time_offset()
451
452
453
454
def cmd_commit(message=None, verbose=False):
455
"""Commit changes to a new revision.
456
457
--message MESSAGE
458
Description of changes in this revision; free form text.
459
It is recommended that the first line be a single-sentence
460
summary.
461
--verbose
462
Show status of changed files,
463
464
TODO: Commit only selected files.
465
466
TODO: Run hooks on tree to-be-committed, and after commit.
467
468
TODO: Strict commit that fails if there are unknown or deleted files.
469
"""
470
471
if not message:
472
bailout("please specify a commit message")
473
Branch('.').commit(message, verbose=verbose)
474
475
476
def cmd_check(dir='.'):
477
"""check: Consistency check of branch history.
478
479
usage: bzr check [-v] [BRANCH]
480
481
options:
482
--verbose, -v Show progress of checking.
483
484
This command checks various invariants about the branch storage to
485
detect data corruption or bzr bugs.
486
"""
487
import bzrlib.check
488
bzrlib.check.check(Branch(dir, find_root=False))
489
490
491
def cmd_is(pred, *rest):
492
"""Test whether PREDICATE is true."""
493
try:
494
cmd_handler = globals()['assert_' + pred.replace('-', '_')]
495
except KeyError:
496
bailout("unknown predicate: %s" % quotefn(pred))
963
964
See also: bzr ignore"""
965
def run(self):
966
tree = Branch('.').working_tree()
967
for path, file_class, kind, file_id in tree.list_files():
968
if file_class != 'I':
969
continue
970
## XXX: Slightly inefficient since this was already calculated
971
pat = tree.is_ignored(path)
972
print '%-50s %s' % (path, pat)
973
974
975
class cmd_lookup_revision(Command):
976
"""Lookup the revision-id from a revision-number
977
978
example:
979
bzr lookup-revision 33
980
"""
981
hidden = True
982
takes_args = ['revno']
983
984
def run(self, revno):
985
try:
986
revno = int(revno)
987
except ValueError:
988
raise BzrCommandError("not a valid revision-number: %r" % revno)
989
990
print Branch('.').lookup_revision(revno)
991
992
993
class cmd_export(Command):
994
"""Export past revision to destination directory.
995
996
If no revision is specified this exports the last committed revision.
997
998
Format may be an "exporter" name, such as tar, tgz, tbz2. If none is
999
given, exports to a directory (equivalent to --format=dir)."""
1000
# TODO: list known exporters
1001
takes_args = ['dest']
1002
takes_options = ['revision', 'format']
1003
def run(self, dest, revision=None, format='dir'):
1004
b = Branch('.')
1005
if revision == None:
1006
rh = b.revision_history()[-1]
1007
else:
1008
rh = b.lookup_revision(int(revision))
1009
t = b.revision_tree(rh)
1010
t.export(dest, format)
1011
1012
1013
class cmd_cat(Command):
1014
"""Write a file's text from a previous revision."""
1015
1016
takes_options = ['revision']
1017
takes_args = ['filename']
1018
1019
def run(self, filename, revision=None):
1020
if revision == None:
1021
raise BzrCommandError("bzr cat requires a revision number")
1022
b = Branch('.')
1023
b.print_file(b.relpath(filename), int(revision))
1024
1025
1026
class cmd_local_time_offset(Command):
1027
"""Show the offset in seconds from GMT to local time."""
1028
hidden = True
1029
def run(self):
1030
print bzrlib.osutils.local_time_offset()
1031
1032
1033
1034
class cmd_commit(Command):
1035
"""Commit changes into a new revision.
1036
1037
If selected files are specified, only changes to those files are
1038
committed. If a directory is specified then its contents are also
1039
committed.
1040
1041
A selected-file commit may fail in some cases where the committed
1042
tree would be invalid, such as trying to commit a file in a
1043
newly-added directory that is not itself committed.
1044
1045
TODO: Run hooks on tree to-be-committed, and after commit.
1046
1047
TODO: Strict commit that fails if there are unknown or deleted files.
1048
"""
1049
takes_args = ['selected*']
1050
takes_options = ['message', 'file', 'verbose']
1051
aliases = ['ci', 'checkin']
1052
1053
def run(self, message=None, file=None, verbose=True, selected_list=None):
1054
from bzrlib.commit import commit
1055
1056
## Warning: shadows builtin file()
1057
if not message and not file:
1058
raise BzrCommandError("please specify a commit message",
1059
["use either --message or --file"])
1060
elif message and file:
1061
raise BzrCommandError("please specify either --message or --file")
497
1062
498
try:
499
cmd_handler(*rest)
500
except BzrCheckError:
501
# by default we don't print the message so that this can
502
# be used from shell scripts without producing noise
503
sys.exit(1)
504
505
506
def cmd_username():
507
print bzrlib.osutils.username()
508
509
510
def cmd_user_email():
511
print bzrlib.osutils.user_email()
512
513
514
def cmd_gen_revision_id():
515
import time
516
print bzrlib.branch._gen_revision_id(time.time())
517
518
519
def cmd_selftest(verbose=False):
1063
if file:
1064
import codecs
1065
message = codecs.open(file, 'rt', bzrlib.user_encoding).read()
1066
1067
b = Branch('.')
1068
commit(b, message, verbose=verbose, specific_files=selected_list)
1069
1070
1071
class cmd_check(Command):
1072
"""Validate consistency of branch history.
1073
1074
This command checks various invariants about the branch storage to
1075
detect data corruption or bzr bugs.
1076
1077
If given the --update flag, it will update some optional fields
1078
to help ensure data consistency.
1079
"""
1080
takes_args = ['dir?']
1081
1082
def run(self, dir='.'):
1083
import bzrlib.check
1084
bzrlib.check.check(Branch(dir))
1085
1086
1087
1088
class cmd_upgrade(Command):
1089
"""Upgrade branch storage to current format.
1090
1091
This should normally be used only after the check command tells
1092
you to run it.
1093
"""
1094
takes_args = ['dir?']
1095
1096
def run(self, dir='.'):
1097
from bzrlib.upgrade import upgrade
1098
upgrade(Branch(dir))
1099
1100
1101
1102
class cmd_whoami(Command):
1103
"""Show bzr user id."""
1104
takes_options = ['email']
1105
1106
def run(self, email=False):
1107
if email:
1108
print bzrlib.osutils.user_email()
1109
else:
1110
print bzrlib.osutils.username()
1111
1112
1113
class cmd_selftest(Command):
520
1114
"""Run internal test suite"""
521
## -v, if present, is seen by doctest; the argument is just here
522
## so our parser doesn't complain
523
524
## TODO: --verbose option
525
526
failures, tests = 0, 0
527
528
import doctest, bzrlib.store, bzrlib.tests
529
bzrlib.trace.verbose = False
530
531
for m in bzrlib.store, bzrlib.inventory, bzrlib.branch, bzrlib.osutils, \
532
bzrlib.tree, bzrlib.tests, bzrlib.commands, bzrlib.add:
533
mf, mt = doctest.testmod(m)
534
failures += mf
535
tests += mt
536
print '%-40s %3d tests' % (m.__name__, mt),
537
if mf:
538
print '%3d FAILED!' % mf
539
else:
540
print
541
542
print '%-40s %3d tests' % ('total', tests),
543
if failures:
544
print '%3d FAILED!' % failures
545
else:
546
print
547
548
549
550
# deprecated
551
cmd_doctest = cmd_selftest
552
553
554
######################################################################
555
# help
556
557
558
def cmd_help(topic=None):
559
if topic == None:
560
print __doc__
561
return
562
563
# otherwise, maybe the name of a command?
564
try:
565
cmdfn = globals()['cmd_' + topic.replace('-', '_')]
566
except KeyError:
567
bailout("no help for %r" % topic)
568
569
doc = cmdfn.__doc__
570
if doc == None:
571
bailout("sorry, no detailed help yet for %r" % topic)
572
573
print doc
574
575
576
577
578
def cmd_version():
1115
hidden = True
1116
def run(self):
1117
from bzrlib.selftest import selftest
1118
return int(not selftest())
1119
1120
1121
class cmd_version(Command):
1122
"""Show version of bzr."""
1123
def run(self):
1124
show_version()
1125
1126
def show_version():
579
1127
print "bzr (bazaar-ng) %s" % bzrlib.__version__
1128
# is bzrlib itself in a branch?
1129
bzrrev = bzrlib.get_bzr_revision()
1130
if bzrrev:
1131
print " (bzr checkout, revision %d {%s})" % bzrrev
580
1132
print bzrlib.__copyright__
581
1133
print "http://bazaar-ng.org/"
582
1134
print
583
print \
584
"""bzr comes with ABSOLUTELY NO WARRANTY. bzr is free software, and
585
you may use, modify and redistribute it under the terms of the GNU
586
General Public License version 2 or later."""
587
588
589
def cmd_rocks():
1135
print "bzr comes with ABSOLUTELY NO WARRANTY. bzr is free software, and"
1136
print "you may use, modify and redistribute it under the terms of the GNU"
1137
print "General Public License version 2 or later."
1138
1139
1140
class cmd_rocks(Command):
590
1141
"""Statement of optimism."""
591
print "it sure does!"
592
593
594
595
######################################################################
596
# main routine
1142
hidden = True
1143
def run(self):
1144
print "it sure does!"
1145
1146
def parse_spec(spec):
1147
"""
1148
>>> parse_spec(None)
1149
[None, None]
1150
>>> parse_spec("./")
1151
['./', None]
1152
>>> parse_spec("../@")
1153
['..', -1]
1154
>>> parse_spec("../f/@35")
1155
['../f', 35]
1156
"""
1157
if spec is None:
1158
return [None, None]
1159
if '/@' in spec:
1160
parsed = spec.split('/@')
1161
assert len(parsed) == 2
1162
if parsed[1] == "":
1163
parsed[1] = -1
1164
else:
1165
parsed[1] = int(parsed[1])
1166
assert parsed[1] >=0
1167
else:
1168
parsed = [spec, None]
1169
return parsed
1170
1171
1172
1173
class cmd_merge(Command):
1174
"""Perform a three-way merge of trees.
1175
1176
The SPEC parameters are working tree or revision specifiers. Working trees
1177
are specified using standard paths or urls. No component of a directory
1178
path may begin with '@'.
1179
1180
Working tree examples: '.', '..', 'foo@', but NOT 'foo/@bar'
1181
1182
Revisions are specified using a dirname/@revno pair, where dirname is the
1183
branch directory and revno is the revision within that branch. If no revno
1184
is specified, the latest revision is used.
1185
1186
Revision examples: './@127', 'foo/@', '../@1'
1187
1188
The OTHER_SPEC parameter is required. If the BASE_SPEC parameter is
1189
not supplied, the common ancestor of OTHER_SPEC the current branch is used
1190
as the BASE.
1191
1192
merge refuses to run if there are any uncommitted changes, unless
1193
--force is given.
1194
"""
1195
takes_args = ['other_spec', 'base_spec?']
1196
takes_options = ['force']
1197
1198
def run(self, other_spec, base_spec=None, force=False):
1199
from bzrlib.merge import merge
1200
merge(parse_spec(other_spec), parse_spec(base_spec),
1201
check_clean=(not force))
1202
1203
1204
class cmd_revert(Command):
1205
"""Reverse all changes since the last commit.
1206
1207
Only versioned files are affected.
1208
1209
TODO: Store backups of any files that will be reverted, so
1210
that the revert can be undone.
1211
"""
1212
takes_options = ['revision']
1213
1214
def run(self, revision=-1):
1215
from bzrlib.merge import merge
1216
merge(('.', revision), parse_spec('.'),
1217
check_clean=False,
1218
ignore_zero=True)
1219
1220
1221
class cmd_assert_fail(Command):
1222
"""Test reporting of assertion failures"""
1223
hidden = True
1224
def run(self):
1225
assert False, "always fails"
1226
1227
1228
class cmd_help(Command):
1229
"""Show help on a command or other topic.
1230
1231
For a list of all available commands, say 'bzr help commands'."""
1232
takes_args = ['topic?']
1233
aliases = ['?']
1234
1235
def run(self, topic=None):
1236
import help
1237
help.help(topic)
1238
1239
1240
class cmd_update_stat_cache(Command):
1241
"""Update stat-cache mapping inodes to SHA-1 hashes.
1242
1243
For testing only."""
1244
hidden = True
1245
def run(self):
1246
import statcache
1247
b = Branch('.')
1248
statcache.update_cache(b.base, b.read_working_inventory())
1249
597
1250
598
1251
599
1252
# list of all available options; the rhs can be either None for an
601
1254
# the type.
602
1255
OPTIONS = {
603
1256
'all': None,
1257
'diff-options': str,
604
1258
'help': None,
1259
'file': unicode,
1260
'force': None,
1261
'format': unicode,
1262
'forward': None,
605
1263
'message': unicode,
1264
'no-recurse': None,
606
1265
'profile': None,
607
'revision': int,
1266
'revision': _parse_revision_str,
608
1267
'show-ids': None,
609
1268
'timezone': str,
610
1269
'verbose': None,
611
1270
'version': None,
1271
'email': None,
1272
'update': None,
612
1273
}
613
1274
614
1275
SHORT_OPTIONS = {
1276
'F': 'file',
1277
'h': 'help',
615
1278
'm': 'message',
616
1279
'r': 'revision',
617
1280
'v': 'verbose',
618
1281
}
619
1282
620
# List of options that apply to particular commands; commands not
621
# listed take none.
622
cmd_options = {
623
'add': ['verbose'],
624
'commit': ['message', 'verbose'],
625
'deleted': ['show-ids'],
626
'diff': ['revision'],
627
'inventory': ['revision'],
628
'log': ['timezone'],
629
'ls': ['revision', 'verbose'],
630
'remove': ['verbose'],
631
'status': ['all'],
632
}
633
634
635
cmd_args = {
636
'add': ['file+'],
637
'commit': [],
638
'diff': [],
639
'export': ['revno', 'dest'],
640
'file-id': ['filename'],
641
'get-file-text': ['text_id'],
642
'get-inventory': ['inventory_id'],
643
'get-revision': ['revision_id'],
644
'get-revision-inventory': ['revision_id'],
645
'help': ['topic?'],
646
'init': [],
647
'log': [],
648
'lookup-revision': ['revno'],
649
'relpath': ['filename'],
650
'remove': ['file+'],
651
'root': ['filename?'],
652
'status': [],
653
}
654
655
1283
656
1284
def parse_args(argv):
657
1285
"""Parse command line.
669
1297
(['status'], {'all': True})
670
1298
>>> parse_args('commit --message=biter'.split())
671
1299
(['commit'], {'message': u'biter'})
1300
>>> parse_args('log -r 500'.split())
1301
(['log'], {'revision': 500})
1302
>>> parse_args('log -r500:600'.split())
1303
(['log'], {'revision': [500, 600]})
1304
>>> parse_args('log -vr500:600'.split())
1305
(['log'], {'verbose': True, 'revision': [500, 600]})
1306
>>> parse_args('log -rv500:600'.split()) #the r takes an argument
1307
Traceback (most recent call last):
1308
...
1309
ValueError: invalid literal for int(): v500
672
1310
"""
673
1311
args = []
674
1312
opts = {}
678
1316
while argv:
679
1317
a = argv.pop(0)
680
1318
if a[0] == '-':
1319
# option names must not be unicode
1320
a = str(a)
681
1321
optarg = None
682
1322
if a[1] == '-':
683
1323
mutter(" got option %r" % a)
686
1326
else:
687
1327
optname = a[2:]
688
1328
if optname not in OPTIONS:
689
bailout('unknown long option %r' % a)
1329
raise BzrError('unknown long option %r' % a)
690
1330
else:
691
1331
shortopt = a[1:]
692
if shortopt not in SHORT_OPTIONS:
693
bailout('unknown short option %r' % a)
694
optname = SHORT_OPTIONS[shortopt]
1332
if shortopt in SHORT_OPTIONS:
1333
# Multi-character options must have a space to delimit
1334
# their value
1335
optname = SHORT_OPTIONS[shortopt]
1336
else:
1337
# Single character short options, can be chained,
1338
# and have their value appended to their name
1339
shortopt = a[1:2]
1340
if shortopt not in SHORT_OPTIONS:
1341
# We didn't find the multi-character name, and we
1342
# didn't find the single char name
1343
raise BzrError('unknown short option %r' % a)
1344
optname = SHORT_OPTIONS[shortopt]
1345
1346
if a[2:]:
1347
# There are extra things on this option
1348
# see if it is the value, or if it is another
1349
# short option
1350
optargfn = OPTIONS[optname]
1351
if optargfn is None:
1352
# This option does not take an argument, so the
1353
# next entry is another short option, pack it back
1354
# into the list
1355
argv.insert(0, '-' + a[2:])
1356
else:
1357
# This option takes an argument, so pack it
1358
# into the array
1359
optarg = a[2:]
695
1360
696
1361
if optname in opts:
697
1362
# XXX: Do we ever want to support this, e.g. for -r?
698
bailout('repeated option %r' % a)
1363
raise BzrError('repeated option %r' % a)
699
1364
700
1365
optargfn = OPTIONS[optname]
701
1366
if optargfn:
702
1367
if optarg == None:
703
1368
if not argv:
704
bailout('option %r needs an argument' % a)
1369
raise BzrError('option %r needs an argument' % a)
705
1370
else:
706
1371
optarg = argv.pop(0)
707
1372
opts[optname] = optargfn(optarg)
708
1373
else:
709
1374
if optarg != None:
710
bailout('option %r takes no argument' % optname)
1375
raise BzrError('option %r takes no argument' % optname)
711
1376
opts[optname] = True
712
1377
else:
713
1378
args.append(a)
716
1381
717
1382
718
1383
719
def _match_args(cmd, args):
720
"""Check non-option arguments match required pattern.
721
1384
722
>>> _match_args('status', ['asdasdsadasd'])
723
Traceback (most recent call last):
724
...
725
BzrError: ("extra arguments to command status: ['asdasdsadasd']", [])
726
>>> _match_args('add', ['asdasdsadasd'])
727
{'file_list': ['asdasdsadasd']}
728
>>> _match_args('add', 'abc def gj'.split())
729
{'file_list': ['abc', 'def', 'gj']}
730
"""
731
# match argument pattern
732
argform = cmd_args.get(cmd, [])
1385
def _match_argform(cmd, takes_args, args):
733
1386
argdict = {}
734
# TODO: Need a way to express 'cp SRC... DEST', where it matches
735
# all but one.
736
1387
737
# step through args and argform, allowing appropriate 0-many matches
738
for ap in argform:
1388
# step through args and takes_args, allowing appropriate 0-many matches
1389
for ap in takes_args:
739
1390
argname = ap[:-1]
740
1391
if ap[-1] == '?':
741
1392
if args:
742
1393
argdict[argname] = args.pop(0)
743
elif ap[-1] == '*':
744
assert 0
1394
elif ap[-1] == '*': # all remaining arguments
1395
if args:
1396
argdict[argname + '_list'] = args[:]
1397
args = []
1398
else:
1399
argdict[argname + '_list'] = None
745
1400
elif ap[-1] == '+':
746
1401
if not args:
747
bailout("command %r needs one or more %s"
1402
raise BzrCommandError("command %r needs one or more %s"
748
1403
% (cmd, argname.upper()))
749
1404
else:
750
1405
argdict[argname + '_list'] = args[:]
751
1406
args = []
1407
elif ap[-1] == '$': # all but one
1408
if len(args) < 2:
1409
raise BzrCommandError("command %r needs one or more %s"
1410
% (cmd, argname.upper()))
1411
argdict[argname + '_list'] = args[:-1]
1412
args[:-1] = []
752
1413
else:
753
1414
# just a plain arg
754
1415
argname = ap
755
1416
if not args:
756
bailout("command %r requires argument %s"
1417
raise BzrCommandError("command %r requires argument %s"
757
1418
% (cmd, argname.upper()))
758
1419
else:
759
1420
argdict[argname] = args.pop(0)
760
1421
761
1422
if args:
762
bailout("extra arguments to command %s: %r"
763
% (cmd, args))
1423
raise BzrCommandError("extra argument to command %s: %s"
1424
% (cmd, args[0]))
764
1425
765
1426
return argdict
766
1427
767
1428
1429
def _parse_master_args(argv):
1430
"""Parse the arguments that always go with the original command.
1431
These are things like bzr --no-plugins, etc.
1432
1433
There are now 2 types of option flags. Ones that come *before* the command,
1434
and ones that come *after* the command.
1435
Ones coming *before* the command are applied against all possible commands.
1436
And are generally applied before plugins are loaded.
1437
1438
The current list are:
1439
--builtin Allow plugins to load, but don't let them override builtin commands,
1440
they will still be allowed if they do not override a builtin.
1441
--no-plugins Don't load any plugins. This lets you get back to official source
1442
behavior.
1443
--profile Enable the hotspot profile before running the command.
1444
For backwards compatibility, this is also a non-master option.
1445
--version Spit out the version of bzr that is running and exit.
1446
This is also a non-master option.
1447
--help Run help and exit, also a non-master option (I think that should stay, though)
1448
1449
>>> argv, opts = _parse_master_args(['bzr', '--test'])
1450
Traceback (most recent call last):
1451
...
1452
BzrCommandError: Invalid master option: 'test'
1453
>>> argv, opts = _parse_master_args(['bzr', '--version', 'command'])
1454
>>> print argv
1455
['command']
1456
>>> print opts['version']
1457
True
1458
>>> argv, opts = _parse_master_args(['bzr', '--profile', 'command', '--more-options'])
1459
>>> print argv
1460
['command', '--more-options']
1461
>>> print opts['profile']
1462
True
1463
>>> argv, opts = _parse_master_args(['bzr', '--no-plugins', 'command'])
1464
>>> print argv
1465
['command']
1466
>>> print opts['no-plugins']
1467
True
1468
>>> print opts['profile']
1469
False
1470
>>> argv, opts = _parse_master_args(['bzr', 'command', '--profile'])
1471
>>> print argv
1472
['command', '--profile']
1473
>>> print opts['profile']
1474
False
1475
"""
1476
master_opts = {'builtin':False,
1477
'no-plugins':False,
1478
'version':False,
1479
'profile':False,
1480
'help':False
1481
}
1482
1483
# This is the point where we could hook into argv[0] to determine
1484
# what front-end is supposed to be run
1485
# For now, we are just ignoring it.
1486
cmd_name = argv.pop(0)
1487
for arg in argv[:]:
1488
if arg[:2] != '--': # at the first non-option, we return the rest
1489
break
1490
arg = arg[2:] # Remove '--'
1491
if arg not in master_opts:
1492
# We could say that this is not an error, that we should
1493
# just let it be handled by the main section instead
1494
raise BzrCommandError('Invalid master option: %r' % arg)
1495
argv.pop(0) # We are consuming this entry
1496
master_opts[arg] = True
1497
return argv, master_opts
1498
1499
768
1500
769
1501
def run_bzr(argv):
770
1502
"""Execute a command.
771
1503
772
1504
This is similar to main(), but without all the trappings for
773
logging and error handling.
1505
logging and error handling.
774
1506
"""
1507
argv = [a.decode(bzrlib.user_encoding) for a in argv]
1508
775
1509
try:
776
args, opts = parse_args(argv[1:])
1510
# some options like --builtin and --no-plugins have special effects
1511
argv, master_opts = _parse_master_args(argv)
1512
if 'no-plugins' not in master_opts:
1513
bzrlib.load_plugins()
1514
1515
args, opts = parse_args(argv)
1516
1517
if master_opts['help']:
1518
from bzrlib.help import help
1519
if argv:
1520
help(argv[0])
1521
else:
1522
help()
1523
return 0
1524
777
1525
if 'help' in opts:
778
# TODO: pass down other arguments in case they asked for
779
# help on a command name?
780
cmd_help()
1526
from bzrlib.help import help
1527
if args:
1528
help(args[0])
1529
else:
1530
help()
781
1531
return 0
782
1532
elif 'version' in opts:
783
cmd_version()
1533
show_version()
784
1534
return 0
785
cmd = args.pop(0)
1535
elif args and args[0] == 'builtin':
1536
include_plugins=False
1537
args = args[1:]
1538
cmd = str(args.pop(0))
786
1539
except IndexError:
787
log_error('usage: bzr COMMAND\n')
788
log_error(' try "bzr help"\n')
1540
import help
1541
help.help()
789
1542
return 1
790
791
try:
792
cmd_handler = globals()['cmd_' + cmd.replace('-', '_')]
793
except KeyError:
794
bailout("unknown command " + `cmd`)
795
796
# global option
1543
1544
1545
plugins_override = not (master_opts['builtin'])
1546
canonical_cmd, cmd_class = get_cmd_class(cmd, plugins_override=plugins_override)
1547
1548
profile = master_opts['profile']
1549
# For backwards compatibility, I would rather stick with --profile being a
1550
# master/global option
797
1551
if 'profile' in opts:
798
1552
profile = True
799
1553
del opts['profile']
800
else:
801
profile = False
802
1554
803
1555
# check options are reasonable
804
allowed = cmd_options.get(cmd, [])
1556
allowed = cmd_class.takes_options
805
1557
for oname in opts:
806
1558
if oname not in allowed:
807
bailout("option %r is not allowed for command %r"
808
% (oname, cmd))
1559
raise BzrCommandError("option '--%s' is not allowed for command %r"
1560
% (oname, cmd))
809
1561
810
1562
# mix arguments and options into one dictionary
811
cmdargs = _match_args(cmd, args)
1563
cmdargs = _match_argform(cmd, cmd_class.takes_args, args)
1564
cmdopts = {}
812
1565
for k, v in opts.items():
813
cmdargs[k.replace('-', '_')] = v
1566
cmdopts[k.replace('-', '_')] = v
814
1567
815
1568
if profile:
816
import hotshot
817
prof = hotshot.Profile('.bzr.profile')
818
ret = prof.runcall(cmd_handler, **cmdargs) or 0
819
prof.close()
820
821
import hotshot.stats
822
stats = hotshot.stats.load('.bzr.profile')
823
#stats.strip_dirs()
824
stats.sort_stats('cumulative', 'calls')
825
stats.print_stats(20)
1569
import hotshot, tempfile
1570
pffileno, pfname = tempfile.mkstemp()
1571
try:
1572
prof = hotshot.Profile(pfname)
1573
ret = prof.runcall(cmd_class, cmdopts, cmdargs) or 0
1574
prof.close()
1575
1576
import hotshot.stats
1577
stats = hotshot.stats.load(pfname)
1578
#stats.strip_dirs()
1579
stats.sort_stats('time')
1580
## XXX: Might like to write to stderr or the trace file instead but
1581
## print_stats seems hardcoded to stdout
1582
stats.print_stats(20)
1583
1584
return ret.status
1585
1586
finally:
1587
os.close(pffileno)
1588
os.remove(pfname)
826
1589
else:
827
return cmd_handler(**cmdargs) or 0
1590
return cmd_class(cmdopts, cmdargs).status
1591
1592
1593
def _report_exception(summary, quiet=False):
1594
import traceback
1595
log_error('bzr: ' + summary)
1596
bzrlib.trace.log_exception()
1597
1598
if not quiet:
1599
tb = sys.exc_info()[2]
1600
exinfo = traceback.extract_tb(tb)
1601
if exinfo:
1602
sys.stderr.write(' at %s:%d in %s()\n' % exinfo[-1][:3])
1603
sys.stderr.write(' see ~/.bzr.log for debug information\n')
828
1604
829
1605
830
1606
831
1607
def main(argv):
832
## TODO: Handle command-line options; probably know what options are valid for
833
## each command
834
835
## TODO: If the arguments are wrong, give a usage message rather
836
## than just a backtrace.
837
838
bzrlib.trace.create_tracefile(argv)
1608
import errno
839
1609
1610
bzrlib.open_tracefile(argv)
1611
840
1612
try:
841
ret = run_bzr(argv)
842
return ret
843
except BzrError, e:
844
log_error('bzr: error: ' + e.args[0] + '\n')
845
if len(e.args) > 1:
846
for h in e.args[1]:
847
log_error(' ' + h + '\n')
848
return 1
849
except Exception, e:
850
log_error('bzr: exception: %s\n' % e)
851
log_error(' see .bzr.log for details\n')
852
traceback.print_exc(None, bzrlib.trace._tracefile)
853
traceback.print_exc(None, sys.stderr)
854
return 1
855
856
# TODO: Maybe nicer handling of IOError?
857
1613
try:
1614
try:
1615
return run_bzr(argv)
1616
finally:
1617
# do this here inside the exception wrappers to catch EPIPE
1618
sys.stdout.flush()
1619
except BzrError, e:
1620
quiet = isinstance(e, (BzrCommandError))
1621
_report_exception('error: ' + e.args[0], quiet=quiet)
1622
if len(e.args) > 1:
1623
for h in e.args[1]:
1624
# some explanation or hints
1625
log_error(' ' + h)
1626
return 1
1627
except AssertionError, e:
1628
msg = 'assertion failed'
1629
if str(e):
1630
msg += ': ' + str(e)
1631
_report_exception(msg)
1632
return 2
1633
except KeyboardInterrupt, e:
1634
_report_exception('interrupted', quiet=True)
1635
return 2
1636
except Exception, e:
1637
quiet = False
1638
if (isinstance(e, IOError)
1639
and hasattr(e, 'errno')
1640
and e.errno == errno.EPIPE):
1641
quiet = True
1642
msg = 'broken pipe'
1643
else:
1644
msg = str(e).rstrip('\n')
1645
_report_exception(msg, quiet)
1646
return 2
1647
finally:
1648
bzrlib.trace.close_trace()
858
1649
859
1650
860
1651
if __name__ == '__main__':
861
1652
sys.exit(main(sys.argv))
862
##import profile
863
##profile.run('main(sys.argv)')
864
Loggerhead is a web-based interface for Breezy
Version: 2.0.1