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
18
# TODO: Split the command framework away from the actual commands.
20
# TODO: probably should say which arguments are candidates for glob
21
# expansion on windows and do that at the command level.
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, time, types, shutil, tempfile, traceback, fnmatch, difflib, os.path
67
from pprint import pprint
70
from inspect import getdoc
27
from bzrlib.trace import mutter, note, log_error, warning
28
from bzrlib.errors import BzrError, BzrCheckError, BzrCommandError
29
from bzrlib.branch import find_branch
30
from bzrlib import BZRDIR
36
def register_command(cmd):
37
"Utility function to help register a command"
40
if k.startswith("cmd_"):
41
k_unsquished = _unsquish_command_name(k)
44
if not plugin_cmds.has_key(k_unsquished):
45
plugin_cmds[k_unsquished] = cmd
47
log_error('Two plugins defined the same command: %r' % k)
48
log_error('Not loading the one in %r' % sys.modules[cmd.__module__])
51
def _squish_command_name(cmd):
52
return 'cmd_' + cmd.replace('-', '_')
55
def _unsquish_command_name(cmd):
56
assert cmd.startswith("cmd_")
57
return cmd[4:].replace('_','-')
60
def _parse_revision_str(revstr):
61
"""This handles a revision string -> revno.
63
This always returns a list. The list will have one element for
65
It supports integers directly, but everything else it
66
defers for passing to Branch.get_revision_info()
68
>>> _parse_revision_str('234')
70
>>> _parse_revision_str('234..567')
72
>>> _parse_revision_str('..')
74
>>> _parse_revision_str('..234')
76
>>> _parse_revision_str('234..')
78
>>> _parse_revision_str('234..456..789') # Maybe this should be an error
80
>>> _parse_revision_str('234....789') # Error?
82
>>> _parse_revision_str('revid:test@other.com-234234')
83
['revid:test@other.com-234234']
84
>>> _parse_revision_str('revid:test@other.com-234234..revid:test@other.com-234235')
85
['revid:test@other.com-234234', 'revid:test@other.com-234235']
86
>>> _parse_revision_str('revid:test@other.com-234234..23')
87
['revid:test@other.com-234234', 23]
88
>>> _parse_revision_str('date:2005-04-12')
90
>>> _parse_revision_str('date:2005-04-12 12:24:33')
91
['date:2005-04-12 12:24:33']
92
>>> _parse_revision_str('date:2005-04-12T12:24:33')
93
['date:2005-04-12T12:24:33']
94
>>> _parse_revision_str('date:2005-04-12,12:24:33')
95
['date:2005-04-12,12:24:33']
96
>>> _parse_revision_str('-5..23')
98
>>> _parse_revision_str('-5')
100
>>> _parse_revision_str('123a')
102
>>> _parse_revision_str('abc')
106
old_format_re = re.compile('\d*:\d*')
107
m = old_format_re.match(revstr)
109
warning('Colon separator for revision numbers is deprecated.'
112
for rev in revstr.split(':'):
114
revs.append(int(rev))
119
for x in revstr.split('..'):
130
def get_merge_type(typestring):
131
"""Attempt to find the merge class/factory associated with a string."""
132
from merge import merge_types
134
return merge_types[typestring][0]
136
templ = '%s%%7s: %%s' % (' '*12)
137
lines = [templ % (f[0], f[1][1]) for f in merge_types.iteritems()]
138
type_list = '\n'.join(lines)
139
msg = "No known merge type %s. Supported types are:\n%s" %\
140
(typestring, type_list)
141
raise BzrCommandError(msg)
145
def _get_cmd_dict(plugins_override=True):
147
for k, v in globals().iteritems():
148
if k.startswith("cmd_"):
149
d[_unsquish_command_name(k)] = v
150
# If we didn't load plugins, the plugin_cmds dict will be empty
152
d.update(plugin_cmds)
154
d2 = plugin_cmds.copy()
160
def get_all_cmds(plugins_override=True):
161
"""Return canonical name and class for all registered commands."""
162
for k, v in _get_cmd_dict(plugins_override=plugins_override).iteritems():
166
def get_cmd_class(cmd, plugins_override=True):
167
"""Return the canonical name and command class for a command.
169
cmd = str(cmd) # not unicode
171
# first look up this command under the specified name
172
cmds = _get_cmd_dict(plugins_override=plugins_override)
174
return cmd, cmds[cmd]
178
# look for any command which claims this as an alias
179
for cmdname, cmdclass in cmds.iteritems():
180
if cmd in cmdclass.aliases:
181
return cmdname, cmdclass
183
cmdclass = ExternalCommand.find_command(cmd)
187
raise BzrCommandError("unknown command %r" % cmd)
190
class Command(object):
191
"""Base class for commands.
193
The docstring for an actual command should give a single-line
194
summary, then a complete description of the command. A grammar
195
description will be inserted.
198
List of argument forms, marked with whether they are optional,
202
List of options that may be given for this command.
205
If true, this command isn't advertised.
214
def __init__(self, options, arguments):
215
"""Construct and run the command.
217
Sets self.status to the return value of run()."""
218
assert isinstance(options, dict)
219
assert isinstance(arguments, dict)
220
cmdargs = options.copy()
221
cmdargs.update(arguments)
222
if self.__doc__ == Command.__doc__:
223
from warnings import warn
224
warn("No help message set for %r" % self)
225
self.status = self.run(**cmdargs)
226
if self.status is None:
231
"""Override this in sub-classes.
233
This is invoked with the options and arguments bound to
236
Return 0 or None if the command was successful, or a shell
242
class ExternalCommand(Command):
243
"""Class to wrap external commands.
245
We cheat a little here, when get_cmd_class() calls us we actually
246
give it back an object we construct that has the appropriate path,
247
help, options etc for the specified command.
249
When run_bzr() tries to instantiate that 'class' it gets caught by
250
the __call__ method, which we override to call the Command.__init__
251
method. That then calls our run method which is pretty straight
254
The only wrinkle is that we have to map bzr's dictionary of options
255
and arguments back into command line options and arguments for the
259
def find_command(cls, cmd):
261
bzrpath = os.environ.get('BZRPATH', '')
263
for dir in bzrpath.split(os.pathsep):
264
path = os.path.join(dir, cmd)
265
if os.path.isfile(path):
266
return ExternalCommand(path)
270
find_command = classmethod(find_command)
272
def __init__(self, path):
275
pipe = os.popen('%s --bzr-usage' % path, 'r')
276
self.takes_options = pipe.readline().split()
278
for opt in self.takes_options:
279
if not opt in OPTIONS:
280
raise BzrError("Unknown option '%s' returned by external command %s"
283
# TODO: Is there any way to check takes_args is valid here?
284
self.takes_args = pipe.readline().split()
286
if pipe.close() is not None:
287
raise BzrError("Failed funning '%s --bzr-usage'" % path)
289
pipe = os.popen('%s --bzr-help' % path, 'r')
290
self.__doc__ = pipe.read()
291
if pipe.close() is not None:
292
raise BzrError("Failed funning '%s --bzr-help'" % path)
294
def __call__(self, options, arguments):
295
Command.__init__(self, options, arguments)
298
def run(self, **kargs):
305
optname = name.replace('_','-')
307
if OPTIONS.has_key(optname):
309
opts.append('--%s' % optname)
310
if value is not None and value is not True:
311
opts.append(str(value))
313
# it's an arg, or arg list
314
if type(value) is not list:
320
self.status = os.spawnv(os.P_WAIT, self.path, [self.path] + opts + args)
324
class cmd_status(Command):
73
from bzrlib.store import ImmutableStore
74
from bzrlib.trace import mutter, note, log_error
75
from bzrlib.errors import bailout, BzrError, BzrCheckError
76
from bzrlib.osutils import quotefn, pumpfile, isdir, isfile
77
from bzrlib.tree import RevisionTree, EmptyTree, WorkingTree, Tree
78
from bzrlib.revision import Revision
79
from bzrlib import Branch, Inventory, InventoryEntry, ScratchBranch, BZRDIR, \
82
BZR_DIFF_FORMAT = "## Bazaar-NG diff, format 0 ##\n"
83
BZR_PATCHNAME_FORMAT = 'cset:sha1:%s'
85
## standard representation
86
NONE_STRING = '(none)'
90
## TODO: Perhaps a different version of inventory commands that
91
## returns iterators...
93
## TODO: Perhaps an AtomicFile class that writes to a temporary file and then renames.
95
## TODO: Some kind of locking on branches. Perhaps there should be a
96
## parameter to the branch object saying whether we want a read or
97
## write lock; release it from destructor. Perhaps don't even need a
98
## read lock to look at immutable objects?
100
## TODO: Perhaps make UUIDs predictable in test mode to make it easier
101
## to compare output?
103
## TODO: Some kind of global code to generate the right Branch object
104
## to work on. Almost, but not quite all, commands need one, and it
105
## can be taken either from their parameters or their working
108
## TODO: rename command, needed soon: check destination doesn't exist
109
## either in working copy or tree; move working copy; update
110
## inventory; write out
112
## TODO: move command; check destination is a directory and will not
115
## TODO: command to show renames, one per line, as to->from
120
def cmd_status(all=False):
325
121
"""Display status summary.
327
This reports on versioned and unknown files, reporting them
328
grouped by state. Possible states are:
331
Versioned in the working copy but not in the previous revision.
334
Versioned in the previous revision but removed or deleted
338
Path of this file changed from the previous revision;
339
the text may also have changed. This includes files whose
340
parent directory was renamed.
343
Text has changed since the previous revision.
346
Nothing about this file has changed since the previous revision.
347
Only shown with --all.
350
Not versioned and not matching an ignore pattern.
352
To see ignored files use 'bzr ignored'. For details in the
353
changes to file texts, use 'bzr diff'.
355
If no arguments are specified, the status of the entire working
356
directory is shown. Otherwise, only the status of the specified
357
files or directories is reported. If a directory is given, status
358
is reported for everything inside that directory.
360
If a revision is specified, the changes since that revision are shown.
362
takes_args = ['file*']
363
takes_options = ['all', 'show-ids', 'revision']
364
aliases = ['st', 'stat']
366
def run(self, all=False, show_ids=False, file_list=None):
368
b = find_branch(file_list[0])
369
file_list = [b.relpath(x) for x in file_list]
370
# special case: only one path was given and it's the root
372
if file_list == ['']:
377
from bzrlib.status import show_status
378
show_status(b, show_unchanged=all, show_ids=show_ids,
379
specific_files=file_list)
382
class cmd_cat_revision(Command):
383
"""Write out metadata for a revision."""
386
takes_args = ['revision_id']
388
def run(self, revision_id):
389
from bzrlib.xml import pack_xml
390
pack_xml(find_branch('.').get_revision(revision_id), sys.stdout)
393
class cmd_revno(Command):
394
"""Show current revision number.
396
This is equal to the number of revisions on this branch."""
398
print find_branch('.').revno()
400
class cmd_revision_info(Command):
401
"""Show revision number and revision id for a given revision identifier.
404
takes_args = ['revision_info*']
405
takes_options = ['revision']
406
def run(self, revision=None, revision_info_list=None):
407
from bzrlib.branch import find_branch
410
if revision is not None:
411
revs.extend(revision)
412
if revision_info_list is not None:
413
revs.extend(revision_info_list)
415
raise BzrCommandError('You must supply a revision identifier')
420
print '%4d %s' % b.get_revision_info(rev)
423
class cmd_add(Command):
123
For each file there is a single line giving its file state and name.
124
The name is that in the current revision unless it is deleted or
125
missing, in which case the old name is shown.
127
:todo: Don't show unchanged files unless ``--all`` is given?
129
#import bzrlib.status
130
#bzrlib.status.tree_status(Branch('.'))
131
Branch('.').show_status(show_all=all)
135
######################################################################
137
def cmd_get_revision(revision_id):
138
Branch('.').get_revision(revision_id).write_xml(sys.stdout)
141
def cmd_get_file_text(text_id):
142
"""Get contents of a file by hash."""
143
sf = Branch('.').text_store[text_id]
144
pumpfile(sf, sys.stdout)
148
######################################################################
153
"""Show number of revisions on this branch"""
154
print Branch('.').revno()
158
def cmd_add(file_list, verbose=False):
424
159
"""Add specified files or directories.
426
161
In non-recursive mode, all the named items are added, regardless
529
224
TODO: Some way to rename multiple files without invoking bzr for each
531
takes_args = ['from_name', 'to_name']
533
def run(self, from_name, to_name):
535
b.rename_one(b.relpath(from_name), b.relpath(to_name))
539
class cmd_mv(Command):
540
"""Move or rename a file.
543
bzr mv OLDNAME NEWNAME
544
bzr mv SOURCE... DESTINATION
546
If the last argument is a versioned directory, all the other names
547
are moved into it. Otherwise, there must be exactly two arguments
548
and the file is changed to a new name, which must not already exist.
550
Files cannot be moved between branches.
552
takes_args = ['names*']
553
def run(self, names_list):
554
if len(names_list) < 2:
555
raise BzrCommandError("missing file argument")
556
b = find_branch(names_list[0])
558
rel_names = [b.relpath(x) for x in names_list]
560
if os.path.isdir(names_list[-1]):
561
# move into existing directory
562
b.move(rel_names[:-1], rel_names[-1])
564
if len(names_list) != 2:
565
raise BzrCommandError('to mv multiple files the destination '
566
'must be a versioned directory')
567
b.move(rel_names[0], rel_names[1])
572
class cmd_pull(Command):
573
"""Pull any changes from another branch into the current one.
575
If the location is omitted, the last-used location will be used.
576
Both the revision history and the working directory will be
579
This command only works on branches that have not diverged. Branches are
580
considered diverged if both branches have had commits without first
581
pulling from the other.
583
If branches have diverged, you can use 'bzr merge' to pull the text changes
584
from one into the other.
586
takes_args = ['location?']
588
def run(self, location=None):
589
from bzrlib.merge import merge
591
from shutil import rmtree
594
br_to = find_branch('.')
597
stored_loc = br_to.controlfile("x-pull", "rb").read().rstrip('\n')
599
if e.errno != errno.ENOENT:
602
if stored_loc is None:
603
raise BzrCommandError("No pull location known or specified.")
605
print "Using last location: %s" % stored_loc
606
location = stored_loc
607
cache_root = tempfile.mkdtemp()
608
from bzrlib.branch import DivergedBranches
609
br_from = find_branch(location)
610
location = pull_loc(br_from)
611
old_revno = br_to.revno()
613
from branch import find_cached_branch, DivergedBranches
614
br_from = find_cached_branch(location, cache_root)
615
location = pull_loc(br_from)
616
old_revno = br_to.revno()
618
br_to.update_revisions(br_from)
619
except DivergedBranches:
620
raise BzrCommandError("These branches have diverged."
623
merge(('.', -1), ('.', old_revno), check_clean=False)
624
if location != stored_loc:
625
br_to.controlfile("x-pull", "wb").write(location + "\n")
631
class cmd_branch(Command):
632
"""Create a new copy of a branch.
634
If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
635
be used. In other words, "branch ../foo/bar" will attempt to create ./bar.
637
To retrieve the branch as of a particular revision, supply the --revision
638
parameter, as in "branch foo/bar -r 5".
640
takes_args = ['from_location', 'to_location?']
641
takes_options = ['revision']
642
aliases = ['get', 'clone']
644
def run(self, from_location, to_location=None, revision=None):
646
from bzrlib.merge import merge
647
from bzrlib.branch import DivergedBranches, \
648
find_cached_branch, Branch
649
from shutil import rmtree
650
from meta_store import CachedStore
652
cache_root = tempfile.mkdtemp()
656
elif len(revision) > 1:
657
raise BzrCommandError('bzr branch --revision takes exactly 1 revision value')
661
br_from = find_cached_branch(from_location, cache_root)
663
if e.errno == errno.ENOENT:
664
raise BzrCommandError('Source location "%s" does not'
665
' exist.' % to_location)
669
if to_location is None:
670
to_location = os.path.basename(from_location.rstrip("/\\"))
673
os.mkdir(to_location)
675
if e.errno == errno.EEXIST:
676
raise BzrCommandError('Target directory "%s" already'
677
' exists.' % to_location)
678
if e.errno == errno.ENOENT:
679
raise BzrCommandError('Parent of "%s" does not exist.' %
683
br_to = Branch(to_location, init=True)
685
br_to.set_root_id(br_from.get_root_id())
688
if revision[0] is None:
689
revno = br_from.revno()
691
revno, rev_id = br_from.get_revision_info(revision[0])
693
br_to.update_revisions(br_from, stop_revision=revno)
694
except bzrlib.errors.NoSuchRevision:
696
msg = "The branch %s has no revision %d." % (from_location,
698
raise BzrCommandError(msg)
700
merge((to_location, -1), (to_location, 0), this_dir=to_location,
701
check_clean=False, ignore_zero=True)
702
from_location = pull_loc(br_from)
703
br_to.controlfile("x-pull", "wb").write(from_location + "\n")
708
def pull_loc(branch):
709
# TODO: Should perhaps just make attribute be 'base' in
710
# RemoteBranch and Branch?
711
if hasattr(branch, "baseurl"):
712
return branch.baseurl
718
class cmd_renames(Command):
227
b.rename_one(b.relpath(from_name), b.relpath(to_name))
232
def cmd_renames(dir='.'):
719
233
"""Show list of renamed files.
235
usage: bzr renames [BRANCH]
721
237
TODO: Option to show renames between two historical versions.
723
239
TODO: Only show renames under dir, rather than in the whole branch.
725
takes_args = ['dir?']
727
def run(self, dir='.'):
729
old_inv = b.basis_tree().inventory
730
new_inv = b.read_working_inventory()
732
renames = list(bzrlib.tree.find_renames(old_inv, new_inv))
734
for old_name, new_name in renames:
735
print "%s => %s" % (old_name, new_name)
738
class cmd_info(Command):
739
"""Show statistical information about a branch."""
740
takes_args = ['branch?']
742
def run(self, branch=None):
745
b = find_branch(branch)
749
class cmd_remove(Command):
750
"""Make a file unversioned.
752
This makes bzr stop tracking changes to a versioned file. It does
753
not delete the working copy.
755
takes_args = ['file+']
756
takes_options = ['verbose']
758
def run(self, file_list, verbose=False):
759
b = find_branch(file_list[0])
760
b.remove([b.relpath(f) for f in file_list], verbose=verbose)
763
class cmd_file_id(Command):
242
old_inv = b.basis_tree().inventory
243
new_inv = b.read_working_inventory()
245
renames = list(bzrlib.tree.find_renames(old_inv, new_inv))
247
for old_name, new_name in renames:
248
print "%s => %s" % (old_name, new_name)
253
"""info: Show statistical information for this branch
257
info.show_info(Branch('.'))
261
def cmd_remove(file_list, verbose=False):
262
b = Branch(file_list[0])
263
b.remove([b.relpath(f) for f in file_list], verbose=verbose)
267
def cmd_file_id(filename):
764
268
"""Print file_id of a particular file or directory.
270
usage: bzr file-id FILE
766
272
The file_id is assigned when the file is first added and remains the
767
273
same through all revisions where the file exists, even when it is
768
274
moved or renamed.
771
takes_args = ['filename']
772
def run(self, filename):
773
b = find_branch(filename)
774
i = b.inventory.path2id(b.relpath(filename))
776
raise BzrError("%r is not a versioned file" % filename)
781
class cmd_file_path(Command):
277
i = b.inventory.path2id(b.relpath(filename))
279
bailout("%r is not a versioned file" % filename)
284
def cmd_file_id_path(filename):
782
285
"""Print path of file_ids to a file or directory.
287
usage: bzr file-id-path FILE
784
289
This prints one line for each directory down to the target,
785
290
starting at the branch root."""
787
takes_args = ['filename']
788
def run(self, filename):
789
b = find_branch(filename)
791
fid = inv.path2id(b.relpath(filename))
793
raise BzrError("%r is not a versioned file" % filename)
794
for fip in inv.get_idpath(fid):
798
class cmd_revision_history(Command):
799
"""Display list of revision ids on this branch."""
802
for patchid in find_branch('.').revision_history():
806
class cmd_directories(Command):
807
"""Display list of versioned directories in this branch."""
809
for name, ie in find_branch('.').read_working_inventory().directories():
816
class cmd_init(Command):
817
"""Make a directory into a versioned branch.
819
Use this to create an empty branch, or before importing an
822
Recipe for importing a tree of files:
827
bzr commit -m 'imported project'
830
from bzrlib.branch import Branch
831
Branch('.', init=True)
834
class cmd_diff(Command):
835
"""Show differences in working tree.
293
fid = inv.path2id(b.relpath(filename))
295
bailout("%r is not a versioned file" % filename)
296
for fip in inv.get_idpath(fid):
300
def cmd_revision_history():
301
for patchid in Branch('.').revision_history():
305
def cmd_directories():
306
for name, ie in Branch('.').read_working_inventory().directories():
314
for name, ie in Branch('.').working_tree().missing():
319
# TODO: Check we're not already in a working directory? At the
320
# moment you'll get an ugly error.
322
# TODO: What if we're in a subdirectory of a branch? Would like
323
# to allow that, but then the parent may need to understand that
324
# the children have disappeared, or should they be versioned in
327
# TODO: Take an argument/option for branch name.
328
Branch('.', init=True)
331
def cmd_diff(revision=None, file_list=None):
332
"""bzr diff: Show differences in working tree.
334
usage: bzr diff [-r REV] [FILE...]
337
Show changes since REV, rather than predecessor.
837
339
If files are listed, only the changes in those files are listed.
838
340
Otherwise, all changes for the tree are listed.
844
346
TODO: Option to use external diff command; could be GNU diff, wdiff,
845
347
or a graphical diff.
847
TODO: Python difflib is not exactly the same as unidiff; should
848
either fix it up or prefer to use an external diff.
850
349
TODO: If a directory is given, diff everything under that.
852
TODO: Selected-file diff is inefficient and doesn't show you
855
TODO: This probably handles non-Unix newlines poorly.
351
TODO: Selected-file diff is inefficient and doesn't show you deleted files.
354
## TODO: Shouldn't be in the cmd function.
359
old_tree = b.basis_tree()
361
old_tree = b.revision_tree(b.lookup_revision(revision))
363
new_tree = b.working_tree()
365
# TODO: Options to control putting on a prefix or suffix, perhaps as a format string
369
DEVNULL = '/dev/null'
370
# Windows users, don't panic about this filename -- it is a
371
# special signal to GNU patch that the file should be created or
372
# deleted respectively.
374
# TODO: Generation of pseudo-diffs for added/deleted files could
375
# be usefully made into a much faster special case.
377
# TODO: Better to return them in sorted order I think.
379
# FIXME: If given a file list, compare only those files rather
380
# than comparing everything and then throwing stuff away.
858
takes_args = ['file*']
859
takes_options = ['revision', 'diff-options']
860
aliases = ['di', 'dif']
862
def run(self, revision=None, file_list=None, diff_options=None):
863
from bzrlib.diff import show_diff
866
b = find_branch(file_list[0])
867
file_list = [b.relpath(f) for f in file_list]
868
if file_list == ['']:
869
# just pointing to top-of-tree
382
for file_state, fid, old_name, new_name, kind in bzrlib.diff_trees(old_tree, new_tree):
384
if file_list and new_name not in file_list:
387
# Don't show this by default; maybe do it if an option is passed
388
# idlabel = ' {%s}' % fid
391
# FIXME: Something about the diff format makes patch unhappy
392
# with newly-added files.
394
def diffit(oldlines, newlines, **kw):
395
# FIXME: difflib is wrong if there is no trailing newline.
397
# Special workaround for Python2.3, where difflib fails if
398
# both sequences are empty.
399
if oldlines or newlines:
400
sys.stdout.writelines(difflib.unified_diff(oldlines, newlines, **kw))
403
if file_state in ['.', '?', 'I']:
405
elif file_state == 'A':
406
print '*** added %s %r' % (kind, new_name)
409
new_tree.get_file(fid).readlines(),
411
tofile=new_label + new_name + idlabel)
412
elif file_state == 'D':
413
assert isinstance(old_name, types.StringTypes)
414
print '*** deleted %s %r' % (kind, old_name)
416
diffit(old_tree.get_file(fid).readlines(), [],
417
fromfile=old_label + old_name + idlabel,
419
elif file_state in ['M', 'R']:
420
if file_state == 'M':
421
assert kind == 'file'
422
assert old_name == new_name
423
print '*** modified %s %r' % (kind, new_name)
424
elif file_state == 'R':
425
print '*** renamed %s %r => %r' % (kind, old_name, new_name)
428
diffit(old_tree.get_file(fid).readlines(),
429
new_tree.get_file(fid).readlines(),
430
fromfile=old_label + old_name + idlabel,
431
tofile=new_label + new_name)
874
# TODO: Make show_diff support taking 2 arguments
876
if revision is not None:
877
if len(revision) != 1:
878
raise BzrCommandError('bzr diff --revision takes exactly one revision identifier')
879
base_rev = revision[0]
881
show_diff(b, base_rev, specific_files=file_list,
882
external_diff_options=diff_options)
888
class cmd_deleted(Command):
433
bailout("can't represent state %s {%s}" % (file_state, fid))
437
def cmd_deleted(show_ids=False):
889
438
"""List files deleted in the working tree.
891
440
TODO: Show files deleted since a previous revision, or between two revisions.
893
def run(self, show_ids=False):
896
new = b.working_tree()
898
## TODO: Much more efficient way to do this: read in new
899
## directories with readdir, rather than stating each one. Same
900
## level of effort but possibly much less IO. (Or possibly not,
901
## if the directories are very large...)
903
for path, ie in old.inventory.iter_entries():
904
if not new.has_id(ie.file_id):
906
print '%-50s %s' % (path, ie.file_id)
911
class cmd_modified(Command):
912
"""List files modified in working tree."""
915
from bzrlib.delta import compare_trees
918
td = compare_trees(b.basis_tree(), b.working_tree())
920
for path, id, kind in td.modified:
925
class cmd_added(Command):
926
"""List files added in working tree."""
930
wt = b.working_tree()
931
basis_inv = b.basis_tree().inventory
934
if file_id in basis_inv:
936
path = inv.id2path(file_id)
937
if not os.access(b.abspath(path), os.F_OK):
444
new = b.working_tree()
446
## TODO: Much more efficient way to do this: read in new
447
## directories with readdir, rather than stating each one. Same
448
## level of effort but possibly much less IO. (Or possibly not,
449
## if the directories are very large...)
451
for path, ie in old.inventory.iter_entries():
452
if not new.has_id(ie.file_id):
454
print '%-50s %s' % (path, ie.file_id)
460
def cmd_parse_inventory():
463
cElementTree.ElementTree().parse(file('.bzr/inventory'))
467
def cmd_load_inventory():
468
"""Load inventory for timing purposes"""
469
Branch('.').basis_tree().inventory
472
def cmd_dump_inventory():
473
Branch('.').read_working_inventory().write_xml(sys.stdout)
476
def cmd_dump_new_inventory():
477
import bzrlib.newinventory
478
inv = Branch('.').basis_tree().inventory
479
bzrlib.newinventory.write_inventory(inv, sys.stdout)
482
def cmd_load_new_inventory():
483
import bzrlib.newinventory
484
bzrlib.newinventory.read_new_inventory(sys.stdin)
943
class cmd_root(Command):
944
"""Show the tree root directory.
946
The root is the nearest enclosing directory with a .bzr control
948
takes_args = ['filename?']
949
def run(self, filename=None):
950
"""Print the branch root."""
951
b = find_branch(filename)
952
print getattr(b, 'base', None) or getattr(b, 'baseurl')
955
class cmd_log(Command):
487
def cmd_dump_slacker_inventory():
488
import bzrlib.newinventory
489
inv = Branch('.').basis_tree().inventory
490
bzrlib.newinventory.write_slacker_inventory(inv, sys.stdout)
494
def cmd_dump_text_inventory():
495
import bzrlib.textinv
496
inv = Branch('.').basis_tree().inventory
497
bzrlib.textinv.write_text_inventory(inv, sys.stdout)
500
def cmd_load_text_inventory():
501
import bzrlib.textinv
502
inv = bzrlib.textinv.read_text_inventory(sys.stdin)
503
print 'loaded %d entries' % len(inv)
507
def cmd_root(filename=None):
508
"""Print the branch root."""
509
print bzrlib.branch.find_branch_root(filename)
512
def cmd_log(timezone='original', verbose=False):
956
513
"""Show log of this branch.
958
To request a range of logs, you can use the command -r begin:end
959
-r revision requests a specific revision, -r :end or -r begin: are
962
--message allows you to give a regular expression, which will be evaluated
963
so that only matching entries will be displayed.
965
TODO: Make --revision support uuid: and hash: [future tag:] notation.
515
:todo: Options for utc; to show ids; to limit range; etc.
969
takes_args = ['filename?']
970
takes_options = ['forward', 'timezone', 'verbose', 'show-ids', 'revision','long', 'message']
972
def run(self, filename=None, timezone='original',
979
from bzrlib.branch import find_branch
980
from bzrlib.log import log_formatter, show_log
983
direction = (forward and 'forward') or 'reverse'
986
b = find_branch(filename)
987
fp = b.relpath(filename)
989
file_id = b.read_working_inventory().path2id(fp)
991
file_id = None # points to branch root
999
elif len(revision) == 1:
1000
rev1 = rev2 = b.get_revision_info(revision[0])[0]
1001
elif len(revision) == 2:
1002
rev1 = b.get_revision_info(revision[0])[0]
1003
rev2 = b.get_revision_info(revision[1])[0]
1005
raise BzrCommandError('bzr log --revision takes one or two values.')
1012
mutter('encoding log as %r' % bzrlib.user_encoding)
1014
# use 'replace' so that we don't abort if trying to write out
1015
# in e.g. the default C locale.
1016
outf = codecs.getwriter(bzrlib.user_encoding)(sys.stdout, errors='replace')
1021
log_format = 'short'
1022
lf = log_formatter(log_format,
1025
show_timezone=timezone)
1031
direction=direction,
1032
start_revision=rev1,
1038
class cmd_touching_revisions(Command):
1039
"""Return revision-ids which affected a particular file.
1041
A more user-friendly interface is "bzr log FILE"."""
1043
takes_args = ["filename"]
1044
def run(self, filename):
1045
b = find_branch(filename)
1046
inv = b.read_working_inventory()
1047
file_id = inv.path2id(b.relpath(filename))
1048
for revno, revision_id, what in bzrlib.log.find_touching_revisions(b, file_id):
1049
print "%6d %s" % (revno, what)
1052
class cmd_ls(Command):
517
Branch('.').write_log(show_timezone=timezone, verbose=verbose)
520
def cmd_ls(revision=None, verbose=False):
1053
521
"""List files in a tree.
1055
TODO: Take a revision or remote path and list that tree instead.
523
:todo: Take a revision or remote path and list that tree instead.
1058
def run(self, revision=None, verbose=False):
1059
b = find_branch('.')
1060
if revision == None:
1061
tree = b.working_tree()
1063
tree = b.revision_tree(b.lookup_revision(revision))
1065
for fp, fc, kind, fid in tree.list_files():
1067
if kind == 'directory':
1069
elif kind == 'file':
1074
print '%-8s %s%s' % (fc, fp, kindch)
527
tree = b.working_tree()
529
tree = b.revision_tree(b.lookup_revision(revision))
531
for fp, fc, kind, fid in tree.list_files():
533
if kind == 'directory':
1080
class cmd_unknowns(Command):
1081
"""List unknown files."""
1083
from bzrlib.osutils import quotefn
1084
for f in find_branch('.').unknowns():
1089
class cmd_ignore(Command):
1090
"""Ignore a command or pattern.
1092
To remove patterns from the ignore list, edit the .bzrignore file.
1094
If the pattern contains a slash, it is compared to the whole path
1095
from the branch root. Otherwise, it is comapred to only the last
1096
component of the path.
1098
Ignore patterns are case-insensitive on case-insensitive systems.
1100
Note: wildcards must be quoted from the shell on Unix.
1103
bzr ignore ./Makefile
1104
bzr ignore '*.class'
1106
takes_args = ['name_pattern']
1108
def run(self, name_pattern):
1109
from bzrlib.atomicfile import AtomicFile
1112
b = find_branch('.')
1113
ifn = b.abspath('.bzrignore')
1115
if os.path.exists(ifn):
1118
igns = f.read().decode('utf-8')
1124
# TODO: If the file already uses crlf-style termination, maybe
1125
# we should use that for the newly added lines?
1127
if igns and igns[-1] != '\n':
1129
igns += name_pattern + '\n'
1132
f = AtomicFile(ifn, 'wt')
1133
f.write(igns.encode('utf-8'))
1138
inv = b.working_tree().inventory
1139
if inv.path2id('.bzrignore'):
1140
mutter('.bzrignore is already versioned')
1142
mutter('need to make new .bzrignore file versioned')
1143
b.add(['.bzrignore'])
1147
class cmd_ignored(Command):
540
print '%-8s %s%s' % (fc, fp, kindch)
547
"""List unknown files"""
548
for f in Branch('.').unknowns():
1148
554
"""List ignored files and the patterns that matched them.
1150
See also: bzr ignore"""
1152
tree = find_branch('.').working_tree()
1153
for path, file_class, kind, file_id in tree.list_files():
1154
if file_class != 'I':
1156
## XXX: Slightly inefficient since this was already calculated
1157
pat = tree.is_ignored(path)
1158
print '%-50s %s' % (path, pat)
1161
class cmd_lookup_revision(Command):
1162
"""Lookup the revision-id from a revision-number
1165
bzr lookup-revision 33
1168
takes_args = ['revno']
1170
def run(self, revno):
1174
raise BzrCommandError("not a valid revision-number: %r" % revno)
1176
print find_branch('.').lookup_revision(revno)
1179
class cmd_export(Command):
1180
"""Export past revision to destination directory.
1182
If no revision is specified this exports the last committed revision.
1184
Format may be an "exporter" name, such as tar, tgz, tbz2. If none is
1185
given, try to find the format with the extension. If no extension
1186
is found exports to a directory (equivalent to --format=dir).
1188
Root may be the top directory for tar, tgz and tbz2 formats. If none
1189
is given, the top directory will be the root name of the file."""
1190
# TODO: list known exporters
1191
takes_args = ['dest']
1192
takes_options = ['revision', 'format', 'root']
1193
def run(self, dest, revision=None, format=None, root=None):
1195
b = find_branch('.')
1196
if revision is None:
1197
rev_id = b.last_patch()
1199
if len(revision) != 1:
1200
raise BzrError('bzr export --revision takes exactly 1 argument')
1201
revno, rev_id = b.get_revision_info(revision[0])
1202
t = b.revision_tree(rev_id)
1203
root, ext = os.path.splitext(dest)
1205
if ext in (".tar",):
1207
elif ext in (".gz", ".tgz"):
1209
elif ext in (".bz2", ".tbz2"):
1213
t.export(dest, format, root)
1216
class cmd_cat(Command):
1217
"""Write a file's text from a previous revision."""
1219
takes_options = ['revision']
1220
takes_args = ['filename']
1222
def run(self, filename, revision=None):
1223
if revision == None:
1224
raise BzrCommandError("bzr cat requires a revision number")
1225
elif len(revision) != 1:
1226
raise BzrCommandError("bzr cat --revision takes exactly one number")
1227
b = find_branch('.')
1228
b.print_file(b.relpath(filename), revision[0])
1231
class cmd_local_time_offset(Command):
1232
"""Show the offset in seconds from GMT to local time."""
1235
print bzrlib.osutils.local_time_offset()
1239
class cmd_commit(Command):
1240
"""Commit changes into a new revision.
1242
If no arguments are given, the entire tree is committed.
1244
If selected files are specified, only changes to those files are
1245
committed. If a directory is specified then the directory and everything
1246
within it is committed.
1248
A selected-file commit may fail in some cases where the committed
1249
tree would be invalid, such as trying to commit a file in a
1250
newly-added directory that is not itself committed.
556
tree = Branch('.').working_tree()
557
for path, file_class, kind, file_id in tree.list_files():
558
if file_class != 'I':
560
## XXX: Slightly inefficient since this was already calculated
561
pat = tree.is_ignored(path)
562
print '%-50s %s' % (path, pat)
565
def cmd_lookup_revision(revno):
569
bailout("usage: lookup-revision REVNO",
570
["REVNO is a non-negative revision number for this branch"])
572
print Branch('.').lookup_revision(revno) or NONE_STRING
576
def cmd_export(revno, dest):
577
"""Export past revision to destination directory."""
579
rh = b.lookup_revision(int(revno))
580
t = b.revision_tree(rh)
583
def cmd_cat(revision, filename):
584
"""Print file to stdout."""
586
b.print_file(b.relpath(filename), int(revision))
589
######################################################################
590
# internal/test commands
594
"""Print a newly-generated UUID."""
595
print bzrlib.osutils.uuid()
599
def cmd_local_time_offset():
600
print bzrlib.osutils.local_time_offset()
604
def cmd_commit(message=None, verbose=False):
605
"""Commit changes to a new revision.
608
Description of changes in this revision; free form text.
609
It is recommended that the first line be a single-sentence
612
Show status of changed files,
614
TODO: Commit only selected files.
1252
616
TODO: Run hooks on tree to-be-committed, and after commit.
1254
618
TODO: Strict commit that fails if there are unknown or deleted files.
1256
takes_args = ['selected*']
1257
takes_options = ['message', 'file', 'verbose', 'unchanged']
1258
aliases = ['ci', 'checkin']
1260
# TODO: Give better message for -s, --summary, used by tla people
1262
def run(self, message=None, file=None, verbose=True, selected_list=None,
1264
from bzrlib.errors import PointlessCommit
1265
from bzrlib.osutils import get_text_message
1267
## Warning: shadows builtin file()
1268
if not message and not file:
1269
# FIXME: Ugly; change status code to send to a provided function?
1273
catcher = cStringIO.StringIO()
1274
sys.stdout = catcher
1275
cmd_status({"file_list":selected_list}, {})
1276
info = catcher.getvalue()
1278
message = get_text_message(info)
1281
raise BzrCommandError("please specify a commit message",
1282
["use either --message or --file"])
1283
elif message and file:
1284
raise BzrCommandError("please specify either --message or --file")
1288
message = codecs.open(file, 'rt', bzrlib.user_encoding).read()
1290
b = find_branch('.')
1292
selected_list = [b.relpath(s) for s in selected_list]
1295
b.commit(message, verbose=verbose,
1296
specific_files=selected_list,
1297
allow_pointless=unchanged)
1298
except PointlessCommit:
1299
# FIXME: This should really happen before the file is read in;
1300
# perhaps prepare the commit; get the message; then actually commit
1301
raise BzrCommandError("no changes to commit",
1302
["use --unchanged to commit anyhow"])
1305
class cmd_check(Command):
1306
"""Validate consistency of branch history.
622
bailout("please specify a commit message")
623
Branch('.').commit(message, verbose=verbose)
626
def cmd_check(dir='.'):
627
"""check: Consistency check of branch history.
629
usage: bzr check [-v] [BRANCH]
632
--verbose, -v Show progress of checking.
1308
634
This command checks various invariants about the branch storage to
1309
635
detect data corruption or bzr bugs.
1311
If given the --update flag, it will update some optional fields
1312
to help ensure data consistency.
1314
takes_args = ['dir?']
1316
def run(self, dir='.'):
1317
from bzrlib.check import check
1318
check(find_branch(dir))
1322
class cmd_scan_cache(Command):
1325
from bzrlib.hashcache import HashCache
1332
print '%6d stats' % c.stat_count
1333
print '%6d in hashcache' % len(c._cache)
1334
print '%6d files removed from cache' % c.removed_count
1335
print '%6d hashes updated' % c.update_count
1336
print '%6d files changed too recently to cache' % c.danger_count
1343
class cmd_upgrade(Command):
1344
"""Upgrade branch storage to current format.
1346
This should normally be used only after the check command tells
1349
takes_args = ['dir?']
1351
def run(self, dir='.'):
1352
from bzrlib.upgrade import upgrade
1353
upgrade(find_branch(dir))
1357
class cmd_whoami(Command):
1358
"""Show bzr user id."""
1359
takes_options = ['email']
1361
def run(self, email=False):
1363
print bzrlib.osutils.user_email()
1365
print bzrlib.osutils.username()
1368
class cmd_selftest(Command):
638
bzrlib.check.check(Branch(dir, find_root=False))
641
def cmd_is(pred, *rest):
642
"""Test whether PREDICATE is true."""
644
cmd_handler = globals()['assert_' + pred.replace('-', '_')]
646
bailout("unknown predicate: %s" % quotefn(pred))
650
except BzrCheckError:
651
# by default we don't print the message so that this can
652
# be used from shell scripts without producing noise
657
print bzrlib.osutils.username()
660
def cmd_user_email():
661
print bzrlib.osutils.user_email()
664
def cmd_gen_revision_id():
665
print bzrlib.branch._gen_revision_id(time.time())
1369
669
"""Run internal test suite"""
1371
takes_options = ['verbose']
1372
def run(self, verbose=False):
1373
from bzrlib.selftest import selftest
1374
return int(not selftest(verbose=verbose))
1377
class cmd_version(Command):
1378
"""Show version of bzr."""
670
## -v, if present, is seen by doctest; the argument is just here
671
## so our parser doesn't complain
673
## TODO: --verbose option
675
failures, tests = 0, 0
677
import doctest, bzrlib.store, bzrlib.tests
678
bzrlib.trace.verbose = False
680
for m in bzrlib.store, bzrlib.inventory, bzrlib.branch, bzrlib.osutils, \
681
bzrlib.tree, bzrlib.tests, bzrlib.commands, bzrlib.add:
682
mf, mt = doctest.testmod(m)
685
print '%-40s %3d tests' % (m.__name__, mt),
687
print '%3d FAILED!' % mf
691
print '%-40s %3d tests' % ('total', tests),
693
print '%3d FAILED!' % failures
700
cmd_doctest = cmd_selftest
703
######################################################################
707
def cmd_help(topic=None):
712
# otherwise, maybe the name of a command?
714
cmdfn = globals()['cmd_' + topic.replace('-', '_')]
716
bailout("no help for %r" % topic)
720
bailout("sorry, no detailed help yet for %r" % topic)
1383
728
print "bzr (bazaar-ng) %s" % bzrlib.__version__
1384
# is bzrlib itself in a branch?
1385
bzrrev = bzrlib.get_bzr_revision()
1387
print " (bzr checkout, revision %d {%s})" % bzrrev
1388
729
print bzrlib.__copyright__
1389
730
print "http://bazaar-ng.org/"
1391
print "bzr comes with ABSOLUTELY NO WARRANTY. bzr is free software, and"
1392
print "you may use, modify and redistribute it under the terms of the GNU"
1393
print "General Public License version 2 or later."
1396
class cmd_rocks(Command):
733
"""bzr comes with ABSOLUTELY NO WARRANTY. bzr is free software, and
734
you may use, modify and redistribute it under the terms of the GNU
735
General Public License version 2 or later."""
1397
739
"""Statement of optimism."""
1400
print "it sure does!"
1402
def parse_spec(spec):
1404
>>> parse_spec(None)
1406
>>> parse_spec("./")
1408
>>> parse_spec("../@")
1410
>>> parse_spec("../f/@35")
1412
>>> parse_spec('./@revid:john@arbash-meinel.com-20050711044610-3ca0327c6a222f67')
1413
['.', 'revid:john@arbash-meinel.com-20050711044610-3ca0327c6a222f67']
1418
parsed = spec.split('/@')
1419
assert len(parsed) == 2
1424
parsed[1] = int(parsed[1])
1426
pass # We can allow stuff like ./@revid:blahblahblah
1428
assert parsed[1] >=0
1430
parsed = [spec, None]
1435
class cmd_merge(Command):
1436
"""Perform a three-way merge of trees.
1438
The SPEC parameters are working tree or revision specifiers. Working trees
1439
are specified using standard paths or urls. No component of a directory
1440
path may begin with '@'.
1442
Working tree examples: '.', '..', 'foo@', but NOT 'foo/@bar'
1444
Revisions are specified using a dirname/@revno pair, where dirname is the
1445
branch directory and revno is the revision within that branch. If no revno
1446
is specified, the latest revision is used.
1448
Revision examples: './@127', 'foo/@', '../@1'
1450
The OTHER_SPEC parameter is required. If the BASE_SPEC parameter is
1451
not supplied, the common ancestor of OTHER_SPEC the current branch is used
1454
merge refuses to run if there are any uncommitted changes, unless
1457
takes_args = ['other_spec', 'base_spec?']
1458
takes_options = ['force', 'merge-type']
1460
def run(self, other_spec, base_spec=None, force=False, merge_type=None):
1461
from bzrlib.merge import merge
1462
from bzrlib.merge_core import ApplyMerge3
1463
if merge_type is None:
1464
merge_type = ApplyMerge3
1465
merge(parse_spec(other_spec), parse_spec(base_spec),
1466
check_clean=(not force), merge_type=merge_type)
1469
class cmd_revert(Command):
1470
"""Reverse all changes since the last commit.
1472
Only versioned files are affected. Specify filenames to revert only
1473
those files. By default, any files that are changed will be backed up
1474
first. Backup files have a '~' appended to their name.
1476
takes_options = ['revision', 'no-backup']
1477
takes_args = ['file*']
1478
aliases = ['merge-revert']
1480
def run(self, revision=None, no_backup=False, file_list=None):
1481
from bzrlib.merge import merge
1482
if file_list is not None:
1483
if len(file_list) == 0:
1484
raise BzrCommandError("No files specified")
1485
if revision is None:
1487
elif len(revision) != 1:
1488
raise BzrCommandError('bzr revert --revision takes exactly 1 argument')
1489
merge(('.', revision[0]), parse_spec('.'),
1492
backup_files=not no_backup,
1493
file_list=file_list)
1496
class cmd_assert_fail(Command):
1497
"""Test reporting of assertion failures"""
1500
assert False, "always fails"
1503
class cmd_help(Command):
1504
"""Show help on a command or other topic.
1506
For a list of all available commands, say 'bzr help commands'."""
1507
takes_args = ['topic?']
1510
def run(self, topic=None):
1517
class cmd_plugins(Command):
1521
import bzrlib.plugin
1522
from inspect import getdoc
1523
from pprint import pprint
1524
for plugin in bzrlib.plugin.all_plugins:
1525
print plugin.__path__[0]
1528
print '\t', d.split('\n')[0]
1530
#pprint(bzrlib.plugin.all_plugins)
740
print "it sure does!"
744
######################################################################
1534
748
# list of all available options; the rhs can be either None for an