1
# Copyright (C) 2004, 2005 by Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# 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.
23
# TODO: Help messages for options.
25
# TODO: Define arguments by objects, rather than just using names.
26
# Those objects can specify the expected type of the argument, which
27
# would help with validation and shell completion.
30
# TODO: Help messages for options.
32
# TODO: Define arguments by objects, rather than just using names.
33
# Those objects can specify the expected type of the argument, which
34
# would help with validation and shell completion.
42
from bzrlib.trace import mutter, note, log_error, warning
43
from bzrlib.errors import BzrError, BzrCheckError, BzrCommandError
44
from bzrlib.branch import find_branch
45
from bzrlib import BZRDIR
51
def register_command(cmd):
52
"Utility function to help register a command"
55
if k.startswith("cmd_"):
56
k_unsquished = _unsquish_command_name(k)
59
if not plugin_cmds.has_key(k_unsquished):
60
plugin_cmds[k_unsquished] = cmd
61
mutter('registered plugin command %s', k_unsquished)
63
log_error('Two plugins defined the same command: %r' % k)
64
log_error('Not loading the one in %r' % sys.modules[cmd.__module__])
67
def _squish_command_name(cmd):
68
return 'cmd_' + cmd.replace('-', '_')
71
def _unsquish_command_name(cmd):
72
assert cmd.startswith("cmd_")
73
return cmd[4:].replace('_','-')
76
def _parse_revision_str(revstr):
77
"""This handles a revision string -> revno.
79
This always returns a list. The list will have one element for
81
It supports integers directly, but everything else it
82
defers for passing to Branch.get_revision_info()
84
>>> _parse_revision_str('234')
86
>>> _parse_revision_str('234..567')
88
>>> _parse_revision_str('..')
90
>>> _parse_revision_str('..234')
92
>>> _parse_revision_str('234..')
94
>>> _parse_revision_str('234..456..789') # Maybe this should be an error
96
>>> _parse_revision_str('234....789') # Error?
98
>>> _parse_revision_str('revid:test@other.com-234234')
99
['revid:test@other.com-234234']
100
>>> _parse_revision_str('revid:test@other.com-234234..revid:test@other.com-234235')
101
['revid:test@other.com-234234', 'revid:test@other.com-234235']
102
>>> _parse_revision_str('revid:test@other.com-234234..23')
103
['revid:test@other.com-234234', 23]
104
>>> _parse_revision_str('date:2005-04-12')
106
>>> _parse_revision_str('date:2005-04-12 12:24:33')
107
['date:2005-04-12 12:24:33']
108
>>> _parse_revision_str('date:2005-04-12T12:24:33')
109
['date:2005-04-12T12:24:33']
110
>>> _parse_revision_str('date:2005-04-12,12:24:33')
111
['date:2005-04-12,12:24:33']
112
>>> _parse_revision_str('-5..23')
114
>>> _parse_revision_str('-5')
116
>>> _parse_revision_str('123a')
118
>>> _parse_revision_str('abc')
122
old_format_re = re.compile('\d*:\d*')
123
m = old_format_re.match(revstr)
125
warning('Colon separator for revision numbers is deprecated.'
128
for rev in revstr.split(':'):
130
revs.append(int(rev))
135
for x in revstr.split('..'):
146
def get_merge_type(typestring):
147
"""Attempt to find the merge class/factory associated with a string."""
148
from merge import merge_types
150
return merge_types[typestring][0]
152
templ = '%s%%7s: %%s' % (' '*12)
153
lines = [templ % (f[0], f[1][1]) for f in merge_types.iteritems()]
154
type_list = '\n'.join(lines)
155
msg = "No known merge type %s. Supported types are:\n%s" %\
156
(typestring, type_list)
157
raise BzrCommandError(msg)
160
def get_merge_type(typestring):
161
"""Attempt to find the merge class/factory associated with a string."""
162
from merge import merge_types
164
return merge_types[typestring][0]
166
templ = '%s%%7s: %%s' % (' '*12)
167
lines = [templ % (f[0], f[1][1]) for f in merge_types.iteritems()]
168
type_list = '\n'.join(lines)
169
msg = "No known merge type %s. Supported types are:\n%s" %\
170
(typestring, type_list)
171
raise BzrCommandError(msg)
175
def _get_cmd_dict(plugins_override=True):
177
for k, v in globals().iteritems():
178
if k.startswith("cmd_"):
179
d[_unsquish_command_name(k)] = v
180
# If we didn't load plugins, the plugin_cmds dict will be empty
182
d.update(plugin_cmds)
184
d2 = plugin_cmds.copy()
190
def get_all_cmds(plugins_override=True):
191
"""Return canonical name and class for all registered commands."""
192
for k, v in _get_cmd_dict(plugins_override=plugins_override).iteritems():
196
def get_cmd_class(cmd, plugins_override=True):
197
"""Return the canonical name and command class for a command.
199
cmd = str(cmd) # not unicode
201
# first look up this command under the specified name
202
cmds = _get_cmd_dict(plugins_override=plugins_override)
203
mutter("all commands: %r", cmds.keys())
205
return cmd, cmds[cmd]
209
# look for any command which claims this as an alias
210
for cmdname, cmdclass in cmds.iteritems():
211
if cmd in cmdclass.aliases:
212
return cmdname, cmdclass
214
cmdclass = ExternalCommand.find_command(cmd)
218
raise BzrCommandError("unknown command %r" % cmd)
221
class Command(object):
222
"""Base class for commands.
224
The docstring for an actual command should give a single-line
225
summary, then a complete description of the command. A grammar
226
description will be inserted.
229
List of argument forms, marked with whether they are optional,
233
List of options that may be given for this command.
236
If true, this command isn't advertised.
245
def __init__(self, options, arguments):
246
"""Construct and run the command.
248
Sets self.status to the return value of run()."""
249
assert isinstance(options, dict)
250
assert isinstance(arguments, dict)
251
cmdargs = options.copy()
252
cmdargs.update(arguments)
253
if self.__doc__ == Command.__doc__:
254
from warnings import warn
255
warn("No help message set for %r" % self)
256
self.status = self.run(**cmdargs)
257
if self.status is None:
262
"""Override this in sub-classes.
264
This is invoked with the options and arguments bound to
267
Return 0 or None if the command was successful, or a shell
273
class ExternalCommand(Command):
274
"""Class to wrap external commands.
276
We cheat a little here, when get_cmd_class() calls us we actually
277
give it back an object we construct that has the appropriate path,
278
help, options etc for the specified command.
280
When run_bzr() tries to instantiate that 'class' it gets caught by
281
the __call__ method, which we override to call the Command.__init__
282
method. That then calls our run method which is pretty straight
285
The only wrinkle is that we have to map bzr's dictionary of options
286
and arguments back into command line options and arguments for the
290
def find_command(cls, cmd):
292
bzrpath = os.environ.get('BZRPATH', '')
294
for dir in bzrpath.split(os.pathsep):
295
path = os.path.join(dir, cmd)
296
if os.path.isfile(path):
297
return ExternalCommand(path)
301
find_command = classmethod(find_command)
303
def __init__(self, path):
306
pipe = os.popen('%s --bzr-usage' % path, 'r')
307
self.takes_options = pipe.readline().split()
309
for opt in self.takes_options:
310
if not opt in OPTIONS:
311
raise BzrError("Unknown option '%s' returned by external command %s"
314
# TODO: Is there any way to check takes_args is valid here?
315
self.takes_args = pipe.readline().split()
317
if pipe.close() is not None:
318
raise BzrError("Failed funning '%s --bzr-usage'" % path)
320
pipe = os.popen('%s --bzr-help' % path, 'r')
321
self.__doc__ = pipe.read()
322
if pipe.close() is not None:
323
raise BzrError("Failed funning '%s --bzr-help'" % path)
325
def __call__(self, options, arguments):
326
Command.__init__(self, options, arguments)
329
def run(self, **kargs):
336
optname = name.replace('_','-')
338
if OPTIONS.has_key(optname):
340
opts.append('--%s' % optname)
341
if value is not None and value is not True:
342
opts.append(str(value))
344
# it's an arg, or arg list
345
if type(value) is not list:
351
self.status = os.spawnv(os.P_WAIT, self.path, [self.path] + opts + args)
355
class cmd_status(Command):
356
"""Display status summary.
358
This reports on versioned and unknown files, reporting them
359
grouped by state. Possible states are:
362
Versioned in the working copy but not in the previous revision.
365
Versioned in the previous revision but removed or deleted
369
Path of this file changed from the previous revision;
370
the text may also have changed. This includes files whose
371
parent directory was renamed.
374
Text has changed since the previous revision.
377
Nothing about this file has changed since the previous revision.
378
Only shown with --all.
381
Not versioned and not matching an ignore pattern.
383
To see ignored files use 'bzr ignored'. For details in the
384
changes to file texts, use 'bzr diff'.
386
If no arguments are specified, the status of the entire working
387
directory is shown. Otherwise, only the status of the specified
388
files or directories is reported. If a directory is given, status
389
is reported for everything inside that directory.
391
If a revision is specified, the changes since that revision are shown.
393
takes_args = ['file*']
394
takes_options = ['all', 'show-ids', 'revision']
395
aliases = ['st', 'stat']
397
def run(self, all=False, show_ids=False, file_list=None):
399
b = find_branch(file_list[0])
400
file_list = [b.relpath(x) for x in file_list]
401
# special case: only one path was given and it's the root
403
if file_list == ['']:
408
from bzrlib.status import show_status
409
show_status(b, show_unchanged=all, show_ids=show_ids,
410
specific_files=file_list)
413
class cmd_cat_revision(Command):
414
"""Write out metadata for a revision."""
417
takes_args = ['revision_id']
419
def run(self, revision_id):
420
from bzrlib.xml import pack_xml
421
pack_xml(find_branch('.').get_revision(revision_id), sys.stdout)
424
class cmd_revno(Command):
425
"""Show current revision number.
427
This is equal to the number of revisions on this branch."""
429
print find_branch('.').revno()
431
class cmd_revision_info(Command):
432
"""Show revision number and revision id for a given revision identifier.
435
takes_args = ['revision_info*']
436
takes_options = ['revision']
437
def run(self, revision=None, revision_info_list=None):
438
from bzrlib.branch import find_branch
441
if revision is not None:
442
revs.extend(revision)
443
if revision_info_list is not None:
444
revs.extend(revision_info_list)
446
raise BzrCommandError('You must supply a revision identifier')
451
print '%4d %s' % b.get_revision_info(rev)
454
class cmd_add(Command):
455
"""Add specified files or directories.
457
In non-recursive mode, all the named items are added, regardless
458
of whether they were previously ignored. A warning is given if
459
any of the named files are already versioned.
461
In recursive mode (the default), files are treated the same way
462
but the behaviour for directories is different. Directories that
463
are already versioned do not give a warning. All directories,
464
whether already versioned or not, are searched for files or
465
subdirectories that are neither versioned or ignored, and these
466
are added. This search proceeds recursively into versioned
467
directories. If no names are given '.' is assumed.
469
Therefore simply saying 'bzr add' will version all files that
470
are currently unknown.
472
TODO: Perhaps adding a file whose directly is not versioned should
473
recursively add that parent, rather than giving an error?
475
takes_args = ['file*']
476
takes_options = ['verbose', 'no-recurse']
478
def run(self, file_list, verbose=False, no_recurse=False):
479
from bzrlib.add import smart_add, _PrintAddCallback
480
recurse = not no_recurse
481
smart_add(file_list, verbose, not no_recurse,
482
callback=_PrintAddCallback)
486
class cmd_mkdir(Command):
487
"""Create a new versioned directory.
489
This is equivalent to creating the directory and then adding it.
491
takes_args = ['dir+']
493
def run(self, dir_list):
504
class cmd_relpath(Command):
505
"""Show path of a file relative to root"""
506
takes_args = ['filename']
509
def run(self, filename):
510
print find_branch(filename).relpath(filename)
514
class cmd_inventory(Command):
515
"""Show inventory of the current working copy or a revision."""
516
takes_options = ['revision', 'show-ids']
518
def run(self, revision=None, show_ids=False):
521
inv = b.read_working_inventory()
523
if len(revision) > 1:
524
raise BzrCommandError('bzr inventory --revision takes'
525
' exactly one revision identifier')
526
inv = b.get_revision_inventory(b.lookup_revision(revision[0]))
528
for path, entry in inv.entries():
530
print '%-50s %s' % (path, entry.file_id)
535
class cmd_move(Command):
536
"""Move files to a different directory.
541
The destination must be a versioned directory in the same branch.
543
takes_args = ['source$', 'dest']
544
def run(self, source_list, dest):
547
# TODO: glob expansion on windows?
548
b.move([b.relpath(s) for s in source_list], b.relpath(dest))
551
class cmd_rename(Command):
552
"""Change the name of an entry.
555
bzr rename frob.c frobber.c
556
bzr rename src/frob.c lib/frob.c
558
It is an error if the destination name exists.
560
See also the 'move' command, which moves files into a different
561
directory without changing their name.
563
TODO: Some way to rename multiple files without invoking bzr for each
565
takes_args = ['from_name', 'to_name']
567
def run(self, from_name, to_name):
569
b.rename_one(b.relpath(from_name), b.relpath(to_name))
573
class cmd_mv(Command):
574
"""Move or rename a file.
577
bzr mv OLDNAME NEWNAME
578
bzr mv SOURCE... DESTINATION
580
If the last argument is a versioned directory, all the other names
581
are moved into it. Otherwise, there must be exactly two arguments
582
and the file is changed to a new name, which must not already exist.
584
Files cannot be moved between branches.
586
takes_args = ['names*']
587
def run(self, names_list):
588
if len(names_list) < 2:
589
raise BzrCommandError("missing file argument")
590
b = find_branch(names_list[0])
592
rel_names = [b.relpath(x) for x in names_list]
594
if os.path.isdir(names_list[-1]):
595
# move into existing directory
596
for pair in b.move(rel_names[:-1], rel_names[-1]):
597
print "%s => %s" % pair
599
if len(names_list) != 2:
600
raise BzrCommandError('to mv multiple files the destination '
601
'must be a versioned directory')
602
for pair in b.move(rel_names[0], rel_names[1]):
603
print "%s => %s" % pair
608
class cmd_pull(Command):
609
"""Pull any changes from another branch into the current one.
611
If the location is omitted, the last-used location will be used.
612
Both the revision history and the working directory will be
615
This command only works on branches that have not diverged. Branches are
616
considered diverged if both branches have had commits without first
617
pulling from the other.
619
If branches have diverged, you can use 'bzr merge' to pull the text changes
620
from one into the other.
622
takes_args = ['location?']
624
def run(self, location=None):
625
from bzrlib.merge import merge
627
from shutil import rmtree
629
from bzrlib.branch import pull_loc
631
br_to = find_branch('.')
634
stored_loc = br_to.controlfile("x-pull", "rb").read().rstrip('\n')
636
if e.errno != errno.ENOENT:
639
if stored_loc is None:
640
raise BzrCommandError("No pull location known or specified.")
642
print "Using last location: %s" % stored_loc
643
location = stored_loc
644
cache_root = tempfile.mkdtemp()
645
from bzrlib.branch import DivergedBranches
646
br_from = find_branch(location)
647
location = pull_loc(br_from)
648
old_revno = br_to.revno()
650
from branch import find_cached_branch, DivergedBranches
651
br_from = find_cached_branch(location, cache_root)
652
location = pull_loc(br_from)
653
old_revno = br_to.revno()
655
br_to.update_revisions(br_from)
656
except DivergedBranches:
657
raise BzrCommandError("These branches have diverged."
660
merge(('.', -1), ('.', old_revno), check_clean=False)
661
if location != stored_loc:
662
br_to.controlfile("x-pull", "wb").write(location + "\n")
668
class cmd_branch(Command):
669
"""Create a new copy of a branch.
671
If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
672
be used. In other words, "branch ../foo/bar" will attempt to create ./bar.
674
To retrieve the branch as of a particular revision, supply the --revision
675
parameter, as in "branch foo/bar -r 5".
677
takes_args = ['from_location', 'to_location?']
678
takes_options = ['revision']
679
aliases = ['get', 'clone']
681
def run(self, from_location, to_location=None, revision=None):
682
from bzrlib.branch import copy_branch, find_cached_branch
685
from shutil import rmtree
686
cache_root = tempfile.mkdtemp()
690
elif len(revision) > 1:
691
raise BzrCommandError(
692
'bzr branch --revision takes exactly 1 revision value')
694
br_from = find_cached_branch(from_location, cache_root)
696
if e.errno == errno.ENOENT:
697
raise BzrCommandError('Source location "%s" does not'
698
' exist.' % to_location)
701
if to_location is None:
702
to_location = os.path.basename(from_location.rstrip("/\\"))
704
os.mkdir(to_location)
706
if e.errno == errno.EEXIST:
707
raise BzrCommandError('Target directory "%s" already'
708
' exists.' % to_location)
709
if e.errno == errno.ENOENT:
710
raise BzrCommandError('Parent of "%s" does not exist.' %
715
copy_branch(br_from, to_location, revision[0])
716
except bzrlib.errors.NoSuchRevision:
718
msg = "The branch %s has no revision %d." % (from_location, revision[0])
719
raise BzrCommandError(msg)
724
class cmd_renames(Command):
725
"""Show list of renamed files.
727
TODO: Option to show renames between two historical versions.
729
TODO: Only show renames under dir, rather than in the whole branch.
731
takes_args = ['dir?']
733
def run(self, dir='.'):
735
old_inv = b.basis_tree().inventory
736
new_inv = b.read_working_inventory()
738
renames = list(bzrlib.tree.find_renames(old_inv, new_inv))
740
for old_name, new_name in renames:
741
print "%s => %s" % (old_name, new_name)
744
class cmd_info(Command):
745
"""Show statistical information about a branch."""
746
takes_args = ['branch?']
748
def run(self, branch=None):
751
b = find_branch(branch)
755
class cmd_remove(Command):
756
"""Make a file unversioned.
758
This makes bzr stop tracking changes to a versioned file. It does
759
not delete the working copy.
761
takes_args = ['file+']
762
takes_options = ['verbose']
764
def run(self, file_list, verbose=False):
765
b = find_branch(file_list[0])
766
b.remove([b.relpath(f) for f in file_list], verbose=verbose)
769
class cmd_file_id(Command):
770
"""Print file_id of a particular file or directory.
772
The file_id is assigned when the file is first added and remains the
773
same through all revisions where the file exists, even when it is
777
takes_args = ['filename']
778
def run(self, filename):
779
b = find_branch(filename)
780
i = b.inventory.path2id(b.relpath(filename))
782
raise BzrError("%r is not a versioned file" % filename)
787
class cmd_file_path(Command):
788
"""Print path of file_ids to a file or directory.
790
This prints one line for each directory down to the target,
791
starting at the branch root."""
793
takes_args = ['filename']
794
def run(self, filename):
795
b = find_branch(filename)
797
fid = inv.path2id(b.relpath(filename))
799
raise BzrError("%r is not a versioned file" % filename)
800
for fip in inv.get_idpath(fid):
804
class cmd_revision_history(Command):
805
"""Display list of revision ids on this branch."""
808
for patchid in find_branch('.').revision_history():
812
class cmd_directories(Command):
813
"""Display list of versioned directories in this branch."""
815
for name, ie in find_branch('.').read_working_inventory().directories():
822
class cmd_init(Command):
823
"""Make a directory into a versioned branch.
825
Use this to create an empty branch, or before importing an
828
Recipe for importing a tree of files:
833
bzr commit -m 'imported project'
836
from bzrlib.branch import Branch
837
Branch('.', init=True)
840
class cmd_diff(Command):
841
"""Show differences in working tree.
843
If files are listed, only the changes in those files are listed.
844
Otherwise, all changes for the tree are listed.
846
TODO: Allow diff across branches.
848
TODO: Option to use external diff command; could be GNU diff, wdiff,
851
TODO: Python difflib is not exactly the same as unidiff; should
852
either fix it up or prefer to use an external diff.
854
TODO: If a directory is given, diff everything under that.
856
TODO: Selected-file diff is inefficient and doesn't show you
859
TODO: This probably handles non-Unix newlines poorly.
867
takes_args = ['file*']
868
takes_options = ['revision', 'diff-options']
869
aliases = ['di', 'dif']
871
def run(self, revision=None, file_list=None, diff_options=None):
872
from bzrlib.diff import show_diff
875
b = find_branch(file_list[0])
876
file_list = [b.relpath(f) for f in file_list]
877
if file_list == ['']:
878
# just pointing to top-of-tree
883
if revision is not None:
884
if len(revision) == 1:
885
show_diff(b, revision[0], specific_files=file_list,
886
external_diff_options=diff_options)
887
elif len(revision) == 2:
888
show_diff(b, revision[0], specific_files=file_list,
889
external_diff_options=diff_options,
890
revision2=revision[1])
892
raise BzrCommandError('bzr diff --revision takes exactly one or two revision identifiers')
894
show_diff(b, None, specific_files=file_list,
895
external_diff_options=diff_options)
900
class cmd_deleted(Command):
901
"""List files deleted in the working tree.
903
TODO: Show files deleted since a previous revision, or between two revisions.
905
def run(self, show_ids=False):
908
new = b.working_tree()
910
## TODO: Much more efficient way to do this: read in new
911
## directories with readdir, rather than stating each one. Same
912
## level of effort but possibly much less IO. (Or possibly not,
913
## if the directories are very large...)
915
for path, ie in old.inventory.iter_entries():
916
if not new.has_id(ie.file_id):
918
print '%-50s %s' % (path, ie.file_id)
923
class cmd_modified(Command):
924
"""List files modified in working tree."""
927
from bzrlib.delta import compare_trees
930
td = compare_trees(b.basis_tree(), b.working_tree())
932
for path, id, kind in td.modified:
937
class cmd_added(Command):
938
"""List files added in working tree."""
942
wt = b.working_tree()
943
basis_inv = b.basis_tree().inventory
946
if file_id in basis_inv:
948
path = inv.id2path(file_id)
949
if not os.access(b.abspath(path), os.F_OK):
955
class cmd_root(Command):
956
"""Show the tree root directory.
958
The root is the nearest enclosing directory with a .bzr control
960
takes_args = ['filename?']
961
def run(self, filename=None):
962
"""Print the branch root."""
963
b = find_branch(filename)
964
print getattr(b, 'base', None) or getattr(b, 'baseurl')
967
class cmd_log(Command):
968
"""Show log of this branch.
970
To request a range of logs, you can use the command -r begin:end
971
-r revision requests a specific revision, -r :end or -r begin: are
974
--message allows you to give a regular expression, which will be evaluated
975
so that only matching entries will be displayed.
977
TODO: Make --revision support uuid: and hash: [future tag:] notation.
981
takes_args = ['filename?']
982
takes_options = ['forward', 'timezone', 'verbose', 'show-ids', 'revision',
983
'long', 'message', 'short',]
985
def run(self, filename=None, timezone='original',
993
from bzrlib.branch import find_branch
994
from bzrlib.log import log_formatter, show_log
997
direction = (forward and 'forward') or 'reverse'
1000
b = find_branch(filename)
1001
fp = b.relpath(filename)
1003
file_id = b.read_working_inventory().path2id(fp)
1005
file_id = None # points to branch root
1007
b = find_branch('.')
1010
if revision is None:
1013
elif len(revision) == 1:
1014
rev1 = rev2 = b.get_revision_info(revision[0])[0]
1015
elif len(revision) == 2:
1016
rev1 = b.get_revision_info(revision[0])[0]
1017
rev2 = b.get_revision_info(revision[1])[0]
1019
raise BzrCommandError('bzr log --revision takes one or two values.')
1026
mutter('encoding log as %r' % bzrlib.user_encoding)
1028
# use 'replace' so that we don't abort if trying to write out
1029
# in e.g. the default C locale.
1030
outf = codecs.getwriter(bzrlib.user_encoding)(sys.stdout, errors='replace')
1035
log_format = 'short'
1036
lf = log_formatter(log_format,
1039
show_timezone=timezone)
1045
direction=direction,
1046
start_revision=rev1,
1052
class cmd_touching_revisions(Command):
1053
"""Return revision-ids which affected a particular file.
1055
A more user-friendly interface is "bzr log FILE"."""
1057
takes_args = ["filename"]
1058
def run(self, filename):
1059
b = find_branch(filename)
1060
inv = b.read_working_inventory()
1061
file_id = inv.path2id(b.relpath(filename))
1062
for revno, revision_id, what in bzrlib.log.find_touching_revisions(b, file_id):
1063
print "%6d %s" % (revno, what)
1066
class cmd_ls(Command):
1067
"""List files in a tree.
1069
TODO: Take a revision or remote path and list that tree instead.
1072
def run(self, revision=None, verbose=False):
1073
b = find_branch('.')
1074
if revision == None:
1075
tree = b.working_tree()
1077
tree = b.revision_tree(b.lookup_revision(revision))
1079
for fp, fc, kind, fid in tree.list_files():
1081
if kind == 'directory':
1083
elif kind == 'file':
1088
print '%-8s %s%s' % (fc, fp, kindch)
1094
class cmd_unknowns(Command):
1095
"""List unknown files."""
1097
from bzrlib.osutils import quotefn
1098
for f in find_branch('.').unknowns():
1103
class cmd_ignore(Command):
1104
"""Ignore a command or pattern.
1106
To remove patterns from the ignore list, edit the .bzrignore file.
1108
If the pattern contains a slash, it is compared to the whole path
1109
from the branch root. Otherwise, it is comapred to only the last
1110
component of the path.
1112
Ignore patterns are case-insensitive on case-insensitive systems.
1114
Note: wildcards must be quoted from the shell on Unix.
1117
bzr ignore ./Makefile
1118
bzr ignore '*.class'
1120
takes_args = ['name_pattern']
1122
def run(self, name_pattern):
1123
from bzrlib.atomicfile import AtomicFile
1126
b = find_branch('.')
1127
ifn = b.abspath('.bzrignore')
1129
if os.path.exists(ifn):
1132
igns = f.read().decode('utf-8')
1138
# TODO: If the file already uses crlf-style termination, maybe
1139
# we should use that for the newly added lines?
1141
if igns and igns[-1] != '\n':
1143
igns += name_pattern + '\n'
1146
f = AtomicFile(ifn, 'wt')
1147
f.write(igns.encode('utf-8'))
1152
inv = b.working_tree().inventory
1153
if inv.path2id('.bzrignore'):
1154
mutter('.bzrignore is already versioned')
1156
mutter('need to make new .bzrignore file versioned')
1157
b.add(['.bzrignore'])
1161
class cmd_ignored(Command):
1162
"""List ignored files and the patterns that matched them.
1164
See also: bzr ignore"""
1166
tree = find_branch('.').working_tree()
1167
for path, file_class, kind, file_id in tree.list_files():
1168
if file_class != 'I':
1170
## XXX: Slightly inefficient since this was already calculated
1171
pat = tree.is_ignored(path)
1172
print '%-50s %s' % (path, pat)
1175
class cmd_lookup_revision(Command):
1176
"""Lookup the revision-id from a revision-number
1179
bzr lookup-revision 33
1182
takes_args = ['revno']
1184
def run(self, revno):
1188
raise BzrCommandError("not a valid revision-number: %r" % revno)
1190
print find_branch('.').lookup_revision(revno)
1193
class cmd_export(Command):
1194
"""Export past revision to destination directory.
1196
If no revision is specified this exports the last committed revision.
1198
Format may be an "exporter" name, such as tar, tgz, tbz2. If none is
1199
given, try to find the format with the extension. If no extension
1200
is found exports to a directory (equivalent to --format=dir).
1202
Root may be the top directory for tar, tgz and tbz2 formats. If none
1203
is given, the top directory will be the root name of the file."""
1204
# TODO: list known exporters
1205
takes_args = ['dest']
1206
takes_options = ['revision', 'format', 'root']
1207
def run(self, dest, revision=None, format=None, root=None):
1209
b = find_branch('.')
1210
if revision is None:
1211
rev_id = b.last_patch()
1213
if len(revision) != 1:
1214
raise BzrError('bzr export --revision takes exactly 1 argument')
1215
revno, rev_id = b.get_revision_info(revision[0])
1216
t = b.revision_tree(rev_id)
1217
root, ext = os.path.splitext(dest)
1219
if ext in (".tar",):
1221
elif ext in (".gz", ".tgz"):
1223
elif ext in (".bz2", ".tbz2"):
1227
t.export(dest, format, root)
1230
class cmd_cat(Command):
1231
"""Write a file's text from a previous revision."""
1233
takes_options = ['revision']
1234
takes_args = ['filename']
1236
def run(self, filename, revision=None):
1237
if revision == None:
1238
raise BzrCommandError("bzr cat requires a revision number")
1239
elif len(revision) != 1:
1240
raise BzrCommandError("bzr cat --revision takes exactly one number")
1241
b = find_branch('.')
1242
b.print_file(b.relpath(filename), revision[0])
1245
class cmd_local_time_offset(Command):
1246
"""Show the offset in seconds from GMT to local time."""
1249
print bzrlib.osutils.local_time_offset()
1253
class cmd_commit(Command):
1254
"""Commit changes into a new revision.
1256
If no arguments are given, the entire tree is committed.
1258
If selected files are specified, only changes to those files are
1259
committed. If a directory is specified then the directory and everything
1260
within it is committed.
1262
A selected-file commit may fail in some cases where the committed
1263
tree would be invalid, such as trying to commit a file in a
1264
newly-added directory that is not itself committed.
1266
TODO: Run hooks on tree to-be-committed, and after commit.
1268
TODO: Strict commit that fails if there are unknown or deleted files.
1270
takes_args = ['selected*']
1271
takes_options = ['message', 'file', 'verbose', 'unchanged']
1272
aliases = ['ci', 'checkin']
1274
# TODO: Give better message for -s, --summary, used by tla people
1276
def run(self, message=None, file=None, verbose=True, selected_list=None,
1278
from bzrlib.errors import PointlessCommit
1279
from bzrlib.osutils import get_text_message
1281
## Warning: shadows builtin file()
1282
if not message and not file:
1283
# FIXME: Ugly; change status code to send to a provided function?
1287
catcher = cStringIO.StringIO()
1288
sys.stdout = catcher
1289
cmd_status({"file_list":selected_list}, {})
1290
info = catcher.getvalue()
1292
message = get_text_message(info)
1295
raise BzrCommandError("please specify a commit message",
1296
["use either --message or --file"])
1297
elif message and file:
1298
raise BzrCommandError("please specify either --message or --file")
1302
message = codecs.open(file, 'rt', bzrlib.user_encoding).read()
1304
b = find_branch('.')
1306
selected_list = [b.relpath(s) for s in selected_list]
1309
b.commit(message, verbose=verbose,
1310
specific_files=selected_list,
1311
allow_pointless=unchanged)
1312
except PointlessCommit:
1313
# FIXME: This should really happen before the file is read in;
1314
# perhaps prepare the commit; get the message; then actually commit
1315
raise BzrCommandError("no changes to commit",
1316
["use --unchanged to commit anyhow"])
1319
class cmd_check(Command):
1320
"""Validate consistency of branch history.
1322
This command checks various invariants about the branch storage to
1323
detect data corruption or bzr bugs.
1325
If given the --update flag, it will update some optional fields
1326
to help ensure data consistency.
1328
takes_args = ['dir?']
1330
def run(self, dir='.'):
1331
from bzrlib.check import check
1333
check(find_branch(dir))
1336
class cmd_scan_cache(Command):
1339
from bzrlib.hashcache import HashCache
1346
print '%6d stats' % c.stat_count
1347
print '%6d in hashcache' % len(c._cache)
1348
print '%6d files removed from cache' % c.removed_count
1349
print '%6d hashes updated' % c.update_count
1350
print '%6d files changed too recently to cache' % c.danger_count
1357
class cmd_upgrade(Command):
1358
"""Upgrade branch storage to current format.
1360
The check command or bzr developers may sometimes advise you to run
1363
takes_args = ['dir?']
1365
def run(self, dir='.'):
1366
from bzrlib.upgrade import upgrade
1367
upgrade(find_branch(dir))
1371
class cmd_whoami(Command):
1372
"""Show bzr user id."""
1373
takes_options = ['email']
1375
def run(self, email=False):
1377
b = bzrlib.branch.find_branch('.')
1382
print bzrlib.osutils.user_email(b)
1384
print bzrlib.osutils.username(b)
1387
class cmd_selftest(Command):
1388
"""Run internal test suite"""
1390
takes_options = ['verbose', 'pattern']
1391
def run(self, verbose=False, pattern=".*"):
1393
from bzrlib.selftest import selftest
1394
# we don't want progress meters from the tests to go to the
1395
# real output; and we don't want log messages cluttering up
1397
save_ui = bzrlib.ui.ui_factory
1398
bzrlib.trace.info('running tests...')
1400
bzrlib.ui.ui_factory = bzrlib.ui.SilentUIFactory()
1401
result = selftest(verbose=verbose, pattern=pattern)
1403
bzrlib.trace.info('tests passed')
1405
bzrlib.trace.info('tests failed')
1406
return int(not result)
1408
bzrlib.ui.ui_factory = save_ui
1411
class cmd_version(Command):
1412
"""Show version of bzr."""
1417
print "bzr (bazaar-ng) %s" % bzrlib.__version__
1418
# is bzrlib itself in a branch?
1419
bzrrev = bzrlib.get_bzr_revision()
1421
print " (bzr checkout, revision %d {%s})" % bzrrev
1422
print bzrlib.__copyright__
1423
print "http://bazaar-ng.org/"
1425
print "bzr comes with ABSOLUTELY NO WARRANTY. bzr is free software, and"
1426
print "you may use, modify and redistribute it under the terms of the GNU"
1427
print "General Public License version 2 or later."
1430
class cmd_rocks(Command):
1431
"""Statement of optimism."""
1434
print "it sure does!"
1436
def parse_spec(spec):
1438
>>> parse_spec(None)
1440
>>> parse_spec("./")
1442
>>> parse_spec("../@")
1444
>>> parse_spec("../f/@35")
1446
>>> parse_spec('./@revid:john@arbash-meinel.com-20050711044610-3ca0327c6a222f67')
1447
['.', 'revid:john@arbash-meinel.com-20050711044610-3ca0327c6a222f67']
1452
parsed = spec.split('/@')
1453
assert len(parsed) == 2
1458
parsed[1] = int(parsed[1])
1460
pass # We can allow stuff like ./@revid:blahblahblah
1462
assert parsed[1] >=0
1464
parsed = [spec, None]
1469
class cmd_find_merge_base(Command):
1470
"""Find and print a base revision for merging two branches.
1472
TODO: Options to specify revisions on either side, as if
1473
merging only part of the history.
1475
takes_args = ['branch', 'other']
1478
def run(self, branch, other):
1479
branch1 = find_branch(branch)
1480
branch2 = find_branch(other)
1482
base_revno, base_revid = branch1.common_ancestor(branch2)
1484
if base_revno is None:
1485
raise bzrlib.errors.UnrelatedBranches()
1487
print 'merge base is revision %s' % base_revid
1488
print ' r%-6d in %s' % (base_revno, branch)
1490
other_revno = branch2.revision_id_to_revno(base_revid)
1492
print ' r%-6d in %s' % (other_revno, other)
1496
class cmd_merge(Command):
1497
"""Perform a three-way merge.
1499
The branch is the branch you will merge from. By default, it will merge
1500
the latest revision. If you specify a revision, that revision will be
1501
merged. If you specify two revisions, the first will be used as a BASE,
1502
and the second one as OTHER. Revision numbers are always relative to the
1507
To merge the latest revision from bzr.dev
1508
bzr merge ../bzr.dev
1510
To merge changes up to and including revision 82 from bzr.dev
1511
bzr merge -r 82 ../bzr.dev
1513
To merge the changes introduced by 82, without previous changes:
1514
bzr merge -r 81..82 ../bzr.dev
1516
merge refuses to run if there are any uncommitted changes, unless
1519
takes_args = ['branch?']
1520
takes_options = ['revision', 'force', 'merge-type']
1522
def run(self, branch='.', revision=None, force=False,
1524
from bzrlib.merge import merge
1525
from bzrlib.merge_core import ApplyMerge3
1526
if merge_type is None:
1527
merge_type = ApplyMerge3
1529
if revision is None or len(revision) < 1:
1531
other = (branch, -1)
1533
if len(revision) == 1:
1534
other = (branch, revision[0])
1537
assert len(revision) == 2
1538
if None in revision:
1539
raise BzrCommandError(
1540
"Merge doesn't permit that revision specifier.")
1541
base = (branch, revision[0])
1542
other = (branch, revision[1])
1544
merge(other, base, check_clean=(not force), merge_type=merge_type)
1547
class cmd_revert(Command):
1548
"""Reverse all changes since the last commit.
1550
Only versioned files are affected. Specify filenames to revert only
1551
those files. By default, any files that are changed will be backed up
1552
first. Backup files have a '~' appended to their name.
1554
takes_options = ['revision', 'no-backup']
1555
takes_args = ['file*']
1556
aliases = ['merge-revert']
1558
def run(self, revision=None, no_backup=False, file_list=None):
1559
from bzrlib.merge import merge
1560
from bzrlib.branch import Branch
1561
if file_list is not None:
1562
if len(file_list) == 0:
1563
raise BzrCommandError("No files specified")
1564
if revision is None:
1566
elif len(revision) != 1:
1567
raise BzrCommandError('bzr revert --revision takes exactly 1 argument')
1568
merge(('.', revision[0]), parse_spec('.'),
1571
backup_files=not no_backup,
1572
file_list=file_list)
1574
Branch('.').set_pending_merges([])
1577
class cmd_assert_fail(Command):
1578
"""Test reporting of assertion failures"""
1581
assert False, "always fails"
1584
class cmd_help(Command):
1585
"""Show help on a command or other topic.
1587
For a list of all available commands, say 'bzr help commands'."""
1588
takes_options = ['long']
1589
takes_args = ['topic?']
1592
def run(self, topic=None, long=False):
1594
if topic is None and long:
1599
class cmd_shell_complete(Command):
1600
"""Show appropriate completions for context.
1602
For a list of all available commands, say 'bzr shell-complete'."""
1603
takes_args = ['context?']
1607
def run(self, context=None):
1608
import shellcomplete
1609
shellcomplete.shellcomplete(context)
1612
class cmd_missing(Command):
1613
"""What is missing in this branch relative to other branch.
1615
takes_args = ['remote?']
1616
aliases = ['mis', 'miss']
1617
# We don't have to add quiet to the list, because
1618
# unknown options are parsed as booleans
1619
takes_options = ['verbose', 'quiet']
1621
def run(self, remote=None, verbose=False, quiet=False):
1622
from bzrlib.branch import find_branch, DivergedBranches
1623
from bzrlib.errors import BzrCommandError
1624
from bzrlib.missing import get_parent, show_missing
1626
if verbose and quiet:
1627
raise BzrCommandError('Cannot pass both quiet and verbose')
1629
b = find_branch('.')
1630
parent = get_parent(b)
1633
raise BzrCommandError("No missing location known or specified.")
1636
print "Using last location: %s" % parent
1638
elif parent is None:
1639
# We only update x-pull if it did not exist, missing should not change the parent
1640
b.controlfile('x-pull', 'wb').write(remote + '\n')
1641
br_remote = find_branch(remote)
1643
return show_missing(b, br_remote, verbose=verbose, quiet=quiet)
1647
class cmd_plugins(Command):
1651
import bzrlib.plugin
1652
from inspect import getdoc
1653
from pprint import pprint
1654
for plugin in bzrlib.plugin.all_plugins:
1655
if hasattr(plugin, '__path__'):
1656
print plugin.__path__[0]
1661
print '\t', d.split('\n')[0]
1663
#pprint(bzrlib.plugin.all_plugins)
1667
# list of all available options; the rhs can be either None for an
1668
# option that takes no argument, or a constructor function that checks
1672
'diff-options': str,
1681
'revision': _parse_revision_str,
1693
'merge-type': get_merge_type,
1707
def parse_args(argv):
1708
"""Parse command line.
1710
Arguments and options are parsed at this level before being passed
1711
down to specific command handlers. This routine knows, from a
1712
lookup table, something about the available options, what optargs
1713
they take, and which commands will accept them.
1715
>>> parse_args('--help'.split())
1716
([], {'help': True})
1717
>>> parse_args('--version'.split())
1718
([], {'version': True})
1719
>>> parse_args('status --all'.split())
1720
(['status'], {'all': True})
1721
>>> parse_args('commit --message=biter'.split())
1722
(['commit'], {'message': u'biter'})
1723
>>> parse_args('log -r 500'.split())
1724
(['log'], {'revision': [500]})
1725
>>> parse_args('log -r500..600'.split())
1726
(['log'], {'revision': [500, 600]})
1727
>>> parse_args('log -vr500..600'.split())
1728
(['log'], {'verbose': True, 'revision': [500, 600]})
1729
>>> parse_args('log -rv500..600'.split()) #the r takes an argument
1730
(['log'], {'revision': ['v500', 600]})
1735
# TODO: Maybe handle '--' to end options?
1740
# option names must not be unicode
1744
mutter(" got option %r" % a)
1746
optname, optarg = a[2:].split('=', 1)
1749
if optname not in OPTIONS:
1750
raise BzrError('unknown long option %r' % a)
1753
if shortopt in SHORT_OPTIONS:
1754
# Multi-character options must have a space to delimit
1756
optname = SHORT_OPTIONS[shortopt]
1758
# Single character short options, can be chained,
1759
# and have their value appended to their name
1761
if shortopt not in SHORT_OPTIONS:
1762
# We didn't find the multi-character name, and we
1763
# didn't find the single char name
1764
raise BzrError('unknown short option %r' % a)
1765
optname = SHORT_OPTIONS[shortopt]
1768
# There are extra things on this option
1769
# see if it is the value, or if it is another
1771
optargfn = OPTIONS[optname]
1772
if optargfn is None:
1773
# This option does not take an argument, so the
1774
# next entry is another short option, pack it back
1776
argv.insert(0, '-' + a[2:])
1778
# This option takes an argument, so pack it
1783
# XXX: Do we ever want to support this, e.g. for -r?
1784
raise BzrError('repeated option %r' % a)
1786
optargfn = OPTIONS[optname]
1790
raise BzrError('option %r needs an argument' % a)
1792
optarg = argv.pop(0)
1793
opts[optname] = optargfn(optarg)
1796
raise BzrError('option %r takes no argument' % optname)
1797
opts[optname] = True
1806
def _match_argform(cmd, takes_args, args):
1809
# step through args and takes_args, allowing appropriate 0-many matches
1810
for ap in takes_args:
1814
argdict[argname] = args.pop(0)
1815
elif ap[-1] == '*': # all remaining arguments
1817
argdict[argname + '_list'] = args[:]
1820
argdict[argname + '_list'] = None
1823
raise BzrCommandError("command %r needs one or more %s"
1824
% (cmd, argname.upper()))
1826
argdict[argname + '_list'] = args[:]
1828
elif ap[-1] == '$': # all but one
1830
raise BzrCommandError("command %r needs one or more %s"
1831
% (cmd, argname.upper()))
1832
argdict[argname + '_list'] = args[:-1]
1838
raise BzrCommandError("command %r requires argument %s"
1839
% (cmd, argname.upper()))
1841
argdict[argname] = args.pop(0)
1844
raise BzrCommandError("extra argument to command %s: %s"
1852
"""Execute a command.
1854
This is similar to main(), but without all the trappings for
1855
logging and error handling.
1858
The command-line arguments, without the program name from argv[0]
1860
Returns a command status or raises an exception.
1862
Special master options: these must come before the command because
1863
they control how the command is interpreted.
1866
Do not load plugin modules at all
1869
Only use builtin commands. (Plugins are still allowed to change
1873
Run under the Python profiler.
1876
argv = [a.decode(bzrlib.user_encoding) for a in argv]
1878
opt_profile = opt_no_plugins = opt_builtin = False
1880
# --no-plugins is handled specially at a very early stage. We need
1881
# to load plugins before doing other command parsing so that they
1882
# can override commands, but this needs to happen first.
1885
if a == '--profile':
1887
elif a == '--no-plugins':
1888
opt_no_plugins = True
1889
elif a == '--builtin':
1895
if not opt_no_plugins:
1896
from bzrlib.plugin import load_plugins
1899
args, opts = parse_args(argv)
1902
from bzrlib.help import help
1909
if 'version' in opts:
1914
from bzrlib.help import help
1918
cmd = str(args.pop(0))
1920
canonical_cmd, cmd_class = \
1921
get_cmd_class(cmd, plugins_override=not opt_builtin)
1923
# check options are reasonable
1924
allowed = cmd_class.takes_options
1926
if oname not in allowed:
1927
raise BzrCommandError("option '--%s' is not allowed for command %r"
1930
# mix arguments and options into one dictionary
1931
cmdargs = _match_argform(cmd, cmd_class.takes_args, args)
1933
for k, v in opts.items():
1934
cmdopts[k.replace('-', '_')] = v
1937
import hotshot, tempfile
1938
pffileno, pfname = tempfile.mkstemp()
1940
prof = hotshot.Profile(pfname)
1941
ret = prof.runcall(cmd_class, cmdopts, cmdargs) or 0
1944
import hotshot.stats
1945
stats = hotshot.stats.load(pfname)
1947
stats.sort_stats('time')
1948
## XXX: Might like to write to stderr or the trace file instead but
1949
## print_stats seems hardcoded to stdout
1950
stats.print_stats(20)
1958
return cmd_class(cmdopts, cmdargs).status
1963
bzrlib.trace.log_startup(argv)
1964
bzrlib.ui.ui_factory = bzrlib.ui.TextUIFactory()
1968
return run_bzr(argv[1:])
1970
# do this here inside the exception wrappers to catch EPIPE
1972
except BzrCommandError, e:
1973
# command line syntax error, etc
1977
bzrlib.trace.log_exception()
1979
except AssertionError, e:
1980
bzrlib.trace.log_exception('assertion failed: ' + str(e))
1982
except KeyboardInterrupt, e:
1983
bzrlib.trace.note('interrupted')
1985
except Exception, e:
1987
if (isinstance(e, IOError)
1988
and hasattr(e, 'errno')
1989
and e.errno == errno.EPIPE):
1990
bzrlib.trace.note('broken pipe')
1993
bzrlib.trace.log_exception()
1997
if __name__ == '__main__':
1998
sys.exit(main(sys.argv))
added
removed
bzrlib/commands.py
