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.
27
from bzrlib.trace import mutter, note, log_error, warning
28
from bzrlib.errors import BzrError, BzrCheckError, BzrCommandError
29
from bzrlib.branch import find_branch
30
from bzrlib import BZRDIR
36
def register_command(cmd):
37
"Utility function to help register a command"
40
if k.startswith("cmd_"):
41
k_unsquished = _unsquish_command_name(k)
44
if not plugin_cmds.has_key(k_unsquished):
45
plugin_cmds[k_unsquished] = cmd
47
log_error('Two plugins defined the same command: %r' % k)
48
log_error('Not loading the one in %r' % sys.modules[cmd.__module__])
51
def _squish_command_name(cmd):
52
return 'cmd_' + cmd.replace('-', '_')
55
def _unsquish_command_name(cmd):
56
assert cmd.startswith("cmd_")
57
return cmd[4:].replace('_','-')
60
def _parse_revision_str(revstr):
61
"""This handles a revision string -> revno.
63
This always returns a list. The list will have one element for
65
It supports integers directly, but everything else it
66
defers for passing to Branch.get_revision_info()
68
>>> _parse_revision_str('234')
70
>>> _parse_revision_str('234..567')
72
>>> _parse_revision_str('..')
74
>>> _parse_revision_str('..234')
76
>>> _parse_revision_str('234..')
78
>>> _parse_revision_str('234..456..789') # Maybe this should be an error
80
>>> _parse_revision_str('234....789') # Error?
82
>>> _parse_revision_str('revid:test@other.com-234234')
83
['revid:test@other.com-234234']
84
>>> _parse_revision_str('revid:test@other.com-234234..revid:test@other.com-234235')
85
['revid:test@other.com-234234', 'revid:test@other.com-234235']
86
>>> _parse_revision_str('revid:test@other.com-234234..23')
87
['revid:test@other.com-234234', 23]
88
>>> _parse_revision_str('date:2005-04-12')
90
>>> _parse_revision_str('date:2005-04-12 12:24:33')
91
['date:2005-04-12 12:24:33']
92
>>> _parse_revision_str('date:2005-04-12T12:24:33')
93
['date:2005-04-12T12:24:33']
94
>>> _parse_revision_str('date:2005-04-12,12:24:33')
95
['date:2005-04-12,12:24:33']
96
>>> _parse_revision_str('-5..23')
98
>>> _parse_revision_str('-5')
100
>>> _parse_revision_str('123a')
102
>>> _parse_revision_str('abc')
106
old_format_re = re.compile('\d*:\d*')
107
m = old_format_re.match(revstr)
109
warning('Colon separator for revision numbers is deprecated.'
112
for rev in revstr.split(':'):
114
revs.append(int(rev))
119
for x in revstr.split('..'):
130
def get_merge_type(typestring):
131
"""Attempt to find the merge class/factory associated with a string."""
132
from merge import merge_types
134
return merge_types[typestring][0]
136
templ = '%s%%7s: %%s' % (' '*12)
137
lines = [templ % (f[0], f[1][1]) for f in merge_types.iteritems()]
138
type_list = '\n'.join(lines)
139
msg = "No known merge type %s. Supported types are:\n%s" %\
140
(typestring, type_list)
141
raise BzrCommandError(msg)
144
def get_merge_type(typestring):
145
"""Attempt to find the merge class/factory associated with a string."""
146
from merge import merge_types
148
return merge_types[typestring][0]
150
templ = '%s%%7s: %%s' % (' '*12)
151
lines = [templ % (f[0], f[1][1]) for f in merge_types.iteritems()]
152
type_list = '\n'.join(lines)
153
msg = "No known merge type %s. Supported types are:\n%s" %\
154
(typestring, type_list)
155
raise BzrCommandError(msg)
159
def _get_cmd_dict(plugins_override=True):
161
for k, v in globals().iteritems():
162
if k.startswith("cmd_"):
163
d[_unsquish_command_name(k)] = v
164
# If we didn't load plugins, the plugin_cmds dict will be empty
166
d.update(plugin_cmds)
168
d2 = plugin_cmds.copy()
174
def get_all_cmds(plugins_override=True):
175
"""Return canonical name and class for all registered commands."""
176
for k, v in _get_cmd_dict(plugins_override=plugins_override).iteritems():
180
def get_cmd_class(cmd, plugins_override=True):
181
"""Return the canonical name and command class for a command.
183
cmd = str(cmd) # not unicode
185
# first look up this command under the specified name
186
cmds = _get_cmd_dict(plugins_override=plugins_override)
188
return cmd, cmds[cmd]
192
# look for any command which claims this as an alias
193
for cmdname, cmdclass in cmds.iteritems():
194
if cmd in cmdclass.aliases:
195
return cmdname, cmdclass
197
cmdclass = ExternalCommand.find_command(cmd)
201
raise BzrCommandError("unknown command %r" % cmd)
204
class Command(object):
205
"""Base class for commands.
207
The docstring for an actual command should give a single-line
208
summary, then a complete description of the command. A grammar
209
description will be inserted.
212
List of argument forms, marked with whether they are optional,
216
List of options that may be given for this command.
219
If true, this command isn't advertised.
228
def __init__(self, options, arguments):
229
"""Construct and run the command.
231
Sets self.status to the return value of run()."""
232
assert isinstance(options, dict)
233
assert isinstance(arguments, dict)
234
cmdargs = options.copy()
235
cmdargs.update(arguments)
236
if self.__doc__ == Command.__doc__:
237
from warnings import warn
238
warn("No help message set for %r" % self)
239
self.status = self.run(**cmdargs)
240
if self.status is None:
245
"""Override this in sub-classes.
247
This is invoked with the options and arguments bound to
250
Return 0 or None if the command was successful, or a shell
256
class ExternalCommand(Command):
257
"""Class to wrap external commands.
259
We cheat a little here, when get_cmd_class() calls us we actually
260
give it back an object we construct that has the appropriate path,
261
help, options etc for the specified command.
263
When run_bzr() tries to instantiate that 'class' it gets caught by
264
the __call__ method, which we override to call the Command.__init__
265
method. That then calls our run method which is pretty straight
268
The only wrinkle is that we have to map bzr's dictionary of options
269
and arguments back into command line options and arguments for the
273
def find_command(cls, cmd):
275
bzrpath = os.environ.get('BZRPATH', '')
277
for dir in bzrpath.split(os.pathsep):
278
path = os.path.join(dir, cmd)
279
if os.path.isfile(path):
280
return ExternalCommand(path)
284
find_command = classmethod(find_command)
286
def __init__(self, path):
289
pipe = os.popen('%s --bzr-usage' % path, 'r')
290
self.takes_options = pipe.readline().split()
292
for opt in self.takes_options:
293
if not opt in OPTIONS:
294
raise BzrError("Unknown option '%s' returned by external command %s"
297
# TODO: Is there any way to check takes_args is valid here?
298
self.takes_args = pipe.readline().split()
300
if pipe.close() is not None:
301
raise BzrError("Failed funning '%s --bzr-usage'" % path)
303
pipe = os.popen('%s --bzr-help' % path, 'r')
304
self.__doc__ = pipe.read()
305
if pipe.close() is not None:
306
raise BzrError("Failed funning '%s --bzr-help'" % path)
308
def __call__(self, options, arguments):
309
Command.__init__(self, options, arguments)
312
def run(self, **kargs):
319
optname = name.replace('_','-')
321
if OPTIONS.has_key(optname):
323
opts.append('--%s' % optname)
324
if value is not None and value is not True:
325
opts.append(str(value))
327
# it's an arg, or arg list
328
if type(value) is not list:
334
self.status = os.spawnv(os.P_WAIT, self.path, [self.path] + opts + args)
338
class cmd_status(Command):
339
"""Display status summary.
341
This reports on versioned and unknown files, reporting them
342
grouped by state. Possible states are:
345
Versioned in the working copy but not in the previous revision.
348
Versioned in the previous revision but removed or deleted
352
Path of this file changed from the previous revision;
353
the text may also have changed. This includes files whose
354
parent directory was renamed.
357
Text has changed since the previous revision.
360
Nothing about this file has changed since the previous revision.
361
Only shown with --all.
364
Not versioned and not matching an ignore pattern.
366
To see ignored files use 'bzr ignored'. For details in the
367
changes to file texts, use 'bzr diff'.
369
If no arguments are specified, the status of the entire working
370
directory is shown. Otherwise, only the status of the specified
371
files or directories is reported. If a directory is given, status
372
is reported for everything inside that directory.
374
If a revision is specified, the changes since that revision are shown.
376
takes_args = ['file*']
377
takes_options = ['all', 'show-ids', 'revision']
378
aliases = ['st', 'stat']
380
def run(self, all=False, show_ids=False, file_list=None):
382
b = find_branch(file_list[0])
383
file_list = [b.relpath(x) for x in file_list]
384
# special case: only one path was given and it's the root
386
if file_list == ['']:
391
from bzrlib.status import show_status
392
show_status(b, show_unchanged=all, show_ids=show_ids,
393
specific_files=file_list)
396
class cmd_cat_revision(Command):
397
"""Write out metadata for a revision."""
400
takes_args = ['revision_id']
402
def run(self, revision_id):
403
from bzrlib.xml import pack_xml
404
pack_xml(find_branch('.').get_revision(revision_id), sys.stdout)
407
class cmd_revno(Command):
408
"""Show current revision number.
410
This is equal to the number of revisions on this branch."""
412
print find_branch('.').revno()
414
class cmd_revision_info(Command):
415
"""Show revision number and revision id for a given revision identifier.
418
takes_args = ['revision_info*']
419
takes_options = ['revision']
420
def run(self, revision=None, revision_info_list=None):
421
from bzrlib.branch import find_branch
424
if revision is not None:
425
revs.extend(revision)
426
if revision_info_list is not None:
427
revs.extend(revision_info_list)
429
raise BzrCommandError('You must supply a revision identifier')
434
print '%4d %s' % b.get_revision_info(rev)
437
class cmd_add(Command):
438
"""Add specified files or directories.
440
In non-recursive mode, all the named items are added, regardless
441
of whether they were previously ignored. A warning is given if
442
any of the named files are already versioned.
444
In recursive mode (the default), files are treated the same way
445
but the behaviour for directories is different. Directories that
446
are already versioned do not give a warning. All directories,
447
whether already versioned or not, are searched for files or
448
subdirectories that are neither versioned or ignored, and these
449
are added. This search proceeds recursively into versioned
450
directories. If no names are given '.' is assumed.
452
Therefore simply saying 'bzr add' will version all files that
453
are currently unknown.
455
TODO: Perhaps adding a file whose directly is not versioned should
456
recursively add that parent, rather than giving an error?
458
takes_args = ['file*']
459
takes_options = ['verbose', 'no-recurse']
461
def run(self, file_list, verbose=False, no_recurse=False):
462
from bzrlib.add import smart_add
463
smart_add(file_list, verbose, not no_recurse)
467
class cmd_mkdir(Command):
468
"""Create a new versioned directory.
470
This is equivalent to creating the directory and then adding it.
472
takes_args = ['dir+']
474
def run(self, dir_list):
481
b.add([d], verbose=True)
484
class cmd_relpath(Command):
485
"""Show path of a file relative to root"""
486
takes_args = ['filename']
489
def run(self, filename):
490
print find_branch(filename).relpath(filename)
494
class cmd_inventory(Command):
495
"""Show inventory of the current working copy or a revision."""
496
takes_options = ['revision', 'show-ids']
498
def run(self, revision=None, show_ids=False):
501
inv = b.read_working_inventory()
503
if len(revision) > 1:
504
raise BzrCommandError('bzr inventory --revision takes'
505
' exactly one revision identifier')
506
inv = b.get_revision_inventory(b.lookup_revision(revision[0]))
508
for path, entry in inv.entries():
510
print '%-50s %s' % (path, entry.file_id)
515
class cmd_move(Command):
516
"""Move files to a different directory.
521
The destination must be a versioned directory in the same branch.
523
takes_args = ['source$', 'dest']
524
def run(self, source_list, dest):
527
# TODO: glob expansion on windows?
528
b.move([b.relpath(s) for s in source_list], b.relpath(dest))
531
class cmd_rename(Command):
532
"""Change the name of an entry.
535
bzr rename frob.c frobber.c
536
bzr rename src/frob.c lib/frob.c
538
It is an error if the destination name exists.
540
See also the 'move' command, which moves files into a different
541
directory without changing their name.
543
TODO: Some way to rename multiple files without invoking bzr for each
545
takes_args = ['from_name', 'to_name']
547
def run(self, from_name, to_name):
549
b.rename_one(b.relpath(from_name), b.relpath(to_name))
553
class cmd_mv(Command):
554
"""Move or rename a file.
557
bzr mv OLDNAME NEWNAME
558
bzr mv SOURCE... DESTINATION
560
If the last argument is a versioned directory, all the other names
561
are moved into it. Otherwise, there must be exactly two arguments
562
and the file is changed to a new name, which must not already exist.
564
Files cannot be moved between branches.
566
takes_args = ['names*']
567
def run(self, names_list):
568
if len(names_list) < 2:
569
raise BzrCommandError("missing file argument")
570
b = find_branch(names_list[0])
572
rel_names = [b.relpath(x) for x in names_list]
574
if os.path.isdir(names_list[-1]):
575
# move into existing directory
576
b.move(rel_names[:-1], rel_names[-1])
578
if len(names_list) != 2:
579
raise BzrCommandError('to mv multiple files the destination '
580
'must be a versioned directory')
581
b.move(rel_names[0], rel_names[1])
586
class cmd_pull(Command):
587
"""Pull any changes from another branch into the current one.
589
If the location is omitted, the last-used location will be used.
590
Both the revision history and the working directory will be
593
This command only works on branches that have not diverged. Branches are
594
considered diverged if both branches have had commits without first
595
pulling from the other.
597
If branches have diverged, you can use 'bzr merge' to pull the text changes
598
from one into the other.
600
takes_args = ['location?']
602
def run(self, location=None):
603
from bzrlib.merge import merge
605
from shutil import rmtree
608
br_to = find_branch('.')
611
stored_loc = br_to.controlfile("x-pull", "rb").read().rstrip('\n')
613
if e.errno != errno.ENOENT:
616
if stored_loc is None:
617
raise BzrCommandError("No pull location known or specified.")
619
print "Using last location: %s" % stored_loc
620
location = stored_loc
621
cache_root = tempfile.mkdtemp()
622
from bzrlib.branch import DivergedBranches
623
br_from = find_branch(location)
624
location = pull_loc(br_from)
625
old_revno = br_to.revno()
627
from branch import find_cached_branch, DivergedBranches
628
br_from = find_cached_branch(location, cache_root)
629
location = pull_loc(br_from)
630
old_revno = br_to.revno()
632
br_to.update_revisions(br_from)
633
except DivergedBranches:
634
raise BzrCommandError("These branches have diverged."
637
merge(('.', -1), ('.', old_revno), check_clean=False)
638
if location != stored_loc:
639
br_to.controlfile("x-pull", "wb").write(location + "\n")
645
class cmd_branch(Command):
646
"""Create a new copy of a branch.
648
If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
649
be used. In other words, "branch ../foo/bar" will attempt to create ./bar.
651
To retrieve the branch as of a particular revision, supply the --revision
652
parameter, as in "branch foo/bar -r 5".
654
takes_args = ['from_location', 'to_location?']
655
takes_options = ['revision']
656
aliases = ['get', 'clone']
658
def run(self, from_location, to_location=None, revision=None):
660
from bzrlib.merge import merge
661
from bzrlib.branch import DivergedBranches, \
662
find_cached_branch, Branch
663
from shutil import rmtree
664
from meta_store import CachedStore
666
cache_root = tempfile.mkdtemp()
670
elif len(revision) > 1:
671
raise BzrCommandError('bzr branch --revision takes exactly 1 revision value')
675
br_from = find_cached_branch(from_location, cache_root)
677
if e.errno == errno.ENOENT:
678
raise BzrCommandError('Source location "%s" does not'
679
' exist.' % to_location)
683
if to_location is None:
684
to_location = os.path.basename(from_location.rstrip("/\\"))
687
os.mkdir(to_location)
689
if e.errno == errno.EEXIST:
690
raise BzrCommandError('Target directory "%s" already'
691
' exists.' % to_location)
692
if e.errno == errno.ENOENT:
693
raise BzrCommandError('Parent of "%s" does not exist.' %
697
br_to = Branch(to_location, init=True)
699
br_to.set_root_id(br_from.get_root_id())
702
if revision[0] is None:
703
revno = br_from.revno()
705
revno, rev_id = br_from.get_revision_info(revision[0])
707
br_to.update_revisions(br_from, stop_revision=revno)
708
except bzrlib.errors.NoSuchRevision:
710
msg = "The branch %s has no revision %d." % (from_location,
712
raise BzrCommandError(msg)
714
merge((to_location, -1), (to_location, 0), this_dir=to_location,
715
check_clean=False, ignore_zero=True)
716
from_location = pull_loc(br_from)
717
br_to.controlfile("x-pull", "wb").write(from_location + "\n")
722
def pull_loc(branch):
723
# TODO: Should perhaps just make attribute be 'base' in
724
# RemoteBranch and Branch?
725
if hasattr(branch, "baseurl"):
726
return branch.baseurl
732
class cmd_renames(Command):
733
"""Show list of renamed files.
735
TODO: Option to show renames between two historical versions.
737
TODO: Only show renames under dir, rather than in the whole branch.
739
takes_args = ['dir?']
741
def run(self, dir='.'):
743
old_inv = b.basis_tree().inventory
744
new_inv = b.read_working_inventory()
746
renames = list(bzrlib.tree.find_renames(old_inv, new_inv))
748
for old_name, new_name in renames:
749
print "%s => %s" % (old_name, new_name)
752
class cmd_info(Command):
753
"""Show statistical information about a branch."""
754
takes_args = ['branch?']
756
def run(self, branch=None):
759
b = find_branch(branch)
763
class cmd_remove(Command):
764
"""Make a file unversioned.
766
This makes bzr stop tracking changes to a versioned file. It does
767
not delete the working copy.
769
takes_args = ['file+']
770
takes_options = ['verbose']
772
def run(self, file_list, verbose=False):
773
b = find_branch(file_list[0])
774
b.remove([b.relpath(f) for f in file_list], verbose=verbose)
777
class cmd_file_id(Command):
778
"""Print file_id of a particular file or directory.
780
The file_id is assigned when the file is first added and remains the
781
same through all revisions where the file exists, even when it is
785
takes_args = ['filename']
786
def run(self, filename):
787
b = find_branch(filename)
788
i = b.inventory.path2id(b.relpath(filename))
790
raise BzrError("%r is not a versioned file" % filename)
795
class cmd_file_path(Command):
796
"""Print path of file_ids to a file or directory.
798
This prints one line for each directory down to the target,
799
starting at the branch root."""
801
takes_args = ['filename']
802
def run(self, filename):
803
b = find_branch(filename)
805
fid = inv.path2id(b.relpath(filename))
807
raise BzrError("%r is not a versioned file" % filename)
808
for fip in inv.get_idpath(fid):
812
class cmd_revision_history(Command):
813
"""Display list of revision ids on this branch."""
816
for patchid in find_branch('.').revision_history():
820
class cmd_directories(Command):
821
"""Display list of versioned directories in this branch."""
823
for name, ie in find_branch('.').read_working_inventory().directories():
830
class cmd_init(Command):
831
"""Make a directory into a versioned branch.
833
Use this to create an empty branch, or before importing an
836
Recipe for importing a tree of files:
841
bzr commit -m 'imported project'
844
from bzrlib.branch import Branch
845
Branch('.', init=True)
848
class cmd_diff(Command):
849
"""Show differences in working tree.
851
If files are listed, only the changes in those files are listed.
852
Otherwise, all changes for the tree are listed.
854
TODO: Allow diff across branches.
856
TODO: Option to use external diff command; could be GNU diff, wdiff,
859
TODO: Python difflib is not exactly the same as unidiff; should
860
either fix it up or prefer to use an external diff.
862
TODO: If a directory is given, diff everything under that.
864
TODO: Selected-file diff is inefficient and doesn't show you
867
TODO: This probably handles non-Unix newlines poorly.
875
takes_args = ['file*']
876
takes_options = ['revision', 'diff-options']
877
aliases = ['di', 'dif']
879
def run(self, revision=None, file_list=None, diff_options=None):
880
from bzrlib.diff import show_diff
883
b = find_branch(file_list[0])
884
file_list = [b.relpath(f) for f in file_list]
885
if file_list == ['']:
886
# just pointing to top-of-tree
891
if revision is not None:
892
if len(revision) == 1:
893
show_diff(b, revision[0], specific_files=file_list,
894
external_diff_options=diff_options)
895
elif len(revision) == 2:
896
show_diff(b, revision[0], specific_files=file_list,
897
external_diff_options=diff_options,
898
revision2=revision[1])
900
raise BzrCommandError('bzr diff --revision takes exactly one or two revision identifiers')
902
show_diff(b, None, specific_files=file_list,
903
external_diff_options=diff_options)
908
class cmd_deleted(Command):
909
"""List files deleted in the working tree.
911
TODO: Show files deleted since a previous revision, or between two revisions.
913
def run(self, show_ids=False):
916
new = b.working_tree()
918
## TODO: Much more efficient way to do this: read in new
919
## directories with readdir, rather than stating each one. Same
920
## level of effort but possibly much less IO. (Or possibly not,
921
## if the directories are very large...)
923
for path, ie in old.inventory.iter_entries():
924
if not new.has_id(ie.file_id):
926
print '%-50s %s' % (path, ie.file_id)
931
class cmd_modified(Command):
932
"""List files modified in working tree."""
935
from bzrlib.delta import compare_trees
938
td = compare_trees(b.basis_tree(), b.working_tree())
940
for path, id, kind in td.modified:
945
class cmd_added(Command):
946
"""List files added in working tree."""
950
wt = b.working_tree()
951
basis_inv = b.basis_tree().inventory
954
if file_id in basis_inv:
956
path = inv.id2path(file_id)
957
if not os.access(b.abspath(path), os.F_OK):
963
class cmd_root(Command):
964
"""Show the tree root directory.
966
The root is the nearest enclosing directory with a .bzr control
968
takes_args = ['filename?']
969
def run(self, filename=None):
970
"""Print the branch root."""
971
b = find_branch(filename)
972
print getattr(b, 'base', None) or getattr(b, 'baseurl')
975
class cmd_log(Command):
976
"""Show log of this branch.
978
To request a range of logs, you can use the command -r begin:end
979
-r revision requests a specific revision, -r :end or -r begin: are
982
--message allows you to give a regular expression, which will be evaluated
983
so that only matching entries will be displayed.
985
TODO: Make --revision support uuid: and hash: [future tag:] notation.
989
takes_args = ['filename?']
990
takes_options = ['forward', 'timezone', 'verbose', 'show-ids', 'revision','long', 'message']
992
def run(self, filename=None, timezone='original',
999
from bzrlib.branch import find_branch
1000
from bzrlib.log import log_formatter, show_log
1003
direction = (forward and 'forward') or 'reverse'
1006
b = find_branch(filename)
1007
fp = b.relpath(filename)
1009
file_id = b.read_working_inventory().path2id(fp)
1011
file_id = None # points to branch root
1013
b = find_branch('.')
1016
if revision is None:
1019
elif len(revision) == 1:
1020
rev1 = rev2 = b.get_revision_info(revision[0])[0]
1021
elif len(revision) == 2:
1022
rev1 = b.get_revision_info(revision[0])[0]
1023
rev2 = b.get_revision_info(revision[1])[0]
1025
raise BzrCommandError('bzr log --revision takes one or two values.')
1032
mutter('encoding log as %r' % bzrlib.user_encoding)
1034
# use 'replace' so that we don't abort if trying to write out
1035
# in e.g. the default C locale.
1036
outf = codecs.getwriter(bzrlib.user_encoding)(sys.stdout, errors='replace')
1041
log_format = 'short'
1042
lf = log_formatter(log_format,
1045
show_timezone=timezone)
1051
direction=direction,
1052
start_revision=rev1,
1058
class cmd_touching_revisions(Command):
1059
"""Return revision-ids which affected a particular file.
1061
A more user-friendly interface is "bzr log FILE"."""
1063
takes_args = ["filename"]
1064
def run(self, filename):
1065
b = find_branch(filename)
1066
inv = b.read_working_inventory()
1067
file_id = inv.path2id(b.relpath(filename))
1068
for revno, revision_id, what in bzrlib.log.find_touching_revisions(b, file_id):
1069
print "%6d %s" % (revno, what)
1072
class cmd_ls(Command):
1073
"""List files in a tree.
1075
TODO: Take a revision or remote path and list that tree instead.
1078
def run(self, revision=None, verbose=False):
1079
b = find_branch('.')
1080
if revision == None:
1081
tree = b.working_tree()
1083
tree = b.revision_tree(b.lookup_revision(revision))
1085
for fp, fc, kind, fid in tree.list_files():
1087
if kind == 'directory':
1089
elif kind == 'file':
1094
print '%-8s %s%s' % (fc, fp, kindch)
1100
class cmd_unknowns(Command):
1101
"""List unknown files."""
1103
from bzrlib.osutils import quotefn
1104
for f in find_branch('.').unknowns():
1109
class cmd_ignore(Command):
1110
"""Ignore a command or pattern.
1112
To remove patterns from the ignore list, edit the .bzrignore file.
1114
If the pattern contains a slash, it is compared to the whole path
1115
from the branch root. Otherwise, it is comapred to only the last
1116
component of the path.
1118
Ignore patterns are case-insensitive on case-insensitive systems.
1120
Note: wildcards must be quoted from the shell on Unix.
1123
bzr ignore ./Makefile
1124
bzr ignore '*.class'
1126
takes_args = ['name_pattern']
1128
def run(self, name_pattern):
1129
from bzrlib.atomicfile import AtomicFile
1132
b = find_branch('.')
1133
ifn = b.abspath('.bzrignore')
1135
if os.path.exists(ifn):
1138
igns = f.read().decode('utf-8')
1144
# TODO: If the file already uses crlf-style termination, maybe
1145
# we should use that for the newly added lines?
1147
if igns and igns[-1] != '\n':
1149
igns += name_pattern + '\n'
1152
f = AtomicFile(ifn, 'wt')
1153
f.write(igns.encode('utf-8'))
1158
inv = b.working_tree().inventory
1159
if inv.path2id('.bzrignore'):
1160
mutter('.bzrignore is already versioned')
1162
mutter('need to make new .bzrignore file versioned')
1163
b.add(['.bzrignore'])
1167
class cmd_ignored(Command):
1168
"""List ignored files and the patterns that matched them.
1170
See also: bzr ignore"""
1172
tree = find_branch('.').working_tree()
1173
for path, file_class, kind, file_id in tree.list_files():
1174
if file_class != 'I':
1176
## XXX: Slightly inefficient since this was already calculated
1177
pat = tree.is_ignored(path)
1178
print '%-50s %s' % (path, pat)
1181
class cmd_lookup_revision(Command):
1182
"""Lookup the revision-id from a revision-number
1185
bzr lookup-revision 33
1188
takes_args = ['revno']
1190
def run(self, revno):
1194
raise BzrCommandError("not a valid revision-number: %r" % revno)
1196
print find_branch('.').lookup_revision(revno)
1199
class cmd_export(Command):
1200
"""Export past revision to destination directory.
1202
If no revision is specified this exports the last committed revision.
1204
Format may be an "exporter" name, such as tar, tgz, tbz2. If none is
1205
given, try to find the format with the extension. If no extension
1206
is found exports to a directory (equivalent to --format=dir).
1208
Root may be the top directory for tar, tgz and tbz2 formats. If none
1209
is given, the top directory will be the root name of the file."""
1210
# TODO: list known exporters
1211
takes_args = ['dest']
1212
takes_options = ['revision', 'format', 'root']
1213
def run(self, dest, revision=None, format=None, root=None):
1215
b = find_branch('.')
1216
if revision is None:
1217
rev_id = b.last_patch()
1219
if len(revision) != 1:
1220
raise BzrError('bzr export --revision takes exactly 1 argument')
1221
revno, rev_id = b.get_revision_info(revision[0])
1222
t = b.revision_tree(rev_id)
1223
root, ext = os.path.splitext(dest)
1225
if ext in (".tar",):
1227
elif ext in (".gz", ".tgz"):
1229
elif ext in (".bz2", ".tbz2"):
1233
t.export(dest, format, root)
1236
class cmd_cat(Command):
1237
"""Write a file's text from a previous revision."""
1239
takes_options = ['revision']
1240
takes_args = ['filename']
1242
def run(self, filename, revision=None):
1243
if revision == None:
1244
raise BzrCommandError("bzr cat requires a revision number")
1245
elif len(revision) != 1:
1246
raise BzrCommandError("bzr cat --revision takes exactly one number")
1247
b = find_branch('.')
1248
b.print_file(b.relpath(filename), revision[0])
1251
class cmd_local_time_offset(Command):
1252
"""Show the offset in seconds from GMT to local time."""
1255
print bzrlib.osutils.local_time_offset()
1259
class cmd_commit(Command):
1260
"""Commit changes into a new revision.
1262
If no arguments are given, the entire tree is committed.
1264
If selected files are specified, only changes to those files are
1265
committed. If a directory is specified then the directory and everything
1266
within it is committed.
1268
A selected-file commit may fail in some cases where the committed
1269
tree would be invalid, such as trying to commit a file in a
1270
newly-added directory that is not itself committed.
1272
TODO: Run hooks on tree to-be-committed, and after commit.
1274
TODO: Strict commit that fails if there are unknown or deleted files.
1276
takes_args = ['selected*']
1277
takes_options = ['message', 'file', 'verbose', 'unchanged']
1278
aliases = ['ci', 'checkin']
1280
# TODO: Give better message for -s, --summary, used by tla people
1282
def run(self, message=None, file=None, verbose=True, selected_list=None,
1284
from bzrlib.errors import PointlessCommit
1285
from bzrlib.osutils import get_text_message
1287
## Warning: shadows builtin file()
1288
if not message and not file:
1289
# FIXME: Ugly; change status code to send to a provided function?
1293
catcher = cStringIO.StringIO()
1294
sys.stdout = catcher
1295
cmd_status({"file_list":selected_list}, {})
1296
info = catcher.getvalue()
1298
message = get_text_message(info)
1301
raise BzrCommandError("please specify a commit message",
1302
["use either --message or --file"])
1303
elif message and file:
1304
raise BzrCommandError("please specify either --message or --file")
1308
message = codecs.open(file, 'rt', bzrlib.user_encoding).read()
1310
b = find_branch('.')
1312
selected_list = [b.relpath(s) for s in selected_list]
1315
b.commit(message, verbose=verbose,
1316
specific_files=selected_list,
1317
allow_pointless=unchanged)
1318
except PointlessCommit:
1319
# FIXME: This should really happen before the file is read in;
1320
# perhaps prepare the commit; get the message; then actually commit
1321
raise BzrCommandError("no changes to commit",
1322
["use --unchanged to commit anyhow"])
1325
class cmd_check(Command):
1326
"""Validate consistency of branch history.
1328
This command checks various invariants about the branch storage to
1329
detect data corruption or bzr bugs.
1331
If given the --update flag, it will update some optional fields
1332
to help ensure data consistency.
1334
takes_args = ['dir?']
1336
def run(self, dir='.'):
1337
from bzrlib.check import check
1338
check(find_branch(dir))
1342
class cmd_scan_cache(Command):
1345
from bzrlib.hashcache import HashCache
1352
print '%6d stats' % c.stat_count
1353
print '%6d in hashcache' % len(c._cache)
1354
print '%6d files removed from cache' % c.removed_count
1355
print '%6d hashes updated' % c.update_count
1356
print '%6d files changed too recently to cache' % c.danger_count
1363
class cmd_upgrade(Command):
1364
"""Upgrade branch storage to current format.
1366
This should normally be used only after the check command tells
1369
takes_args = ['dir?']
1371
def run(self, dir='.'):
1372
from bzrlib.upgrade import upgrade
1373
upgrade(find_branch(dir))
1377
class cmd_whoami(Command):
1378
"""Show bzr user id."""
1379
takes_options = ['email']
1381
def run(self, email=False):
1383
print bzrlib.osutils.user_email()
1385
print bzrlib.osutils.username()
1388
class cmd_selftest(Command):
1389
"""Run internal test suite"""
1391
takes_options = ['verbose']
1392
def run(self, verbose=False):
1393
from bzrlib.selftest import selftest
1394
return int(not selftest(verbose=verbose))
1397
class cmd_version(Command):
1398
"""Show version of bzr."""
1403
print "bzr (bazaar-ng) %s" % bzrlib.__version__
1404
# is bzrlib itself in a branch?
1405
bzrrev = bzrlib.get_bzr_revision()
1407
print " (bzr checkout, revision %d {%s})" % bzrrev
1408
print bzrlib.__copyright__
1409
print "http://bazaar-ng.org/"
1411
print "bzr comes with ABSOLUTELY NO WARRANTY. bzr is free software, and"
1412
print "you may use, modify and redistribute it under the terms of the GNU"
1413
print "General Public License version 2 or later."
1416
class cmd_rocks(Command):
1417
"""Statement of optimism."""
1420
print "it sure does!"
1422
def parse_spec(spec):
1424
>>> parse_spec(None)
1426
>>> parse_spec("./")
1428
>>> parse_spec("../@")
1430
>>> parse_spec("../f/@35")
1432
>>> parse_spec('./@revid:john@arbash-meinel.com-20050711044610-3ca0327c6a222f67')
1433
['.', 'revid:john@arbash-meinel.com-20050711044610-3ca0327c6a222f67']
1438
parsed = spec.split('/@')
1439
assert len(parsed) == 2
1444
parsed[1] = int(parsed[1])
1446
pass # We can allow stuff like ./@revid:blahblahblah
1448
assert parsed[1] >=0
1450
parsed = [spec, None]
1455
class cmd_merge(Command):
1456
"""Perform a three-way merge of trees.
1458
The SPEC parameters are working tree or revision specifiers. Working trees
1459
are specified using standard paths or urls. No component of a directory
1460
path may begin with '@'.
1462
Working tree examples: '.', '..', 'foo@', but NOT 'foo/@bar'
1464
Revisions are specified using a dirname/@revno pair, where dirname is the
1465
branch directory and revno is the revision within that branch. If no revno
1466
is specified, the latest revision is used.
1468
Revision examples: './@127', 'foo/@', '../@1'
1470
The OTHER_SPEC parameter is required. If the BASE_SPEC parameter is
1471
not supplied, the common ancestor of OTHER_SPEC the current branch is used
1474
merge refuses to run if there are any uncommitted changes, unless
1477
takes_args = ['other_spec', 'base_spec?']
1478
takes_options = ['force', 'merge-type']
1480
def run(self, other_spec, base_spec=None, force=False, merge_type=None):
1481
from bzrlib.merge import merge
1482
from bzrlib.merge_core import ApplyMerge3
1483
if merge_type is None:
1484
merge_type = ApplyMerge3
1485
merge(parse_spec(other_spec), parse_spec(base_spec),
1486
check_clean=(not force), merge_type=merge_type)
1489
class cmd_revert(Command):
1490
"""Reverse all changes since the last commit.
1492
Only versioned files are affected. Specify filenames to revert only
1493
those files. By default, any files that are changed will be backed up
1494
first. Backup files have a '~' appended to their name.
1496
takes_options = ['revision', 'no-backup']
1497
takes_args = ['file*']
1498
aliases = ['merge-revert']
1500
def run(self, revision=None, no_backup=False, file_list=None):
1501
from bzrlib.merge import merge
1502
if file_list is not None:
1503
if len(file_list) == 0:
1504
raise BzrCommandError("No files specified")
1505
if revision is None:
1507
elif len(revision) != 1:
1508
raise BzrCommandError('bzr revert --revision takes exactly 1 argument')
1509
merge(('.', revision[0]), parse_spec('.'),
1512
backup_files=not no_backup,
1513
file_list=file_list)
1516
class cmd_assert_fail(Command):
1517
"""Test reporting of assertion failures"""
1520
assert False, "always fails"
1523
class cmd_help(Command):
1524
"""Show help on a command or other topic.
1526
For a list of all available commands, say 'bzr help commands'."""
1527
takes_args = ['topic?']
1530
def run(self, topic=None):
1537
class cmd_plugins(Command):
1541
import bzrlib.plugin
1542
from inspect import getdoc
1543
from pprint import pprint
1544
for plugin in bzrlib.plugin.all_plugins:
1545
print plugin.__path__[0]
1548
print '\t', d.split('\n')[0]
1550
#pprint(bzrlib.plugin.all_plugins)
1554
# list of all available options; the rhs can be either None for an
1555
# option that takes no argument, or a constructor function that checks
1559
'diff-options': str,
1568
'revision': _parse_revision_str,
1579
'merge-type': get_merge_type,
1592
def parse_args(argv):
1593
"""Parse command line.
1595
Arguments and options are parsed at this level before being passed
1596
down to specific command handlers. This routine knows, from a
1597
lookup table, something about the available options, what optargs
1598
they take, and which commands will accept them.
1600
>>> parse_args('--help'.split())
1601
([], {'help': True})
1602
>>> parse_args('--version'.split())
1603
([], {'version': True})
1604
>>> parse_args('status --all'.split())
1605
(['status'], {'all': True})
1606
>>> parse_args('commit --message=biter'.split())
1607
(['commit'], {'message': u'biter'})
1608
>>> parse_args('log -r 500'.split())
1609
(['log'], {'revision': [500]})
1610
>>> parse_args('log -r500..600'.split())
1611
(['log'], {'revision': [500, 600]})
1612
>>> parse_args('log -vr500..600'.split())
1613
(['log'], {'verbose': True, 'revision': [500, 600]})
1614
>>> parse_args('log -rv500..600'.split()) #the r takes an argument
1615
(['log'], {'revision': ['v500', 600]})
1620
# TODO: Maybe handle '--' to end options?
1625
# option names must not be unicode
1629
mutter(" got option %r" % a)
1631
optname, optarg = a[2:].split('=', 1)
1634
if optname not in OPTIONS:
1635
raise BzrError('unknown long option %r' % a)
1638
if shortopt in SHORT_OPTIONS:
1639
# Multi-character options must have a space to delimit
1641
optname = SHORT_OPTIONS[shortopt]
1643
# Single character short options, can be chained,
1644
# and have their value appended to their name
1646
if shortopt not in SHORT_OPTIONS:
1647
# We didn't find the multi-character name, and we
1648
# didn't find the single char name
1649
raise BzrError('unknown short option %r' % a)
1650
optname = SHORT_OPTIONS[shortopt]
1653
# There are extra things on this option
1654
# see if it is the value, or if it is another
1656
optargfn = OPTIONS[optname]
1657
if optargfn is None:
1658
# This option does not take an argument, so the
1659
# next entry is another short option, pack it back
1661
argv.insert(0, '-' + a[2:])
1663
# This option takes an argument, so pack it
1668
# XXX: Do we ever want to support this, e.g. for -r?
1669
raise BzrError('repeated option %r' % a)
1671
optargfn = OPTIONS[optname]
1675
raise BzrError('option %r needs an argument' % a)
1677
optarg = argv.pop(0)
1678
opts[optname] = optargfn(optarg)
1681
raise BzrError('option %r takes no argument' % optname)
1682
opts[optname] = True
1691
def _match_argform(cmd, takes_args, args):
1694
# step through args and takes_args, allowing appropriate 0-many matches
1695
for ap in takes_args:
1699
argdict[argname] = args.pop(0)
1700
elif ap[-1] == '*': # all remaining arguments
1702
argdict[argname + '_list'] = args[:]
1705
argdict[argname + '_list'] = None
1708
raise BzrCommandError("command %r needs one or more %s"
1709
% (cmd, argname.upper()))
1711
argdict[argname + '_list'] = args[:]
1713
elif ap[-1] == '$': # all but one
1715
raise BzrCommandError("command %r needs one or more %s"
1716
% (cmd, argname.upper()))
1717
argdict[argname + '_list'] = args[:-1]
1723
raise BzrCommandError("command %r requires argument %s"
1724
% (cmd, argname.upper()))
1726
argdict[argname] = args.pop(0)
1729
raise BzrCommandError("extra argument to command %s: %s"
1737
"""Execute a command.
1739
This is similar to main(), but without all the trappings for
1740
logging and error handling.
1743
The command-line arguments, without the program name from argv[0]
1745
Returns a command status or raises an exception.
1747
Special master options: these must come before the command because
1748
they control how the command is interpreted.
1751
Do not load plugin modules at all
1754
Only use builtin commands. (Plugins are still allowed to change
1758
Run under the Python profiler.
1761
argv = [a.decode(bzrlib.user_encoding) for a in argv]
1763
opt_profile = opt_no_plugins = opt_builtin = False
1765
# --no-plugins is handled specially at a very early stage. We need
1766
# to load plugins before doing other command parsing so that they
1767
# can override commands, but this needs to happen first.
1770
if a == '--profile':
1772
elif a == '--no-plugins':
1773
opt_no_plugins = True
1774
elif a == '--builtin':
1780
if not opt_no_plugins:
1781
from bzrlib.plugin import load_plugins
1784
args, opts = parse_args(argv)
1787
from bzrlib.help import help
1794
if 'version' in opts:
1799
print >>sys.stderr, "please try 'bzr help' for help"
1802
cmd = str(args.pop(0))
1804
canonical_cmd, cmd_class = \
1805
get_cmd_class(cmd, plugins_override=not opt_builtin)
1807
# check options are reasonable
1808
allowed = cmd_class.takes_options
1810
if oname not in allowed:
1811
raise BzrCommandError("option '--%s' is not allowed for command %r"
1814
# mix arguments and options into one dictionary
1815
cmdargs = _match_argform(cmd, cmd_class.takes_args, args)
1817
for k, v in opts.items():
1818
cmdopts[k.replace('-', '_')] = v
1821
import hotshot, tempfile
1822
pffileno, pfname = tempfile.mkstemp()
1824
prof = hotshot.Profile(pfname)
1825
ret = prof.runcall(cmd_class, cmdopts, cmdargs) or 0
1828
import hotshot.stats
1829
stats = hotshot.stats.load(pfname)
1831
stats.sort_stats('time')
1832
## XXX: Might like to write to stderr or the trace file instead but
1833
## print_stats seems hardcoded to stdout
1834
stats.print_stats(20)
1842
return cmd_class(cmdopts, cmdargs).status
1845
def _report_exception(summary, quiet=False):
1848
log_error('bzr: ' + summary)
1849
bzrlib.trace.log_exception()
1851
if os.environ.get('BZR_DEBUG'):
1852
traceback.print_exc()
1855
sys.stderr.write('\n')
1856
tb = sys.exc_info()[2]
1857
exinfo = traceback.extract_tb(tb)
1859
sys.stderr.write(' at %s:%d in %s()\n' % exinfo[-1][:3])
1860
sys.stderr.write(' see ~/.bzr.log for debug information\n')
1866
bzrlib.trace.open_tracefile(argv)
1871
return run_bzr(argv[1:])
1873
# do this here inside the exception wrappers to catch EPIPE
1876
quiet = isinstance(e, (BzrCommandError))
1877
_report_exception('error: ' + str(e), quiet=quiet)
1880
# some explanation or hints
1883
except AssertionError, e:
1884
msg = 'assertion failed'
1886
msg += ': ' + str(e)
1887
_report_exception(msg)
1889
except KeyboardInterrupt, e:
1890
_report_exception('interrupted', quiet=True)
1892
except Exception, e:
1895
if (isinstance(e, IOError)
1896
and hasattr(e, 'errno')
1897
and e.errno == errno.EPIPE):
1901
msg = str(e).rstrip('\n')
1902
_report_exception(msg, quiet)
1905
bzrlib.trace.close_trace()
1908
if __name__ == '__main__':
1909
sys.exit(main(sys.argv))
added
removed
bzrlib/commands.py
