14
19
# along with this program; if not, write to the Free Software
15
20
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
22
"""Bazaar-NG -- a free distributed version-control tool
24
**WARNING: THIS IS AN UNSTABLE DEVELOPMENT VERSION**
26
Current limitation include:
28
* Metadata format is not stable yet -- you may need to
29
discard history in the future.
31
* No handling of subdirectories, symlinks or any non-text files.
33
* Insufficient error handling.
35
* Many commands unimplemented or partially implemented.
37
* Space-inefficient storage.
39
* No merge operators yet.
41
Interesting commands::
44
Show summary help screen
46
Show software version/licence/non-warranty.
48
Start versioning the current directory
52
Show revision history.
54
Show changes from last revision to working copy.
55
bzr commit -m 'MESSAGE'
56
Store current state as new revision.
57
bzr export REVNO DESTINATION
58
Export the branch state at a previous version.
60
Show summary of pending changes.
62
Make a file not versioned.
65
# not currently working:
67
# Run internal consistency checks.
69
# Show some information about this branch.
73
__copyright__ = "Copyright 2005 Canonical Development Ltd."
74
__author__ = "Martin Pool <mbp@canonical.com>"
75
__docformat__ = "restructuredtext en"
79
import sys, os, random, time, sha, sets, types, re, shutil, tempfile
80
import traceback, socket, fnmatch, difflib
83
from pprint import pprint
88
from bzrlib.store import ImmutableStore
22
89
from bzrlib.trace import mutter, note, log_error
23
from bzrlib.errors import BzrError, BzrCheckError, BzrCommandError
24
from bzrlib.osutils import quotefn
25
from bzrlib import Branch, Inventory, InventoryEntry, BZRDIR, \
90
from bzrlib.errors import bailout, BzrError
91
from bzrlib.osutils import quotefn, pumpfile, isdir, isfile
92
from bzrlib.tree import RevisionTree, EmptyTree, WorkingTree, Tree
93
from bzrlib.revision import Revision
94
from bzrlib import Branch, Inventory, InventoryEntry, ScratchBranch, BZRDIR, \
32
def register_plugin_command(cmd):
33
"Utility function to help register a command"
36
if k.startswith("cmd_"):
37
k_unsquished = _unsquish_command_name(k)
40
if not plugin_cmds.has_key(k_unsquished):
41
plugin_cmds[k_unsquished] = cmd
43
log_error('Two plugins defined the same command: %r' % k)
44
log_error('Not loading the one in %r' % sys.modules[cmd.__module__])
47
def _squish_command_name(cmd):
48
return 'cmd_' + cmd.replace('-', '_')
51
def _unsquish_command_name(cmd):
52
assert cmd.startswith("cmd_")
53
return cmd[4:].replace('_','-')
55
def _parse_revision_str(revstr):
56
"""This handles a revision string -> revno.
58
There are several possibilities:
61
'234:345' -> [234, 345]
65
In the future we will also support:
66
'uuid:blah-blah-blah' -> ?
67
'hash:blahblahblah' -> ?
71
if revstr.find(':') != -1:
72
revs = revstr.split(':')
74
raise ValueError('More than 2 pieces not supported for --revision: %r' % revstr)
79
revs[0] = int(revs[0])
84
revs[1] = int(revs[1])
91
def _get_cmd_dict(plugins_override=True):
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
100
d2 = plugin_cmds.copy()
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():
112
def get_cmd_class(cmd, plugins_override=True):
113
"""Return the canonical name and command class for a command.
115
cmd = str(cmd) # not unicode
117
# first look up this command under the specified name
118
cmds = _get_cmd_dict(plugins_override=plugins_override)
120
return cmd, cmds[cmd]
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
129
cmdclass = ExternalCommand.find_command(cmd)
133
raise BzrCommandError("unknown command %r" % cmd)
136
class Command(object):
137
"""Base class for commands.
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.
144
List of argument forms, marked with whether they are optional,
148
List of options that may be given for this command.
151
If true, this command isn't advertised.
160
def __init__(self, options, arguments):
161
"""Construct and run the command.
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)
174
"""Override this in sub-classes.
176
This is invoked with the options and arguments bound to
179
Return 0 or None if the command was successful, or a shell
185
class ExternalCommand(Command):
186
"""Class to wrap external commands.
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
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.
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.
200
def find_command(cls, cmd):
202
bzrpath = os.environ.get('BZRPATH', '')
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)
211
find_command = classmethod(find_command)
213
def __init__(self, path):
216
pipe = os.popen('%s --bzr-usage' % path, 'r')
217
self.takes_options = pipe.readline().split()
219
for opt in self.takes_options:
220
if not opt in OPTIONS:
221
raise BzrError("Unknown option '%s' returned by external command %s"
224
# TODO: Is there any way to check takes_args is valid here?
225
self.takes_args = pipe.readline().split()
227
if pipe.close() is not None:
228
raise BzrError("Failed funning '%s --bzr-usage'" % path)
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)
235
def __call__(self, options, arguments):
236
Command.__init__(self, options, arguments)
239
def run(self, **kargs):
246
optname = name.replace('_','-')
248
if OPTIONS.has_key(optname):
250
opts.append('--%s' % optname)
251
if value is not None and value is not True:
252
opts.append(str(value))
254
# it's an arg, or arg list
255
if type(value) is not list:
261
self.status = os.spawnv(os.P_WAIT, self.path, [self.path] + opts + args)
265
class cmd_status(Command):
97
BZR_DIFF_FORMAT = "## Bazaar-NG diff, format 0 ##\n"
98
BZR_PATCHNAME_FORMAT = 'cset:sha1:%s'
100
## standard representation
101
NONE_STRING = '(none)'
105
## TODO: Perhaps a different version of inventory commands that
106
## returns iterators...
108
## TODO: Perhaps an AtomicFile class that writes to a temporary file and then renames.
110
## TODO: Some kind of locking on branches. Perhaps there should be a
111
## parameter to the branch object saying whether we want a read or
112
## write lock; release it from destructor. Perhaps don't even need a
113
## read lock to look at immutable objects?
115
## TODO: Perhaps make UUIDs predictable in test mode to make it easier
116
## to compare output?
121
######################################################################
125
def cmd_status(all=False):
266
126
"""Display status summary.
268
This reports on versioned and unknown files, reporting them
269
grouped by state. Possible states are:
272
Versioned in the working copy but not in the previous revision.
275
Versioned in the previous revision but removed or deleted
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.
284
Text has changed since the previous revision.
287
Nothing about this file has changed since the previous revision.
288
Only shown with --all.
291
Not versioned and not matching an ignore pattern.
293
To see ignored files use 'bzr ignored'. For details in the
294
changes to file texts, use 'bzr diff'.
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.
301
takes_args = ['file*']
302
takes_options = ['all', 'show-ids']
303
aliases = ['st', 'stat']
305
def run(self, all=False, show_ids=False, file_list=None):
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
311
if file_list == ['']:
316
status.show_status(b, show_unchanged=all, show_ids=show_ids,
317
specific_files=file_list)
320
class cmd_cat_revision(Command):
321
"""Write out metadata for a revision."""
324
takes_args = ['revision_id']
326
def run(self, revision_id):
327
Branch('.').get_revision(revision_id).write_xml(sys.stdout)
330
class cmd_revno(Command):
331
"""Show current revision number.
333
This is equal to the number of revisions on this branch."""
335
print Branch('.').revno()
338
class cmd_add(Command):
339
"""Add specified files or directories.
341
In non-recursive mode, all the named items are added, regardless
342
of whether they were previously ignored. A warning is given if
343
any of the named files are already versioned.
345
In recursive mode (the default), files are treated the same way
346
but the behaviour for directories is different. Directories that
347
are already versioned do not give a warning. All directories,
348
whether already versioned or not, are searched for files or
349
subdirectories that are neither versioned or ignored, and these
350
are added. This search proceeds recursively into versioned
353
Therefore simply saying 'bzr add .' will version all files that
354
are currently unknown.
356
TODO: Perhaps adding a file whose directly is not versioned should
357
recursively add that parent, rather than giving an error?
359
takes_args = ['file+']
360
takes_options = ['verbose', 'no-recurse']
362
def run(self, file_list, verbose=False, no_recurse=False):
363
bzrlib.add.smart_add(file_list, verbose, not no_recurse)
366
class cmd_relpath(Command):
367
"""Show path of a file relative to root"""
368
takes_args = ['filename']
371
def run(self, filename):
372
print Branch(filename).relpath(filename)
376
class cmd_inventory(Command):
377
"""Show inventory of the current working copy or a revision."""
378
takes_options = ['revision', 'show-ids']
380
def run(self, revision=None, show_ids=False):
383
inv = b.read_working_inventory()
385
inv = b.get_revision_inventory(b.lookup_revision(revision))
387
for path, entry in inv.entries():
389
print '%-50s %s' % (path, entry.file_id)
394
class cmd_move(Command):
395
"""Move files to a different directory.
400
The destination must be a versioned directory in the same branch.
402
takes_args = ['source$', 'dest']
403
def run(self, source_list, dest):
406
b.move([b.relpath(s) for s in source_list], b.relpath(dest))
409
class cmd_rename(Command):
410
"""Change the name of an entry.
413
bzr rename frob.c frobber.c
414
bzr rename src/frob.c lib/frob.c
416
It is an error if the destination name exists.
418
See also the 'move' command, which moves files into a different
419
directory without changing their name.
421
TODO: Some way to rename multiple files without invoking bzr for each
423
takes_args = ['from_name', 'to_name']
425
def run(self, from_name, to_name):
427
b.rename_one(b.relpath(from_name), b.relpath(to_name))
433
class cmd_pull(Command):
434
"""Pull any changes from another branch into the current one.
436
If the location is omitted, the last-used location will be used.
437
Both the revision history and the working directory will be
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.
444
If branches have diverged, you can use 'bzr merge' to pull the text changes
445
from one into the other.
447
takes_args = ['location?']
449
def run(self, location=None):
450
from bzrlib.merge import merge
456
stored_loc = br_to.controlfile("x-pull", "rb").read().rstrip('\n')
458
if errno == errno.ENOENT:
461
if stored_loc is None:
462
raise BzrCommandError("No pull location known or specified.")
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()
471
br_to.update_revisions(br_from)
472
except DivergedBranches:
473
raise BzrCommandError("These branches have diverged. Try merge.")
475
merge(('.', -1), ('.', old_revno), check_clean=False)
476
if location != stored_loc:
477
br_to.controlfile("x-pull", "wb").write(location + "\n")
481
class cmd_branch(Command):
482
"""Create a new copy of a branch.
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.
487
To retrieve the branch as of a particular revision, supply the --revision
488
parameter, as in "branch foo/bar -r 5".
490
takes_args = ['from_location', 'to_location?']
491
takes_options = ['revision']
493
def run(self, from_location, to_location=None, revision=None):
495
from bzrlib.merge import merge
496
from branch import find_branch, DivergedBranches, NoSuchRevision
497
from shutil import rmtree
499
br_from = find_branch(from_location)
501
if e.errno == errno.ENOENT:
502
raise BzrCommandError('Source location "%s" does not exist.' %
507
if to_location is None:
508
to_location = os.path.basename(from_location.rstrip("/\\"))
511
os.mkdir(to_location)
513
if e.errno == errno.EEXIST:
514
raise BzrCommandError('Target directory "%s" already exists.' %
516
if e.errno == errno.ENOENT:
517
raise BzrCommandError('Parent of "%s" does not exist.' %
521
br_to = Branch(to_location, init=True)
524
br_to.update_revisions(br_from, stop_revision=revision)
525
except NoSuchRevision:
527
msg = "The branch %s has no revision %d." % (from_location,
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")
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
546
class cmd_renames(Command):
547
"""Show list of renamed files.
549
TODO: Option to show renames between two historical versions.
551
TODO: Only show renames under dir, rather than in the whole branch.
553
takes_args = ['dir?']
555
def run(self, dir='.'):
557
old_inv = b.basis_tree().inventory
558
new_inv = b.read_working_inventory()
560
renames = list(bzrlib.tree.find_renames(old_inv, new_inv))
562
for old_name, new_name in renames:
563
print "%s => %s" % (old_name, new_name)
566
class cmd_info(Command):
567
"""Show statistical information about a branch."""
568
takes_args = ['branch?']
570
def run(self, branch=None):
573
from branch import find_branch
574
b = find_branch(branch)
578
class cmd_remove(Command):
579
"""Make a file unversioned.
581
This makes bzr stop tracking changes to a versioned file. It does
582
not delete the working copy.
584
takes_args = ['file+']
585
takes_options = ['verbose']
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)
592
class cmd_file_id(Command):
593
"""Print file_id of a particular file or directory.
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
600
takes_args = ['filename']
601
def run(self, filename):
603
i = b.inventory.path2id(b.relpath(filename))
605
raise BzrError("%r is not a versioned file" % filename)
610
class cmd_file_path(Command):
611
"""Print path of file_ids to a file or directory.
613
This prints one line for each directory down to the target,
614
starting at the branch root."""
616
takes_args = ['filename']
617
def run(self, filename):
620
fid = inv.path2id(b.relpath(filename))
622
raise BzrError("%r is not a versioned file" % filename)
623
for fip in inv.get_idpath(fid):
627
class cmd_revision_history(Command):
628
"""Display list of revision ids on this branch."""
631
for patchid in Branch('.').revision_history():
635
class cmd_directories(Command):
636
"""Display list of versioned directories in this branch."""
638
for name, ie in Branch('.').read_working_inventory().directories():
645
class cmd_init(Command):
646
"""Make a directory into a versioned branch.
648
Use this to create an empty branch, or before importing an
651
Recipe for importing a tree of files:
656
bzr commit -m 'imported project'
659
Branch('.', init=True)
662
class cmd_diff(Command):
663
"""Show differences in working tree.
665
If files are listed, only the changes in those files are listed.
666
Otherwise, all changes for the tree are listed.
668
TODO: Given two revision arguments, show the difference between them.
670
TODO: Allow diff across branches.
672
TODO: Option to use external diff command; could be GNU diff, wdiff,
675
TODO: Python difflib is not exactly the same as unidiff; should
676
either fix it up or prefer to use an external diff.
678
TODO: If a directory is given, diff everything under that.
680
TODO: Selected-file diff is inefficient and doesn't show you
683
TODO: This probably handles non-Unix newlines poorly.
686
takes_args = ['file*']
687
takes_options = ['revision', 'diff-options']
688
aliases = ['di', 'dif']
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
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
703
show_diff(b, revision, specific_files=file_list,
704
external_diff_options=diff_options)
710
class cmd_deleted(Command):
711
"""List files deleted in the working tree.
713
TODO: Show files deleted since a previous revision, or between two revisions.
715
def run(self, show_ids=False):
718
new = b.working_tree()
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...)
725
for path, ie in old.inventory.iter_entries():
726
if not new.has_id(ie.file_id):
728
print '%-50s %s' % (path, ie.file_id)
733
class cmd_modified(Command):
734
"""List files modified in working tree."""
128
For each file there is a single line giving its file state and name.
129
The name is that in the current revision unless it is deleted or
130
missing, in which case the old name is shown.
132
:todo: Don't show unchanged files unless ``--all`` is given?
134
Branch('.').show_status(show_all=all)
138
######################################################################
140
def cmd_get_revision(revision_id):
141
Branch('.').get_revision(revision_id).write_xml(sys.stdout)
144
def cmd_get_inventory(inventory_id):
145
"""Return inventory in XML by hash"""
146
Branch('.').get_inventory(inventory_hash).write_xml(sys.stdout)
149
def cmd_get_revision_inventory(revision_id):
150
"""Output inventory for a revision."""
152
b.get_revision_inventory(revision_id).write_xml(sys.stdout)
155
def cmd_get_file_text(text_id):
156
"""Get contents of a file by hash."""
157
sf = Branch('.').text_store[text_id]
158
pumpfile(sf, sys.stdout)
162
######################################################################
167
"""Show number of revisions on this branch"""
168
print Branch('.').revno()
171
def cmd_add(file_list, verbose=False):
172
"""Add specified files.
174
Fails if the files are already added.
176
Branch('.').add(file_list, verbose=verbose)
179
def cmd_inventory(revision=None):
180
"""Show inventory of the current working copy."""
181
## TODO: Also optionally show a previous inventory
182
## TODO: Format options
739
185
inv = b.read_working_inventory()
740
sc = statcache.update_cache(b, inv)
741
basis = b.basis_tree()
742
basis_inv = basis.inventory
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.
749
for file_id in basis_inv:
750
cacheentry = sc.get(file_id)
751
if not cacheentry: # deleted
753
ie = basis_inv[file_id]
754
if cacheentry[statcache.SC_SHA1] != ie.text_sha1:
755
path = inv.id2path(file_id)
760
class cmd_added(Command):
761
"""List files added in working tree."""
765
wt = b.working_tree()
766
basis_inv = b.basis_tree().inventory
769
if file_id in basis_inv:
771
path = inv.id2path(file_id)
772
if not os.access(b.abspath(path), os.F_OK):
778
class cmd_root(Command):
779
"""Show the tree root directory.
781
The root is the nearest enclosing directory with a .bzr control
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')
791
class cmd_log(Command):
187
inv = b.get_revision_inventory(b.lookup_revision(revision))
189
for path, entry in inv.iter_entries():
190
print '%-50s %s' % (entry.file_id, path)
196
print 'branch format:', b.controlfile('branch-format', 'r').readline().rstrip('\n')
198
def plural(n, base='', pl=None):
206
count_version_dirs = 0
208
count_status = {'A': 0, 'D': 0, 'M': 0, 'R': 0, '?': 0, 'I': 0, '.': 0}
209
for st_tup in bzrlib.diff_trees(b.basis_tree(), b.working_tree()):
211
count_status[fs] += 1
212
if fs not in ['I', '?'] and st_tup[4] == 'directory':
213
count_version_dirs += 1
216
print 'in the working tree:'
217
for name, fs in (('unchanged', '.'),
218
('modified', 'M'), ('added', 'A'), ('removed', 'D'),
219
('renamed', 'R'), ('unknown', '?'), ('ignored', 'I'),
221
print ' %5d %s' % (count_status[fs], name)
222
print ' %5d versioned subdirector%s' % (count_version_dirs,
223
plural(count_version_dirs, 'y', 'ies'))
226
print 'branch history:'
227
history = b.revision_history()
229
print ' %5d revision%s' % (revno, plural(revno))
232
committers.add(b.get_revision(rev).committer)
233
print ' %5d committer%s' % (len(committers), plural(len(committers)))
235
firstrev = b.get_revision(history[0])
236
age = int((time.time() - firstrev.timestamp) / 3600 / 24)
237
print ' %5d day%s old' % (age, plural(age))
238
print ' first revision: %s' % format_date(firstrev.timestamp,
241
lastrev = b.get_revision(history[-1])
242
print ' latest revision: %s' % format_date(lastrev.timestamp,
248
def cmd_remove(file_list, verbose=False):
249
Branch('.').remove(file_list, verbose=verbose)
253
def cmd_file_id(filename):
254
i = Branch('.').read_working_inventory().path2id(filename)
256
bailout("%s is not a versioned file" % filename)
261
def cmd_find_filename(fileid):
262
n = find_filename(fileid)
264
bailout("%s is not a live file id" % fileid)
269
def cmd_revision_history():
270
for patchid in Branch('.').revision_history():
276
# TODO: Check we're not already in a working directory? At the
277
# moment you'll get an ugly error.
279
# TODO: What if we're in a subdirectory of a branch? Would like
280
# to allow that, but then the parent may need to understand that
281
# the children have disappeared, or should they be versioned in
284
# TODO: Take an argument/option for branch name.
285
Branch('.', init=True)
288
def cmd_diff(revision=None):
289
"""Show diff from basis to working copy.
291
:todo: Take one or two revision arguments, look up those trees,
294
:todo: Allow diff across branches.
296
:todo: Mangle filenames in diff to be more relevant.
298
:todo: Shouldn't be in the cmd function.
304
old_tree = b.basis_tree()
306
old_tree = b.revision_tree(b.lookup_revision(revision))
308
new_tree = b.working_tree()
309
old_inv = old_tree.inventory
310
new_inv = new_tree.inventory
312
# TODO: Options to control putting on a prefix or suffix, perhaps as a format string
316
DEVNULL = '/dev/null'
317
# Windows users, don't panic about this filename -- it is a
318
# special signal to GNU patch that the file should be created or
319
# deleted respectively.
321
# TODO: Generation of pseudo-diffs for added/deleted files could
322
# be usefully made into a much faster special case.
324
# TODO: Better to return them in sorted order I think.
326
for file_state, fid, old_name, new_name, kind in bzrlib.diff_trees(old_tree, new_tree):
329
# Don't show this by default; maybe do it if an option is passed
330
# idlabel = ' {%s}' % fid
333
# FIXME: Something about the diff format makes patch unhappy
334
# with newly-added files.
336
def diffit(*a, **kw):
337
sys.stdout.writelines(difflib.unified_diff(*a, **kw))
340
if file_state in ['.', '?', 'I']:
342
elif file_state == 'A':
343
print '*** added %s %r' % (kind, new_name)
346
new_tree.get_file(fid).readlines(),
348
tofile=new_label + new_name + idlabel)
349
elif file_state == 'D':
350
assert isinstance(old_name, types.StringTypes)
351
print '*** deleted %s %r' % (kind, old_name)
353
diffit(old_tree.get_file(fid).readlines(), [],
354
fromfile=old_label + old_name + idlabel,
356
elif file_state in ['M', 'R']:
357
if file_state == 'M':
358
assert kind == 'file'
359
assert old_name == new_name
360
print '*** modified %s %r' % (kind, new_name)
361
elif file_state == 'R':
362
print '*** renamed %s %r => %r' % (kind, old_name, new_name)
365
diffit(old_tree.get_file(fid).readlines(),
366
new_tree.get_file(fid).readlines(),
367
fromfile=old_label + old_name + idlabel,
368
tofile=new_label + new_name)
370
bailout("can't represent state %s {%s}" % (file_state, fid))
374
def cmd_log(timezone='original'):
792
375
"""Show log of this branch.
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
798
TODO: Make --revision support uuid: and hash: [future tag:] notation.
377
:todo: Options for utc; to show ids; to limit range; etc.
802
takes_args = ['filename?']
803
takes_options = ['forward', 'timezone', 'verbose', 'show-ids', 'revision']
805
def run(self, filename=None, timezone='original',
810
from bzrlib import show_log, find_branch
813
direction = (forward and 'forward') or 'reverse'
816
b = find_branch(filename)
817
fp = b.relpath(filename)
819
file_id = b.read_working_inventory().path2id(fp)
821
file_id = None # points to branch root
827
revision = [None, None]
828
elif isinstance(revision, int):
829
revision = [revision, revision]
834
assert len(revision) == 2
836
mutter('encoding log as %r' % bzrlib.user_encoding)
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')
843
show_timezone=timezone,
848
start_revision=revision[0],
849
end_revision=revision[1])
853
class cmd_touching_revisions(Command):
854
"""Return revision-ids which affected a particular file.
856
A more user-friendly interface is "bzr log FILE"."""
858
takes_args = ["filename"]
859
def run(self, 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)
867
class cmd_ls(Command):
379
Branch('.').write_log(show_timezone=timezone)
382
def cmd_ls(revision=None, verbose=False):
868
383
"""List files in a tree.
870
TODO: Take a revision or remote path and list that tree instead.
385
:todo: Take a revision or remote path and list that tree instead.
873
def run(self, revision=None, verbose=False):
876
tree = b.working_tree()
878
tree = b.revision_tree(b.lookup_revision(revision))
880
for fp, fc, kind, fid in tree.list_files():
882
if kind == 'directory':
889
print '%-8s %s%s' % (fc, fp, kindch)
389
tree = b.working_tree()
391
tree = b.revision_tree(b.lookup_revision(revision))
393
for fp, fc, kind, fid in tree.list_files():
395
if kind == 'directory':
895
class cmd_unknowns(Command):
896
"""List unknown files."""
898
for f in Branch('.').unknowns():
903
class cmd_ignore(Command):
904
"""Ignore a command or pattern.
906
To remove patterns from the ignore list, edit the .bzrignore file.
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.
912
Ignore patterns are case-insensitive on case-insensitive systems.
914
Note: wildcards must be quoted from the shell on Unix.
917
bzr ignore ./Makefile
920
takes_args = ['name_pattern']
922
def run(self, name_pattern):
923
from bzrlib.atomicfile import AtomicFile
927
ifn = b.abspath('.bzrignore')
929
if os.path.exists(ifn):
932
igns = f.read().decode('utf-8')
938
# TODO: If the file already uses crlf-style termination, maybe
939
# we should use that for the newly added lines?
941
if igns and igns[-1] != '\n':
943
igns += name_pattern + '\n'
946
f = AtomicFile(ifn, 'wt')
947
f.write(igns.encode('utf-8'))
952
inv = b.working_tree().inventory
953
if inv.path2id('.bzrignore'):
954
mutter('.bzrignore is already versioned')
956
mutter('need to make new .bzrignore file versioned')
957
b.add(['.bzrignore'])
961
class cmd_ignored(Command):
962
"""List ignored files and the patterns that matched them.
964
See also: bzr ignore"""
966
tree = Branch('.').working_tree()
967
for path, file_class, kind, file_id in tree.list_files():
968
if file_class != 'I':
970
## XXX: Slightly inefficient since this was already calculated
971
pat = tree.is_ignored(path)
972
print '%-50s %s' % (path, pat)
975
class cmd_lookup_revision(Command):
976
"""Lookup the revision-id from a revision-number
979
bzr lookup-revision 33
982
takes_args = ['revno']
984
def run(self, revno):
988
raise BzrCommandError("not a valid revision-number: %r" % revno)
990
print Branch('.').lookup_revision(revno)
993
class cmd_export(Command):
994
"""Export past revision to destination directory.
996
If no revision is specified this exports the last committed revision.
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'):
1005
if revision == None:
1006
rh = b.revision_history()[-1]
1008
rh = b.lookup_revision(int(revision))
1009
t = b.revision_tree(rh)
1010
t.export(dest, format)
1013
class cmd_cat(Command):
1014
"""Write a file's text from a previous revision."""
1016
takes_options = ['revision']
1017
takes_args = ['filename']
1019
def run(self, filename, revision=None):
1020
if revision == None:
1021
raise BzrCommandError("bzr cat requires a revision number")
1023
b.print_file(b.relpath(filename), int(revision))
1026
class cmd_local_time_offset(Command):
1027
"""Show the offset in seconds from GMT to local time."""
1030
print bzrlib.osutils.local_time_offset()
1034
class cmd_commit(Command):
1035
"""Commit changes into a new revision.
1037
If selected files are specified, only changes to those files are
1038
committed. If a directory is specified then its contents are also
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.
1045
TODO: Run hooks on tree to-be-committed, and after commit.
1047
TODO: Strict commit that fails if there are unknown or deleted files.
1049
takes_args = ['selected*']
1050
takes_options = ['message', 'file', 'verbose']
1051
aliases = ['ci', 'checkin']
1053
def run(self, message=None, file=None, verbose=True, selected_list=None):
1054
from bzrlib.commit import commit
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")
402
print '%-8s %s%s' % (fc, fp, kindch)
409
"""List unknown files"""
410
for f in Branch('.').unknowns():
414
def cmd_lookup_revision(revno):
418
bailout("usage: lookup-revision REVNO",
419
["REVNO is a non-negative revision number for this branch"])
421
print Branch('.').lookup_revision(revno) or NONE_STRING
425
def cmd_export(revno, dest):
426
"""Export past revision to destination directory."""
428
rh = b.lookup_revision(int(revno))
429
t = b.revision_tree(rh)
434
######################################################################
435
# internal/test commands
439
"""Print a newly-generated UUID."""
444
def cmd_local_time_offset():
445
print bzrlib.osutils.local_time_offset()
449
def cmd_commit(message, verbose=False):
450
Branch('.').commit(message, verbose=verbose)
454
"""Check consistency of the branch."""
458
def cmd_is(pred, *rest):
459
"""Test whether PREDICATE is true."""
461
cmd_handler = globals()['assert_' + pred.replace('-', '_')]
463
bailout("unknown predicate: %s" % quotefn(pred))
1065
message = codecs.open(file, 'rt', bzrlib.user_encoding).read()
1068
commit(b, message, verbose=verbose, specific_files=selected_list)
1071
class cmd_check(Command):
1072
"""Validate consistency of branch history.
1074
This command checks various invariants about the branch storage to
1075
detect data corruption or bzr bugs.
1077
If given the --update flag, it will update some optional fields
1078
to help ensure data consistency.
1080
takes_args = ['dir?']
1082
def run(self, dir='.'):
1084
bzrlib.check.check(Branch(dir))
1088
class cmd_upgrade(Command):
1089
"""Upgrade branch storage to current format.
1091
This should normally be used only after the check command tells
1094
takes_args = ['dir?']
1096
def run(self, dir='.'):
1097
from bzrlib.upgrade import upgrade
1098
upgrade(Branch(dir))
1102
class cmd_whoami(Command):
1103
"""Show bzr user id."""
1104
takes_options = ['email']
467
except BzrCheckError:
468
# by default we don't print the message so that this can
469
# be used from shell scripts without producing noise
474
print bzrlib.osutils.username()
477
def cmd_user_email():
478
print bzrlib.osutils.user_email()
481
def cmd_gen_revision_id():
483
print bzrlib.branch._gen_revision_id(time.time())
487
"""Run internal doctest suite"""
488
## -v, if present, is seen by doctest; the argument is just here
489
## so our parser doesn't complain
491
## TODO: --verbose option
1106
def run(self, email=False):
1108
print bzrlib.osutils.user_email()
1110
print bzrlib.osutils.username()
1113
class cmd_selftest(Command):
1114
"""Run internal test suite"""
1117
from bzrlib.selftest import selftest
1118
return int(not selftest())
1121
class cmd_version(Command):
1122
"""Show version of bzr."""
1127
print "bzr (bazaar-ng) %s" % bzrlib.__version__
1128
# is bzrlib itself in a branch?
1129
bzrrev = bzrlib.get_bzr_revision()
1131
print " (bzr checkout, revision %d {%s})" % bzrrev
1132
print bzrlib.__copyright__
493
import bzr, doctest, bzrlib.store
494
bzrlib.trace.verbose = False
496
doctest.testmod(bzrlib.store)
497
doctest.testmod(bzrlib.inventory)
498
doctest.testmod(bzrlib.branch)
499
doctest.testmod(bzrlib.osutils)
500
doctest.testmod(bzrlib.tree)
502
# more strenuous tests;
504
doctest.testmod(bzrlib.tests)
507
######################################################################
512
# TODO: Specific help for particular commands
517
print "bzr (bazaar-ng) %s" % __version__
1133
519
print "http://bazaar-ng.org/"
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."
1140
class cmd_rocks(Command):
522
"""bzr comes with ABSOLUTELY NO WARRANTY. bzr is free software, and
523
you may use, modify and redistribute it under the terms of the GNU
524
General Public License version 2 or later."""
1141
528
"""Statement of optimism."""
1144
print "it sure does!"
1146
def parse_spec(spec):
1148
>>> parse_spec(None)
1150
>>> parse_spec("./")
1152
>>> parse_spec("../@")
1154
>>> parse_spec("../f/@35")
1160
parsed = spec.split('/@')
1161
assert len(parsed) == 2
1165
parsed[1] = int(parsed[1])
1166
assert parsed[1] >=0
1168
parsed = [spec, None]
1173
class cmd_merge(Command):
1174
"""Perform a three-way merge of trees.
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 '@'.
1180
Working tree examples: '.', '..', 'foo@', but NOT 'foo/@bar'
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.
1186
Revision examples: './@127', 'foo/@', '../@1'
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
1192
merge refuses to run if there are any uncommitted changes, unless
1195
takes_args = ['other_spec', 'base_spec?']
1196
takes_options = ['force']
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))
1204
class cmd_revert(Command):
1205
"""Reverse all changes since the last commit.
1207
Only versioned files are affected.
1209
TODO: Store backups of any files that will be reverted, so
1210
that the revert can be undone.
1212
takes_options = ['revision']
1214
def run(self, revision=-1):
1215
from bzrlib.merge import merge
1216
merge(('.', revision), parse_spec('.'),
1221
class cmd_assert_fail(Command):
1222
"""Test reporting of assertion failures"""
1225
assert False, "always fails"
1228
class cmd_help(Command):
1229
"""Show help on a command or other topic.
1231
For a list of all available commands, say 'bzr help commands'."""
1232
takes_args = ['topic?']
1235
def run(self, topic=None):
1240
class cmd_update_stat_cache(Command):
1241
"""Update stat-cache mapping inodes to SHA-1 hashes.
1243
For testing only."""
1248
statcache.update_cache(b.base, b.read_working_inventory())
529
print "it sure does!"
533
######################################################################
1252
537
# list of all available options; the rhs can be either None for an
653
def _match_args(cmd, args):
654
"""Check non-option arguments match required pattern.
1385
def _match_argform(cmd, takes_args, args):
656
>>> _match_args('status', ['asdasdsadasd'])
657
Traceback (most recent call last):
659
BzrError: ("extra arguments to command status: ['asdasdsadasd']", [])
660
>>> _match_args('add', ['asdasdsadasd'])
661
{'file_list': ['asdasdsadasd']}
662
>>> _match_args('add', 'abc def gj'.split())
663
{'file_list': ['abc', 'def', 'gj']}
665
# match argument pattern
666
argform = cmd_args.get(cmd, [])
668
# TODO: Need a way to express 'cp SRC... DEST', where it matches
1388
# step through args and takes_args, allowing appropriate 0-many matches
1389
for ap in takes_args:
1390
672
argname = ap[:-1]
1391
673
if ap[-1] == '?':
1393
argdict[argname] = args.pop(0)
1394
elif ap[-1] == '*': # all remaining arguments
1396
argdict[argname + '_list'] = args[:]
1399
argdict[argname + '_list'] = None
1400
677
elif ap[-1] == '+':
1402
raise BzrCommandError("command %r needs one or more %s"
679
bailout("command %r needs one or more %s"
1403
680
% (cmd, argname.upper()))
1405
682
argdict[argname + '_list'] = args[:]
1407
elif ap[-1] == '$': # all but one
1409
raise BzrCommandError("command %r needs one or more %s"
1410
% (cmd, argname.upper()))
1411
argdict[argname + '_list'] = args[:-1]
1414
685
# just a plain arg
1417
raise BzrCommandError("command %r requires argument %s"
688
bailout("command %r requires argument %s"
1418
689
% (cmd, argname.upper()))
1420
691
argdict[argname] = args.pop(0)
1423
raise BzrCommandError("extra argument to command %s: %s"
694
bailout("extra arguments to command %s: %r"
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.
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.
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
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)
1449
>>> argv, opts = _parse_master_args(['bzr', '--test'])
1450
Traceback (most recent call last):
1452
BzrCommandError: Invalid master option: 'test'
1453
>>> argv, opts = _parse_master_args(['bzr', '--version', 'command'])
1456
>>> print opts['version']
1458
>>> argv, opts = _parse_master_args(['bzr', '--profile', 'command', '--more-options'])
1460
['command', '--more-options']
1461
>>> print opts['profile']
1463
>>> argv, opts = _parse_master_args(['bzr', '--no-plugins', 'command'])
1466
>>> print opts['no-plugins']
1468
>>> print opts['profile']
1470
>>> argv, opts = _parse_master_args(['bzr', 'command', '--profile'])
1472
['command', '--profile']
1473
>>> print opts['profile']
1476
master_opts = {'builtin':False,
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)
1488
if arg[:2] != '--': # at the first non-option, we return the rest
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
1501
701
def run_bzr(argv):
1502
702
"""Execute a command.
1504
704
This is similar to main(), but without all the trappings for
1505
logging and error handling.
705
logging and error handling.
1507
argv = [a.decode(bzrlib.user_encoding) for a in argv]
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()
1515
args, opts = parse_args(argv)
1517
if master_opts['help']:
1518
from bzrlib.help import help
708
args, opts = parse_args(argv[1:])
1525
709
if 'help' in opts:
1526
from bzrlib.help import help
710
# TODO: pass down other arguments in case they asked for
711
# help on a command name?
1532
714
elif 'version' in opts:
1535
elif args and args[0] == 'builtin':
1536
include_plugins=False
1538
cmd = str(args.pop(0))
1539
718
except IndexError:
719
log_error('usage: bzr COMMAND\n')
720
log_error(' try "bzr help"\n')
1545
plugins_override = not (master_opts['builtin'])
1546
canonical_cmd, cmd_class = get_cmd_class(cmd, plugins_override=plugins_override)
1548
profile = master_opts['profile']
1549
# For backwards compatibility, I would rather stick with --profile being a
1550
# master/global option
1551
if 'profile' in opts:
724
cmd_handler = globals()['cmd_' + cmd.replace('-', '_')]
726
bailout("unknown command " + `cmd`)
728
# TODO: special --profile option to turn on the Python profiler
1555
730
# check options are reasonable
1556
allowed = cmd_class.takes_options
731
allowed = cmd_options.get(cmd, [])
1557
732
for oname in opts:
1558
733
if oname not in allowed:
1559
raise BzrCommandError("option '--%s' is not allowed for command %r"
1562
# mix arguments and options into one dictionary
1563
cmdargs = _match_argform(cmd, cmd_class.takes_args, args)
1565
for k, v in opts.items():
1566
cmdopts[k.replace('-', '_')] = v
1569
import hotshot, tempfile
1570
pffileno, pfname = tempfile.mkstemp()
1572
prof = hotshot.Profile(pfname)
1573
ret = prof.runcall(cmd_class, cmdopts, cmdargs) or 0
1576
import hotshot.stats
1577
stats = hotshot.stats.load(pfname)
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)
1590
return cmd_class(cmdopts, cmdargs).status
1593
def _report_exception(summary, quiet=False):
1595
log_error('bzr: ' + summary)
1596
bzrlib.trace.log_exception()
1599
tb = sys.exc_info()[2]
1600
exinfo = traceback.extract_tb(tb)
1602
sys.stderr.write(' at %s:%d in %s()\n' % exinfo[-1][:3])
1603
sys.stderr.write(' see ~/.bzr.log for debug information\n')
734
bailout("option %r is not allowed for command %r"
737
cmdargs = _match_args(cmd, args)
740
ret = cmd_handler(**cmdargs) or 0
1610
bzrlib.open_tracefile(argv)
745
## TODO: Handle command-line options; probably know what options are valid for
748
## TODO: If the arguments are wrong, give a usage message rather
749
## than just a backtrace.
1615
return run_bzr(argv)
1617
# do this here inside the exception wrappers to catch EPIPE
1620
quiet = isinstance(e, (BzrCommandError))
1621
_report_exception('error: ' + e.args[0], quiet=quiet)
1624
# some explanation or hints
1627
except AssertionError, e:
1628
msg = 'assertion failed'
1630
msg += ': ' + str(e)
1631
_report_exception(msg)
1633
except KeyboardInterrupt, e:
1634
_report_exception('interrupted', quiet=True)
1636
except Exception, e:
1638
if (isinstance(e, IOError)
1639
and hasattr(e, 'errno')
1640
and e.errno == errno.EPIPE):
1644
msg = str(e).rstrip('\n')
1645
_report_exception(msg, quiet)
1648
bzrlib.trace.close_trace()
752
t = bzrlib.trace._tracefile
753
t.write('-' * 60 + '\n')
754
t.write('bzr invoked at %s\n' % format_date(time.time()))
755
t.write(' by %s on %s\n' % (bzrlib.osutils.username(), socket.gethostname()))
756
t.write(' arguments: %r\n' % argv)
758
starttime = os.times()[4]
761
t.write(' platform: %s\n' % platform.platform())
762
t.write(' python: %s\n' % platform.python_version())
767
mutter("finished, %.3fu/%.3fs cpu, %.3fu/%.3fs cum"
769
mutter(" %.3f elapsed" % (times[4] - starttime))
773
log_error('bzr: error: ' + e.args[0] + '\n')
776
log_error(' ' + h + '\n')
779
log_error('bzr: exception: %s\n' % e)
780
log_error(' see .bzr.log for details\n')
781
traceback.print_exc(None, bzrlib.trace._tracefile)
782
traceback.print_exc(None, sys.stderr)
785
# TODO: Maybe nicer handling of IOError?
1651
789
if __name__ == '__main__':
1652
790
sys.exit(main(sys.argv))
792
##profile.run('main(sys.argv)')