14
16
# along with this program; if not, write to the Free Software
15
17
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
19
"""Bazaar-NG -- a free distributed version-control tool
21
**WARNING: THIS IS AN UNSTABLE DEVELOPMENT VERSION**
23
Current limitation include:
25
* Metadata format is not stable yet -- you may need to
26
discard history in the future.
28
* Insufficient error handling.
30
* Many commands unimplemented or partially implemented.
32
* Space-inefficient storage.
34
* No merge operators yet.
36
Interesting commands::
41
Show software version/licence/non-warranty.
43
Start versioning the current directory
47
Show revision history.
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.
55
Show summary of pending changes.
57
Make a file not versioned.
59
Show statistics about this branch.
65
import sys, os, random, time, sha, sets, types, re, shutil, tempfile
66
import traceback, socket, fnmatch, difflib
69
from pprint import pprint
74
from bzrlib.store import ImmutableStore
22
75
from bzrlib.trace import mutter, note, log_error
23
from bzrlib.errors import BzrError, BzrCheckError, BzrCommandError
24
from bzrlib.branch import find_branch
25
from bzrlib import BZRDIR
31
def register_command(cmd):
32
"Utility function to help register a command"
35
if k.startswith("cmd_"):
36
k_unsquished = _unsquish_command_name(k)
39
if not plugin_cmds.has_key(k_unsquished):
40
plugin_cmds[k_unsquished] = cmd
42
log_error('Two plugins defined the same command: %r' % k)
43
log_error('Not loading the one in %r' % sys.modules[cmd.__module__])
46
def _squish_command_name(cmd):
47
return 'cmd_' + cmd.replace('-', '_')
50
def _unsquish_command_name(cmd):
51
assert cmd.startswith("cmd_")
52
return cmd[4:].replace('_','-')
54
def _parse_revision_str(revstr):
55
"""This handles a revision string -> revno.
57
There are several possibilities:
60
'234:345' -> [234, 345]
64
In the future we will also support:
65
'uuid:blah-blah-blah' -> ?
66
'hash:blahblahblah' -> ?
70
if revstr.find(':') != -1:
71
revs = revstr.split(':')
73
raise ValueError('More than 2 pieces not supported for --revision: %r' % revstr)
78
revs[0] = int(revs[0])
83
revs[1] = int(revs[1])
90
def _get_cmd_dict(plugins_override=True):
92
for k, v in globals().iteritems():
93
if k.startswith("cmd_"):
94
d[_unsquish_command_name(k)] = v
95
# If we didn't load plugins, the plugin_cmds dict will be empty
99
d2 = plugin_cmds.copy()
105
def get_all_cmds(plugins_override=True):
106
"""Return canonical name and class for all registered commands."""
107
for k, v in _get_cmd_dict(plugins_override=plugins_override).iteritems():
111
def get_cmd_class(cmd, plugins_override=True):
112
"""Return the canonical name and command class for a command.
114
cmd = str(cmd) # not unicode
116
# first look up this command under the specified name
117
cmds = _get_cmd_dict(plugins_override=plugins_override)
119
return cmd, cmds[cmd]
123
# look for any command which claims this as an alias
124
for cmdname, cmdclass in cmds.iteritems():
125
if cmd in cmdclass.aliases:
126
return cmdname, cmdclass
128
cmdclass = ExternalCommand.find_command(cmd)
132
raise BzrCommandError("unknown command %r" % cmd)
135
class Command(object):
136
"""Base class for commands.
138
The docstring for an actual command should give a single-line
139
summary, then a complete description of the command. A grammar
140
description will be inserted.
143
List of argument forms, marked with whether they are optional,
147
List of options that may be given for this command.
150
If true, this command isn't advertised.
159
def __init__(self, options, arguments):
160
"""Construct and run the command.
162
Sets self.status to the return value of run()."""
163
assert isinstance(options, dict)
164
assert isinstance(arguments, dict)
165
cmdargs = options.copy()
166
cmdargs.update(arguments)
167
assert self.__doc__ != Command.__doc__, \
168
("No help message set for %r" % self)
169
self.status = self.run(**cmdargs)
173
"""Override this in sub-classes.
175
This is invoked with the options and arguments bound to
178
Return 0 or None if the command was successful, or a shell
184
class ExternalCommand(Command):
185
"""Class to wrap external commands.
187
We cheat a little here, when get_cmd_class() calls us we actually give it back
188
an object we construct that has the appropriate path, help, options etc for the
191
When run_bzr() tries to instantiate that 'class' it gets caught by the __call__
192
method, which we override to call the Command.__init__ method. That then calls
193
our run method which is pretty straight forward.
195
The only wrinkle is that we have to map bzr's dictionary of options and arguments
196
back into command line options and arguments for the script.
199
def find_command(cls, cmd):
201
bzrpath = os.environ.get('BZRPATH', '')
203
for dir in bzrpath.split(os.pathsep):
204
path = os.path.join(dir, cmd)
205
if os.path.isfile(path):
206
return ExternalCommand(path)
210
find_command = classmethod(find_command)
212
def __init__(self, path):
215
pipe = os.popen('%s --bzr-usage' % path, 'r')
216
self.takes_options = pipe.readline().split()
218
for opt in self.takes_options:
219
if not opt in OPTIONS:
220
raise BzrError("Unknown option '%s' returned by external command %s"
223
# TODO: Is there any way to check takes_args is valid here?
224
self.takes_args = pipe.readline().split()
226
if pipe.close() is not None:
227
raise BzrError("Failed funning '%s --bzr-usage'" % path)
229
pipe = os.popen('%s --bzr-help' % path, 'r')
230
self.__doc__ = pipe.read()
231
if pipe.close() is not None:
232
raise BzrError("Failed funning '%s --bzr-help'" % path)
234
def __call__(self, options, arguments):
235
Command.__init__(self, options, arguments)
238
def run(self, **kargs):
245
optname = name.replace('_','-')
247
if OPTIONS.has_key(optname):
249
opts.append('--%s' % optname)
250
if value is not None and value is not True:
251
opts.append(str(value))
253
# it's an arg, or arg list
254
if type(value) is not list:
260
self.status = os.spawnv(os.P_WAIT, self.path, [self.path] + opts + args)
264
class cmd_status(Command):
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, \
83
BZR_DIFF_FORMAT = "## Bazaar-NG diff, format 0 ##\n"
84
BZR_PATCHNAME_FORMAT = 'cset:sha1:%s'
86
## standard representation
87
NONE_STRING = '(none)'
91
## TODO: Perhaps a different version of inventory commands that
92
## returns iterators...
94
## TODO: Perhaps an AtomicFile class that writes to a temporary file and then renames.
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?
101
## TODO: Perhaps make UUIDs predictable in test mode to make it easier
102
## to compare output?
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
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
113
## TODO: move command; check destination is a directory and will not
116
## TODO: command to show renames, one per line, as to->from
121
def cmd_status(all=False):
265
122
"""Display status summary.
267
This reports on versioned and unknown files, reporting them
268
grouped by state. Possible states are:
271
Versioned in the working copy but not in the previous revision.
274
Versioned in the previous revision but removed or deleted
278
Path of this file changed from the previous revision;
279
the text may also have changed. This includes files whose
280
parent directory was renamed.
283
Text has changed since the previous revision.
286
Nothing about this file has changed since the previous revision.
287
Only shown with --all.
290
Not versioned and not matching an ignore pattern.
292
To see ignored files use 'bzr ignored'. For details in the
293
changes to file texts, use 'bzr diff'.
295
If no arguments are specified, the status of the entire working
296
directory is shown. Otherwise, only the status of the specified
297
files or directories is reported. If a directory is given, status
298
is reported for everything inside that directory.
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.
128
:todo: Don't show unchanged files unless ``--all`` is given?
300
takes_args = ['file*']
301
takes_options = ['all', 'show-ids']
302
aliases = ['st', 'stat']
304
def run(self, all=False, show_ids=False, file_list=None):
306
b = find_branch(file_list[0])
307
file_list = [b.relpath(x) for x in file_list]
308
# special case: only one path was given and it's the root
310
if file_list == ['']:
315
status.show_status(b, show_unchanged=all, show_ids=show_ids,
316
specific_files=file_list)
319
class cmd_cat_revision(Command):
320
"""Write out metadata for a revision."""
323
takes_args = ['revision_id']
325
def run(self, revision_id):
326
from bzrlib.xml import pack_xml
327
pack_xml(find_branch('.').get_revision(revision_id), 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 find_branch('.').revno()
338
class cmd_add(Command):
130
Branch('.').show_status(show_all=all)
134
######################################################################
136
def cmd_get_revision(revision_id):
137
Branch('.').get_revision(revision_id).write_xml(sys.stdout)
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)
147
######################################################################
152
"""Show number of revisions on this branch"""
153
print Branch('.').revno()
157
def cmd_add(file_list, verbose=False):
339
158
"""Add specified files or directories.
341
160
In non-recursive mode, all the named items are added, regardless
353
172
Therefore simply saying 'bzr add .' will version all files that
354
173
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
from bzrlib.add import smart_add
364
smart_add(file_list, verbose, not no_recurse)
368
class cmd_mkdir(Command):
369
"""Create a new versioned directory.
371
This is equivalent to creating the directory and then adding it.
373
takes_args = ['dir+']
375
def run(self, dir_list):
382
b.add([d], verbose=True)
385
class cmd_relpath(Command):
386
"""Show path of a file relative to root"""
387
takes_args = ['filename']
390
def run(self, filename):
391
print find_branch(filename).relpath(filename)
395
class cmd_inventory(Command):
396
"""Show inventory of the current working copy or a revision."""
397
takes_options = ['revision', 'show-ids']
399
def run(self, revision=None, show_ids=False):
402
inv = b.read_working_inventory()
404
inv = b.get_revision_inventory(b.lookup_revision(revision))
406
for path, entry in inv.entries():
408
print '%-50s %s' % (path, entry.file_id)
413
class cmd_move(Command):
414
"""Move files to a different directory.
419
The destination must be a versioned directory in the same branch.
421
takes_args = ['source$', 'dest']
422
def run(self, source_list, dest):
425
b.move([b.relpath(s) for s in source_list], b.relpath(dest))
428
class cmd_rename(Command):
429
"""Change the name of an entry.
432
bzr rename frob.c frobber.c
433
bzr rename src/frob.c lib/frob.c
435
It is an error if the destination name exists.
437
See also the 'move' command, which moves files into a different
438
directory without changing their name.
440
TODO: Some way to rename multiple files without invoking bzr for each
442
takes_args = ['from_name', 'to_name']
444
def run(self, from_name, to_name):
446
b.rename_one(b.relpath(from_name), b.relpath(to_name))
452
class cmd_pull(Command):
453
"""Pull any changes from another branch into the current one.
455
If the location is omitted, the last-used location will be used.
456
Both the revision history and the working directory will be
459
This command only works on branches that have not diverged. Branches are
460
considered diverged if both branches have had commits without first
461
pulling from the other.
463
If branches have diverged, you can use 'bzr merge' to pull the text changes
464
from one into the other.
466
takes_args = ['location?']
468
def run(self, location=None):
469
from bzrlib.merge import merge
471
from shutil import rmtree
474
br_to = find_branch('.')
477
stored_loc = br_to.controlfile("x-pull", "rb").read().rstrip('\n')
479
if e.errno != errno.ENOENT:
482
if stored_loc is None:
483
raise BzrCommandError("No pull location known or specified.")
485
print "Using last location: %s" % stored_loc
486
location = stored_loc
487
cache_root = tempfile.mkdtemp()
488
from bzrlib.branch import DivergedBranches
489
br_from = find_branch(location)
490
location = pull_loc(br_from)
491
old_revno = br_to.revno()
493
from branch import find_cached_branch, DivergedBranches
494
br_from = find_cached_branch(location, cache_root)
495
location = pull_loc(br_from)
496
old_revno = br_to.revno()
498
br_to.update_revisions(br_from)
499
except DivergedBranches:
500
raise BzrCommandError("These branches have diverged."
503
merge(('.', -1), ('.', old_revno), check_clean=False)
504
if location != stored_loc:
505
br_to.controlfile("x-pull", "wb").write(location + "\n")
511
class cmd_branch(Command):
512
"""Create a new copy of a branch.
514
If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
515
be used. In other words, "branch ../foo/bar" will attempt to create ./bar.
517
To retrieve the branch as of a particular revision, supply the --revision
518
parameter, as in "branch foo/bar -r 5".
520
takes_args = ['from_location', 'to_location?']
521
takes_options = ['revision']
523
def run(self, from_location, to_location=None, revision=None):
525
from bzrlib.merge import merge
526
from bzrlib.branch import DivergedBranches, NoSuchRevision, \
527
find_cached_branch, Branch
528
from shutil import rmtree
529
from meta_store import CachedStore
531
cache_root = tempfile.mkdtemp()
534
br_from = find_cached_branch(from_location, cache_root)
536
if e.errno == errno.ENOENT:
537
raise BzrCommandError('Source location "%s" does not'
538
' exist.' % to_location)
542
if to_location is None:
543
to_location = os.path.basename(from_location.rstrip("/\\"))
546
os.mkdir(to_location)
548
if e.errno == errno.EEXIST:
549
raise BzrCommandError('Target directory "%s" already'
550
' exists.' % to_location)
551
if e.errno == errno.ENOENT:
552
raise BzrCommandError('Parent of "%s" does not exist.' %
556
br_to = Branch(to_location, init=True)
559
br_to.update_revisions(br_from, stop_revision=revision)
560
except NoSuchRevision:
562
msg = "The branch %s has no revision %d." % (from_location,
564
raise BzrCommandError(msg)
565
merge((to_location, -1), (to_location, 0), this_dir=to_location,
566
check_clean=False, ignore_zero=True)
567
from_location = pull_loc(br_from)
568
br_to.controlfile("x-pull", "wb").write(from_location + "\n")
573
def pull_loc(branch):
574
# TODO: Should perhaps just make attribute be 'base' in
575
# RemoteBranch and Branch?
576
if hasattr(branch, "baseurl"):
577
return branch.baseurl
583
class cmd_renames(Command):
584
"""Show list of renamed files.
586
TODO: Option to show renames between two historical versions.
588
TODO: Only show renames under dir, rather than in the whole branch.
590
takes_args = ['dir?']
592
def run(self, dir='.'):
594
old_inv = b.basis_tree().inventory
595
new_inv = b.read_working_inventory()
597
renames = list(bzrlib.tree.find_renames(old_inv, new_inv))
599
for old_name, new_name in renames:
600
print "%s => %s" % (old_name, new_name)
603
class cmd_info(Command):
604
"""Show statistical information about a branch."""
605
takes_args = ['branch?']
607
def run(self, branch=None):
610
b = find_branch(branch)
614
class cmd_remove(Command):
615
"""Make a file unversioned.
617
This makes bzr stop tracking changes to a versioned file. It does
618
not delete the working copy.
620
takes_args = ['file+']
621
takes_options = ['verbose']
623
def run(self, file_list, verbose=False):
624
b = find_branch(file_list[0])
625
b.remove([b.relpath(f) for f in file_list], verbose=verbose)
628
class cmd_file_id(Command):
629
"""Print file_id of a particular file or directory.
631
The file_id is assigned when the file is first added and remains the
632
same through all revisions where the file exists, even when it is
636
takes_args = ['filename']
637
def run(self, filename):
638
b = find_branch(filename)
639
i = b.inventory.path2id(b.relpath(filename))
641
raise BzrError("%r is not a versioned file" % filename)
646
class cmd_file_path(Command):
647
"""Print path of file_ids to a file or directory.
649
This prints one line for each directory down to the target,
650
starting at the branch root."""
652
takes_args = ['filename']
653
def run(self, filename):
654
b = find_branch(filename)
656
fid = inv.path2id(b.relpath(filename))
658
raise BzrError("%r is not a versioned file" % filename)
659
for fip in inv.get_idpath(fid):
663
class cmd_revision_history(Command):
664
"""Display list of revision ids on this branch."""
667
for patchid in find_branch('.').revision_history():
671
class cmd_directories(Command):
672
"""Display list of versioned directories in this branch."""
674
for name, ie in find_branch('.').read_working_inventory().directories():
681
class cmd_init(Command):
682
"""Make a directory into a versioned branch.
684
Use this to create an empty branch, or before importing an
687
Recipe for importing a tree of files:
692
bzr commit -m 'imported project'
695
from bzrlib.branch import Branch
696
Branch('.', init=True)
699
class cmd_diff(Command):
700
"""Show differences in working tree.
702
If files are listed, only the changes in those files are listed.
703
Otherwise, all changes for the tree are listed.
705
TODO: Given two revision arguments, show the difference between them.
707
TODO: Allow diff across branches.
709
TODO: Option to use external diff command; could be GNU diff, wdiff,
712
TODO: Python difflib is not exactly the same as unidiff; should
713
either fix it up or prefer to use an external diff.
715
TODO: If a directory is given, diff everything under that.
717
TODO: Selected-file diff is inefficient and doesn't show you
720
TODO: This probably handles non-Unix newlines poorly.
723
takes_args = ['file*']
724
takes_options = ['revision', 'diff-options']
725
aliases = ['di', 'dif']
727
def run(self, revision=None, file_list=None, diff_options=None):
728
from bzrlib.diff import show_diff
731
b = find_branch(file_list[0])
732
file_list = [b.relpath(f) for f in file_list]
733
if file_list == ['']:
734
# just pointing to top-of-tree
739
show_diff(b, revision, specific_files=file_list,
740
external_diff_options=diff_options)
746
class cmd_deleted(Command):
747
"""List files deleted in the working tree.
749
TODO: Show files deleted since a previous revision, or between two revisions.
751
def run(self, show_ids=False):
754
new = b.working_tree()
756
## TODO: Much more efficient way to do this: read in new
757
## directories with readdir, rather than stating each one. Same
758
## level of effort but possibly much less IO. (Or possibly not,
759
## if the directories are very large...)
761
for path, ie in old.inventory.iter_entries():
762
if not new.has_id(ie.file_id):
764
print '%-50s %s' % (path, ie.file_id)
769
class cmd_modified(Command):
770
"""List files modified in working tree."""
175
bzrlib.add.smart_add(file_list, verbose)
178
def cmd_relpath(filename):
179
"""Show path of file relative to root"""
180
print Branch(filename).relpath(filename)
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
775
189
inv = b.read_working_inventory()
776
sc = statcache.update_cache(b, inv)
777
basis = b.basis_tree()
778
basis_inv = basis.inventory
780
# We used to do this through iter_entries(), but that's slow
781
# when most of the files are unmodified, as is usually the
782
# case. So instead we iterate by inventory entry, and only
783
# calculate paths as necessary.
785
for file_id in basis_inv:
786
cacheentry = sc.get(file_id)
787
if not cacheentry: # deleted
789
ie = basis_inv[file_id]
790
if cacheentry[statcache.SC_SHA1] != ie.text_sha1:
791
path = inv.id2path(file_id)
796
class cmd_added(Command):
797
"""List files added in working tree."""
801
wt = b.working_tree()
802
basis_inv = b.basis_tree().inventory
805
if file_id in basis_inv:
807
path = inv.id2path(file_id)
808
if not os.access(b.abspath(path), os.F_OK):
814
class cmd_root(Command):
815
"""Show the tree root directory.
817
The root is the nearest enclosing directory with a .bzr control
819
takes_args = ['filename?']
820
def run(self, filename=None):
821
"""Print the branch root."""
822
b = find_branch(filename)
823
print getattr(b, 'base', None) or getattr(b, 'baseurl')
826
class cmd_log(Command):
191
inv = b.get_revision_inventory(b.lookup_revision(revision))
193
for path, entry in inv.iter_entries():
194
print '%-50s %s' % (entry.file_id, path)
199
"""info: Show statistical information for this branch
203
info.show_info(Branch('.'))
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)
213
def cmd_file_id(filename):
215
i = b.inventory.path2id(b.relpath(filename))
217
bailout("%s is not a versioned file" % filename)
222
def cmd_find_filename(fileid):
223
n = find_filename(fileid)
225
bailout("%s is not a live file id" % fileid)
230
def cmd_revision_history():
231
for patchid in Branch('.').revision_history():
237
# TODO: Check we're not already in a working directory? At the
238
# moment you'll get an ugly error.
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
245
# TODO: Take an argument/option for branch name.
246
Branch('.', init=True)
249
def cmd_diff(revision=None):
250
"""bzr diff: Show differences in working tree.
252
usage: bzr diff [-r REV]
255
Show changes since REV, rather than predecessor.
257
TODO: Given two revision arguments, show the difference between them.
259
TODO: Allow diff across branches.
261
TODO: Option to use external diff command; could be GNU diff, wdiff,
264
TODO: Diff selected files.
267
## TODO: Shouldn't be in the cmd function.
272
old_tree = b.basis_tree()
274
old_tree = b.revision_tree(b.lookup_revision(revision))
276
new_tree = b.working_tree()
277
old_inv = old_tree.inventory
278
new_inv = new_tree.inventory
280
# TODO: Options to control putting on a prefix or suffix, perhaps as a format string
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.
289
# TODO: Generation of pseudo-diffs for added/deleted files could
290
# be usefully made into a much faster special case.
292
# TODO: Better to return them in sorted order I think.
294
for file_state, fid, old_name, new_name, kind in bzrlib.diff_trees(old_tree, new_tree):
297
# Don't show this by default; maybe do it if an option is passed
298
# idlabel = ' {%s}' % fid
301
# FIXME: Something about the diff format makes patch unhappy
302
# with newly-added files.
304
def diffit(*a, **kw):
305
sys.stdout.writelines(difflib.unified_diff(*a, **kw))
308
if file_state in ['.', '?', 'I']:
310
elif file_state == 'A':
311
print '*** added %s %r' % (kind, new_name)
314
new_tree.get_file(fid).readlines(),
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)
321
diffit(old_tree.get_file(fid).readlines(), [],
322
fromfile=old_label + old_name + idlabel,
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)
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)
338
bailout("can't represent state %s {%s}" % (file_state, fid))
342
def cmd_root(filename=None):
343
"""Print the branch root."""
344
print bzrlib.branch.find_branch_root(filename)
347
def cmd_log(timezone='original'):
827
348
"""Show log of this branch.
829
To request a range of logs, you can use the command -r begin:end
830
-r revision requests a specific revision, -r :end or -r begin: are
833
TODO: Make --revision support uuid: and hash: [future tag:] notation.
350
:todo: Options for utc; to show ids; to limit range; etc.
837
takes_args = ['filename?']
838
takes_options = ['forward', 'timezone', 'verbose', 'show-ids', 'revision','long']
840
def run(self, filename=None, timezone='original',
846
from bzrlib.branch import find_branch
847
from bzrlib.log import log_formatter, show_log
850
direction = (forward and 'forward') or 'reverse'
853
b = find_branch(filename)
854
fp = b.relpath(filename)
856
file_id = b.read_working_inventory().path2id(fp)
858
file_id = None # points to branch root
864
revision = [None, None]
865
elif isinstance(revision, int):
866
revision = [revision, revision]
871
assert len(revision) == 2
873
mutter('encoding log as %r' % bzrlib.user_encoding)
875
# use 'replace' so that we don't abort if trying to write out
876
# in e.g. the default C locale.
877
outf = codecs.getwriter(bzrlib.user_encoding)(sys.stdout, errors='replace')
883
lf = log_formatter(log_format,
886
show_timezone=timezone)
893
start_revision=revision[0],
894
end_revision=revision[1])
898
class cmd_touching_revisions(Command):
899
"""Return revision-ids which affected a particular file.
901
A more user-friendly interface is "bzr log FILE"."""
903
takes_args = ["filename"]
904
def run(self, filename):
905
b = find_branch(filename)
906
inv = b.read_working_inventory()
907
file_id = inv.path2id(b.relpath(filename))
908
for revno, revision_id, what in bzrlib.log.find_touching_revisions(b, file_id):
909
print "%6d %s" % (revno, what)
912
class cmd_ls(Command):
352
Branch('.').write_log(show_timezone=timezone)
355
def cmd_ls(revision=None, verbose=False):
913
356
"""List files in a tree.
915
TODO: Take a revision or remote path and list that tree instead.
358
:todo: Take a revision or remote path and list that tree instead.
918
def run(self, revision=None, verbose=False):
921
tree = b.working_tree()
923
tree = b.revision_tree(b.lookup_revision(revision))
925
for fp, fc, kind, fid in tree.list_files():
927
if kind == 'directory':
934
print '%-8s %s%s' % (fc, fp, kindch)
362
tree = b.working_tree()
364
tree = b.revision_tree(b.lookup_revision(revision))
366
for fp, fc, kind, fid in tree.list_files():
368
if kind == 'directory':
940
class cmd_unknowns(Command):
941
"""List unknown files."""
943
from bzrlib.osutils import quotefn
944
for f in find_branch('.').unknowns():
949
class cmd_ignore(Command):
950
"""Ignore a command or pattern.
952
To remove patterns from the ignore list, edit the .bzrignore file.
954
If the pattern contains a slash, it is compared to the whole path
955
from the branch root. Otherwise, it is comapred to only the last
956
component of the path.
958
Ignore patterns are case-insensitive on case-insensitive systems.
960
Note: wildcards must be quoted from the shell on Unix.
963
bzr ignore ./Makefile
966
takes_args = ['name_pattern']
968
def run(self, name_pattern):
969
from bzrlib.atomicfile import AtomicFile
973
ifn = b.abspath('.bzrignore')
975
if os.path.exists(ifn):
978
igns = f.read().decode('utf-8')
984
# TODO: If the file already uses crlf-style termination, maybe
985
# we should use that for the newly added lines?
987
if igns and igns[-1] != '\n':
989
igns += name_pattern + '\n'
992
f = AtomicFile(ifn, 'wt')
993
f.write(igns.encode('utf-8'))
998
inv = b.working_tree().inventory
999
if inv.path2id('.bzrignore'):
1000
mutter('.bzrignore is already versioned')
1002
mutter('need to make new .bzrignore file versioned')
1003
b.add(['.bzrignore'])
1007
class cmd_ignored(Command):
375
print '%-8s %s%s' % (fc, fp, kindch)
382
"""List unknown files"""
383
for f in Branch('.').unknowns():
388
def cmd_ignored(verbose=True):
1008
389
"""List ignored files and the patterns that matched them.
1010
See also: bzr ignore"""
1012
tree = find_branch('.').working_tree()
1013
for path, file_class, kind, file_id in tree.list_files():
1014
if file_class != 'I':
1016
## XXX: Slightly inefficient since this was already calculated
1017
pat = tree.is_ignored(path)
1018
print '%-50s %s' % (path, pat)
1021
class cmd_lookup_revision(Command):
1022
"""Lookup the revision-id from a revision-number
1025
bzr lookup-revision 33
1028
takes_args = ['revno']
391
tree = Branch('.').working_tree()
392
for path, file_class, kind, id in tree.list_files():
393
if file_class != 'I':
395
## XXX: Slightly inefficient since this was already calculated
396
pat = tree.is_ignored(path)
397
print '%-50s %s' % (path, pat)
1030
def run(self, revno):
1034
raise BzrCommandError("not a valid revision-number: %r" % revno)
1036
print find_branch('.').lookup_revision(revno)
1039
class cmd_export(Command):
1040
"""Export past revision to destination directory.
1042
If no revision is specified this exports the last committed revision.
1044
Format may be an "exporter" name, such as tar, tgz, tbz2. If none is
1045
given, exports to a directory (equivalent to --format=dir)."""
1046
# TODO: list known exporters
1047
takes_args = ['dest']
1048
takes_options = ['revision', 'format']
1049
def run(self, dest, revision=None, format='dir'):
1050
b = find_branch('.')
1051
if revision == None:
1052
rh = b.revision_history()[-1]
1054
rh = b.lookup_revision(int(revision))
1055
t = b.revision_tree(rh)
1056
t.export(dest, format)
1059
class cmd_cat(Command):
1060
"""Write a file's text from a previous revision."""
1062
takes_options = ['revision']
1063
takes_args = ['filename']
1065
def run(self, filename, revision=None):
1066
if revision == None:
1067
raise BzrCommandError("bzr cat requires a revision number")
1068
b = find_branch('.')
1069
b.print_file(b.relpath(filename), int(revision))
1072
class cmd_local_time_offset(Command):
1073
"""Show the offset in seconds from GMT to local time."""
1076
print bzrlib.osutils.local_time_offset()
1080
class cmd_commit(Command):
1081
"""Commit changes into a new revision.
1083
If selected files are specified, only changes to those files are
1084
committed. If a directory is specified then its contents are also
1087
A selected-file commit may fail in some cases where the committed
1088
tree would be invalid, such as trying to commit a file in a
1089
newly-added directory that is not itself committed.
1091
TODO: Run hooks on tree to-be-committed, and after commit.
1093
TODO: Strict commit that fails if there are unknown or deleted files.
1095
takes_args = ['selected*']
1096
takes_options = ['message', 'file', 'verbose']
1097
aliases = ['ci', 'checkin']
1099
def run(self, message=None, file=None, verbose=True, selected_list=None):
1100
from bzrlib.commit import commit
1101
from bzrlib.osutils import get_text_message
1103
## Warning: shadows builtin file()
1104
if not message and not file:
1107
catcher = cStringIO.StringIO()
1108
sys.stdout = catcher
1109
cmd_status({"file_list":selected_list}, {})
1110
info = catcher.getvalue()
1112
message = get_text_message(info)
1115
raise BzrCommandError("please specify a commit message",
1116
["use either --message or --file"])
1117
elif message and file:
1118
raise BzrCommandError("please specify either --message or --file")
401
def cmd_lookup_revision(revno):
405
bailout("usage: lookup-revision REVNO",
406
["REVNO is a non-negative revision number for this branch"])
408
print Branch('.').lookup_revision(revno) or NONE_STRING
412
def cmd_export(revno, dest):
413
"""Export past revision to destination directory."""
415
rh = b.lookup_revision(int(revno))
416
t = b.revision_tree(rh)
421
######################################################################
422
# internal/test commands
426
"""Print a newly-generated UUID."""
427
print bzrlib.osutils.uuid()
431
def cmd_local_time_offset():
432
print bzrlib.osutils.local_time_offset()
436
def cmd_commit(message=None, verbose=False):
437
"""Commit changes to a new revision.
440
Description of changes in this revision; free form text.
441
It is recommended that the first line be a single-sentence
444
Show status of changed files,
446
TODO: Commit only selected files.
448
TODO: Run hooks on tree to-be-committed, and after commit.
450
TODO: Strict commit that fails if there are unknown or deleted files.
454
bailout("please specify a commit message")
455
Branch('.').commit(message, verbose=verbose)
458
def cmd_check(dir='.'):
459
"""check: Consistency check of branch history.
461
usage: bzr check [-v] [BRANCH]
464
--verbose, -v Show progress of checking.
466
This command checks various invariants about the branch storage to
467
detect data corruption or bzr bugs.
470
bzrlib.check.check(Branch(dir, find_root=False))
473
def cmd_is(pred, *rest):
474
"""Test whether PREDICATE is true."""
476
cmd_handler = globals()['assert_' + pred.replace('-', '_')]
478
bailout("unknown predicate: %s" % quotefn(pred))
1122
message = codecs.open(file, 'rt', bzrlib.user_encoding).read()
1124
b = find_branch('.')
1125
commit(b, message, verbose=verbose, specific_files=selected_list)
1128
class cmd_check(Command):
1129
"""Validate consistency of branch history.
1131
This command checks various invariants about the branch storage to
1132
detect data corruption or bzr bugs.
1134
If given the --update flag, it will update some optional fields
1135
to help ensure data consistency.
1137
takes_args = ['dir?']
1139
def run(self, dir='.'):
1140
from bzrlib.check import check
1141
check(find_branch(dir))
1145
class cmd_upgrade(Command):
1146
"""Upgrade branch storage to current format.
1148
This should normally be used only after the check command tells
1151
takes_args = ['dir?']
1153
def run(self, dir='.'):
1154
from bzrlib.upgrade import upgrade
1155
upgrade(find_branch(dir))
1159
class cmd_whoami(Command):
1160
"""Show bzr user id."""
1161
takes_options = ['email']
1163
def run(self, email=False):
1165
print bzrlib.osutils.user_email()
1167
print bzrlib.osutils.username()
1170
class cmd_selftest(Command):
482
except BzrCheckError:
483
# by default we don't print the message so that this can
484
# be used from shell scripts without producing noise
489
print bzrlib.osutils.username()
492
def cmd_user_email():
493
print bzrlib.osutils.user_email()
496
def cmd_gen_revision_id():
498
print bzrlib.branch._gen_revision_id(time.time())
501
def cmd_selftest(verbose=False):
1171
502
"""Run internal test suite"""
1174
from bzrlib.selftest import selftest
1175
return int(not selftest())
1178
class cmd_version(Command):
1179
"""Show version of bzr."""
503
## -v, if present, is seen by doctest; the argument is just here
504
## so our parser doesn't complain
506
## TODO: --verbose option
508
failures, tests = 0, 0
510
import doctest, bzrlib.store, bzrlib.tests
511
bzrlib.trace.verbose = False
513
for m in bzrlib.store, bzrlib.inventory, bzrlib.branch, bzrlib.osutils, \
514
bzrlib.tree, bzrlib.tests, bzrlib.commands, bzrlib.add:
515
mf, mt = doctest.testmod(m)
518
print '%-40s %3d tests' % (m.__name__, mt),
520
print '%3d FAILED!' % mf
524
print '%-40s %3d tests' % ('total', tests),
526
print '%3d FAILED!' % failures
533
cmd_doctest = cmd_selftest
536
######################################################################
540
def cmd_help(topic=None):
545
# otherwise, maybe the name of a command?
547
cmdfn = globals()['cmd_' + topic.replace('-', '_')]
549
bailout("no help for %r" % topic)
553
bailout("sorry, no detailed help yet for %r" % topic)
1184
561
print "bzr (bazaar-ng) %s" % bzrlib.__version__
1185
# is bzrlib itself in a branch?
1186
bzrrev = bzrlib.get_bzr_revision()
1188
print " (bzr checkout, revision %d {%s})" % bzrrev
1189
562
print bzrlib.__copyright__
1190
563
print "http://bazaar-ng.org/"
1192
print "bzr comes with ABSOLUTELY NO WARRANTY. bzr is free software, and"
1193
print "you may use, modify and redistribute it under the terms of the GNU"
1194
print "General Public License version 2 or later."
1197
class cmd_rocks(Command):
566
"""bzr comes with ABSOLUTELY NO WARRANTY. bzr is free software, and
567
you may use, modify and redistribute it under the terms of the GNU
568
General Public License version 2 or later."""
1198
572
"""Statement of optimism."""
1201
print "it sure does!"
1203
def parse_spec(spec):
1205
>>> parse_spec(None)
1207
>>> parse_spec("./")
1209
>>> parse_spec("../@")
1211
>>> parse_spec("../f/@35")
1217
parsed = spec.split('/@')
1218
assert len(parsed) == 2
1222
parsed[1] = int(parsed[1])
1223
assert parsed[1] >=0
1225
parsed = [spec, None]
1230
class cmd_merge(Command):
1231
"""Perform a three-way merge of trees.
1233
The SPEC parameters are working tree or revision specifiers. Working trees
1234
are specified using standard paths or urls. No component of a directory
1235
path may begin with '@'.
1237
Working tree examples: '.', '..', 'foo@', but NOT 'foo/@bar'
1239
Revisions are specified using a dirname/@revno pair, where dirname is the
1240
branch directory and revno is the revision within that branch. If no revno
1241
is specified, the latest revision is used.
1243
Revision examples: './@127', 'foo/@', '../@1'
1245
The OTHER_SPEC parameter is required. If the BASE_SPEC parameter is
1246
not supplied, the common ancestor of OTHER_SPEC the current branch is used
1249
merge refuses to run if there are any uncommitted changes, unless
1252
takes_args = ['other_spec', 'base_spec?']
1253
takes_options = ['force']
1255
def run(self, other_spec, base_spec=None, force=False):
1256
from bzrlib.merge import merge
1257
merge(parse_spec(other_spec), parse_spec(base_spec),
1258
check_clean=(not force))
1262
class cmd_revert(Command):
1263
"""Restore selected files from a previous revision.
1265
takes_args = ['file+']
1266
def run(self, file_list):
1267
from bzrlib.branch import find_branch
1272
b = find_branch(file_list[0])
1274
b.revert([b.relpath(f) for f in file_list])
1277
class cmd_merge_revert(Command):
1278
"""Reverse all changes since the last commit.
1280
Only versioned files are affected.
1282
TODO: Store backups of any files that will be reverted, so
1283
that the revert can be undone.
1285
takes_options = ['revision']
1287
def run(self, revision=-1):
1288
from bzrlib.merge import merge
1289
merge(('.', revision), parse_spec('.'),
1294
class cmd_assert_fail(Command):
1295
"""Test reporting of assertion failures"""
1298
assert False, "always fails"
1301
class cmd_help(Command):
1302
"""Show help on a command or other topic.
1304
For a list of all available commands, say 'bzr help commands'."""
1305
takes_args = ['topic?']
1308
def run(self, topic=None):
1313
class cmd_update_stat_cache(Command):
1314
"""Update stat-cache mapping inodes to SHA-1 hashes.
1316
For testing only."""
1320
b = find_branch('.')
1321
statcache.update_cache(b.base, b.read_working_inventory())
1325
class cmd_plugins(Command):
1329
import bzrlib.plugin
1330
from pprint import pprint
1331
pprint(bzrlib.plugin.all_plugins)
573
print "it sure does!"
577
######################################################################
1335
581
# list of all available options; the rhs can be either None for an
700
def _match_args(cmd, args):
701
"""Check non-option arguments match required pattern.
1470
def _match_argform(cmd, takes_args, args):
703
>>> _match_args('status', ['asdasdsadasd'])
704
Traceback (most recent call last):
706
BzrError: ("extra arguments to command status: ['asdasdsadasd']", [])
707
>>> _match_args('add', ['asdasdsadasd'])
708
{'file_list': ['asdasdsadasd']}
709
>>> _match_args('add', 'abc def gj'.split())
710
{'file_list': ['abc', 'def', 'gj']}
712
# match argument pattern
713
argform = cmd_args.get(cmd, [])
715
# TODO: Need a way to express 'cp SRC... DEST', where it matches
1473
# step through args and takes_args, allowing appropriate 0-many matches
1474
for ap in takes_args:
718
# step through args and argform, allowing appropriate 0-many matches
1475
720
argname = ap[:-1]
1476
721
if ap[-1] == '?':
1478
723
argdict[argname] = args.pop(0)
1479
elif ap[-1] == '*': # all remaining arguments
1481
argdict[argname + '_list'] = args[:]
1484
argdict[argname + '_list'] = None
1485
726
elif ap[-1] == '+':
1487
raise BzrCommandError("command %r needs one or more %s"
728
bailout("command %r needs one or more %s"
1488
729
% (cmd, argname.upper()))
1490
731
argdict[argname + '_list'] = args[:]
1492
elif ap[-1] == '$': # all but one
1494
raise BzrCommandError("command %r needs one or more %s"
1495
% (cmd, argname.upper()))
1496
argdict[argname + '_list'] = args[:-1]
1499
734
# just a plain arg
1502
raise BzrCommandError("command %r requires argument %s"
737
bailout("command %r requires argument %s"
1503
738
% (cmd, argname.upper()))
1505
740
argdict[argname] = args.pop(0)
1508
raise BzrCommandError("extra argument to command %s: %s"
743
bailout("extra arguments to command %s: %r"
1514
def _parse_master_args(argv):
1515
"""Parse the arguments that always go with the original command.
1516
These are things like bzr --no-plugins, etc.
1518
There are now 2 types of option flags. Ones that come *before* the command,
1519
and ones that come *after* the command.
1520
Ones coming *before* the command are applied against all possible commands.
1521
And are generally applied before plugins are loaded.
1523
The current list are:
1524
--builtin Allow plugins to load, but don't let them override builtin commands,
1525
they will still be allowed if they do not override a builtin.
1526
--no-plugins Don't load any plugins. This lets you get back to official source
1528
--profile Enable the hotspot profile before running the command.
1529
For backwards compatibility, this is also a non-master option.
1530
--version Spit out the version of bzr that is running and exit.
1531
This is also a non-master option.
1532
--help Run help and exit, also a non-master option (I think that should stay, though)
1534
>>> argv, opts = _parse_master_args(['bzr', '--test'])
1535
Traceback (most recent call last):
1537
BzrCommandError: Invalid master option: 'test'
1538
>>> argv, opts = _parse_master_args(['bzr', '--version', 'command'])
1541
>>> print opts['version']
1543
>>> argv, opts = _parse_master_args(['bzr', '--profile', 'command', '--more-options'])
1545
['command', '--more-options']
1546
>>> print opts['profile']
1548
>>> argv, opts = _parse_master_args(['bzr', '--no-plugins', 'command'])
1551
>>> print opts['no-plugins']
1553
>>> print opts['profile']
1555
>>> argv, opts = _parse_master_args(['bzr', 'command', '--profile'])
1557
['command', '--profile']
1558
>>> print opts['profile']
1561
master_opts = {'builtin':False,
1568
# This is the point where we could hook into argv[0] to determine
1569
# what front-end is supposed to be run
1570
# For now, we are just ignoring it.
1571
cmd_name = argv.pop(0)
1573
if arg[:2] != '--': # at the first non-option, we return the rest
1575
arg = arg[2:] # Remove '--'
1576
if arg not in master_opts:
1577
# We could say that this is not an error, that we should
1578
# just let it be handled by the main section instead
1579
raise BzrCommandError('Invalid master option: %r' % arg)
1580
argv.pop(0) # We are consuming this entry
1581
master_opts[arg] = True
1582
return argv, master_opts
1586
750
def run_bzr(argv):
1587
751
"""Execute a command.
1589
753
This is similar to main(), but without all the trappings for
1590
logging and error handling.
754
logging and error handling.
1592
argv = [a.decode(bzrlib.user_encoding) for a in argv]
1595
# some options like --builtin and --no-plugins have special effects
1596
argv, master_opts = _parse_master_args(argv)
1597
if not master_opts['no-plugins']:
1598
from bzrlib.plugin import load_plugins
1601
args, opts = parse_args(argv)
1603
if master_opts['help']:
1604
from bzrlib.help import help
757
args, opts = parse_args(argv[1:])
1611
758
if 'help' in opts:
1612
from bzrlib.help import help
759
# TODO: pass down other arguments in case they asked for
760
# help on a command name?
1618
763
elif 'version' in opts:
1621
elif args and args[0] == 'builtin':
1622
include_plugins=False
1624
cmd = str(args.pop(0))
1625
767
except IndexError:
768
log_error('usage: bzr COMMAND\n')
769
log_error(' try "bzr help"\n')
1631
plugins_override = not (master_opts['builtin'])
1632
canonical_cmd, cmd_class = get_cmd_class(cmd, plugins_override=plugins_override)
1634
profile = master_opts['profile']
1635
# For backwards compatibility, I would rather stick with --profile being a
1636
# master/global option
1637
if 'profile' in opts:
773
cmd_handler = globals()['cmd_' + cmd.replace('-', '_')]
775
bailout("unknown command " + `cmd`)
777
# TODO: special --profile option to turn on the Python profiler
1641
779
# check options are reasonable
1642
allowed = cmd_class.takes_options
780
allowed = cmd_options.get(cmd, [])
1643
781
for oname in opts:
1644
782
if oname not in allowed:
1645
raise BzrCommandError("option '--%s' is not allowed for command %r"
1648
# mix arguments and options into one dictionary
1649
cmdargs = _match_argform(cmd, cmd_class.takes_args, args)
1651
for k, v in opts.items():
1652
cmdopts[k.replace('-', '_')] = v
1655
import hotshot, tempfile
1656
pffileno, pfname = tempfile.mkstemp()
1658
prof = hotshot.Profile(pfname)
1659
ret = prof.runcall(cmd_class, cmdopts, cmdargs) or 0
1662
import hotshot.stats
1663
stats = hotshot.stats.load(pfname)
1665
stats.sort_stats('time')
1666
## XXX: Might like to write to stderr or the trace file instead but
1667
## print_stats seems hardcoded to stdout
1668
stats.print_stats(20)
1676
return cmd_class(cmdopts, cmdargs).status
1679
def _report_exception(summary, quiet=False):
1681
log_error('bzr: ' + summary)
1682
bzrlib.trace.log_exception()
1685
tb = sys.exc_info()[2]
1686
exinfo = traceback.extract_tb(tb)
1688
sys.stderr.write(' at %s:%d in %s()\n' % exinfo[-1][:3])
1689
sys.stderr.write(' see ~/.bzr.log for debug information\n')
783
bailout("option %r is not allowed for command %r"
786
cmdargs = _match_args(cmd, args)
789
ret = cmd_handler(**cmdargs) or 0
794
## TODO: Handle command-line options; probably know what options are valid for
797
## TODO: If the arguments are wrong, give a usage message rather
798
## than just a backtrace.
800
bzrlib.trace.create_tracefile(argv)
1695
bzrlib.trace.open_tracefile(argv)
1700
return run_bzr(argv)
1702
# do this here inside the exception wrappers to catch EPIPE
1705
quiet = isinstance(e, (BzrCommandError))
1706
_report_exception('error: ' + e.args[0], quiet=quiet)
1709
# some explanation or hints
1712
except AssertionError, e:
1713
msg = 'assertion failed'
1715
msg += ': ' + str(e)
1716
_report_exception(msg)
1718
except KeyboardInterrupt, e:
1719
_report_exception('interrupted', quiet=True)
1721
except Exception, e:
1724
if (isinstance(e, IOError)
1725
and hasattr(e, 'errno')
1726
and e.errno == errno.EPIPE):
1730
msg = str(e).rstrip('\n')
1731
_report_exception(msg, quiet)
1734
bzrlib.trace.close_trace()
806
log_error('bzr: error: ' + e.args[0] + '\n')
809
log_error(' ' + h + '\n')
812
log_error('bzr: exception: %s\n' % e)
813
log_error(' see .bzr.log for details\n')
814
traceback.print_exc(None, bzrlib.trace._tracefile)
815
traceback.print_exc(None, sys.stderr)
818
# TODO: Maybe nicer handling of IOError?
1737
822
if __name__ == '__main__':
1738
823
sys.exit(main(sys.argv))
825
##profile.run('main(sys.argv)')