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
22
from bzrlib.trace import mutter, note, log_error
23
from bzrlib.errors import BzrError, BzrCheckError, BzrCommandError
24
from bzrlib.branch import find_branch
25
from bzrlib import BZRDIR
31
def register_command(cmd):
32
"Utility function to help register a command"
35
if k.startswith("cmd_"):
36
k_unsquished = _unsquish_command_name(k)
39
if not plugin_cmds.has_key(k_unsquished):
40
plugin_cmds[k_unsquished] = cmd
42
log_error('Two plugins defined the same command: %r' % k)
43
log_error('Not loading the one in %r' % sys.modules[cmd.__module__])
46
def _squish_command_name(cmd):
47
return 'cmd_' + cmd.replace('-', '_')
50
def _unsquish_command_name(cmd):
51
assert cmd.startswith("cmd_")
52
return cmd[4:].replace('_','-')
54
def _parse_revision_str(revstr):
55
"""This handles a revision string -> revno.
57
There are several possibilities:
60
'234:345' -> [234, 345]
64
In the future we will also support:
65
'uuid:blah-blah-blah' -> ?
66
'hash:blahblahblah' -> ?
70
if revstr.find(':') != -1:
71
revs = revstr.split(':')
73
raise ValueError('More than 2 pieces not supported for --revision: %r' % revstr)
78
revs[0] = int(revs[0])
83
revs[1] = int(revs[1])
90
def _get_cmd_dict(plugins_override=True):
92
for k, v in globals().iteritems():
93
if k.startswith("cmd_"):
94
d[_unsquish_command_name(k)] = v
95
# If we didn't load plugins, the plugin_cmds dict will be empty
99
d2 = plugin_cmds.copy()
105
def get_all_cmds(plugins_override=True):
106
"""Return canonical name and class for all registered commands."""
107
for k, v in _get_cmd_dict(plugins_override=plugins_override).iteritems():
111
def get_cmd_class(cmd, plugins_override=True):
112
"""Return the canonical name and command class for a command.
114
cmd = str(cmd) # not unicode
116
# first look up this command under the specified name
117
cmds = _get_cmd_dict(plugins_override=plugins_override)
119
return cmd, cmds[cmd]
123
# look for any command which claims this as an alias
124
for cmdname, cmdclass in cmds.iteritems():
125
if cmd in cmdclass.aliases:
126
return cmdname, cmdclass
128
cmdclass = ExternalCommand.find_command(cmd)
132
raise BzrCommandError("unknown command %r" % cmd)
135
class Command(object):
136
"""Base class for commands.
138
The docstring for an actual command should give a single-line
139
summary, then a complete description of the command. A grammar
140
description will be inserted.
143
List of argument forms, marked with whether they are optional,
147
List of options that may be given for this command.
150
If true, this command isn't advertised.
159
def __init__(self, options, arguments):
160
"""Construct and run the command.
162
Sets self.status to the return value of run()."""
163
assert isinstance(options, dict)
164
assert isinstance(arguments, dict)
165
cmdargs = options.copy()
166
cmdargs.update(arguments)
167
assert self.__doc__ != Command.__doc__, \
168
("No help message set for %r" % self)
169
self.status = self.run(**cmdargs)
173
"""Override this in sub-classes.
175
This is invoked with the options and arguments bound to
178
Return 0 or None if the command was successful, or a shell
184
class ExternalCommand(Command):
185
"""Class to wrap external commands.
187
We cheat a little here, when get_cmd_class() calls us we actually give it back
188
an object we construct that has the appropriate path, help, options etc for the
191
When run_bzr() tries to instantiate that 'class' it gets caught by the __call__
192
method, which we override to call the Command.__init__ method. That then calls
193
our run method which is pretty straight forward.
195
The only wrinkle is that we have to map bzr's dictionary of options and arguments
196
back into command line options and arguments for the script.
199
def find_command(cls, cmd):
201
bzrpath = os.environ.get('BZRPATH', '')
203
for dir in bzrpath.split(os.pathsep):
204
path = os.path.join(dir, cmd)
205
if os.path.isfile(path):
206
return ExternalCommand(path)
210
find_command = classmethod(find_command)
212
def __init__(self, path):
215
pipe = os.popen('%s --bzr-usage' % path, 'r')
216
self.takes_options = pipe.readline().split()
218
for opt in self.takes_options:
219
if not opt in OPTIONS:
220
raise BzrError("Unknown option '%s' returned by external command %s"
223
# TODO: Is there any way to check takes_args is valid here?
224
self.takes_args = pipe.readline().split()
226
if pipe.close() is not None:
227
raise BzrError("Failed funning '%s --bzr-usage'" % path)
229
pipe = os.popen('%s --bzr-help' % path, 'r')
230
self.__doc__ = pipe.read()
231
if pipe.close() is not None:
232
raise BzrError("Failed funning '%s --bzr-help'" % path)
234
def __call__(self, options, arguments):
235
Command.__init__(self, options, arguments)
238
def run(self, **kargs):
245
optname = name.replace('_','-')
247
if OPTIONS.has_key(optname):
249
opts.append('--%s' % optname)
250
if value is not None and value is not True:
251
opts.append(str(value))
253
# it's an arg, or arg list
254
if type(value) is not list:
260
self.status = os.spawnv(os.P_WAIT, self.path, [self.path] + opts + args)
264
class cmd_status(Command):
265
"""Display status summary.
267
This reports on versioned and unknown files, reporting them
268
grouped by state. Possible states are:
271
Versioned in the working copy but not in the previous revision.
274
Versioned in the previous revision but removed or deleted
278
Path of this file changed from the previous revision;
279
the text may also have changed. This includes files whose
280
parent directory was renamed.
283
Text has changed since the previous revision.
286
Nothing about this file has changed since the previous revision.
287
Only shown with --all.
290
Not versioned and not matching an ignore pattern.
292
To see ignored files use 'bzr ignored'. For details in the
293
changes to file texts, use 'bzr diff'.
295
If no arguments are specified, the status of the entire working
296
directory is shown. Otherwise, only the status of the specified
297
files or directories is reported. If a directory is given, status
298
is reported for everything inside that directory.
300
takes_args = ['file*']
301
takes_options = ['all', 'show-ids']
302
aliases = ['st', 'stat']
304
def run(self, all=False, show_ids=False, file_list=None):
306
b = find_branch(file_list[0])
307
file_list = [b.relpath(x) for x in file_list]
308
# special case: only one path was given and it's the root
310
if file_list == ['']:
315
status.show_status(b, show_unchanged=all, show_ids=show_ids,
316
specific_files=file_list)
319
class cmd_cat_revision(Command):
320
"""Write out metadata for a revision."""
323
takes_args = ['revision_id']
325
def run(self, revision_id):
326
from bzrlib.xml import pack_xml
327
pack_xml(find_branch('.').get_revision(revision_id), sys.stdout)
330
class cmd_revno(Command):
331
"""Show current revision number.
333
This is equal to the number of revisions on this branch."""
335
print find_branch('.').revno()
338
class cmd_add(Command):
339
"""Add specified files or directories.
341
In non-recursive mode, all the named items are added, regardless
342
of whether they were previously ignored. A warning is given if
343
any of the named files are already versioned.
345
In recursive mode (the default), files are treated the same way
346
but the behaviour for directories is different. Directories that
347
are already versioned do not give a warning. All directories,
348
whether already versioned or not, are searched for files or
349
subdirectories that are neither versioned or ignored, and these
350
are added. This search proceeds recursively into versioned
353
Therefore simply saying 'bzr add .' will version all files that
354
are currently unknown.
356
TODO: Perhaps adding a file whose directly is not versioned should
357
recursively add that parent, rather than giving an error?
359
takes_args = ['file+']
360
takes_options = ['verbose', 'no-recurse']
362
def run(self, file_list, verbose=False, no_recurse=False):
363
from bzrlib.add import smart_add
364
smart_add(file_list, verbose, not no_recurse)
368
class cmd_mkdir(Command):
369
"""Create a new versioned directory.
371
This is equivalent to creating the directory and then adding it.
373
takes_args = ['dir+']
375
def run(self, dir_list):
382
b.add([d], verbose=True)
385
class cmd_relpath(Command):
386
"""Show path of a file relative to root"""
387
takes_args = ['filename']
390
def run(self, filename):
391
print find_branch(filename).relpath(filename)
395
class cmd_inventory(Command):
396
"""Show inventory of the current working copy or a revision."""
397
takes_options = ['revision', 'show-ids']
399
def run(self, revision=None, show_ids=False):
402
inv = b.read_working_inventory()
404
inv = b.get_revision_inventory(b.lookup_revision(revision))
406
for path, entry in inv.entries():
408
print '%-50s %s' % (path, entry.file_id)
413
class cmd_move(Command):
414
"""Move files to a different directory.
419
The destination must be a versioned directory in the same branch.
421
takes_args = ['source$', 'dest']
422
def run(self, source_list, dest):
425
b.move([b.relpath(s) for s in source_list], b.relpath(dest))
428
class cmd_rename(Command):
429
"""Change the name of an entry.
432
bzr rename frob.c frobber.c
433
bzr rename src/frob.c lib/frob.c
435
It is an error if the destination name exists.
437
See also the 'move' command, which moves files into a different
438
directory without changing their name.
440
TODO: Some way to rename multiple files without invoking bzr for each
442
takes_args = ['from_name', 'to_name']
444
def run(self, from_name, to_name):
446
b.rename_one(b.relpath(from_name), b.relpath(to_name))
452
class cmd_pull(Command):
453
"""Pull any changes from another branch into the current one.
455
If the location is omitted, the last-used location will be used.
456
Both the revision history and the working directory will be
459
This command only works on branches that have not diverged. Branches are
460
considered diverged if both branches have had commits without first
461
pulling from the other.
463
If branches have diverged, you can use 'bzr merge' to pull the text changes
464
from one into the other.
466
takes_args = ['location?']
468
def run(self, location=None):
469
from bzrlib.merge import merge
471
from shutil import rmtree
474
br_to = find_branch('.')
477
stored_loc = br_to.controlfile("x-pull", "rb").read().rstrip('\n')
479
if e.errno != errno.ENOENT:
482
if stored_loc is None:
483
raise BzrCommandError("No pull location known or specified.")
485
print "Using last location: %s" % stored_loc
486
location = stored_loc
487
cache_root = tempfile.mkdtemp()
488
from bzrlib.branch import DivergedBranches
489
br_from = find_branch(location)
490
location = pull_loc(br_from)
491
old_revno = br_to.revno()
493
from branch import find_cached_branch, DivergedBranches
494
br_from = find_cached_branch(location, cache_root)
495
location = pull_loc(br_from)
496
old_revno = br_to.revno()
498
br_to.update_revisions(br_from)
499
except DivergedBranches:
500
raise BzrCommandError("These branches have diverged."
503
merge(('.', -1), ('.', old_revno), check_clean=False)
504
if location != stored_loc:
505
br_to.controlfile("x-pull", "wb").write(location + "\n")
511
class cmd_branch(Command):
512
"""Create a new copy of a branch.
514
If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
515
be used. In other words, "branch ../foo/bar" will attempt to create ./bar.
517
To retrieve the branch as of a particular revision, supply the --revision
518
parameter, as in "branch foo/bar -r 5".
520
takes_args = ['from_location', 'to_location?']
521
takes_options = ['revision']
523
def run(self, from_location, to_location=None, revision=None):
525
from bzrlib.merge import merge
526
from bzrlib.branch import DivergedBranches, NoSuchRevision, \
527
find_cached_branch, Branch
528
from shutil import rmtree
529
from meta_store import CachedStore
531
cache_root = tempfile.mkdtemp()
534
br_from = find_cached_branch(from_location, cache_root)
536
if e.errno == errno.ENOENT:
537
raise BzrCommandError('Source location "%s" does not'
538
' exist.' % to_location)
542
if to_location is None:
543
to_location = os.path.basename(from_location.rstrip("/\\"))
546
os.mkdir(to_location)
548
if e.errno == errno.EEXIST:
549
raise BzrCommandError('Target directory "%s" already'
550
' exists.' % to_location)
551
if e.errno == errno.ENOENT:
552
raise BzrCommandError('Parent of "%s" does not exist.' %
556
br_to = Branch(to_location, init=True)
559
br_to.update_revisions(br_from, stop_revision=revision)
560
except NoSuchRevision:
562
msg = "The branch %s has no revision %d." % (from_location,
564
raise BzrCommandError(msg)
565
merge((to_location, -1), (to_location, 0), this_dir=to_location,
566
check_clean=False, ignore_zero=True)
567
from_location = pull_loc(br_from)
568
br_to.controlfile("x-pull", "wb").write(from_location + "\n")
573
def pull_loc(branch):
574
# TODO: Should perhaps just make attribute be 'base' in
575
# RemoteBranch and Branch?
576
if hasattr(branch, "baseurl"):
577
return branch.baseurl
583
class cmd_renames(Command):
584
"""Show list of renamed files.
586
TODO: Option to show renames between two historical versions.
588
TODO: Only show renames under dir, rather than in the whole branch.
590
takes_args = ['dir?']
592
def run(self, dir='.'):
594
old_inv = b.basis_tree().inventory
595
new_inv = b.read_working_inventory()
597
renames = list(bzrlib.tree.find_renames(old_inv, new_inv))
599
for old_name, new_name in renames:
600
print "%s => %s" % (old_name, new_name)
603
class cmd_info(Command):
604
"""Show statistical information about a branch."""
605
takes_args = ['branch?']
607
def run(self, branch=None):
610
b = find_branch(branch)
614
class cmd_remove(Command):
615
"""Make a file unversioned.
617
This makes bzr stop tracking changes to a versioned file. It does
618
not delete the working copy.
620
takes_args = ['file+']
621
takes_options = ['verbose']
623
def run(self, file_list, verbose=False):
624
b = find_branch(file_list[0])
625
b.remove([b.relpath(f) for f in file_list], verbose=verbose)
628
class cmd_file_id(Command):
629
"""Print file_id of a particular file or directory.
631
The file_id is assigned when the file is first added and remains the
632
same through all revisions where the file exists, even when it is
636
takes_args = ['filename']
637
def run(self, filename):
638
b = find_branch(filename)
639
i = b.inventory.path2id(b.relpath(filename))
641
raise BzrError("%r is not a versioned file" % filename)
646
class cmd_file_path(Command):
647
"""Print path of file_ids to a file or directory.
649
This prints one line for each directory down to the target,
650
starting at the branch root."""
652
takes_args = ['filename']
653
def run(self, filename):
654
b = find_branch(filename)
656
fid = inv.path2id(b.relpath(filename))
658
raise BzrError("%r is not a versioned file" % filename)
659
for fip in inv.get_idpath(fid):
663
class cmd_revision_history(Command):
664
"""Display list of revision ids on this branch."""
667
for patchid in find_branch('.').revision_history():
671
class cmd_directories(Command):
672
"""Display list of versioned directories in this branch."""
674
for name, ie in find_branch('.').read_working_inventory().directories():
681
class cmd_init(Command):
682
"""Make a directory into a versioned branch.
684
Use this to create an empty branch, or before importing an
687
Recipe for importing a tree of files:
692
bzr commit -m 'imported project'
695
from bzrlib.branch import Branch
696
Branch('.', init=True)
699
class cmd_diff(Command):
700
"""Show differences in working tree.
702
If files are listed, only the changes in those files are listed.
703
Otherwise, all changes for the tree are listed.
705
TODO: Given two revision arguments, show the difference between them.
707
TODO: Allow diff across branches.
709
TODO: Option to use external diff command; could be GNU diff, wdiff,
712
TODO: Python difflib is not exactly the same as unidiff; should
713
either fix it up or prefer to use an external diff.
715
TODO: If a directory is given, diff everything under that.
717
TODO: Selected-file diff is inefficient and doesn't show you
720
TODO: This probably handles non-Unix newlines poorly.
723
takes_args = ['file*']
724
takes_options = ['revision', 'diff-options']
725
aliases = ['di', 'dif']
727
def run(self, revision=None, file_list=None, diff_options=None):
728
from bzrlib.diff import show_diff
731
b = find_branch(file_list[0])
732
file_list = [b.relpath(f) for f in file_list]
733
if file_list == ['']:
734
# just pointing to top-of-tree
739
show_diff(b, revision, specific_files=file_list,
740
external_diff_options=diff_options)
746
class cmd_deleted(Command):
747
"""List files deleted in the working tree.
749
TODO: Show files deleted since a previous revision, or between two revisions.
751
def run(self, show_ids=False):
754
new = b.working_tree()
756
## TODO: Much more efficient way to do this: read in new
757
## directories with readdir, rather than stating each one. Same
758
## level of effort but possibly much less IO. (Or possibly not,
759
## if the directories are very large...)
761
for path, ie in old.inventory.iter_entries():
762
if not new.has_id(ie.file_id):
764
print '%-50s %s' % (path, ie.file_id)
769
class cmd_modified(Command):
770
"""List files modified in working tree."""
773
from bzrlib.diff import compare_trees
776
td = compare_trees(b.basis_tree(), b.working_tree())
778
for path, id, kind in td.modified:
783
class cmd_added(Command):
784
"""List files added in working tree."""
788
wt = b.working_tree()
789
basis_inv = b.basis_tree().inventory
792
if file_id in basis_inv:
794
path = inv.id2path(file_id)
795
if not os.access(b.abspath(path), os.F_OK):
801
class cmd_root(Command):
802
"""Show the tree root directory.
804
The root is the nearest enclosing directory with a .bzr control
806
takes_args = ['filename?']
807
def run(self, filename=None):
808
"""Print the branch root."""
809
b = find_branch(filename)
810
print getattr(b, 'base', None) or getattr(b, 'baseurl')
813
class cmd_log(Command):
814
"""Show log of this branch.
816
To request a range of logs, you can use the command -r begin:end
817
-r revision requests a specific revision, -r :end or -r begin: are
820
TODO: Make --revision support uuid: and hash: [future tag:] notation.
824
takes_args = ['filename?']
825
takes_options = ['forward', 'timezone', 'verbose', 'show-ids', 'revision','long']
827
def run(self, filename=None, timezone='original',
833
from bzrlib.branch import find_branch
834
from bzrlib.log import log_formatter, show_log
837
direction = (forward and 'forward') or 'reverse'
840
b = find_branch(filename)
841
fp = b.relpath(filename)
843
file_id = b.read_working_inventory().path2id(fp)
845
file_id = None # points to branch root
851
revision = [None, None]
852
elif isinstance(revision, int):
853
revision = [revision, revision]
858
assert len(revision) == 2
860
mutter('encoding log as %r' % bzrlib.user_encoding)
862
# use 'replace' so that we don't abort if trying to write out
863
# in e.g. the default C locale.
864
outf = codecs.getwriter(bzrlib.user_encoding)(sys.stdout, errors='replace')
870
lf = log_formatter(log_format,
873
show_timezone=timezone)
880
start_revision=revision[0],
881
end_revision=revision[1])
885
class cmd_touching_revisions(Command):
886
"""Return revision-ids which affected a particular file.
888
A more user-friendly interface is "bzr log FILE"."""
890
takes_args = ["filename"]
891
def run(self, filename):
892
b = find_branch(filename)
893
inv = b.read_working_inventory()
894
file_id = inv.path2id(b.relpath(filename))
895
for revno, revision_id, what in bzrlib.log.find_touching_revisions(b, file_id):
896
print "%6d %s" % (revno, what)
899
class cmd_ls(Command):
900
"""List files in a tree.
902
TODO: Take a revision or remote path and list that tree instead.
905
def run(self, revision=None, verbose=False):
908
tree = b.working_tree()
910
tree = b.revision_tree(b.lookup_revision(revision))
912
for fp, fc, kind, fid in tree.list_files():
914
if kind == 'directory':
921
print '%-8s %s%s' % (fc, fp, kindch)
927
class cmd_unknowns(Command):
928
"""List unknown files."""
930
from bzrlib.osutils import quotefn
931
for f in find_branch('.').unknowns():
936
class cmd_ignore(Command):
937
"""Ignore a command or pattern.
939
To remove patterns from the ignore list, edit the .bzrignore file.
941
If the pattern contains a slash, it is compared to the whole path
942
from the branch root. Otherwise, it is comapred to only the last
943
component of the path.
945
Ignore patterns are case-insensitive on case-insensitive systems.
947
Note: wildcards must be quoted from the shell on Unix.
950
bzr ignore ./Makefile
953
takes_args = ['name_pattern']
955
def run(self, name_pattern):
956
from bzrlib.atomicfile import AtomicFile
960
ifn = b.abspath('.bzrignore')
962
if os.path.exists(ifn):
965
igns = f.read().decode('utf-8')
971
# TODO: If the file already uses crlf-style termination, maybe
972
# we should use that for the newly added lines?
974
if igns and igns[-1] != '\n':
976
igns += name_pattern + '\n'
979
f = AtomicFile(ifn, 'wt')
980
f.write(igns.encode('utf-8'))
985
inv = b.working_tree().inventory
986
if inv.path2id('.bzrignore'):
987
mutter('.bzrignore is already versioned')
989
mutter('need to make new .bzrignore file versioned')
990
b.add(['.bzrignore'])
994
class cmd_ignored(Command):
995
"""List ignored files and the patterns that matched them.
997
See also: bzr ignore"""
999
tree = find_branch('.').working_tree()
1000
for path, file_class, kind, file_id in tree.list_files():
1001
if file_class != 'I':
1003
## XXX: Slightly inefficient since this was already calculated
1004
pat = tree.is_ignored(path)
1005
print '%-50s %s' % (path, pat)
1008
class cmd_lookup_revision(Command):
1009
"""Lookup the revision-id from a revision-number
1012
bzr lookup-revision 33
1015
takes_args = ['revno']
1017
def run(self, revno):
1021
raise BzrCommandError("not a valid revision-number: %r" % revno)
1023
print find_branch('.').lookup_revision(revno)
1026
class cmd_export(Command):
1027
"""Export past revision to destination directory.
1029
If no revision is specified this exports the last committed revision.
1031
Format may be an "exporter" name, such as tar, tgz, tbz2. If none is
1032
given, try to find the format with the extension. If no extension
1033
is found exports to a directory (equivalent to --format=dir).
1035
Root may be the top directory for tar, tgz and tbz2 formats. If none
1036
is given, the top directory will be the root name of the file."""
1037
# TODO: list known exporters
1038
takes_args = ['dest']
1039
takes_options = ['revision', 'format', 'root']
1040
def run(self, dest, revision=None, format=None, root=None):
1042
b = find_branch('.')
1043
if revision == None:
1044
rh = b.revision_history()[-1]
1046
rh = b.lookup_revision(int(revision))
1047
t = b.revision_tree(rh)
1048
root, ext = os.path.splitext(dest)
1050
if ext in (".tar",):
1052
elif ext in (".gz", ".tgz"):
1054
elif ext in (".bz2", ".tbz2"):
1058
t.export(dest, format, root)
1061
class cmd_cat(Command):
1062
"""Write a file's text from a previous revision."""
1064
takes_options = ['revision']
1065
takes_args = ['filename']
1067
def run(self, filename, revision=None):
1068
if revision == None:
1069
raise BzrCommandError("bzr cat requires a revision number")
1070
b = find_branch('.')
1071
b.print_file(b.relpath(filename), int(revision))
1074
class cmd_local_time_offset(Command):
1075
"""Show the offset in seconds from GMT to local time."""
1078
print bzrlib.osutils.local_time_offset()
1082
class cmd_commit(Command):
1083
"""Commit changes into a new revision.
1085
If selected files are specified, only changes to those files are
1086
committed. If a directory is specified then its contents are also
1089
A selected-file commit may fail in some cases where the committed
1090
tree would be invalid, such as trying to commit a file in a
1091
newly-added directory that is not itself committed.
1093
TODO: Run hooks on tree to-be-committed, and after commit.
1095
TODO: Strict commit that fails if there are unknown or deleted files.
1097
takes_args = ['selected*']
1098
takes_options = ['message', 'file', 'verbose', 'unchanged']
1099
aliases = ['ci', 'checkin']
1101
def run(self, message=None, file=None, verbose=True, selected_list=None,
1103
from bzrlib.errors import PointlessCommit
1104
from bzrlib.osutils import get_text_message
1106
## Warning: shadows builtin file()
1107
if not message and not file:
1110
catcher = cStringIO.StringIO()
1111
sys.stdout = catcher
1112
cmd_status({"file_list":selected_list}, {})
1113
info = catcher.getvalue()
1115
message = get_text_message(info)
1118
raise BzrCommandError("please specify a commit message",
1119
["use either --message or --file"])
1120
elif message and file:
1121
raise BzrCommandError("please specify either --message or --file")
1125
message = codecs.open(file, 'rt', bzrlib.user_encoding).read()
1127
b = find_branch('.')
1130
b.commit(message, verbose=verbose,
1131
specific_files=selected_list,
1132
allow_pointless=unchanged)
1133
except PointlessCommit:
1134
# FIXME: This should really happen before the file is read in;
1135
# perhaps prepare the commit; get the message; then actually commit
1136
raise BzrCommandError("no changes to commit",
1137
["use --unchanged to commit anyhow"])
1140
class cmd_check(Command):
1141
"""Validate consistency of branch history.
1143
This command checks various invariants about the branch storage to
1144
detect data corruption or bzr bugs.
1146
If given the --update flag, it will update some optional fields
1147
to help ensure data consistency.
1149
takes_args = ['dir?']
1151
def run(self, dir='.'):
1152
from bzrlib.check import check
1153
check(find_branch(dir))
1157
class cmd_upgrade(Command):
1158
"""Upgrade branch storage to current format.
1160
This should normally be used only after the check command tells
1163
takes_args = ['dir?']
1165
def run(self, dir='.'):
1166
from bzrlib.upgrade import upgrade
1167
upgrade(find_branch(dir))
1171
class cmd_whoami(Command):
1172
"""Show bzr user id."""
1173
takes_options = ['email']
1175
def run(self, email=False):
1177
print bzrlib.osutils.user_email()
1179
print bzrlib.osutils.username()
1182
class cmd_selftest(Command):
1183
"""Run internal test suite"""
1186
from bzrlib.selftest import selftest
1187
return int(not selftest())
1190
class cmd_version(Command):
1191
"""Show version of bzr."""
1196
print "bzr (bazaar-ng) %s" % bzrlib.__version__
1197
# is bzrlib itself in a branch?
1198
bzrrev = bzrlib.get_bzr_revision()
1200
print " (bzr checkout, revision %d {%s})" % bzrrev
1201
print bzrlib.__copyright__
1202
print "http://bazaar-ng.org/"
1204
print "bzr comes with ABSOLUTELY NO WARRANTY. bzr is free software, and"
1205
print "you may use, modify and redistribute it under the terms of the GNU"
1206
print "General Public License version 2 or later."
1209
class cmd_rocks(Command):
1210
"""Statement of optimism."""
1213
print "it sure does!"
1215
def parse_spec(spec):
1217
>>> parse_spec(None)
1219
>>> parse_spec("./")
1221
>>> parse_spec("../@")
1223
>>> parse_spec("../f/@35")
1229
parsed = spec.split('/@')
1230
assert len(parsed) == 2
1234
parsed[1] = int(parsed[1])
1235
assert parsed[1] >=0
1237
parsed = [spec, None]
1242
class cmd_merge(Command):
1243
"""Perform a three-way merge of trees.
1245
The SPEC parameters are working tree or revision specifiers. Working trees
1246
are specified using standard paths or urls. No component of a directory
1247
path may begin with '@'.
1249
Working tree examples: '.', '..', 'foo@', but NOT 'foo/@bar'
1251
Revisions are specified using a dirname/@revno pair, where dirname is the
1252
branch directory and revno is the revision within that branch. If no revno
1253
is specified, the latest revision is used.
1255
Revision examples: './@127', 'foo/@', '../@1'
1257
The OTHER_SPEC parameter is required. If the BASE_SPEC parameter is
1258
not supplied, the common ancestor of OTHER_SPEC the current branch is used
1261
merge refuses to run if there are any uncommitted changes, unless
1264
takes_args = ['other_spec', 'base_spec?']
1265
takes_options = ['force']
1267
def run(self, other_spec, base_spec=None, force=False):
1268
from bzrlib.merge import merge
1269
merge(parse_spec(other_spec), parse_spec(base_spec),
1270
check_clean=(not force))
1274
class cmd_revert(Command):
1275
"""Restore selected files from a previous revision.
1277
takes_args = ['file+']
1278
def run(self, file_list):
1279
from bzrlib.branch import find_branch
1284
b = find_branch(file_list[0])
1286
b.revert([b.relpath(f) for f in file_list])
1289
class cmd_merge_revert(Command):
1290
"""Reverse all changes since the last commit.
1292
Only versioned files are affected.
1294
TODO: Store backups of any files that will be reverted, so
1295
that the revert can be undone.
1297
takes_options = ['revision']
1299
def run(self, revision=-1):
1300
from bzrlib.merge import merge
1301
merge(('.', revision), parse_spec('.'),
1306
class cmd_assert_fail(Command):
1307
"""Test reporting of assertion failures"""
1310
assert False, "always fails"
1313
class cmd_help(Command):
1314
"""Show help on a command or other topic.
1316
For a list of all available commands, say 'bzr help commands'."""
1317
takes_args = ['topic?']
1320
def run(self, topic=None):
1327
class cmd_plugins(Command):
1331
import bzrlib.plugin
1332
from pprint import pprint
1333
pprint(bzrlib.plugin.all_plugins)
1337
# list of all available options; the rhs can be either None for an
1338
# option that takes no argument, or a constructor function that checks
1342
'diff-options': str,
1351
'revision': _parse_revision_str,
1373
def parse_args(argv):
1374
"""Parse command line.
1376
Arguments and options are parsed at this level before being passed
1377
down to specific command handlers. This routine knows, from a
1378
lookup table, something about the available options, what optargs
1379
they take, and which commands will accept them.
1381
>>> parse_args('--help'.split())
1382
([], {'help': True})
1383
>>> parse_args('--version'.split())
1384
([], {'version': True})
1385
>>> parse_args('status --all'.split())
1386
(['status'], {'all': True})
1387
>>> parse_args('commit --message=biter'.split())
1388
(['commit'], {'message': u'biter'})
1389
>>> parse_args('log -r 500'.split())
1390
(['log'], {'revision': 500})
1391
>>> parse_args('log -r500:600'.split())
1392
(['log'], {'revision': [500, 600]})
1393
>>> parse_args('log -vr500:600'.split())
1394
(['log'], {'verbose': True, 'revision': [500, 600]})
1395
>>> parse_args('log -rv500:600'.split()) #the r takes an argument
1396
Traceback (most recent call last):
1398
ValueError: invalid literal for int(): v500
1403
# TODO: Maybe handle '--' to end options?
1408
# option names must not be unicode
1412
mutter(" got option %r" % a)
1414
optname, optarg = a[2:].split('=', 1)
1417
if optname not in OPTIONS:
1418
raise BzrError('unknown long option %r' % a)
1421
if shortopt in SHORT_OPTIONS:
1422
# Multi-character options must have a space to delimit
1424
optname = SHORT_OPTIONS[shortopt]
1426
# Single character short options, can be chained,
1427
# and have their value appended to their name
1429
if shortopt not in SHORT_OPTIONS:
1430
# We didn't find the multi-character name, and we
1431
# didn't find the single char name
1432
raise BzrError('unknown short option %r' % a)
1433
optname = SHORT_OPTIONS[shortopt]
1436
# There are extra things on this option
1437
# see if it is the value, or if it is another
1439
optargfn = OPTIONS[optname]
1440
if optargfn is None:
1441
# This option does not take an argument, so the
1442
# next entry is another short option, pack it back
1444
argv.insert(0, '-' + a[2:])
1446
# This option takes an argument, so pack it
1451
# XXX: Do we ever want to support this, e.g. for -r?
1452
raise BzrError('repeated option %r' % a)
1454
optargfn = OPTIONS[optname]
1458
raise BzrError('option %r needs an argument' % a)
1460
optarg = argv.pop(0)
1461
opts[optname] = optargfn(optarg)
1464
raise BzrError('option %r takes no argument' % optname)
1465
opts[optname] = True
1474
def _match_argform(cmd, takes_args, args):
1477
# step through args and takes_args, allowing appropriate 0-many matches
1478
for ap in takes_args:
1482
argdict[argname] = args.pop(0)
1483
elif ap[-1] == '*': # all remaining arguments
1485
argdict[argname + '_list'] = args[:]
1488
argdict[argname + '_list'] = None
1491
raise BzrCommandError("command %r needs one or more %s"
1492
% (cmd, argname.upper()))
1494
argdict[argname + '_list'] = args[:]
1496
elif ap[-1] == '$': # all but one
1498
raise BzrCommandError("command %r needs one or more %s"
1499
% (cmd, argname.upper()))
1500
argdict[argname + '_list'] = args[:-1]
1506
raise BzrCommandError("command %r requires argument %s"
1507
% (cmd, argname.upper()))
1509
argdict[argname] = args.pop(0)
1512
raise BzrCommandError("extra argument to command %s: %s"
1518
def _parse_master_args(argv):
1519
"""Parse the arguments that always go with the original command.
1520
These are things like bzr --no-plugins, etc.
1522
There are now 2 types of option flags. Ones that come *before* the command,
1523
and ones that come *after* the command.
1524
Ones coming *before* the command are applied against all possible commands.
1525
And are generally applied before plugins are loaded.
1527
The current list are:
1528
--builtin Allow plugins to load, but don't let them override builtin commands,
1529
they will still be allowed if they do not override a builtin.
1530
--no-plugins Don't load any plugins. This lets you get back to official source
1532
--profile Enable the hotspot profile before running the command.
1533
For backwards compatibility, this is also a non-master option.
1534
--version Spit out the version of bzr that is running and exit.
1535
This is also a non-master option.
1536
--help Run help and exit, also a non-master option (I think that should stay, though)
1538
>>> argv, opts = _parse_master_args(['bzr', '--test'])
1539
Traceback (most recent call last):
1541
BzrCommandError: Invalid master option: 'test'
1542
>>> argv, opts = _parse_master_args(['bzr', '--version', 'command'])
1545
>>> print opts['version']
1547
>>> argv, opts = _parse_master_args(['bzr', '--profile', 'command', '--more-options'])
1549
['command', '--more-options']
1550
>>> print opts['profile']
1552
>>> argv, opts = _parse_master_args(['bzr', '--no-plugins', 'command'])
1555
>>> print opts['no-plugins']
1557
>>> print opts['profile']
1559
>>> argv, opts = _parse_master_args(['bzr', 'command', '--profile'])
1561
['command', '--profile']
1562
>>> print opts['profile']
1565
master_opts = {'builtin':False,
1572
# This is the point where we could hook into argv[0] to determine
1573
# what front-end is supposed to be run
1574
# For now, we are just ignoring it.
1575
cmd_name = argv.pop(0)
1577
if arg[:2] != '--': # at the first non-option, we return the rest
1579
arg = arg[2:] # Remove '--'
1580
if arg not in master_opts:
1581
# We could say that this is not an error, that we should
1582
# just let it be handled by the main section instead
1583
raise BzrCommandError('Invalid master option: %r' % arg)
1584
argv.pop(0) # We are consuming this entry
1585
master_opts[arg] = True
1586
return argv, master_opts
1591
"""Execute a command.
1593
This is similar to main(), but without all the trappings for
1594
logging and error handling.
1596
argv = [a.decode(bzrlib.user_encoding) for a in argv]
1599
# some options like --builtin and --no-plugins have special effects
1600
argv, master_opts = _parse_master_args(argv)
1601
if not master_opts['no-plugins']:
1602
from bzrlib.plugin import load_plugins
1605
args, opts = parse_args(argv)
1607
if master_opts['help']:
1608
from bzrlib.help import help
1616
from bzrlib.help import help
1622
elif 'version' in opts:
1625
elif args and args[0] == 'builtin':
1626
include_plugins=False
1628
cmd = str(args.pop(0))
1635
plugins_override = not (master_opts['builtin'])
1636
canonical_cmd, cmd_class = get_cmd_class(cmd, plugins_override=plugins_override)
1638
profile = master_opts['profile']
1639
# For backwards compatibility, I would rather stick with --profile being a
1640
# master/global option
1641
if 'profile' in opts:
1645
# check options are reasonable
1646
allowed = cmd_class.takes_options
1648
if oname not in allowed:
1649
raise BzrCommandError("option '--%s' is not allowed for command %r"
1652
# mix arguments and options into one dictionary
1653
cmdargs = _match_argform(cmd, cmd_class.takes_args, args)
1655
for k, v in opts.items():
1656
cmdopts[k.replace('-', '_')] = v
1659
import hotshot, tempfile
1660
pffileno, pfname = tempfile.mkstemp()
1662
prof = hotshot.Profile(pfname)
1663
ret = prof.runcall(cmd_class, cmdopts, cmdargs) or 0
1666
import hotshot.stats
1667
stats = hotshot.stats.load(pfname)
1669
stats.sort_stats('time')
1670
## XXX: Might like to write to stderr or the trace file instead but
1671
## print_stats seems hardcoded to stdout
1672
stats.print_stats(20)
1680
return cmd_class(cmdopts, cmdargs).status
1683
def _report_exception(summary, quiet=False):
1685
log_error('bzr: ' + summary)
1686
bzrlib.trace.log_exception()
1689
tb = sys.exc_info()[2]
1690
exinfo = traceback.extract_tb(tb)
1692
sys.stderr.write(' at %s:%d in %s()\n' % exinfo[-1][:3])
1693
sys.stderr.write(' see ~/.bzr.log for debug information\n')
1699
bzrlib.trace.open_tracefile(argv)
1704
return run_bzr(argv)
1706
# do this here inside the exception wrappers to catch EPIPE
1709
quiet = isinstance(e, (BzrCommandError))
1710
_report_exception('error: ' + e.args[0], quiet=quiet)
1713
# some explanation or hints
1716
except AssertionError, e:
1717
msg = 'assertion failed'
1719
msg += ': ' + str(e)
1720
_report_exception(msg)
1722
except KeyboardInterrupt, e:
1723
_report_exception('interrupted', quiet=True)
1725
except Exception, e:
1728
if (isinstance(e, IOError)
1729
and hasattr(e, 'errno')
1730
and e.errno == errno.EPIPE):
1734
msg = str(e).rstrip('\n')
1735
_report_exception(msg, quiet)
1738
bzrlib.trace.close_trace()
1741
if __name__ == '__main__':
1742
sys.exit(main(sys.argv))