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.
34
from bzrlib.trace import mutter, note, log_error, warning
35
from bzrlib.errors import BzrError, BzrCheckError, BzrCommandError
36
from bzrlib.branch import find_branch
37
from bzrlib import BZRDIR
43
def register_command(cmd):
44
"Utility function to help register a command"
47
if k.startswith("cmd_"):
48
k_unsquished = _unsquish_command_name(k)
51
if not plugin_cmds.has_key(k_unsquished):
52
plugin_cmds[k_unsquished] = cmd
54
log_error('Two plugins defined the same command: %r' % k)
55
log_error('Not loading the one in %r' % sys.modules[cmd.__module__])
58
def _squish_command_name(cmd):
59
return 'cmd_' + cmd.replace('-', '_')
62
def _unsquish_command_name(cmd):
63
assert cmd.startswith("cmd_")
64
return cmd[4:].replace('_','-')
67
def _parse_revision_str(revstr):
68
"""This handles a revision string -> revno.
70
This always returns a list. The list will have one element for
72
It supports integers directly, but everything else it
73
defers for passing to Branch.get_revision_info()
75
>>> _parse_revision_str('234')
77
>>> _parse_revision_str('234..567')
79
>>> _parse_revision_str('..')
81
>>> _parse_revision_str('..234')
83
>>> _parse_revision_str('234..')
85
>>> _parse_revision_str('234..456..789') # Maybe this should be an error
87
>>> _parse_revision_str('234....789') # Error?
89
>>> _parse_revision_str('revid:test@other.com-234234')
90
['revid:test@other.com-234234']
91
>>> _parse_revision_str('revid:test@other.com-234234..revid:test@other.com-234235')
92
['revid:test@other.com-234234', 'revid:test@other.com-234235']
93
>>> _parse_revision_str('revid:test@other.com-234234..23')
94
['revid:test@other.com-234234', 23]
95
>>> _parse_revision_str('date:2005-04-12')
97
>>> _parse_revision_str('date:2005-04-12 12:24:33')
98
['date:2005-04-12 12:24:33']
99
>>> _parse_revision_str('date:2005-04-12T12:24:33')
100
['date:2005-04-12T12:24:33']
101
>>> _parse_revision_str('date:2005-04-12,12:24:33')
102
['date:2005-04-12,12:24:33']
103
>>> _parse_revision_str('-5..23')
105
>>> _parse_revision_str('-5')
107
>>> _parse_revision_str('123a')
109
>>> _parse_revision_str('abc')
113
old_format_re = re.compile('\d*:\d*')
114
m = old_format_re.match(revstr)
116
warning('Colon separator for revision numbers is deprecated.'
119
for rev in revstr.split(':'):
121
revs.append(int(rev))
126
for x in revstr.split('..'):
137
def get_merge_type(typestring):
138
"""Attempt to find the merge class/factory associated with a string."""
139
from merge import merge_types
141
return merge_types[typestring][0]
143
templ = '%s%%7s: %%s' % (' '*12)
144
lines = [templ % (f[0], f[1][1]) for f in merge_types.iteritems()]
145
type_list = '\n'.join(lines)
146
msg = "No known merge type %s. Supported types are:\n%s" %\
147
(typestring, type_list)
148
raise BzrCommandError(msg)
151
def get_merge_type(typestring):
152
"""Attempt to find the merge class/factory associated with a string."""
153
from merge import merge_types
155
return merge_types[typestring][0]
157
templ = '%s%%7s: %%s' % (' '*12)
158
lines = [templ % (f[0], f[1][1]) for f in merge_types.iteritems()]
159
type_list = '\n'.join(lines)
160
msg = "No known merge type %s. Supported types are:\n%s" %\
161
(typestring, type_list)
162
raise BzrCommandError(msg)
166
def _get_cmd_dict(plugins_override=True):
168
for k, v in globals().iteritems():
169
if k.startswith("cmd_"):
170
d[_unsquish_command_name(k)] = v
171
# If we didn't load plugins, the plugin_cmds dict will be empty
173
d.update(plugin_cmds)
175
d2 = plugin_cmds.copy()
181
def get_all_cmds(plugins_override=True):
182
"""Return canonical name and class for all registered commands."""
183
for k, v in _get_cmd_dict(plugins_override=plugins_override).iteritems():
187
def get_cmd_class(cmd, plugins_override=True):
188
"""Return the canonical name and command class for a command.
190
cmd = str(cmd) # not unicode
192
# first look up this command under the specified name
193
cmds = _get_cmd_dict(plugins_override=plugins_override)
195
return cmd, cmds[cmd]
199
# look for any command which claims this as an alias
200
for cmdname, cmdclass in cmds.iteritems():
201
if cmd in cmdclass.aliases:
202
return cmdname, cmdclass
204
cmdclass = ExternalCommand.find_command(cmd)
208
raise BzrCommandError("unknown command %r" % cmd)
211
class Command(object):
212
"""Base class for commands.
214
The docstring for an actual command should give a single-line
215
summary, then a complete description of the command. A grammar
216
description will be inserted.
219
List of argument forms, marked with whether they are optional,
223
List of options that may be given for this command.
226
If true, this command isn't advertised.
235
def __init__(self, options, arguments):
236
"""Construct and run the command.
238
Sets self.status to the return value of run()."""
239
assert isinstance(options, dict)
240
assert isinstance(arguments, dict)
241
cmdargs = options.copy()
242
cmdargs.update(arguments)
243
if self.__doc__ == Command.__doc__:
244
from warnings import warn
245
warn("No help message set for %r" % self)
246
self.status = self.run(**cmdargs)
247
if self.status is None:
252
"""Override this in sub-classes.
254
This is invoked with the options and arguments bound to
257
Return 0 or None if the command was successful, or a shell
263
class ExternalCommand(Command):
264
"""Class to wrap external commands.
266
We cheat a little here, when get_cmd_class() calls us we actually
267
give it back an object we construct that has the appropriate path,
268
help, options etc for the specified command.
270
When run_bzr() tries to instantiate that 'class' it gets caught by
271
the __call__ method, which we override to call the Command.__init__
272
method. That then calls our run method which is pretty straight
275
The only wrinkle is that we have to map bzr's dictionary of options
276
and arguments back into command line options and arguments for the
280
def find_command(cls, cmd):
282
bzrpath = os.environ.get('BZRPATH', '')
284
for dir in bzrpath.split(os.pathsep):
285
path = os.path.join(dir, cmd)
286
if os.path.isfile(path):
287
return ExternalCommand(path)
291
find_command = classmethod(find_command)
293
def __init__(self, path):
296
pipe = os.popen('%s --bzr-usage' % path, 'r')
297
self.takes_options = pipe.readline().split()
299
for opt in self.takes_options:
300
if not opt in OPTIONS:
301
raise BzrError("Unknown option '%s' returned by external command %s"
304
# TODO: Is there any way to check takes_args is valid here?
305
self.takes_args = pipe.readline().split()
307
if pipe.close() is not None:
308
raise BzrError("Failed funning '%s --bzr-usage'" % path)
310
pipe = os.popen('%s --bzr-help' % path, 'r')
311
self.__doc__ = pipe.read()
312
if pipe.close() is not None:
313
raise BzrError("Failed funning '%s --bzr-help'" % path)
315
def __call__(self, options, arguments):
316
Command.__init__(self, options, arguments)
319
def run(self, **kargs):
326
optname = name.replace('_','-')
328
if OPTIONS.has_key(optname):
330
opts.append('--%s' % optname)
331
if value is not None and value is not True:
332
opts.append(str(value))
334
# it's an arg, or arg list
335
if type(value) is not list:
341
self.status = os.spawnv(os.P_WAIT, self.path, [self.path] + opts + args)
345
class cmd_status(Command):
346
"""Display status summary.
348
This reports on versioned and unknown files, reporting them
349
grouped by state. Possible states are:
352
Versioned in the working copy but not in the previous revision.
355
Versioned in the previous revision but removed or deleted
359
Path of this file changed from the previous revision;
360
the text may also have changed. This includes files whose
361
parent directory was renamed.
364
Text has changed since the previous revision.
367
Nothing about this file has changed since the previous revision.
368
Only shown with --all.
371
Not versioned and not matching an ignore pattern.
373
To see ignored files use 'bzr ignored'. For details in the
374
changes to file texts, use 'bzr diff'.
376
If no arguments are specified, the status of the entire working
377
directory is shown. Otherwise, only the status of the specified
378
files or directories is reported. If a directory is given, status
379
is reported for everything inside that directory.
381
If a revision is specified, the changes since that revision are shown.
383
takes_args = ['file*']
384
takes_options = ['all', 'show-ids', 'revision']
385
aliases = ['st', 'stat']
387
def run(self, all=False, show_ids=False, file_list=None):
389
b = find_branch(file_list[0])
390
file_list = [b.relpath(x) for x in file_list]
391
# special case: only one path was given and it's the root
393
if file_list == ['']:
398
from bzrlib.status import show_status
399
show_status(b, show_unchanged=all, show_ids=show_ids,
400
specific_files=file_list)
403
class cmd_cat_revision(Command):
404
"""Write out metadata for a revision."""
407
takes_args = ['revision_id']
409
def run(self, revision_id):
410
from bzrlib.xml import pack_xml
411
pack_xml(find_branch('.').get_revision(revision_id), sys.stdout)
414
class cmd_revno(Command):
415
"""Show current revision number.
417
This is equal to the number of revisions on this branch."""
419
print find_branch('.').revno()
421
class cmd_revision_info(Command):
422
"""Show revision number and revision id for a given revision identifier.
425
takes_args = ['revision_info*']
426
takes_options = ['revision']
427
def run(self, revision=None, revision_info_list=None):
428
from bzrlib.branch import find_branch
431
if revision is not None:
432
revs.extend(revision)
433
if revision_info_list is not None:
434
revs.extend(revision_info_list)
436
raise BzrCommandError('You must supply a revision identifier')
441
print '%4d %s' % b.get_revision_info(rev)
444
class cmd_add(Command):
445
"""Add specified files or directories.
447
In non-recursive mode, all the named items are added, regardless
448
of whether they were previously ignored. A warning is given if
449
any of the named files are already versioned.
451
In recursive mode (the default), files are treated the same way
452
but the behaviour for directories is different. Directories that
453
are already versioned do not give a warning. All directories,
454
whether already versioned or not, are searched for files or
455
subdirectories that are neither versioned or ignored, and these
456
are added. This search proceeds recursively into versioned
457
directories. If no names are given '.' is assumed.
459
Therefore simply saying 'bzr add' will version all files that
460
are currently unknown.
462
TODO: Perhaps adding a file whose directly is not versioned should
463
recursively add that parent, rather than giving an error?
465
takes_args = ['file*']
466
takes_options = ['verbose', 'no-recurse']
468
def run(self, file_list, verbose=False, no_recurse=False):
469
from bzrlib.add import smart_add
470
smart_add(file_list, verbose, not no_recurse)
474
class cmd_mkdir(Command):
475
"""Create a new versioned directory.
477
This is equivalent to creating the directory and then adding it.
479
takes_args = ['dir+']
481
def run(self, dir_list):
488
b.add([d], verbose=True)
491
class cmd_relpath(Command):
492
"""Show path of a file relative to root"""
493
takes_args = ['filename']
496
def run(self, filename):
497
print find_branch(filename).relpath(filename)
501
class cmd_inventory(Command):
502
"""Show inventory of the current working copy or a revision."""
503
takes_options = ['revision', 'show-ids']
505
def run(self, revision=None, show_ids=False):
508
inv = b.read_working_inventory()
510
if len(revision) > 1:
511
raise BzrCommandError('bzr inventory --revision takes'
512
' exactly one revision identifier')
513
inv = b.get_revision_inventory(b.lookup_revision(revision[0]))
515
for path, entry in inv.entries():
517
print '%-50s %s' % (path, entry.file_id)
522
class cmd_move(Command):
523
"""Move files to a different directory.
528
The destination must be a versioned directory in the same branch.
530
takes_args = ['source$', 'dest']
531
def run(self, source_list, dest):
534
# TODO: glob expansion on windows?
535
b.move([b.relpath(s) for s in source_list], b.relpath(dest))
538
class cmd_rename(Command):
539
"""Change the name of an entry.
542
bzr rename frob.c frobber.c
543
bzr rename src/frob.c lib/frob.c
545
It is an error if the destination name exists.
547
See also the 'move' command, which moves files into a different
548
directory without changing their name.
550
TODO: Some way to rename multiple files without invoking bzr for each
552
takes_args = ['from_name', 'to_name']
554
def run(self, from_name, to_name):
556
b.rename_one(b.relpath(from_name), b.relpath(to_name))
560
class cmd_mv(Command):
561
"""Move or rename a file.
564
bzr mv OLDNAME NEWNAME
565
bzr mv SOURCE... DESTINATION
567
If the last argument is a versioned directory, all the other names
568
are moved into it. Otherwise, there must be exactly two arguments
569
and the file is changed to a new name, which must not already exist.
571
Files cannot be moved between branches.
573
takes_args = ['names*']
574
def run(self, names_list):
575
if len(names_list) < 2:
576
raise BzrCommandError("missing file argument")
577
b = find_branch(names_list[0])
579
rel_names = [b.relpath(x) for x in names_list]
581
if os.path.isdir(names_list[-1]):
582
# move into existing directory
583
b.move(rel_names[:-1], rel_names[-1])
585
if len(names_list) != 2:
586
raise BzrCommandError('to mv multiple files the destination '
587
'must be a versioned directory')
588
b.move(rel_names[0], rel_names[1])
593
class cmd_pull(Command):
594
"""Pull any changes from another branch into the current one.
596
If the location is omitted, the last-used location will be used.
597
Both the revision history and the working directory will be
600
This command only works on branches that have not diverged. Branches are
601
considered diverged if both branches have had commits without first
602
pulling from the other.
604
If branches have diverged, you can use 'bzr merge' to pull the text changes
605
from one into the other.
607
takes_args = ['location?']
609
def run(self, location=None):
610
from bzrlib.merge import merge
612
from shutil import rmtree
615
br_to = find_branch('.')
618
stored_loc = br_to.controlfile("x-pull", "rb").read().rstrip('\n')
620
if e.errno != errno.ENOENT:
623
if stored_loc is None:
624
raise BzrCommandError("No pull location known or specified.")
626
print "Using last location: %s" % stored_loc
627
location = stored_loc
628
cache_root = tempfile.mkdtemp()
629
from bzrlib.branch import DivergedBranches
630
br_from = find_branch(location)
631
location = pull_loc(br_from)
632
old_revno = br_to.revno()
634
from branch import find_cached_branch, DivergedBranches
635
br_from = find_cached_branch(location, cache_root)
636
location = pull_loc(br_from)
637
old_revno = br_to.revno()
639
br_to.update_revisions(br_from)
640
except DivergedBranches:
641
raise BzrCommandError("These branches have diverged."
644
merge(('.', -1), ('.', old_revno), check_clean=False)
645
if location != stored_loc:
646
br_to.controlfile("x-pull", "wb").write(location + "\n")
652
class cmd_branch(Command):
653
"""Create a new copy of a branch.
655
If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
656
be used. In other words, "branch ../foo/bar" will attempt to create ./bar.
658
To retrieve the branch as of a particular revision, supply the --revision
659
parameter, as in "branch foo/bar -r 5".
661
takes_args = ['from_location', 'to_location?']
662
takes_options = ['revision']
663
aliases = ['get', 'clone']
665
def run(self, from_location, to_location=None, revision=None):
667
from bzrlib.merge import merge
668
from bzrlib.branch import DivergedBranches, \
669
find_cached_branch, Branch
670
from shutil import rmtree
671
from meta_store import CachedStore
673
cache_root = tempfile.mkdtemp()
677
elif len(revision) > 1:
678
raise BzrCommandError('bzr branch --revision takes exactly 1 revision value')
682
br_from = find_cached_branch(from_location, cache_root)
684
if e.errno == errno.ENOENT:
685
raise BzrCommandError('Source location "%s" does not'
686
' exist.' % to_location)
690
if to_location is None:
691
to_location = os.path.basename(from_location.rstrip("/\\"))
694
os.mkdir(to_location)
696
if e.errno == errno.EEXIST:
697
raise BzrCommandError('Target directory "%s" already'
698
' exists.' % to_location)
699
if e.errno == errno.ENOENT:
700
raise BzrCommandError('Parent of "%s" does not exist.' %
704
br_to = Branch(to_location, init=True)
706
br_to.set_root_id(br_from.get_root_id())
709
if revision[0] is None:
710
revno = br_from.revno()
712
revno, rev_id = br_from.get_revision_info(revision[0])
714
br_to.update_revisions(br_from, stop_revision=revno)
715
except bzrlib.errors.NoSuchRevision:
717
msg = "The branch %s has no revision %d." % (from_location,
719
raise BzrCommandError(msg)
721
merge((to_location, -1), (to_location, 0), this_dir=to_location,
722
check_clean=False, ignore_zero=True)
723
from_location = pull_loc(br_from)
724
br_to.controlfile("x-pull", "wb").write(from_location + "\n")
729
def pull_loc(branch):
730
# TODO: Should perhaps just make attribute be 'base' in
731
# RemoteBranch and Branch?
732
if hasattr(branch, "baseurl"):
733
return branch.baseurl
739
class cmd_renames(Command):
740
"""Show list of renamed files.
742
TODO: Option to show renames between two historical versions.
744
TODO: Only show renames under dir, rather than in the whole branch.
746
takes_args = ['dir?']
748
def run(self, dir='.'):
750
old_inv = b.basis_tree().inventory
751
new_inv = b.read_working_inventory()
753
renames = list(bzrlib.tree.find_renames(old_inv, new_inv))
755
for old_name, new_name in renames:
756
print "%s => %s" % (old_name, new_name)
759
class cmd_info(Command):
760
"""Show statistical information about a branch."""
761
takes_args = ['branch?']
763
def run(self, branch=None):
766
b = find_branch(branch)
770
class cmd_remove(Command):
771
"""Make a file unversioned.
773
This makes bzr stop tracking changes to a versioned file. It does
774
not delete the working copy.
776
takes_args = ['file+']
777
takes_options = ['verbose']
779
def run(self, file_list, verbose=False):
780
b = find_branch(file_list[0])
781
b.remove([b.relpath(f) for f in file_list], verbose=verbose)
784
class cmd_file_id(Command):
785
"""Print file_id of a particular file or directory.
787
The file_id is assigned when the file is first added and remains the
788
same through all revisions where the file exists, even when it is
792
takes_args = ['filename']
793
def run(self, filename):
794
b = find_branch(filename)
795
i = b.inventory.path2id(b.relpath(filename))
797
raise BzrError("%r is not a versioned file" % filename)
802
class cmd_file_path(Command):
803
"""Print path of file_ids to a file or directory.
805
This prints one line for each directory down to the target,
806
starting at the branch root."""
808
takes_args = ['filename']
809
def run(self, filename):
810
b = find_branch(filename)
812
fid = inv.path2id(b.relpath(filename))
814
raise BzrError("%r is not a versioned file" % filename)
815
for fip in inv.get_idpath(fid):
819
class cmd_revision_history(Command):
820
"""Display list of revision ids on this branch."""
823
for patchid in find_branch('.').revision_history():
827
class cmd_directories(Command):
828
"""Display list of versioned directories in this branch."""
830
for name, ie in find_branch('.').read_working_inventory().directories():
837
class cmd_init(Command):
838
"""Make a directory into a versioned branch.
840
Use this to create an empty branch, or before importing an
843
Recipe for importing a tree of files:
848
bzr commit -m 'imported project'
851
from bzrlib.branch import Branch
852
Branch('.', init=True)
855
class cmd_diff(Command):
856
"""Show differences in working tree.
858
If files are listed, only the changes in those files are listed.
859
Otherwise, all changes for the tree are listed.
861
TODO: Allow diff across branches.
863
TODO: Option to use external diff command; could be GNU diff, wdiff,
866
TODO: Python difflib is not exactly the same as unidiff; should
867
either fix it up or prefer to use an external diff.
869
TODO: If a directory is given, diff everything under that.
871
TODO: Selected-file diff is inefficient and doesn't show you
874
TODO: This probably handles non-Unix newlines poorly.
882
takes_args = ['file*']
883
takes_options = ['revision', 'diff-options']
884
aliases = ['di', 'dif']
886
def run(self, revision=None, file_list=None, diff_options=None):
887
from bzrlib.diff import show_diff
892
b = find_branch(file_list[0])
893
file_list = [b.relpath(f) for f in file_list]
894
if file_list == ['']:
895
# just pointing to top-of-tree
900
if revision is not None:
901
if len(revision) == 1:
902
show_diff(b, revision[0], specific_files=file_list,
903
external_diff_options=diff_options)
904
elif len(revision) == 2:
905
show_diff(b, revision[0], specific_files=file_list,
906
external_diff_options=diff_options,
907
revision2=revision[1])
909
raise BzrCommandError('bzr diff --revision takes exactly one or two revision identifiers')
911
show_diff(b, None, specific_files=file_list,
912
external_diff_options=diff_options)
917
class cmd_deleted(Command):
918
"""List files deleted in the working tree.
920
TODO: Show files deleted since a previous revision, or between two revisions.
922
def run(self, show_ids=False):
925
new = b.working_tree()
927
## TODO: Much more efficient way to do this: read in new
928
## directories with readdir, rather than stating each one. Same
929
## level of effort but possibly much less IO. (Or possibly not,
930
## if the directories are very large...)
932
for path, ie in old.inventory.iter_entries():
933
if not new.has_id(ie.file_id):
935
print '%-50s %s' % (path, ie.file_id)
940
class cmd_modified(Command):
941
"""List files modified in working tree."""
944
from bzrlib.delta import compare_trees
947
td = compare_trees(b.basis_tree(), b.working_tree())
949
for path, id, kind in td.modified:
954
class cmd_added(Command):
955
"""List files added in working tree."""
959
wt = b.working_tree()
960
basis_inv = b.basis_tree().inventory
963
if file_id in basis_inv:
965
path = inv.id2path(file_id)
966
if not os.access(b.abspath(path), os.F_OK):
972
class cmd_root(Command):
973
"""Show the tree root directory.
975
The root is the nearest enclosing directory with a .bzr control
977
takes_args = ['filename?']
978
def run(self, filename=None):
979
"""Print the branch root."""
980
b = find_branch(filename)
981
print getattr(b, 'base', None) or getattr(b, 'baseurl')
984
class cmd_log(Command):
985
"""Show log of this branch.
987
To request a range of logs, you can use the command -r begin:end
988
-r revision requests a specific revision, -r :end or -r begin: are
991
--message allows you to give a regular expression, which will be evaluated
992
so that only matching entries will be displayed.
994
TODO: Make --revision support uuid: and hash: [future tag:] notation.
998
takes_args = ['filename?']
999
takes_options = ['forward', 'timezone', 'verbose', 'show-ids', 'revision',
1000
'long', 'message', 'short',]
1002
def run(self, filename=None, timezone='original',
1010
from bzrlib.branch import find_branch
1011
from bzrlib.log import log_formatter, show_log
1014
direction = (forward and 'forward') or 'reverse'
1017
b = find_branch(filename)
1018
fp = b.relpath(filename)
1020
file_id = b.read_working_inventory().path2id(fp)
1022
file_id = None # points to branch root
1024
b = find_branch('.')
1027
if revision is None:
1030
elif len(revision) == 1:
1031
rev1 = rev2 = b.get_revision_info(revision[0])[0]
1032
elif len(revision) == 2:
1033
rev1 = b.get_revision_info(revision[0])[0]
1034
rev2 = b.get_revision_info(revision[1])[0]
1036
raise BzrCommandError('bzr log --revision takes one or two values.')
1043
mutter('encoding log as %r' % bzrlib.user_encoding)
1045
# use 'replace' so that we don't abort if trying to write out
1046
# in e.g. the default C locale.
1047
outf = codecs.getwriter(bzrlib.user_encoding)(sys.stdout, errors='replace')
1052
log_format = 'short'
1053
lf = log_formatter(log_format,
1056
show_timezone=timezone)
1062
direction=direction,
1063
start_revision=rev1,
1069
class cmd_touching_revisions(Command):
1070
"""Return revision-ids which affected a particular file.
1072
A more user-friendly interface is "bzr log FILE"."""
1074
takes_args = ["filename"]
1075
def run(self, filename):
1076
b = find_branch(filename)
1077
inv = b.read_working_inventory()
1078
file_id = inv.path2id(b.relpath(filename))
1079
for revno, revision_id, what in bzrlib.log.find_touching_revisions(b, file_id):
1080
print "%6d %s" % (revno, what)
1083
class cmd_ls(Command):
1084
"""List files in a tree.
1086
TODO: Take a revision or remote path and list that tree instead.
1089
def run(self, revision=None, verbose=False):
1090
b = find_branch('.')
1091
if revision == None:
1092
tree = b.working_tree()
1094
tree = b.revision_tree(b.lookup_revision(revision))
1096
for fp, fc, kind, fid in tree.list_files():
1098
if kind == 'directory':
1100
elif kind == 'file':
1105
print '%-8s %s%s' % (fc, fp, kindch)
1111
class cmd_unknowns(Command):
1112
"""List unknown files."""
1114
from bzrlib.osutils import quotefn
1115
for f in find_branch('.').unknowns():
1120
class cmd_ignore(Command):
1121
"""Ignore a command or pattern.
1123
To remove patterns from the ignore list, edit the .bzrignore file.
1125
If the pattern contains a slash, it is compared to the whole path
1126
from the branch root. Otherwise, it is comapred to only the last
1127
component of the path.
1129
Ignore patterns are case-insensitive on case-insensitive systems.
1131
Note: wildcards must be quoted from the shell on Unix.
1134
bzr ignore ./Makefile
1135
bzr ignore '*.class'
1137
takes_args = ['name_pattern']
1139
def run(self, name_pattern):
1140
from bzrlib.atomicfile import AtomicFile
1143
b = find_branch('.')
1144
ifn = b.abspath('.bzrignore')
1146
if os.path.exists(ifn):
1149
igns = f.read().decode('utf-8')
1155
# TODO: If the file already uses crlf-style termination, maybe
1156
# we should use that for the newly added lines?
1158
if igns and igns[-1] != '\n':
1160
igns += name_pattern + '\n'
1163
f = AtomicFile(ifn, 'wt')
1164
f.write(igns.encode('utf-8'))
1169
inv = b.working_tree().inventory
1170
if inv.path2id('.bzrignore'):
1171
mutter('.bzrignore is already versioned')
1173
mutter('need to make new .bzrignore file versioned')
1174
b.add(['.bzrignore'])
1178
class cmd_ignored(Command):
1179
"""List ignored files and the patterns that matched them.
1181
See also: bzr ignore"""
1183
tree = find_branch('.').working_tree()
1184
for path, file_class, kind, file_id in tree.list_files():
1185
if file_class != 'I':
1187
## XXX: Slightly inefficient since this was already calculated
1188
pat = tree.is_ignored(path)
1189
print '%-50s %s' % (path, pat)
1192
class cmd_lookup_revision(Command):
1193
"""Lookup the revision-id from a revision-number
1196
bzr lookup-revision 33
1199
takes_args = ['revno']
1201
def run(self, revno):
1205
raise BzrCommandError("not a valid revision-number: %r" % revno)
1207
print find_branch('.').lookup_revision(revno)
1210
class cmd_export(Command):
1211
"""Export past revision to destination directory.
1213
If no revision is specified this exports the last committed revision.
1215
Format may be an "exporter" name, such as tar, tgz, tbz2. If none is
1216
given, try to find the format with the extension. If no extension
1217
is found exports to a directory (equivalent to --format=dir).
1219
Root may be the top directory for tar, tgz and tbz2 formats. If none
1220
is given, the top directory will be the root name of the file."""
1221
# TODO: list known exporters
1222
takes_args = ['dest']
1223
takes_options = ['revision', 'format', 'root']
1224
def run(self, dest, revision=None, format=None, root=None):
1226
b = find_branch('.')
1227
if revision is None:
1228
rev_id = b.last_patch()
1230
if len(revision) != 1:
1231
raise BzrError('bzr export --revision takes exactly 1 argument')
1232
revno, rev_id = b.get_revision_info(revision[0])
1233
t = b.revision_tree(rev_id)
1234
root, ext = os.path.splitext(dest)
1236
if ext in (".tar",):
1238
elif ext in (".gz", ".tgz"):
1240
elif ext in (".bz2", ".tbz2"):
1244
t.export(dest, format, root)
1247
class cmd_cat(Command):
1248
"""Write a file's text from a previous revision."""
1250
takes_options = ['revision']
1251
takes_args = ['filename']
1253
def run(self, filename, revision=None):
1254
if revision == None:
1255
raise BzrCommandError("bzr cat requires a revision number")
1256
elif len(revision) != 1:
1257
raise BzrCommandError("bzr cat --revision takes exactly one number")
1258
b = find_branch('.')
1259
b.print_file(b.relpath(filename), revision[0])
1262
class cmd_local_time_offset(Command):
1263
"""Show the offset in seconds from GMT to local time."""
1266
print bzrlib.osutils.local_time_offset()
1270
class cmd_commit(Command):
1271
"""Commit changes into a new revision.
1273
If no arguments are given, the entire tree is committed.
1275
If selected files are specified, only changes to those files are
1276
committed. If a directory is specified then the directory and everything
1277
within it is committed.
1279
A selected-file commit may fail in some cases where the committed
1280
tree would be invalid, such as trying to commit a file in a
1281
newly-added directory that is not itself committed.
1283
TODO: Run hooks on tree to-be-committed, and after commit.
1285
TODO: Strict commit that fails if there are unknown or deleted files.
1287
takes_args = ['selected*']
1288
takes_options = ['message', 'file', 'verbose', 'unchanged']
1289
aliases = ['ci', 'checkin']
1291
# TODO: Give better message for -s, --summary, used by tla people
1293
def run(self, message=None, file=None, verbose=True, selected_list=None,
1295
from bzrlib.errors import PointlessCommit
1296
from bzrlib.osutils import get_text_message
1298
## Warning: shadows builtin file()
1299
if not message and not file:
1300
# FIXME: Ugly; change status code to send to a provided function?
1304
catcher = cStringIO.StringIO()
1305
sys.stdout = catcher
1306
cmd_status({"file_list":selected_list}, {})
1307
info = catcher.getvalue()
1309
message = get_text_message(info)
1312
raise BzrCommandError("please specify a commit message",
1313
["use either --message or --file"])
1314
elif message and file:
1315
raise BzrCommandError("please specify either --message or --file")
1319
message = codecs.open(file, 'rt', bzrlib.user_encoding).read()
1321
b = find_branch('.')
1323
selected_list = [b.relpath(s) for s in selected_list]
1326
b.commit(message, verbose=verbose,
1327
specific_files=selected_list,
1328
allow_pointless=unchanged)
1329
except PointlessCommit:
1330
# FIXME: This should really happen before the file is read in;
1331
# perhaps prepare the commit; get the message; then actually commit
1332
raise BzrCommandError("no changes to commit",
1333
["use --unchanged to commit anyhow"])
1336
class cmd_check(Command):
1337
"""Validate consistency of branch history.
1339
This command checks various invariants about the branch storage to
1340
detect data corruption or bzr bugs.
1342
If given the --update flag, it will update some optional fields
1343
to help ensure data consistency.
1345
takes_args = ['dir?']
1347
def run(self, dir='.'):
1348
from bzrlib.check import check
1350
check(find_branch(dir))
1353
class cmd_scan_cache(Command):
1356
from bzrlib.hashcache import HashCache
1363
print '%6d stats' % c.stat_count
1364
print '%6d in hashcache' % len(c._cache)
1365
print '%6d files removed from cache' % c.removed_count
1366
print '%6d hashes updated' % c.update_count
1367
print '%6d files changed too recently to cache' % c.danger_count
1374
class cmd_upgrade(Command):
1375
"""Upgrade branch storage to current format.
1377
This should normally be used only after the check command tells
1380
takes_args = ['dir?']
1382
def run(self, dir='.'):
1383
from bzrlib.upgrade import upgrade
1384
upgrade(find_branch(dir))
1388
class cmd_whoami(Command):
1389
"""Show bzr user id."""
1390
takes_options = ['email']
1392
def run(self, email=False):
1394
b = bzrlib.branch.find_branch('.')
1399
print bzrlib.osutils.user_email(b)
1401
print bzrlib.osutils.username(b)
1404
class cmd_selftest(Command):
1405
"""Run internal test suite"""
1407
takes_options = ['verbose']
1408
def run(self, verbose=False):
1410
from bzrlib.selftest import selftest
1412
# we don't want progress meters from the tests to go to the
1415
save_ui = bzrlib.ui.ui_factory
1417
bzrlib.ui.ui_factory = bzrlib.ui.SilentUIFactory()
1418
return int(not selftest(verbose=verbose))
1420
bzrlib.ui.ui_factory = save_ui
1423
class cmd_version(Command):
1424
"""Show version of bzr."""
1429
print "bzr (bazaar-ng) %s" % bzrlib.__version__
1430
# is bzrlib itself in a branch?
1431
bzrrev = bzrlib.get_bzr_revision()
1433
print " (bzr checkout, revision %d {%s})" % bzrrev
1434
print bzrlib.__copyright__
1435
print "http://bazaar-ng.org/"
1437
print "bzr comes with ABSOLUTELY NO WARRANTY. bzr is free software, and"
1438
print "you may use, modify and redistribute it under the terms of the GNU"
1439
print "General Public License version 2 or later."
1442
class cmd_rocks(Command):
1443
"""Statement of optimism."""
1446
print "it sure does!"
1448
def parse_spec(spec):
1450
>>> parse_spec(None)
1452
>>> parse_spec("./")
1454
>>> parse_spec("../@")
1456
>>> parse_spec("../f/@35")
1458
>>> parse_spec('./@revid:john@arbash-meinel.com-20050711044610-3ca0327c6a222f67')
1459
['.', 'revid:john@arbash-meinel.com-20050711044610-3ca0327c6a222f67']
1464
parsed = spec.split('/@')
1465
assert len(parsed) == 2
1470
parsed[1] = int(parsed[1])
1472
pass # We can allow stuff like ./@revid:blahblahblah
1474
assert parsed[1] >=0
1476
parsed = [spec, None]
1481
class cmd_find_merge_base(Command):
1482
"""Find and print a base revision for merging two branches.
1484
TODO: Options to specify revisions on either side, as if
1485
merging only part of the history.
1487
takes_args = ['branch', 'other']
1490
def run(self, branch, other):
1491
branch1 = find_branch(branch)
1492
branch2 = find_branch(other)
1494
base_revno, base_revid = branch1.common_ancestor(branch2)
1496
if base_revno is None:
1497
raise bzrlib.errors.UnrelatedBranches()
1499
print 'merge base is revision %s' % base_revid
1500
print ' r%-6d in %s' % (base_revno, branch)
1502
other_revno = branch2.revision_id_to_revno(base_revid)
1504
print ' r%-6d in %s' % (other_revno, other)
1508
class cmd_merge(Command):
1509
"""Perform a three-way merge.
1511
The branch is the branch you will merge from. By default, it will merge
1512
the latest revision. If you specify a revision, that revision will be
1513
merged. If you specify two revisions, the first will be used as a BASE,
1514
and the second one as OTHER. Revision numbers are always relative to the
1519
To merge the latest revision from bzr.dev
1520
bzr merge ../bzr.dev
1522
To merge changes up to and including revision 82 from bzr.dev
1523
bzr merge -r 82 ../bzr.dev
1525
To merge the changes introduced by 82, without previous changes:
1526
bzr merge -r 81..82 ../bzr.dev
1528
merge refuses to run if there are any uncommitted changes, unless
1531
takes_args = ['branch?']
1532
takes_options = ['revision', 'force', 'merge-type']
1534
def run(self, branch='.', revision=None, force=False,
1536
from bzrlib.merge import merge
1537
from bzrlib.merge_core import ApplyMerge3
1538
if merge_type is None:
1539
merge_type = ApplyMerge3
1541
if revision is None or len(revision) < 1:
1543
other = (branch, -1)
1545
if len(revision) == 1:
1546
other = (branch, revision[0])
1549
assert len(revision) == 2
1550
if None in revision:
1551
raise BzrCommandError(
1552
"Merge doesn't permit that revision specifier.")
1553
base = (branch, revision[0])
1554
other = (branch, revision[1])
1556
merge(other, base, check_clean=(not force), merge_type=merge_type)
1559
class cmd_revert(Command):
1560
"""Reverse all changes since the last commit.
1562
Only versioned files are affected. Specify filenames to revert only
1563
those files. By default, any files that are changed will be backed up
1564
first. Backup files have a '~' appended to their name.
1566
takes_options = ['revision', 'no-backup']
1567
takes_args = ['file*']
1568
aliases = ['merge-revert']
1570
def run(self, revision=None, no_backup=False, file_list=None):
1571
from bzrlib.merge import merge
1572
if file_list is not None:
1573
if len(file_list) == 0:
1574
raise BzrCommandError("No files specified")
1575
if revision is None:
1577
elif len(revision) != 1:
1578
raise BzrCommandError('bzr revert --revision takes exactly 1 argument')
1579
merge(('.', revision[0]), parse_spec('.'),
1582
backup_files=not no_backup,
1583
file_list=file_list)
1586
class cmd_assert_fail(Command):
1587
"""Test reporting of assertion failures"""
1590
assert False, "always fails"
1593
class cmd_help(Command):
1594
"""Show help on a command or other topic.
1596
For a list of all available commands, say 'bzr help commands'."""
1597
takes_args = ['topic?']
1600
def run(self, topic=None):
1605
class cmd_shell_complete(Command):
1606
"""Show appropriate completions for context.
1608
For a list of all available commands, say 'bzr shell-complete'."""
1609
takes_args = ['context?']
1613
def run(self, context=None):
1614
import shellcomplete
1615
shellcomplete.shellcomplete(context)
1618
class cmd_missing(Command):
1619
"""What is missing in this branch relative to other branch.
1621
takes_args = ['remote?']
1622
aliases = ['mis', 'miss']
1623
# We don't have to add quiet to the list, because
1624
# unknown options are parsed as booleans
1625
takes_options = ['verbose', 'quiet']
1627
def run(self, remote=None, verbose=False, quiet=False):
1628
from bzrlib.branch import find_branch, DivergedBranches
1629
from bzrlib.errors import BzrCommandError
1630
from bzrlib.missing import get_parent, show_missing
1632
if verbose and quiet:
1633
raise BzrCommandError('Cannot pass both quiet and verbose')
1635
b = find_branch('.')
1636
parent = get_parent(b)
1639
raise BzrCommandError("No missing location known or specified.")
1642
print "Using last location: %s" % parent
1644
elif parent is None:
1645
# We only update x-pull if it did not exist, missing should not change the parent
1646
b.controlfile('x-pull', 'wb').write(remote + '\n')
1647
br_remote = find_branch(remote)
1649
return show_missing(b, br_remote, verbose=verbose, quiet=quiet)
1653
class cmd_plugins(Command):
1657
import bzrlib.plugin
1658
from inspect import getdoc
1659
from pprint import pprint
1660
for plugin in bzrlib.plugin.all_plugins:
1661
print plugin.__path__[0]
1664
print '\t', d.split('\n')[0]
1666
#pprint(bzrlib.plugin.all_plugins)
1670
# list of all available options; the rhs can be either None for an
1671
# option that takes no argument, or a constructor function that checks
1675
'diff-options': str,
1684
'revision': _parse_revision_str,
1696
'merge-type': get_merge_type,
1709
def parse_args(argv):
1710
"""Parse command line.
1712
Arguments and options are parsed at this level before being passed
1713
down to specific command handlers. This routine knows, from a
1714
lookup table, something about the available options, what optargs
1715
they take, and which commands will accept them.
1717
>>> parse_args('--help'.split())
1718
([], {'help': True})
1719
>>> parse_args('--version'.split())
1720
([], {'version': True})
1721
>>> parse_args('status --all'.split())
1722
(['status'], {'all': True})
1723
>>> parse_args('commit --message=biter'.split())
1724
(['commit'], {'message': u'biter'})
1725
>>> parse_args('log -r 500'.split())
1726
(['log'], {'revision': [500]})
1727
>>> parse_args('log -r500..600'.split())
1728
(['log'], {'revision': [500, 600]})
1729
>>> parse_args('log -vr500..600'.split())
1730
(['log'], {'verbose': True, 'revision': [500, 600]})
1731
>>> parse_args('log -rv500..600'.split()) #the r takes an argument
1732
(['log'], {'revision': ['v500', 600]})
1737
# TODO: Maybe handle '--' to end options?
1742
# option names must not be unicode
1746
mutter(" got option %r" % a)
1748
optname, optarg = a[2:].split('=', 1)
1751
if optname not in OPTIONS:
1752
raise BzrError('unknown long option %r' % a)
1755
if shortopt in SHORT_OPTIONS:
1756
# Multi-character options must have a space to delimit
1758
optname = SHORT_OPTIONS[shortopt]
1760
# Single character short options, can be chained,
1761
# and have their value appended to their name
1763
if shortopt not in SHORT_OPTIONS:
1764
# We didn't find the multi-character name, and we
1765
# didn't find the single char name
1766
raise BzrError('unknown short option %r' % a)
1767
optname = SHORT_OPTIONS[shortopt]
1770
# There are extra things on this option
1771
# see if it is the value, or if it is another
1773
optargfn = OPTIONS[optname]
1774
if optargfn is None:
1775
# This option does not take an argument, so the
1776
# next entry is another short option, pack it back
1778
argv.insert(0, '-' + a[2:])
1780
# This option takes an argument, so pack it
1785
# XXX: Do we ever want to support this, e.g. for -r?
1786
raise BzrError('repeated option %r' % a)
1788
optargfn = OPTIONS[optname]
1792
raise BzrError('option %r needs an argument' % a)
1794
optarg = argv.pop(0)
1795
opts[optname] = optargfn(optarg)
1798
raise BzrError('option %r takes no argument' % optname)
1799
opts[optname] = True
1808
def _match_argform(cmd, takes_args, args):
1811
# step through args and takes_args, allowing appropriate 0-many matches
1812
for ap in takes_args:
1816
argdict[argname] = args.pop(0)
1817
elif ap[-1] == '*': # all remaining arguments
1819
argdict[argname + '_list'] = args[:]
1822
argdict[argname + '_list'] = None
1825
raise BzrCommandError("command %r needs one or more %s"
1826
% (cmd, argname.upper()))
1828
argdict[argname + '_list'] = args[:]
1830
elif ap[-1] == '$': # all but one
1832
raise BzrCommandError("command %r needs one or more %s"
1833
% (cmd, argname.upper()))
1834
argdict[argname + '_list'] = args[:-1]
1840
raise BzrCommandError("command %r requires argument %s"
1841
% (cmd, argname.upper()))
1843
argdict[argname] = args.pop(0)
1846
raise BzrCommandError("extra argument to command %s: %s"
1854
"""Execute a command.
1856
This is similar to main(), but without all the trappings for
1857
logging and error handling.
1860
The command-line arguments, without the program name from argv[0]
1862
Returns a command status or raises an exception.
1864
Special master options: these must come before the command because
1865
they control how the command is interpreted.
1868
Do not load plugin modules at all
1871
Only use builtin commands. (Plugins are still allowed to change
1875
Run under the Python profiler.
1878
argv = [a.decode(bzrlib.user_encoding) for a in argv]
1880
opt_profile = opt_no_plugins = opt_builtin = False
1882
# --no-plugins is handled specially at a very early stage. We need
1883
# to load plugins before doing other command parsing so that they
1884
# can override commands, but this needs to happen first.
1887
if a == '--profile':
1889
elif a == '--no-plugins':
1890
opt_no_plugins = True
1891
elif a == '--builtin':
1897
if not opt_no_plugins:
1898
from bzrlib.plugin import load_plugins
1901
args, opts = parse_args(argv)
1904
from bzrlib.help import help
1911
if 'version' in opts:
1916
from bzrlib.help import help
1920
cmd = str(args.pop(0))
1922
canonical_cmd, cmd_class = \
1923
get_cmd_class(cmd, plugins_override=not opt_builtin)
1925
# check options are reasonable
1926
allowed = cmd_class.takes_options
1928
if oname not in allowed:
1929
raise BzrCommandError("option '--%s' is not allowed for command %r"
1932
# mix arguments and options into one dictionary
1933
cmdargs = _match_argform(cmd, cmd_class.takes_args, args)
1935
for k, v in opts.items():
1936
cmdopts[k.replace('-', '_')] = v
1939
import hotshot, tempfile
1940
pffileno, pfname = tempfile.mkstemp()
1942
prof = hotshot.Profile(pfname)
1943
ret = prof.runcall(cmd_class, cmdopts, cmdargs) or 0
1946
import hotshot.stats
1947
stats = hotshot.stats.load(pfname)
1949
stats.sort_stats('time')
1950
## XXX: Might like to write to stderr or the trace file instead but
1951
## print_stats seems hardcoded to stdout
1952
stats.print_stats(20)
1960
return cmd_class(cmdopts, cmdargs).status
1966
bzrlib.trace.open_tracefile(argv)
1968
bzrlib.ui.ui_factory = bzrlib.ui.TextUIFactory()
1972
return run_bzr(argv[1:])
1974
# do this here inside the exception wrappers to catch EPIPE
1976
except BzrCommandError, e:
1977
# command line syntax error, etc
1981
bzrlib.trace.log_exception()
1983
except AssertionError, e:
1984
bzrlib.trace.log_exception('assertion failed: ' + str(e))
1986
except KeyboardInterrupt, e:
1987
bzrlib.trace.note('interrupted')
1989
except Exception, e:
1991
if (isinstance(e, IOError)
1992
and hasattr(e, 'errno')
1993
and e.errno == errno.EPIPE):
1994
bzrlib.trace.note('broken pipe')
1997
bzrlib.trace.log_exception()
2001
if __name__ == '__main__':
2002
sys.exit(main(sys.argv))
added
removed
bzrlib/commands.py
