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, _PrintAddCallback
470
smart_add(file_list, verbose, not no_recurse,
471
callback=_PrintAddCallback)
475
class cmd_mkdir(Command):
476
"""Create a new versioned directory.
478
This is equivalent to creating the directory and then adding it.
480
takes_args = ['dir+']
482
def run(self, dir_list):
489
b.add([d], verbose=True)
492
class cmd_relpath(Command):
493
"""Show path of a file relative to root"""
494
takes_args = ['filename']
497
def run(self, filename):
498
print find_branch(filename).relpath(filename)
502
class cmd_inventory(Command):
503
"""Show inventory of the current working copy or a revision."""
504
takes_options = ['revision', 'show-ids']
506
def run(self, revision=None, show_ids=False):
509
inv = b.read_working_inventory()
511
if len(revision) > 1:
512
raise BzrCommandError('bzr inventory --revision takes'
513
' exactly one revision identifier')
514
inv = b.get_revision_inventory(b.lookup_revision(revision[0]))
516
for path, entry in inv.entries():
518
print '%-50s %s' % (path, entry.file_id)
523
class cmd_move(Command):
524
"""Move files to a different directory.
529
The destination must be a versioned directory in the same branch.
531
takes_args = ['source$', 'dest']
532
def run(self, source_list, dest):
535
# TODO: glob expansion on windows?
536
b.move([b.relpath(s) for s in source_list], b.relpath(dest))
539
class cmd_rename(Command):
540
"""Change the name of an entry.
543
bzr rename frob.c frobber.c
544
bzr rename src/frob.c lib/frob.c
546
It is an error if the destination name exists.
548
See also the 'move' command, which moves files into a different
549
directory without changing their name.
551
TODO: Some way to rename multiple files without invoking bzr for each
553
takes_args = ['from_name', 'to_name']
555
def run(self, from_name, to_name):
557
b.rename_one(b.relpath(from_name), b.relpath(to_name))
561
class cmd_mv(Command):
562
"""Move or rename a file.
565
bzr mv OLDNAME NEWNAME
566
bzr mv SOURCE... DESTINATION
568
If the last argument is a versioned directory, all the other names
569
are moved into it. Otherwise, there must be exactly two arguments
570
and the file is changed to a new name, which must not already exist.
572
Files cannot be moved between branches.
574
takes_args = ['names*']
575
def run(self, names_list):
576
if len(names_list) < 2:
577
raise BzrCommandError("missing file argument")
578
b = find_branch(names_list[0])
580
rel_names = [b.relpath(x) for x in names_list]
582
if os.path.isdir(names_list[-1]):
583
# move into existing directory
584
b.move(rel_names[:-1], rel_names[-1])
586
if len(names_list) != 2:
587
raise BzrCommandError('to mv multiple files the destination '
588
'must be a versioned directory')
589
b.move(rel_names[0], rel_names[1])
594
class cmd_pull(Command):
595
"""Pull any changes from another branch into the current one.
597
If the location is omitted, the last-used location will be used.
598
Both the revision history and the working directory will be
601
This command only works on branches that have not diverged. Branches are
602
considered diverged if both branches have had commits without first
603
pulling from the other.
605
If branches have diverged, you can use 'bzr merge' to pull the text changes
606
from one into the other.
608
takes_args = ['location?']
610
def run(self, location=None):
611
from bzrlib.merge import merge
613
from shutil import rmtree
616
br_to = find_branch('.')
619
stored_loc = br_to.controlfile("x-pull", "rb").read().rstrip('\n')
621
if e.errno != errno.ENOENT:
624
if stored_loc is None:
625
raise BzrCommandError("No pull location known or specified.")
627
print "Using last location: %s" % stored_loc
628
location = stored_loc
629
cache_root = tempfile.mkdtemp()
630
from bzrlib.branch import DivergedBranches
631
br_from = find_branch(location)
632
location = pull_loc(br_from)
633
old_revno = br_to.revno()
635
from branch import find_cached_branch, DivergedBranches
636
br_from = find_cached_branch(location, cache_root)
637
location = pull_loc(br_from)
638
old_revno = br_to.revno()
640
br_to.update_revisions(br_from)
641
except DivergedBranches:
642
raise BzrCommandError("These branches have diverged."
645
merge(('.', -1), ('.', old_revno), check_clean=False)
646
if location != stored_loc:
647
br_to.controlfile("x-pull", "wb").write(location + "\n")
653
class cmd_branch(Command):
654
"""Create a new copy of a branch.
656
If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
657
be used. In other words, "branch ../foo/bar" will attempt to create ./bar.
659
To retrieve the branch as of a particular revision, supply the --revision
660
parameter, as in "branch foo/bar -r 5".
662
takes_args = ['from_location', 'to_location?']
663
takes_options = ['revision']
664
aliases = ['get', 'clone']
666
def run(self, from_location, to_location=None, revision=None):
668
from bzrlib.merge import merge
669
from bzrlib.branch import DivergedBranches, \
670
find_cached_branch, Branch
671
from shutil import rmtree
672
from meta_store import CachedStore
674
cache_root = tempfile.mkdtemp()
678
elif len(revision) > 1:
679
raise BzrCommandError('bzr branch --revision takes exactly 1 revision value')
683
br_from = find_cached_branch(from_location, cache_root)
685
if e.errno == errno.ENOENT:
686
raise BzrCommandError('Source location "%s" does not'
687
' exist.' % to_location)
691
if to_location is None:
692
to_location = os.path.basename(from_location.rstrip("/\\"))
695
os.mkdir(to_location)
697
if e.errno == errno.EEXIST:
698
raise BzrCommandError('Target directory "%s" already'
699
' exists.' % to_location)
700
if e.errno == errno.ENOENT:
701
raise BzrCommandError('Parent of "%s" does not exist.' %
705
br_to = Branch(to_location, init=True)
707
br_to.set_root_id(br_from.get_root_id())
710
if revision[0] is None:
711
revno = br_from.revno()
713
revno, rev_id = br_from.get_revision_info(revision[0])
715
br_to.update_revisions(br_from, stop_revision=revno)
716
except bzrlib.errors.NoSuchRevision:
718
msg = "The branch %s has no revision %d." % (from_location,
720
raise BzrCommandError(msg)
722
merge((to_location, -1), (to_location, 0), this_dir=to_location,
723
check_clean=False, ignore_zero=True)
724
from_location = pull_loc(br_from)
725
br_to.controlfile("x-pull", "wb").write(from_location + "\n")
730
def pull_loc(branch):
731
# TODO: Should perhaps just make attribute be 'base' in
732
# RemoteBranch and Branch?
733
if hasattr(branch, "baseurl"):
734
return branch.baseurl
740
class cmd_renames(Command):
741
"""Show list of renamed files.
743
TODO: Option to show renames between two historical versions.
745
TODO: Only show renames under dir, rather than in the whole branch.
747
takes_args = ['dir?']
749
def run(self, dir='.'):
751
old_inv = b.basis_tree().inventory
752
new_inv = b.read_working_inventory()
754
renames = list(bzrlib.tree.find_renames(old_inv, new_inv))
756
for old_name, new_name in renames:
757
print "%s => %s" % (old_name, new_name)
760
class cmd_info(Command):
761
"""Show statistical information about a branch."""
762
takes_args = ['branch?']
764
def run(self, branch=None):
767
b = find_branch(branch)
771
class cmd_remove(Command):
772
"""Make a file unversioned.
774
This makes bzr stop tracking changes to a versioned file. It does
775
not delete the working copy.
777
takes_args = ['file+']
778
takes_options = ['verbose']
780
def run(self, file_list, verbose=False):
781
b = find_branch(file_list[0])
782
b.remove([b.relpath(f) for f in file_list], verbose=verbose)
785
class cmd_file_id(Command):
786
"""Print file_id of a particular file or directory.
788
The file_id is assigned when the file is first added and remains the
789
same through all revisions where the file exists, even when it is
793
takes_args = ['filename']
794
def run(self, filename):
795
b = find_branch(filename)
796
i = b.inventory.path2id(b.relpath(filename))
798
raise BzrError("%r is not a versioned file" % filename)
803
class cmd_file_path(Command):
804
"""Print path of file_ids to a file or directory.
806
This prints one line for each directory down to the target,
807
starting at the branch root."""
809
takes_args = ['filename']
810
def run(self, filename):
811
b = find_branch(filename)
813
fid = inv.path2id(b.relpath(filename))
815
raise BzrError("%r is not a versioned file" % filename)
816
for fip in inv.get_idpath(fid):
820
class cmd_revision_history(Command):
821
"""Display list of revision ids on this branch."""
824
for patchid in find_branch('.').revision_history():
828
class cmd_directories(Command):
829
"""Display list of versioned directories in this branch."""
831
for name, ie in find_branch('.').read_working_inventory().directories():
838
class cmd_init(Command):
839
"""Make a directory into a versioned branch.
841
Use this to create an empty branch, or before importing an
844
Recipe for importing a tree of files:
849
bzr commit -m 'imported project'
852
from bzrlib.branch import Branch
853
Branch('.', init=True)
856
class cmd_diff(Command):
857
"""Show differences in working tree.
859
If files are listed, only the changes in those files are listed.
860
Otherwise, all changes for the tree are listed.
862
TODO: Allow diff across branches.
864
TODO: Option to use external diff command; could be GNU diff, wdiff,
867
TODO: Python difflib is not exactly the same as unidiff; should
868
either fix it up or prefer to use an external diff.
870
TODO: If a directory is given, diff everything under that.
872
TODO: Selected-file diff is inefficient and doesn't show you
875
TODO: This probably handles non-Unix newlines poorly.
883
takes_args = ['file*']
884
takes_options = ['revision', 'diff-options']
885
aliases = ['di', 'dif']
887
def run(self, revision=None, file_list=None, diff_options=None):
888
from bzrlib.diff import show_diff
891
b = find_branch(file_list[0])
892
file_list = [b.relpath(f) for f in file_list]
893
if file_list == ['']:
894
# just pointing to top-of-tree
899
if revision is not None:
900
if len(revision) == 1:
901
show_diff(b, revision[0], specific_files=file_list,
902
external_diff_options=diff_options)
903
elif len(revision) == 2:
904
show_diff(b, revision[0], specific_files=file_list,
905
external_diff_options=diff_options,
906
revision2=revision[1])
908
raise BzrCommandError('bzr diff --revision takes exactly one or two revision identifiers')
910
show_diff(b, None, specific_files=file_list,
911
external_diff_options=diff_options)
916
class cmd_deleted(Command):
917
"""List files deleted in the working tree.
919
TODO: Show files deleted since a previous revision, or between two revisions.
921
def run(self, show_ids=False):
924
new = b.working_tree()
926
## TODO: Much more efficient way to do this: read in new
927
## directories with readdir, rather than stating each one. Same
928
## level of effort but possibly much less IO. (Or possibly not,
929
## if the directories are very large...)
931
for path, ie in old.inventory.iter_entries():
932
if not new.has_id(ie.file_id):
934
print '%-50s %s' % (path, ie.file_id)
939
class cmd_modified(Command):
940
"""List files modified in working tree."""
943
from bzrlib.delta import compare_trees
946
td = compare_trees(b.basis_tree(), b.working_tree())
948
for path, id, kind in td.modified:
953
class cmd_added(Command):
954
"""List files added in working tree."""
958
wt = b.working_tree()
959
basis_inv = b.basis_tree().inventory
962
if file_id in basis_inv:
964
path = inv.id2path(file_id)
965
if not os.access(b.abspath(path), os.F_OK):
971
class cmd_root(Command):
972
"""Show the tree root directory.
974
The root is the nearest enclosing directory with a .bzr control
976
takes_args = ['filename?']
977
def run(self, filename=None):
978
"""Print the branch root."""
979
b = find_branch(filename)
980
print getattr(b, 'base', None) or getattr(b, 'baseurl')
983
class cmd_log(Command):
984
"""Show log of this branch.
986
To request a range of logs, you can use the command -r begin:end
987
-r revision requests a specific revision, -r :end or -r begin: are
990
--message allows you to give a regular expression, which will be evaluated
991
so that only matching entries will be displayed.
993
TODO: Make --revision support uuid: and hash: [future tag:] notation.
997
takes_args = ['filename?']
998
takes_options = ['forward', 'timezone', 'verbose', 'show-ids', 'revision',
999
'long', 'message', 'short',]
1001
def run(self, filename=None, timezone='original',
1009
from bzrlib.branch import find_branch
1010
from bzrlib.log import log_formatter, show_log
1013
direction = (forward and 'forward') or 'reverse'
1016
b = find_branch(filename)
1017
fp = b.relpath(filename)
1019
file_id = b.read_working_inventory().path2id(fp)
1021
file_id = None # points to branch root
1023
b = find_branch('.')
1026
if revision is None:
1029
elif len(revision) == 1:
1030
rev1 = rev2 = b.get_revision_info(revision[0])[0]
1031
elif len(revision) == 2:
1032
rev1 = b.get_revision_info(revision[0])[0]
1033
rev2 = b.get_revision_info(revision[1])[0]
1035
raise BzrCommandError('bzr log --revision takes one or two values.')
1042
mutter('encoding log as %r' % bzrlib.user_encoding)
1044
# use 'replace' so that we don't abort if trying to write out
1045
# in e.g. the default C locale.
1046
outf = codecs.getwriter(bzrlib.user_encoding)(sys.stdout, errors='replace')
1051
log_format = 'short'
1052
lf = log_formatter(log_format,
1055
show_timezone=timezone)
1061
direction=direction,
1062
start_revision=rev1,
1068
class cmd_touching_revisions(Command):
1069
"""Return revision-ids which affected a particular file.
1071
A more user-friendly interface is "bzr log FILE"."""
1073
takes_args = ["filename"]
1074
def run(self, filename):
1075
b = find_branch(filename)
1076
inv = b.read_working_inventory()
1077
file_id = inv.path2id(b.relpath(filename))
1078
for revno, revision_id, what in bzrlib.log.find_touching_revisions(b, file_id):
1079
print "%6d %s" % (revno, what)
1082
class cmd_ls(Command):
1083
"""List files in a tree.
1085
TODO: Take a revision or remote path and list that tree instead.
1088
def run(self, revision=None, verbose=False):
1089
b = find_branch('.')
1090
if revision == None:
1091
tree = b.working_tree()
1093
tree = b.revision_tree(b.lookup_revision(revision))
1095
for fp, fc, kind, fid in tree.list_files():
1097
if kind == 'directory':
1099
elif kind == 'file':
1104
print '%-8s %s%s' % (fc, fp, kindch)
1110
class cmd_unknowns(Command):
1111
"""List unknown files."""
1113
from bzrlib.osutils import quotefn
1114
for f in find_branch('.').unknowns():
1119
class cmd_ignore(Command):
1120
"""Ignore a command or pattern.
1122
To remove patterns from the ignore list, edit the .bzrignore file.
1124
If the pattern contains a slash, it is compared to the whole path
1125
from the branch root. Otherwise, it is comapred to only the last
1126
component of the path.
1128
Ignore patterns are case-insensitive on case-insensitive systems.
1130
Note: wildcards must be quoted from the shell on Unix.
1133
bzr ignore ./Makefile
1134
bzr ignore '*.class'
1136
takes_args = ['name_pattern']
1138
def run(self, name_pattern):
1139
from bzrlib.atomicfile import AtomicFile
1142
b = find_branch('.')
1143
ifn = b.abspath('.bzrignore')
1145
if os.path.exists(ifn):
1148
igns = f.read().decode('utf-8')
1154
# TODO: If the file already uses crlf-style termination, maybe
1155
# we should use that for the newly added lines?
1157
if igns and igns[-1] != '\n':
1159
igns += name_pattern + '\n'
1162
f = AtomicFile(ifn, 'wt')
1163
f.write(igns.encode('utf-8'))
1168
inv = b.working_tree().inventory
1169
if inv.path2id('.bzrignore'):
1170
mutter('.bzrignore is already versioned')
1172
mutter('need to make new .bzrignore file versioned')
1173
b.add(['.bzrignore'])
1177
class cmd_ignored(Command):
1178
"""List ignored files and the patterns that matched them.
1180
See also: bzr ignore"""
1182
tree = find_branch('.').working_tree()
1183
for path, file_class, kind, file_id in tree.list_files():
1184
if file_class != 'I':
1186
## XXX: Slightly inefficient since this was already calculated
1187
pat = tree.is_ignored(path)
1188
print '%-50s %s' % (path, pat)
1191
class cmd_lookup_revision(Command):
1192
"""Lookup the revision-id from a revision-number
1195
bzr lookup-revision 33
1198
takes_args = ['revno']
1200
def run(self, revno):
1204
raise BzrCommandError("not a valid revision-number: %r" % revno)
1206
print find_branch('.').lookup_revision(revno)
1209
class cmd_export(Command):
1210
"""Export past revision to destination directory.
1212
If no revision is specified this exports the last committed revision.
1214
Format may be an "exporter" name, such as tar, tgz, tbz2. If none is
1215
given, try to find the format with the extension. If no extension
1216
is found exports to a directory (equivalent to --format=dir).
1218
Root may be the top directory for tar, tgz and tbz2 formats. If none
1219
is given, the top directory will be the root name of the file."""
1220
# TODO: list known exporters
1221
takes_args = ['dest']
1222
takes_options = ['revision', 'format', 'root']
1223
def run(self, dest, revision=None, format=None, root=None):
1225
b = find_branch('.')
1226
if revision is None:
1227
rev_id = b.last_patch()
1229
if len(revision) != 1:
1230
raise BzrError('bzr export --revision takes exactly 1 argument')
1231
revno, rev_id = b.get_revision_info(revision[0])
1232
t = b.revision_tree(rev_id)
1233
root, ext = os.path.splitext(dest)
1235
if ext in (".tar",):
1237
elif ext in (".gz", ".tgz"):
1239
elif ext in (".bz2", ".tbz2"):
1243
t.export(dest, format, root)
1246
class cmd_cat(Command):
1247
"""Write a file's text from a previous revision."""
1249
takes_options = ['revision']
1250
takes_args = ['filename']
1252
def run(self, filename, revision=None):
1253
if revision == None:
1254
raise BzrCommandError("bzr cat requires a revision number")
1255
elif len(revision) != 1:
1256
raise BzrCommandError("bzr cat --revision takes exactly one number")
1257
b = find_branch('.')
1258
b.print_file(b.relpath(filename), revision[0])
1261
class cmd_local_time_offset(Command):
1262
"""Show the offset in seconds from GMT to local time."""
1265
print bzrlib.osutils.local_time_offset()
1269
class cmd_commit(Command):
1270
"""Commit changes into a new revision.
1272
If no arguments are given, the entire tree is committed.
1274
If selected files are specified, only changes to those files are
1275
committed. If a directory is specified then the directory and everything
1276
within it is committed.
1278
A selected-file commit may fail in some cases where the committed
1279
tree would be invalid, such as trying to commit a file in a
1280
newly-added directory that is not itself committed.
1282
TODO: Run hooks on tree to-be-committed, and after commit.
1284
TODO: Strict commit that fails if there are unknown or deleted files.
1286
takes_args = ['selected*']
1287
takes_options = ['message', 'file', 'verbose', 'unchanged']
1288
aliases = ['ci', 'checkin']
1290
# TODO: Give better message for -s, --summary, used by tla people
1292
def run(self, message=None, file=None, verbose=True, selected_list=None,
1294
from bzrlib.errors import PointlessCommit
1295
from bzrlib.osutils import get_text_message
1297
## Warning: shadows builtin file()
1298
if not message and not file:
1299
# FIXME: Ugly; change status code to send to a provided function?
1303
catcher = cStringIO.StringIO()
1304
sys.stdout = catcher
1305
cmd_status({"file_list":selected_list}, {})
1306
info = catcher.getvalue()
1308
message = get_text_message(info)
1311
raise BzrCommandError("please specify a commit message",
1312
["use either --message or --file"])
1313
elif message and file:
1314
raise BzrCommandError("please specify either --message or --file")
1318
message = codecs.open(file, 'rt', bzrlib.user_encoding).read()
1320
b = find_branch('.')
1322
selected_list = [b.relpath(s) for s in selected_list]
1325
b.commit(message, verbose=verbose,
1326
specific_files=selected_list,
1327
allow_pointless=unchanged)
1328
except PointlessCommit:
1329
# FIXME: This should really happen before the file is read in;
1330
# perhaps prepare the commit; get the message; then actually commit
1331
raise BzrCommandError("no changes to commit",
1332
["use --unchanged to commit anyhow"])
1335
class cmd_check(Command):
1336
"""Validate consistency of branch history.
1338
This command checks various invariants about the branch storage to
1339
detect data corruption or bzr bugs.
1341
If given the --update flag, it will update some optional fields
1342
to help ensure data consistency.
1344
takes_args = ['dir?']
1346
def run(self, dir='.'):
1347
from bzrlib.check import check
1349
check(find_branch(dir))
1352
class cmd_scan_cache(Command):
1355
from bzrlib.hashcache import HashCache
1362
print '%6d stats' % c.stat_count
1363
print '%6d in hashcache' % len(c._cache)
1364
print '%6d files removed from cache' % c.removed_count
1365
print '%6d hashes updated' % c.update_count
1366
print '%6d files changed too recently to cache' % c.danger_count
1373
class cmd_upgrade(Command):
1374
"""Upgrade branch storage to current format.
1376
This should normally be used only after the check command tells
1379
takes_args = ['dir?']
1381
def run(self, dir='.'):
1382
from bzrlib.upgrade import upgrade
1383
upgrade(find_branch(dir))
1387
class cmd_whoami(Command):
1388
"""Show bzr user id."""
1389
takes_options = ['email']
1391
def run(self, email=False):
1393
b = bzrlib.branch.find_branch('.')
1398
print bzrlib.osutils.user_email(b)
1400
print bzrlib.osutils.username(b)
1403
class cmd_selftest(Command):
1404
"""Run internal test suite"""
1406
takes_options = ['verbose', 'pattern']
1407
def run(self, verbose=False, pattern=".*"):
1409
from bzrlib.selftest import selftest
1410
# we don't want progress meters from the tests to go to the
1412
save_ui = bzrlib.ui.ui_factory
1414
bzrlib.ui.ui_factory = bzrlib.ui.SilentUIFactory()
1415
return int(not selftest(verbose=verbose, pattern=pattern))
1417
bzrlib.ui.ui_factory = save_ui
1420
class cmd_version(Command):
1421
"""Show version of bzr."""
1426
print "bzr (bazaar-ng) %s" % bzrlib.__version__
1427
# is bzrlib itself in a branch?
1428
bzrrev = bzrlib.get_bzr_revision()
1430
print " (bzr checkout, revision %d {%s})" % bzrrev
1431
print bzrlib.__copyright__
1432
print "http://bazaar-ng.org/"
1434
print "bzr comes with ABSOLUTELY NO WARRANTY. bzr is free software, and"
1435
print "you may use, modify and redistribute it under the terms of the GNU"
1436
print "General Public License version 2 or later."
1439
class cmd_rocks(Command):
1440
"""Statement of optimism."""
1443
print "it sure does!"
1445
def parse_spec(spec):
1447
>>> parse_spec(None)
1449
>>> parse_spec("./")
1451
>>> parse_spec("../@")
1453
>>> parse_spec("../f/@35")
1455
>>> parse_spec('./@revid:john@arbash-meinel.com-20050711044610-3ca0327c6a222f67')
1456
['.', 'revid:john@arbash-meinel.com-20050711044610-3ca0327c6a222f67']
1461
parsed = spec.split('/@')
1462
assert len(parsed) == 2
1467
parsed[1] = int(parsed[1])
1469
pass # We can allow stuff like ./@revid:blahblahblah
1471
assert parsed[1] >=0
1473
parsed = [spec, None]
1478
class cmd_merge(Command):
1479
"""Perform a three-way merge.
1481
The branch is the branch you will merge from. By default, it will merge
1482
the latest revision. If you specify a revision, that revision will be
1483
merged. If you specify two revisions, the first will be used as a BASE,
1484
and the second one as OTHER. Revision numbers are always relative to the
1489
To merge the latest revision from bzr.dev
1490
bzr merge ../bzr.dev
1492
To merge changes up to and including revision 82 from bzr.dev
1493
bzr merge -r 82 ../bzr.dev
1495
To merge the changes introduced by 82, without previous changes:
1496
bzr merge -r 81..82 ../bzr.dev
1498
merge refuses to run if there are any uncommitted changes, unless
1501
takes_args = ['branch?']
1502
takes_options = ['revision', 'force', 'merge-type']
1504
def run(self, branch='.', revision=None, force=False,
1506
from bzrlib.merge import merge
1507
from bzrlib.merge_core import ApplyMerge3
1508
if merge_type is None:
1509
merge_type = ApplyMerge3
1511
if revision is None or len(revision) < 1:
1513
other = (branch, -1)
1515
if len(revision) == 1:
1516
other = (branch, revision[0])
1519
assert len(revision) == 2
1520
if None in revision:
1521
raise BzrCommandError(
1522
"Merge doesn't permit that revision specifier.")
1523
base = (branch, revision[0])
1524
other = (branch, revision[1])
1526
merge(other, base, check_clean=(not force), merge_type=merge_type)
1529
class cmd_revert(Command):
1530
"""Reverse all changes since the last commit.
1532
Only versioned files are affected. Specify filenames to revert only
1533
those files. By default, any files that are changed will be backed up
1534
first. Backup files have a '~' appended to their name.
1536
takes_options = ['revision', 'no-backup']
1537
takes_args = ['file*']
1538
aliases = ['merge-revert']
1540
def run(self, revision=None, no_backup=False, file_list=None):
1541
from bzrlib.merge import merge
1542
if file_list is not None:
1543
if len(file_list) == 0:
1544
raise BzrCommandError("No files specified")
1545
if revision is None:
1547
elif len(revision) != 1:
1548
raise BzrCommandError('bzr revert --revision takes exactly 1 argument')
1549
merge(('.', revision[0]), parse_spec('.'),
1552
backup_files=not no_backup,
1553
file_list=file_list)
1556
class cmd_assert_fail(Command):
1557
"""Test reporting of assertion failures"""
1560
assert False, "always fails"
1563
class cmd_help(Command):
1564
"""Show help on a command or other topic.
1566
For a list of all available commands, say 'bzr help commands'."""
1567
takes_args = ['topic?']
1570
def run(self, topic=None):
1575
class cmd_shell_complete(Command):
1576
"""Show appropriate completions for context.
1578
For a list of all available commands, say 'bzr shell-complete'."""
1579
takes_args = ['context?']
1583
def run(self, context=None):
1584
import shellcomplete
1585
shellcomplete.shellcomplete(context)
1588
class cmd_missing(Command):
1589
"""What is missing in this branch relative to other branch.
1591
takes_args = ['remote?']
1592
aliases = ['mis', 'miss']
1593
# We don't have to add quiet to the list, because
1594
# unknown options are parsed as booleans
1595
takes_options = ['verbose', 'quiet']
1597
def run(self, remote=None, verbose=False, quiet=False):
1598
from bzrlib.branch import find_branch, DivergedBranches
1599
from bzrlib.errors import BzrCommandError
1600
from bzrlib.missing import get_parent, show_missing
1602
if verbose and quiet:
1603
raise BzrCommandError('Cannot pass both quiet and verbose')
1605
b = find_branch('.')
1606
parent = get_parent(b)
1609
raise BzrCommandError("No missing location known or specified.")
1612
print "Using last location: %s" % parent
1614
elif parent is None:
1615
# We only update x-pull if it did not exist, missing should not change the parent
1616
b.controlfile('x-pull', 'wb').write(remote + '\n')
1617
br_remote = find_branch(remote)
1619
return show_missing(b, br_remote, verbose=verbose, quiet=quiet)
1623
class cmd_plugins(Command):
1627
import bzrlib.plugin
1628
from inspect import getdoc
1629
from pprint import pprint
1630
for plugin in bzrlib.plugin.all_plugins:
1631
print plugin.__path__[0]
1634
print '\t', d.split('\n')[0]
1636
#pprint(bzrlib.plugin.all_plugins)
1640
# list of all available options; the rhs can be either None for an
1641
# option that takes no argument, or a constructor function that checks
1645
'diff-options': str,
1654
'revision': _parse_revision_str,
1666
'merge-type': get_merge_type,
1680
def parse_args(argv):
1681
"""Parse command line.
1683
Arguments and options are parsed at this level before being passed
1684
down to specific command handlers. This routine knows, from a
1685
lookup table, something about the available options, what optargs
1686
they take, and which commands will accept them.
1688
>>> parse_args('--help'.split())
1689
([], {'help': True})
1690
>>> parse_args('--version'.split())
1691
([], {'version': True})
1692
>>> parse_args('status --all'.split())
1693
(['status'], {'all': True})
1694
>>> parse_args('commit --message=biter'.split())
1695
(['commit'], {'message': u'biter'})
1696
>>> parse_args('log -r 500'.split())
1697
(['log'], {'revision': [500]})
1698
>>> parse_args('log -r500..600'.split())
1699
(['log'], {'revision': [500, 600]})
1700
>>> parse_args('log -vr500..600'.split())
1701
(['log'], {'verbose': True, 'revision': [500, 600]})
1702
>>> parse_args('log -rv500..600'.split()) #the r takes an argument
1703
(['log'], {'revision': ['v500', 600]})
1708
# TODO: Maybe handle '--' to end options?
1713
# option names must not be unicode
1717
mutter(" got option %r" % a)
1719
optname, optarg = a[2:].split('=', 1)
1722
if optname not in OPTIONS:
1723
raise BzrError('unknown long option %r' % a)
1726
if shortopt in SHORT_OPTIONS:
1727
# Multi-character options must have a space to delimit
1729
optname = SHORT_OPTIONS[shortopt]
1731
# Single character short options, can be chained,
1732
# and have their value appended to their name
1734
if shortopt not in SHORT_OPTIONS:
1735
# We didn't find the multi-character name, and we
1736
# didn't find the single char name
1737
raise BzrError('unknown short option %r' % a)
1738
optname = SHORT_OPTIONS[shortopt]
1741
# There are extra things on this option
1742
# see if it is the value, or if it is another
1744
optargfn = OPTIONS[optname]
1745
if optargfn is None:
1746
# This option does not take an argument, so the
1747
# next entry is another short option, pack it back
1749
argv.insert(0, '-' + a[2:])
1751
# This option takes an argument, so pack it
1756
# XXX: Do we ever want to support this, e.g. for -r?
1757
raise BzrError('repeated option %r' % a)
1759
optargfn = OPTIONS[optname]
1763
raise BzrError('option %r needs an argument' % a)
1765
optarg = argv.pop(0)
1766
opts[optname] = optargfn(optarg)
1769
raise BzrError('option %r takes no argument' % optname)
1770
opts[optname] = True
1779
def _match_argform(cmd, takes_args, args):
1782
# step through args and takes_args, allowing appropriate 0-many matches
1783
for ap in takes_args:
1787
argdict[argname] = args.pop(0)
1788
elif ap[-1] == '*': # all remaining arguments
1790
argdict[argname + '_list'] = args[:]
1793
argdict[argname + '_list'] = None
1796
raise BzrCommandError("command %r needs one or more %s"
1797
% (cmd, argname.upper()))
1799
argdict[argname + '_list'] = args[:]
1801
elif ap[-1] == '$': # all but one
1803
raise BzrCommandError("command %r needs one or more %s"
1804
% (cmd, argname.upper()))
1805
argdict[argname + '_list'] = args[:-1]
1811
raise BzrCommandError("command %r requires argument %s"
1812
% (cmd, argname.upper()))
1814
argdict[argname] = args.pop(0)
1817
raise BzrCommandError("extra argument to command %s: %s"
1825
"""Execute a command.
1827
This is similar to main(), but without all the trappings for
1828
logging and error handling.
1831
The command-line arguments, without the program name from argv[0]
1833
Returns a command status or raises an exception.
1835
Special master options: these must come before the command because
1836
they control how the command is interpreted.
1839
Do not load plugin modules at all
1842
Only use builtin commands. (Plugins are still allowed to change
1846
Run under the Python profiler.
1849
argv = [a.decode(bzrlib.user_encoding) for a in argv]
1851
opt_profile = opt_no_plugins = opt_builtin = False
1853
# --no-plugins is handled specially at a very early stage. We need
1854
# to load plugins before doing other command parsing so that they
1855
# can override commands, but this needs to happen first.
1858
if a == '--profile':
1860
elif a == '--no-plugins':
1861
opt_no_plugins = True
1862
elif a == '--builtin':
1868
if not opt_no_plugins:
1869
from bzrlib.plugin import load_plugins
1872
args, opts = parse_args(argv)
1875
from bzrlib.help import help
1882
if 'version' in opts:
1887
from bzrlib.help import help
1891
cmd = str(args.pop(0))
1893
canonical_cmd, cmd_class = \
1894
get_cmd_class(cmd, plugins_override=not opt_builtin)
1896
# check options are reasonable
1897
allowed = cmd_class.takes_options
1899
if oname not in allowed:
1900
raise BzrCommandError("option '--%s' is not allowed for command %r"
1903
# mix arguments and options into one dictionary
1904
cmdargs = _match_argform(cmd, cmd_class.takes_args, args)
1906
for k, v in opts.items():
1907
cmdopts[k.replace('-', '_')] = v
1910
import hotshot, tempfile
1911
pffileno, pfname = tempfile.mkstemp()
1913
prof = hotshot.Profile(pfname)
1914
ret = prof.runcall(cmd_class, cmdopts, cmdargs) or 0
1917
import hotshot.stats
1918
stats = hotshot.stats.load(pfname)
1920
stats.sort_stats('time')
1921
## XXX: Might like to write to stderr or the trace file instead but
1922
## print_stats seems hardcoded to stdout
1923
stats.print_stats(20)
1931
return cmd_class(cmdopts, cmdargs).status
1934
def _report_exception(summary, quiet=False):
1937
log_error('bzr: ' + summary)
1940
sys.stderr.write('\n')
1941
tb = sys.exc_info()[2]
1942
exinfo = traceback.extract_tb(tb)
1944
sys.stderr.write(' at %s:%d in %s()\n' % exinfo[-1][:3])
1945
sys.stderr.write(' see ~/.bzr.log for debug information\n')
1952
bzrlib.trace.open_tracefile(argv)
1954
bzrlib.ui.ui_factory = bzrlib.ui.TextUIFactory()
1958
return run_bzr(argv[1:])
1960
# do this here inside the exception wrappers to catch EPIPE
1962
except BzrCommandError, e:
1963
# command line syntax error, etc
1967
bzrlib.trace.log_exception()
1969
except AssertionError, e:
1970
bzrlib.trace.log_exception('assertion failed: ' + str(e))
1972
except KeyboardInterrupt, e:
1973
bzrlib.trace.note('interrupted')
1975
except Exception, e:
1977
if (isinstance(e, IOError)
1978
and hasattr(e, 'errno')
1979
and e.errno == errno.EPIPE):
1980
bzrlib.trace.note('broken pipe')
1983
bzrlib.trace.log_exception('terminated by exception')
1987
if __name__ == '__main__':
1988
sys.exit(main(sys.argv))