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.
35
from bzrlib.trace import mutter, note, log_error, warning
36
from bzrlib.errors import BzrError, BzrCheckError, BzrCommandError
37
from bzrlib.branch import find_branch
38
from bzrlib import BZRDIR
44
def register_command(cmd):
45
"Utility function to help register a command"
48
if k.startswith("cmd_"):
49
k_unsquished = _unsquish_command_name(k)
52
if not plugin_cmds.has_key(k_unsquished):
53
plugin_cmds[k_unsquished] = cmd
54
mutter('registered plugin command %s', k_unsquished)
56
log_error('Two plugins defined the same command: %r' % k)
57
log_error('Not loading the one in %r' % sys.modules[cmd.__module__])
60
def _squish_command_name(cmd):
61
return 'cmd_' + cmd.replace('-', '_')
64
def _unsquish_command_name(cmd):
65
assert cmd.startswith("cmd_")
66
return cmd[4:].replace('_','-')
69
def _parse_revision_str(revstr):
70
"""This handles a revision string -> revno.
72
This always returns a list. The list will have one element for
74
It supports integers directly, but everything else it
75
defers for passing to Branch.get_revision_info()
77
>>> _parse_revision_str('234')
79
>>> _parse_revision_str('234..567')
81
>>> _parse_revision_str('..')
83
>>> _parse_revision_str('..234')
85
>>> _parse_revision_str('234..')
87
>>> _parse_revision_str('234..456..789') # Maybe this should be an error
89
>>> _parse_revision_str('234....789') # Error?
91
>>> _parse_revision_str('revid:test@other.com-234234')
92
['revid:test@other.com-234234']
93
>>> _parse_revision_str('revid:test@other.com-234234..revid:test@other.com-234235')
94
['revid:test@other.com-234234', 'revid:test@other.com-234235']
95
>>> _parse_revision_str('revid:test@other.com-234234..23')
96
['revid:test@other.com-234234', 23]
97
>>> _parse_revision_str('date:2005-04-12')
99
>>> _parse_revision_str('date:2005-04-12 12:24:33')
100
['date:2005-04-12 12:24:33']
101
>>> _parse_revision_str('date:2005-04-12T12:24:33')
102
['date:2005-04-12T12:24:33']
103
>>> _parse_revision_str('date:2005-04-12,12:24:33')
104
['date:2005-04-12,12:24:33']
105
>>> _parse_revision_str('-5..23')
107
>>> _parse_revision_str('-5')
109
>>> _parse_revision_str('123a')
111
>>> _parse_revision_str('abc')
115
old_format_re = re.compile('\d*:\d*')
116
m = old_format_re.match(revstr)
118
warning('Colon separator for revision numbers is deprecated.'
121
for rev in revstr.split(':'):
123
revs.append(int(rev))
128
for x in revstr.split('..'):
139
def get_merge_type(typestring):
140
"""Attempt to find the merge class/factory associated with a string."""
141
from merge import merge_types
143
return merge_types[typestring][0]
145
templ = '%s%%7s: %%s' % (' '*12)
146
lines = [templ % (f[0], f[1][1]) for f in merge_types.iteritems()]
147
type_list = '\n'.join(lines)
148
msg = "No known merge type %s. Supported types are:\n%s" %\
149
(typestring, type_list)
150
raise BzrCommandError(msg)
153
def get_merge_type(typestring):
154
"""Attempt to find the merge class/factory associated with a string."""
155
from merge import merge_types
157
return merge_types[typestring][0]
159
templ = '%s%%7s: %%s' % (' '*12)
160
lines = [templ % (f[0], f[1][1]) for f in merge_types.iteritems()]
161
type_list = '\n'.join(lines)
162
msg = "No known merge type %s. Supported types are:\n%s" %\
163
(typestring, type_list)
164
raise BzrCommandError(msg)
168
def _get_cmd_dict(plugins_override=True):
170
for k, v in globals().iteritems():
171
if k.startswith("cmd_"):
172
d[_unsquish_command_name(k)] = v
173
# If we didn't load plugins, the plugin_cmds dict will be empty
175
d.update(plugin_cmds)
177
d2 = plugin_cmds.copy()
183
def get_all_cmds(plugins_override=True):
184
"""Return canonical name and class for all registered commands."""
185
for k, v in _get_cmd_dict(plugins_override=plugins_override).iteritems():
189
def get_cmd_class(cmd, plugins_override=True):
190
"""Return the canonical name and command class for a command.
192
cmd = str(cmd) # not unicode
194
# first look up this command under the specified name
195
cmds = _get_cmd_dict(plugins_override=plugins_override)
196
mutter("all commands: %r", cmds.keys())
198
return cmd, cmds[cmd]
202
# look for any command which claims this as an alias
203
for cmdname, cmdclass in cmds.iteritems():
204
if cmd in cmdclass.aliases:
205
return cmdname, cmdclass
207
cmdclass = ExternalCommand.find_command(cmd)
211
raise BzrCommandError("unknown command %r" % cmd)
214
class Command(object):
215
"""Base class for commands.
217
The docstring for an actual command should give a single-line
218
summary, then a complete description of the command. A grammar
219
description will be inserted.
222
List of argument forms, marked with whether they are optional,
226
List of options that may be given for this command.
229
If true, this command isn't advertised.
238
def __init__(self, options, arguments):
239
"""Construct and run the command.
241
Sets self.status to the return value of run()."""
242
assert isinstance(options, dict)
243
assert isinstance(arguments, dict)
244
cmdargs = options.copy()
245
cmdargs.update(arguments)
246
if self.__doc__ == Command.__doc__:
247
from warnings import warn
248
warn("No help message set for %r" % self)
249
self.status = self.run(**cmdargs)
250
if self.status is None:
255
"""Override this in sub-classes.
257
This is invoked with the options and arguments bound to
260
Return 0 or None if the command was successful, or a shell
266
class ExternalCommand(Command):
267
"""Class to wrap external commands.
269
We cheat a little here, when get_cmd_class() calls us we actually
270
give it back an object we construct that has the appropriate path,
271
help, options etc for the specified command.
273
When run_bzr() tries to instantiate that 'class' it gets caught by
274
the __call__ method, which we override to call the Command.__init__
275
method. That then calls our run method which is pretty straight
278
The only wrinkle is that we have to map bzr's dictionary of options
279
and arguments back into command line options and arguments for the
283
def find_command(cls, cmd):
285
bzrpath = os.environ.get('BZRPATH', '')
287
for dir in bzrpath.split(os.pathsep):
288
path = os.path.join(dir, cmd)
289
if os.path.isfile(path):
290
return ExternalCommand(path)
294
find_command = classmethod(find_command)
296
def __init__(self, path):
299
pipe = os.popen('%s --bzr-usage' % path, 'r')
300
self.takes_options = pipe.readline().split()
302
for opt in self.takes_options:
303
if not opt in OPTIONS:
304
raise BzrError("Unknown option '%s' returned by external command %s"
307
# TODO: Is there any way to check takes_args is valid here?
308
self.takes_args = pipe.readline().split()
310
if pipe.close() is not None:
311
raise BzrError("Failed funning '%s --bzr-usage'" % path)
313
pipe = os.popen('%s --bzr-help' % path, 'r')
314
self.__doc__ = pipe.read()
315
if pipe.close() is not None:
316
raise BzrError("Failed funning '%s --bzr-help'" % path)
318
def __call__(self, options, arguments):
319
Command.__init__(self, options, arguments)
322
def run(self, **kargs):
329
optname = name.replace('_','-')
331
if OPTIONS.has_key(optname):
333
opts.append('--%s' % optname)
334
if value is not None and value is not True:
335
opts.append(str(value))
337
# it's an arg, or arg list
338
if type(value) is not list:
344
self.status = os.spawnv(os.P_WAIT, self.path, [self.path] + opts + args)
348
class cmd_status(Command):
349
"""Display status summary.
351
This reports on versioned and unknown files, reporting them
352
grouped by state. Possible states are:
355
Versioned in the working copy but not in the previous revision.
358
Versioned in the previous revision but removed or deleted
362
Path of this file changed from the previous revision;
363
the text may also have changed. This includes files whose
364
parent directory was renamed.
367
Text has changed since the previous revision.
370
Nothing about this file has changed since the previous revision.
371
Only shown with --all.
374
Not versioned and not matching an ignore pattern.
376
To see ignored files use 'bzr ignored'. For details in the
377
changes to file texts, use 'bzr diff'.
379
If no arguments are specified, the status of the entire working
380
directory is shown. Otherwise, only the status of the specified
381
files or directories is reported. If a directory is given, status
382
is reported for everything inside that directory.
384
If a revision is specified, the changes since that revision are shown.
386
takes_args = ['file*']
387
takes_options = ['all', 'show-ids', 'revision']
388
aliases = ['st', 'stat']
390
def run(self, all=False, show_ids=False, file_list=None):
392
b = find_branch(file_list[0])
393
file_list = [b.relpath(x) for x in file_list]
394
# special case: only one path was given and it's the root
396
if file_list == ['']:
401
from bzrlib.status import show_status
402
show_status(b, show_unchanged=all, show_ids=show_ids,
403
specific_files=file_list)
406
class cmd_cat_revision(Command):
407
"""Write out metadata for a revision."""
410
takes_args = ['revision_id']
412
def run(self, revision_id):
413
from bzrlib.xml import pack_xml
414
pack_xml(find_branch('.').get_revision(revision_id), sys.stdout)
417
class cmd_revno(Command):
418
"""Show current revision number.
420
This is equal to the number of revisions on this branch."""
422
print find_branch('.').revno()
424
class cmd_revision_info(Command):
425
"""Show revision number and revision id for a given revision identifier.
428
takes_args = ['revision_info*']
429
takes_options = ['revision']
430
def run(self, revision=None, revision_info_list=None):
431
from bzrlib.branch import find_branch
434
if revision is not None:
435
revs.extend(revision)
436
if revision_info_list is not None:
437
revs.extend(revision_info_list)
439
raise BzrCommandError('You must supply a revision identifier')
444
print '%4d %s' % b.get_revision_info(rev)
447
class cmd_add(Command):
448
"""Add specified files or directories.
450
In non-recursive mode, all the named items are added, regardless
451
of whether they were previously ignored. A warning is given if
452
any of the named files are already versioned.
454
In recursive mode (the default), files are treated the same way
455
but the behaviour for directories is different. Directories that
456
are already versioned do not give a warning. All directories,
457
whether already versioned or not, are searched for files or
458
subdirectories that are neither versioned or ignored, and these
459
are added. This search proceeds recursively into versioned
460
directories. If no names are given '.' is assumed.
462
Therefore simply saying 'bzr add' will version all files that
463
are currently unknown.
465
TODO: Perhaps adding a file whose directly is not versioned should
466
recursively add that parent, rather than giving an error?
468
takes_args = ['file*']
469
takes_options = ['verbose', 'no-recurse']
471
def run(self, file_list, verbose=False, no_recurse=False):
472
from bzrlib.add import smart_add
474
recurse = not no_recurse
475
for path, kind, file_id in smart_add(file_list, verbose, recurse):
480
class cmd_mkdir(Command):
481
"""Create a new versioned directory.
483
This is equivalent to creating the directory and then adding it.
485
takes_args = ['dir+']
487
def run(self, dir_list):
498
class cmd_relpath(Command):
499
"""Show path of a file relative to root"""
500
takes_args = ['filename']
503
def run(self, filename):
504
print find_branch(filename).relpath(filename)
508
class cmd_inventory(Command):
509
"""Show inventory of the current working copy or a revision."""
510
takes_options = ['revision', 'show-ids']
512
def run(self, revision=None, show_ids=False):
515
inv = b.read_working_inventory()
517
if len(revision) > 1:
518
raise BzrCommandError('bzr inventory --revision takes'
519
' exactly one revision identifier')
520
inv = b.get_revision_inventory(b.lookup_revision(revision[0]))
522
for path, entry in inv.entries():
524
print '%-50s %s' % (path, entry.file_id)
529
class cmd_move(Command):
530
"""Move files to a different directory.
535
The destination must be a versioned directory in the same branch.
537
takes_args = ['source$', 'dest']
538
def run(self, source_list, dest):
541
# TODO: glob expansion on windows?
542
b.move([b.relpath(s) for s in source_list], b.relpath(dest))
545
class cmd_rename(Command):
546
"""Change the name of an entry.
549
bzr rename frob.c frobber.c
550
bzr rename src/frob.c lib/frob.c
552
It is an error if the destination name exists.
554
See also the 'move' command, which moves files into a different
555
directory without changing their name.
557
TODO: Some way to rename multiple files without invoking bzr for each
559
takes_args = ['from_name', 'to_name']
561
def run(self, from_name, to_name):
563
b.rename_one(b.relpath(from_name), b.relpath(to_name))
567
class cmd_mv(Command):
568
"""Move or rename a file.
571
bzr mv OLDNAME NEWNAME
572
bzr mv SOURCE... DESTINATION
574
If the last argument is a versioned directory, all the other names
575
are moved into it. Otherwise, there must be exactly two arguments
576
and the file is changed to a new name, which must not already exist.
578
Files cannot be moved between branches.
580
takes_args = ['names*']
581
def run(self, names_list):
582
if len(names_list) < 2:
583
raise BzrCommandError("missing file argument")
584
b = find_branch(names_list[0])
586
rel_names = [b.relpath(x) for x in names_list]
588
if os.path.isdir(names_list[-1]):
589
# move into existing directory
590
for pair in b.move(rel_names[:-1], rel_names[-1]):
591
print "%s => %s" % pair
593
if len(names_list) != 2:
594
raise BzrCommandError('to mv multiple files the destination '
595
'must be a versioned directory')
596
for pair in b.move(rel_names[0], rel_names[1]):
597
print "%s => %s" % pair
602
class cmd_pull(Command):
603
"""Pull any changes from another branch into the current one.
605
If the location is omitted, the last-used location will be used.
606
Both the revision history and the working directory will be
609
This command only works on branches that have not diverged. Branches are
610
considered diverged if both branches have had commits without first
611
pulling from the other.
613
If branches have diverged, you can use 'bzr merge' to pull the text changes
614
from one into the other.
616
takes_args = ['location?']
618
def run(self, location=None):
619
from bzrlib.merge import merge
621
from shutil import rmtree
624
br_to = find_branch('.')
627
stored_loc = br_to.controlfile("x-pull", "rb").read().rstrip('\n')
629
if e.errno != errno.ENOENT:
632
if stored_loc is None:
633
raise BzrCommandError("No pull location known or specified.")
635
print "Using last location: %s" % stored_loc
636
location = stored_loc
637
cache_root = tempfile.mkdtemp()
638
from bzrlib.branch import DivergedBranches
639
br_from = find_branch(location)
640
location = pull_loc(br_from)
641
old_revno = br_to.revno()
643
from branch import find_cached_branch, DivergedBranches
644
br_from = find_cached_branch(location, cache_root)
645
location = pull_loc(br_from)
646
old_revno = br_to.revno()
648
br_to.update_revisions(br_from)
649
except DivergedBranches:
650
raise BzrCommandError("These branches have diverged."
653
merge(('.', -1), ('.', old_revno), check_clean=False)
654
if location != stored_loc:
655
br_to.controlfile("x-pull", "wb").write(location + "\n")
661
class cmd_branch(Command):
662
"""Create a new copy of a branch.
664
If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
665
be used. In other words, "branch ../foo/bar" will attempt to create ./bar.
667
To retrieve the branch as of a particular revision, supply the --revision
668
parameter, as in "branch foo/bar -r 5".
670
takes_args = ['from_location', 'to_location?']
671
takes_options = ['revision']
672
aliases = ['get', 'clone']
674
def run(self, from_location, to_location=None, revision=None):
676
from bzrlib.merge import merge
677
from bzrlib.branch import DivergedBranches, \
678
find_cached_branch, Branch
679
from shutil import rmtree
680
from meta_store import CachedStore
682
cache_root = tempfile.mkdtemp()
686
elif len(revision) > 1:
687
raise BzrCommandError('bzr branch --revision takes exactly 1 revision value')
691
br_from = find_cached_branch(from_location, cache_root)
693
if e.errno == errno.ENOENT:
694
raise BzrCommandError('Source location "%s" does not'
695
' exist.' % to_location)
699
if to_location is None:
700
to_location = os.path.basename(from_location.rstrip("/\\"))
703
os.mkdir(to_location)
705
if e.errno == errno.EEXIST:
706
raise BzrCommandError('Target directory "%s" already'
707
' exists.' % to_location)
708
if e.errno == errno.ENOENT:
709
raise BzrCommandError('Parent of "%s" does not exist.' %
713
br_to = Branch(to_location, init=True)
715
br_to.set_root_id(br_from.get_root_id())
718
if revision[0] is None:
719
revno = br_from.revno()
721
revno, rev_id = br_from.get_revision_info(revision[0])
723
br_to.update_revisions(br_from, stop_revision=revno)
724
except bzrlib.errors.NoSuchRevision:
726
msg = "The branch %s has no revision %d." % (from_location,
728
raise BzrCommandError(msg)
730
merge((to_location, -1), (to_location, 0), this_dir=to_location,
731
check_clean=False, ignore_zero=True)
732
from_location = pull_loc(br_from)
733
br_to.controlfile("x-pull", "wb").write(from_location + "\n")
738
def pull_loc(branch):
739
# TODO: Should perhaps just make attribute be 'base' in
740
# RemoteBranch and Branch?
741
if hasattr(branch, "baseurl"):
742
return branch.baseurl
748
class cmd_renames(Command):
749
"""Show list of renamed files.
751
TODO: Option to show renames between two historical versions.
753
TODO: Only show renames under dir, rather than in the whole branch.
755
takes_args = ['dir?']
757
def run(self, dir='.'):
759
old_inv = b.basis_tree().inventory
760
new_inv = b.read_working_inventory()
762
renames = list(bzrlib.tree.find_renames(old_inv, new_inv))
764
for old_name, new_name in renames:
765
print "%s => %s" % (old_name, new_name)
768
class cmd_info(Command):
769
"""Show statistical information about a branch."""
770
takes_args = ['branch?']
772
def run(self, branch=None):
775
b = find_branch(branch)
779
class cmd_remove(Command):
780
"""Make a file unversioned.
782
This makes bzr stop tracking changes to a versioned file. It does
783
not delete the working copy.
785
takes_args = ['file+']
786
takes_options = ['verbose']
788
def run(self, file_list, verbose=False):
789
b = find_branch(file_list[0])
790
b.remove([b.relpath(f) for f in file_list], verbose=verbose)
793
class cmd_file_id(Command):
794
"""Print file_id of a particular file or directory.
796
The file_id is assigned when the file is first added and remains the
797
same through all revisions where the file exists, even when it is
801
takes_args = ['filename']
802
def run(self, filename):
803
b = find_branch(filename)
804
i = b.inventory.path2id(b.relpath(filename))
806
raise BzrError("%r is not a versioned file" % filename)
811
class cmd_file_path(Command):
812
"""Print path of file_ids to a file or directory.
814
This prints one line for each directory down to the target,
815
starting at the branch root."""
817
takes_args = ['filename']
818
def run(self, filename):
819
b = find_branch(filename)
821
fid = inv.path2id(b.relpath(filename))
823
raise BzrError("%r is not a versioned file" % filename)
824
for fip in inv.get_idpath(fid):
828
class cmd_revision_history(Command):
829
"""Display list of revision ids on this branch."""
832
for patchid in find_branch('.').revision_history():
836
class cmd_directories(Command):
837
"""Display list of versioned directories in this branch."""
839
for name, ie in find_branch('.').read_working_inventory().directories():
846
class cmd_init(Command):
847
"""Make a directory into a versioned branch.
849
Use this to create an empty branch, or before importing an
852
Recipe for importing a tree of files:
857
bzr commit -m 'imported project'
860
from bzrlib.branch import Branch
861
Branch('.', init=True)
864
class cmd_diff(Command):
865
"""Show differences in working tree.
867
If files are listed, only the changes in those files are listed.
868
Otherwise, all changes for the tree are listed.
870
TODO: Allow diff across branches.
872
TODO: Option to use external diff command; could be GNU diff, wdiff,
875
TODO: Python difflib is not exactly the same as unidiff; should
876
either fix it up or prefer to use an external diff.
878
TODO: If a directory is given, diff everything under that.
880
TODO: Selected-file diff is inefficient and doesn't show you
883
TODO: This probably handles non-Unix newlines poorly.
891
takes_args = ['file*']
892
takes_options = ['revision', 'diff-options']
893
aliases = ['di', 'dif']
895
def run(self, revision=None, file_list=None, diff_options=None):
896
from bzrlib.diff import show_diff
899
b = find_branch(file_list[0])
900
file_list = [b.relpath(f) for f in file_list]
901
if file_list == ['']:
902
# just pointing to top-of-tree
907
if revision is not None:
908
if len(revision) == 1:
909
show_diff(b, revision[0], specific_files=file_list,
910
external_diff_options=diff_options)
911
elif len(revision) == 2:
912
show_diff(b, revision[0], specific_files=file_list,
913
external_diff_options=diff_options,
914
revision2=revision[1])
916
raise BzrCommandError('bzr diff --revision takes exactly one or two revision identifiers')
918
show_diff(b, None, specific_files=file_list,
919
external_diff_options=diff_options)
924
class cmd_deleted(Command):
925
"""List files deleted in the working tree.
927
TODO: Show files deleted since a previous revision, or between two revisions.
929
def run(self, show_ids=False):
932
new = b.working_tree()
934
## TODO: Much more efficient way to do this: read in new
935
## directories with readdir, rather than stating each one. Same
936
## level of effort but possibly much less IO. (Or possibly not,
937
## if the directories are very large...)
939
for path, ie in old.inventory.iter_entries():
940
if not new.has_id(ie.file_id):
942
print '%-50s %s' % (path, ie.file_id)
947
class cmd_modified(Command):
948
"""List files modified in working tree."""
951
from bzrlib.delta import compare_trees
954
td = compare_trees(b.basis_tree(), b.working_tree())
956
for path, id, kind in td.modified:
961
class cmd_added(Command):
962
"""List files added in working tree."""
966
wt = b.working_tree()
967
basis_inv = b.basis_tree().inventory
970
if file_id in basis_inv:
972
path = inv.id2path(file_id)
973
if not os.access(b.abspath(path), os.F_OK):
979
class cmd_root(Command):
980
"""Show the tree root directory.
982
The root is the nearest enclosing directory with a .bzr control
984
takes_args = ['filename?']
985
def run(self, filename=None):
986
"""Print the branch root."""
987
b = find_branch(filename)
988
print getattr(b, 'base', None) or getattr(b, 'baseurl')
991
class cmd_log(Command):
992
"""Show log of this branch.
994
To request a range of logs, you can use the command -r begin:end
995
-r revision requests a specific revision, -r :end or -r begin: are
998
--message allows you to give a regular expression, which will be evaluated
999
so that only matching entries will be displayed.
1001
TODO: Make --revision support uuid: and hash: [future tag:] notation.
1005
takes_args = ['filename?']
1006
takes_options = ['forward', 'timezone', 'verbose', 'show-ids', 'revision',
1007
'long', 'message', 'short',]
1009
def run(self, filename=None, timezone='original',
1017
from bzrlib.branch import find_branch
1018
from bzrlib.log import log_formatter, show_log
1021
direction = (forward and 'forward') or 'reverse'
1024
b = find_branch(filename)
1025
fp = b.relpath(filename)
1027
file_id = b.read_working_inventory().path2id(fp)
1029
file_id = None # points to branch root
1031
b = find_branch('.')
1034
if revision is None:
1037
elif len(revision) == 1:
1038
rev1 = rev2 = b.get_revision_info(revision[0])[0]
1039
elif len(revision) == 2:
1040
rev1 = b.get_revision_info(revision[0])[0]
1041
rev2 = b.get_revision_info(revision[1])[0]
1043
raise BzrCommandError('bzr log --revision takes one or two values.')
1050
mutter('encoding log as %r' % bzrlib.user_encoding)
1052
# use 'replace' so that we don't abort if trying to write out
1053
# in e.g. the default C locale.
1054
outf = codecs.getwriter(bzrlib.user_encoding)(sys.stdout, errors='replace')
1059
log_format = 'short'
1060
lf = log_formatter(log_format,
1063
show_timezone=timezone)
1069
direction=direction,
1070
start_revision=rev1,
1076
class cmd_touching_revisions(Command):
1077
"""Return revision-ids which affected a particular file.
1079
A more user-friendly interface is "bzr log FILE"."""
1081
takes_args = ["filename"]
1082
def run(self, filename):
1083
b = find_branch(filename)
1084
inv = b.read_working_inventory()
1085
file_id = inv.path2id(b.relpath(filename))
1086
for revno, revision_id, what in bzrlib.log.find_touching_revisions(b, file_id):
1087
print "%6d %s" % (revno, what)
1090
class cmd_ls(Command):
1091
"""List files in a tree.
1093
TODO: Take a revision or remote path and list that tree instead.
1096
def run(self, revision=None, verbose=False):
1097
b = find_branch('.')
1098
if revision == None:
1099
tree = b.working_tree()
1101
tree = b.revision_tree(b.lookup_revision(revision))
1103
for fp, fc, kind, fid in tree.list_files():
1105
if kind == 'directory':
1107
elif kind == 'file':
1112
print '%-8s %s%s' % (fc, fp, kindch)
1118
class cmd_unknowns(Command):
1119
"""List unknown files."""
1121
from bzrlib.osutils import quotefn
1122
for f in find_branch('.').unknowns():
1127
class cmd_ignore(Command):
1128
"""Ignore a command or pattern.
1130
To remove patterns from the ignore list, edit the .bzrignore file.
1132
If the pattern contains a slash, it is compared to the whole path
1133
from the branch root. Otherwise, it is comapred to only the last
1134
component of the path.
1136
Ignore patterns are case-insensitive on case-insensitive systems.
1138
Note: wildcards must be quoted from the shell on Unix.
1141
bzr ignore ./Makefile
1142
bzr ignore '*.class'
1144
takes_args = ['name_pattern']
1146
def run(self, name_pattern):
1147
from bzrlib.atomicfile import AtomicFile
1150
b = find_branch('.')
1151
ifn = b.abspath('.bzrignore')
1153
if os.path.exists(ifn):
1156
igns = f.read().decode('utf-8')
1162
# TODO: If the file already uses crlf-style termination, maybe
1163
# we should use that for the newly added lines?
1165
if igns and igns[-1] != '\n':
1167
igns += name_pattern + '\n'
1170
f = AtomicFile(ifn, 'wt')
1171
f.write(igns.encode('utf-8'))
1176
inv = b.working_tree().inventory
1177
if inv.path2id('.bzrignore'):
1178
mutter('.bzrignore is already versioned')
1180
mutter('need to make new .bzrignore file versioned')
1181
b.add(['.bzrignore'])
1185
class cmd_ignored(Command):
1186
"""List ignored files and the patterns that matched them.
1188
See also: bzr ignore"""
1190
tree = find_branch('.').working_tree()
1191
for path, file_class, kind, file_id in tree.list_files():
1192
if file_class != 'I':
1194
## XXX: Slightly inefficient since this was already calculated
1195
pat = tree.is_ignored(path)
1196
print '%-50s %s' % (path, pat)
1199
class cmd_lookup_revision(Command):
1200
"""Lookup the revision-id from a revision-number
1203
bzr lookup-revision 33
1206
takes_args = ['revno']
1208
def run(self, revno):
1212
raise BzrCommandError("not a valid revision-number: %r" % revno)
1214
print find_branch('.').lookup_revision(revno)
1217
class cmd_export(Command):
1218
"""Export past revision to destination directory.
1220
If no revision is specified this exports the last committed revision.
1222
Format may be an "exporter" name, such as tar, tgz, tbz2. If none is
1223
given, try to find the format with the extension. If no extension
1224
is found exports to a directory (equivalent to --format=dir).
1226
Root may be the top directory for tar, tgz and tbz2 formats. If none
1227
is given, the top directory will be the root name of the file."""
1228
# TODO: list known exporters
1229
takes_args = ['dest']
1230
takes_options = ['revision', 'format', 'root']
1231
def run(self, dest, revision=None, format=None, root=None):
1233
b = find_branch('.')
1234
if revision is None:
1235
rev_id = b.last_patch()
1237
if len(revision) != 1:
1238
raise BzrError('bzr export --revision takes exactly 1 argument')
1239
revno, rev_id = b.get_revision_info(revision[0])
1240
t = b.revision_tree(rev_id)
1241
root, ext = os.path.splitext(dest)
1243
if ext in (".tar",):
1245
elif ext in (".gz", ".tgz"):
1247
elif ext in (".bz2", ".tbz2"):
1251
t.export(dest, format, root)
1254
class cmd_cat(Command):
1255
"""Write a file's text from a previous revision."""
1257
takes_options = ['revision']
1258
takes_args = ['filename']
1260
def run(self, filename, revision=None):
1261
if revision == None:
1262
raise BzrCommandError("bzr cat requires a revision number")
1263
elif len(revision) != 1:
1264
raise BzrCommandError("bzr cat --revision takes exactly one number")
1265
b = find_branch('.')
1266
b.print_file(b.relpath(filename), revision[0])
1269
class cmd_local_time_offset(Command):
1270
"""Show the offset in seconds from GMT to local time."""
1273
print bzrlib.osutils.local_time_offset()
1277
class cmd_commit(Command):
1278
"""Commit changes into a new revision.
1280
If no arguments are given, the entire tree is committed.
1282
If selected files are specified, only changes to those files are
1283
committed. If a directory is specified then the directory and everything
1284
within it is committed.
1286
A selected-file commit may fail in some cases where the committed
1287
tree would be invalid, such as trying to commit a file in a
1288
newly-added directory that is not itself committed.
1290
TODO: Run hooks on tree to-be-committed, and after commit.
1292
TODO: Strict commit that fails if there are unknown or deleted files.
1294
takes_args = ['selected*']
1295
takes_options = ['message', 'file', 'verbose', 'unchanged']
1296
aliases = ['ci', 'checkin']
1298
# TODO: Give better message for -s, --summary, used by tla people
1300
def run(self, message=None, file=None, verbose=True, selected_list=None,
1302
from bzrlib.errors import PointlessCommit
1303
from bzrlib.osutils import get_text_message
1305
## Warning: shadows builtin file()
1306
if not message and not file:
1307
# FIXME: Ugly; change status code to send to a provided function?
1311
catcher = cStringIO.StringIO()
1312
sys.stdout = catcher
1313
cmd_status({"file_list":selected_list}, {})
1314
info = catcher.getvalue()
1316
message = get_text_message(info)
1319
raise BzrCommandError("please specify a commit message",
1320
["use either --message or --file"])
1321
elif message and file:
1322
raise BzrCommandError("please specify either --message or --file")
1326
message = codecs.open(file, 'rt', bzrlib.user_encoding).read()
1328
b = find_branch('.')
1330
selected_list = [b.relpath(s) for s in selected_list]
1333
b.commit(message, verbose=verbose,
1334
specific_files=selected_list,
1335
allow_pointless=unchanged)
1336
except PointlessCommit:
1337
# FIXME: This should really happen before the file is read in;
1338
# perhaps prepare the commit; get the message; then actually commit
1339
raise BzrCommandError("no changes to commit",
1340
["use --unchanged to commit anyhow"])
1343
class cmd_check(Command):
1344
"""Validate consistency of branch history.
1346
This command checks various invariants about the branch storage to
1347
detect data corruption or bzr bugs.
1349
If given the --update flag, it will update some optional fields
1350
to help ensure data consistency.
1352
takes_args = ['dir?']
1354
def run(self, dir='.'):
1355
from bzrlib.check import check
1357
check(find_branch(dir))
1360
class cmd_scan_cache(Command):
1363
from bzrlib.hashcache import HashCache
1370
print '%6d stats' % c.stat_count
1371
print '%6d in hashcache' % len(c._cache)
1372
print '%6d files removed from cache' % c.removed_count
1373
print '%6d hashes updated' % c.update_count
1374
print '%6d files changed too recently to cache' % c.danger_count
1381
class cmd_upgrade(Command):
1382
"""Upgrade branch storage to current format.
1384
The check command or bzr developers may sometimes advise you to run
1387
takes_args = ['dir?']
1389
def run(self, dir='.'):
1390
from bzrlib.upgrade import upgrade
1391
upgrade(find_branch(dir))
1395
class cmd_whoami(Command):
1396
"""Show bzr user id."""
1397
takes_options = ['email']
1399
def run(self, email=False):
1401
b = bzrlib.branch.find_branch('.')
1406
print bzrlib.osutils.user_email(b)
1408
print bzrlib.osutils.username(b)
1411
class cmd_selftest(Command):
1412
"""Run internal test suite"""
1414
takes_options = ['verbose']
1415
def run(self, verbose=False):
1417
from bzrlib.selftest import selftest
1419
# we don't want progress meters from the tests to go to the
1420
# real output; and we don't want log messages cluttering up
1423
save_ui = bzrlib.ui.ui_factory
1424
bzrlib.trace.info('running tests...')
1426
bzrlib.ui.ui_factory = bzrlib.ui.SilentUIFactory()
1427
result = selftest(verbose=verbose)
1429
bzrlib.trace.info('tests passed')
1431
bzrlib.trace.info('tests failed')
1432
return int(not result)
1434
bzrlib.ui.ui_factory = save_ui
1437
class cmd_version(Command):
1438
"""Show version of bzr."""
1443
print "bzr (bazaar-ng) %s" % bzrlib.__version__
1444
# is bzrlib itself in a branch?
1445
bzrrev = bzrlib.get_bzr_revision()
1447
print " (bzr checkout, revision %d {%s})" % bzrrev
1448
print bzrlib.__copyright__
1449
print "http://bazaar-ng.org/"
1451
print "bzr comes with ABSOLUTELY NO WARRANTY. bzr is free software, and"
1452
print "you may use, modify and redistribute it under the terms of the GNU"
1453
print "General Public License version 2 or later."
1456
class cmd_rocks(Command):
1457
"""Statement of optimism."""
1460
print "it sure does!"
1462
def parse_spec(spec):
1464
>>> parse_spec(None)
1466
>>> parse_spec("./")
1468
>>> parse_spec("../@")
1470
>>> parse_spec("../f/@35")
1472
>>> parse_spec('./@revid:john@arbash-meinel.com-20050711044610-3ca0327c6a222f67')
1473
['.', 'revid:john@arbash-meinel.com-20050711044610-3ca0327c6a222f67']
1478
parsed = spec.split('/@')
1479
assert len(parsed) == 2
1484
parsed[1] = int(parsed[1])
1486
pass # We can allow stuff like ./@revid:blahblahblah
1488
assert parsed[1] >=0
1490
parsed = [spec, None]
1495
class cmd_find_merge_base(Command):
1496
"""Find and print a base revision for merging two branches.
1498
TODO: Options to specify revisions on either side, as if
1499
merging only part of the history.
1501
takes_args = ['branch', 'other']
1504
def run(self, branch, other):
1505
branch1 = find_branch(branch)
1506
branch2 = find_branch(other)
1508
base_revno, base_revid = branch1.common_ancestor(branch2)
1510
if base_revno is None:
1511
raise bzrlib.errors.UnrelatedBranches()
1513
print 'merge base is revision %s' % base_revid
1514
print ' r%-6d in %s' % (base_revno, branch)
1516
other_revno = branch2.revision_id_to_revno(base_revid)
1518
print ' r%-6d in %s' % (other_revno, other)
1522
class cmd_merge(Command):
1523
"""Perform a three-way merge.
1525
The branch is the branch you will merge from. By default, it will merge
1526
the latest revision. If you specify a revision, that revision will be
1527
merged. If you specify two revisions, the first will be used as a BASE,
1528
and the second one as OTHER. Revision numbers are always relative to the
1533
To merge the latest revision from bzr.dev
1534
bzr merge ../bzr.dev
1536
To merge changes up to and including revision 82 from bzr.dev
1537
bzr merge -r 82 ../bzr.dev
1539
To merge the changes introduced by 82, without previous changes:
1540
bzr merge -r 81..82 ../bzr.dev
1542
merge refuses to run if there are any uncommitted changes, unless
1545
takes_args = ['branch?']
1546
takes_options = ['revision', 'force', 'merge-type']
1548
def run(self, branch='.', revision=None, force=False,
1550
from bzrlib.merge import merge
1551
from bzrlib.merge_core import ApplyMerge3
1552
if merge_type is None:
1553
merge_type = ApplyMerge3
1555
if revision is None or len(revision) < 1:
1557
other = (branch, -1)
1559
if len(revision) == 1:
1560
other = (branch, revision[0])
1563
assert len(revision) == 2
1564
if None in revision:
1565
raise BzrCommandError(
1566
"Merge doesn't permit that revision specifier.")
1567
base = (branch, revision[0])
1568
other = (branch, revision[1])
1570
merge(other, base, check_clean=(not force), merge_type=merge_type)
1573
class cmd_revert(Command):
1574
"""Reverse all changes since the last commit.
1576
Only versioned files are affected. Specify filenames to revert only
1577
those files. By default, any files that are changed will be backed up
1578
first. Backup files have a '~' appended to their name.
1580
takes_options = ['revision', 'no-backup']
1581
takes_args = ['file*']
1582
aliases = ['merge-revert']
1584
def run(self, revision=None, no_backup=False, file_list=None):
1585
from bzrlib.merge import merge
1586
if file_list is not None:
1587
if len(file_list) == 0:
1588
raise BzrCommandError("No files specified")
1589
if revision is None:
1591
elif len(revision) != 1:
1592
raise BzrCommandError('bzr revert --revision takes exactly 1 argument')
1593
merge(('.', revision[0]), parse_spec('.'),
1596
backup_files=not no_backup,
1597
file_list=file_list)
1600
class cmd_assert_fail(Command):
1601
"""Test reporting of assertion failures"""
1604
assert False, "always fails"
1607
class cmd_help(Command):
1608
"""Show help on a command or other topic.
1610
For a list of all available commands, say 'bzr help commands'."""
1611
takes_options = ['long']
1612
takes_args = ['topic?']
1615
def run(self, topic=None, long=False):
1617
if topic is None and long:
1622
class cmd_shell_complete(Command):
1623
"""Show appropriate completions for context.
1625
For a list of all available commands, say 'bzr shell-complete'."""
1626
takes_args = ['context?']
1630
def run(self, context=None):
1631
import shellcomplete
1632
shellcomplete.shellcomplete(context)
1635
class cmd_missing(Command):
1636
"""What is missing in this branch relative to other branch.
1638
takes_args = ['remote?']
1639
aliases = ['mis', 'miss']
1640
# We don't have to add quiet to the list, because
1641
# unknown options are parsed as booleans
1642
takes_options = ['verbose', 'quiet']
1644
def run(self, remote=None, verbose=False, quiet=False):
1645
from bzrlib.branch import find_branch, DivergedBranches
1646
from bzrlib.errors import BzrCommandError
1647
from bzrlib.missing import get_parent, show_missing
1649
if verbose and quiet:
1650
raise BzrCommandError('Cannot pass both quiet and verbose')
1652
b = find_branch('.')
1653
parent = get_parent(b)
1656
raise BzrCommandError("No missing location known or specified.")
1659
print "Using last location: %s" % parent
1661
elif parent is None:
1662
# We only update x-pull if it did not exist, missing should not change the parent
1663
b.controlfile('x-pull', 'wb').write(remote + '\n')
1664
br_remote = find_branch(remote)
1666
return show_missing(b, br_remote, verbose=verbose, quiet=quiet)
1670
class cmd_plugins(Command):
1674
import bzrlib.plugin
1675
from inspect import getdoc
1676
from pprint import pprint
1677
for plugin in bzrlib.plugin.all_plugins:
1678
if hasattr(plugin, '__path__'):
1679
print plugin.__path__[0]
1684
print '\t', d.split('\n')[0]
1686
#pprint(bzrlib.plugin.all_plugins)
1690
# list of all available options; the rhs can be either None for an
1691
# option that takes no argument, or a constructor function that checks
1695
'diff-options': str,
1704
'revision': _parse_revision_str,
1716
'merge-type': get_merge_type,
1729
def parse_args(argv):
1730
"""Parse command line.
1732
Arguments and options are parsed at this level before being passed
1733
down to specific command handlers. This routine knows, from a
1734
lookup table, something about the available options, what optargs
1735
they take, and which commands will accept them.
1737
>>> parse_args('--help'.split())
1738
([], {'help': True})
1739
>>> parse_args('--version'.split())
1740
([], {'version': True})
1741
>>> parse_args('status --all'.split())
1742
(['status'], {'all': True})
1743
>>> parse_args('commit --message=biter'.split())
1744
(['commit'], {'message': u'biter'})
1745
>>> parse_args('log -r 500'.split())
1746
(['log'], {'revision': [500]})
1747
>>> parse_args('log -r500..600'.split())
1748
(['log'], {'revision': [500, 600]})
1749
>>> parse_args('log -vr500..600'.split())
1750
(['log'], {'verbose': True, 'revision': [500, 600]})
1751
>>> parse_args('log -rv500..600'.split()) #the r takes an argument
1752
(['log'], {'revision': ['v500', 600]})
1757
# TODO: Maybe handle '--' to end options?
1762
# option names must not be unicode
1766
mutter(" got option %r" % a)
1768
optname, optarg = a[2:].split('=', 1)
1771
if optname not in OPTIONS:
1772
raise BzrError('unknown long option %r' % a)
1775
if shortopt in SHORT_OPTIONS:
1776
# Multi-character options must have a space to delimit
1778
optname = SHORT_OPTIONS[shortopt]
1780
# Single character short options, can be chained,
1781
# and have their value appended to their name
1783
if shortopt not in SHORT_OPTIONS:
1784
# We didn't find the multi-character name, and we
1785
# didn't find the single char name
1786
raise BzrError('unknown short option %r' % a)
1787
optname = SHORT_OPTIONS[shortopt]
1790
# There are extra things on this option
1791
# see if it is the value, or if it is another
1793
optargfn = OPTIONS[optname]
1794
if optargfn is None:
1795
# This option does not take an argument, so the
1796
# next entry is another short option, pack it back
1798
argv.insert(0, '-' + a[2:])
1800
# This option takes an argument, so pack it
1805
# XXX: Do we ever want to support this, e.g. for -r?
1806
raise BzrError('repeated option %r' % a)
1808
optargfn = OPTIONS[optname]
1812
raise BzrError('option %r needs an argument' % a)
1814
optarg = argv.pop(0)
1815
opts[optname] = optargfn(optarg)
1818
raise BzrError('option %r takes no argument' % optname)
1819
opts[optname] = True
1828
def _match_argform(cmd, takes_args, args):
1831
# step through args and takes_args, allowing appropriate 0-many matches
1832
for ap in takes_args:
1836
argdict[argname] = args.pop(0)
1837
elif ap[-1] == '*': # all remaining arguments
1839
argdict[argname + '_list'] = args[:]
1842
argdict[argname + '_list'] = None
1845
raise BzrCommandError("command %r needs one or more %s"
1846
% (cmd, argname.upper()))
1848
argdict[argname + '_list'] = args[:]
1850
elif ap[-1] == '$': # all but one
1852
raise BzrCommandError("command %r needs one or more %s"
1853
% (cmd, argname.upper()))
1854
argdict[argname + '_list'] = args[:-1]
1860
raise BzrCommandError("command %r requires argument %s"
1861
% (cmd, argname.upper()))
1863
argdict[argname] = args.pop(0)
1866
raise BzrCommandError("extra argument to command %s: %s"
1874
"""Execute a command.
1876
This is similar to main(), but without all the trappings for
1877
logging and error handling.
1880
The command-line arguments, without the program name from argv[0]
1882
Returns a command status or raises an exception.
1884
Special master options: these must come before the command because
1885
they control how the command is interpreted.
1888
Do not load plugin modules at all
1891
Only use builtin commands. (Plugins are still allowed to change
1895
Run under the Python profiler.
1898
argv = [a.decode(bzrlib.user_encoding) for a in argv]
1900
opt_profile = opt_no_plugins = opt_builtin = False
1902
# --no-plugins is handled specially at a very early stage. We need
1903
# to load plugins before doing other command parsing so that they
1904
# can override commands, but this needs to happen first.
1907
if a == '--profile':
1909
elif a == '--no-plugins':
1910
opt_no_plugins = True
1911
elif a == '--builtin':
1917
if not opt_no_plugins:
1918
from bzrlib.plugin import load_plugins
1921
args, opts = parse_args(argv)
1924
from bzrlib.help import help
1931
if 'version' in opts:
1936
from bzrlib.help import help
1940
cmd = str(args.pop(0))
1942
canonical_cmd, cmd_class = \
1943
get_cmd_class(cmd, plugins_override=not opt_builtin)
1945
# check options are reasonable
1946
allowed = cmd_class.takes_options
1948
if oname not in allowed:
1949
raise BzrCommandError("option '--%s' is not allowed for command %r"
1952
# mix arguments and options into one dictionary
1953
cmdargs = _match_argform(cmd, cmd_class.takes_args, args)
1955
for k, v in opts.items():
1956
cmdopts[k.replace('-', '_')] = v
1959
import hotshot, tempfile
1960
pffileno, pfname = tempfile.mkstemp()
1962
prof = hotshot.Profile(pfname)
1963
ret = prof.runcall(cmd_class, cmdopts, cmdargs) or 0
1966
import hotshot.stats
1967
stats = hotshot.stats.load(pfname)
1969
stats.sort_stats('time')
1970
## XXX: Might like to write to stderr or the trace file instead but
1971
## print_stats seems hardcoded to stdout
1972
stats.print_stats(20)
1980
return cmd_class(cmdopts, cmdargs).status
1986
bzrlib.trace.log_startup(argv)
1988
bzrlib.ui.ui_factory = bzrlib.ui.TextUIFactory()
1992
return run_bzr(argv[1:])
1994
# do this here inside the exception wrappers to catch EPIPE
1996
except BzrCommandError, e:
1997
# command line syntax error, etc
2001
bzrlib.trace.log_exception()
2003
except AssertionError, e:
2004
bzrlib.trace.log_exception('assertion failed: ' + str(e))
2006
except KeyboardInterrupt, e:
2007
bzrlib.trace.note('interrupted')
2009
except Exception, e:
2011
if (isinstance(e, IOError)
2012
and hasattr(e, 'errno')
2013
and e.errno == errno.EPIPE):
2014
bzrlib.trace.note('broken pipe')
2017
bzrlib.trace.log_exception()
2021
if __name__ == '__main__':
2022
sys.exit(main(sys.argv))
added
removed
bzrlib/commands.py
