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.osutils import quotefn
25
from bzrlib import Branch, Inventory, InventoryEntry, BZRDIR, \
32
def register_command(cmd):
33
"Utility function to help register a command"
36
if k.startswith("cmd_"):
37
k_unsquished = _unsquish_command_name(k)
40
if not plugin_cmds.has_key(k_unsquished):
41
plugin_cmds[k_unsquished] = cmd
43
log_error('Two plugins defined the same command: %r' % k)
44
log_error('Not loading the one in %r' % sys.modules[cmd.__module__])
47
def _squish_command_name(cmd):
48
return 'cmd_' + cmd.replace('-', '_')
51
def _unsquish_command_name(cmd):
52
assert cmd.startswith("cmd_")
53
return cmd[4:].replace('_','-')
55
def _parse_revision_str(revstr):
56
"""This handles a revision string -> revno.
58
There are several possibilities:
61
'234:345' -> [234, 345]
65
In the future we will also support:
66
'uuid:blah-blah-blah' -> ?
67
'hash:blahblahblah' -> ?
71
if revstr.find(':') != -1:
72
revs = revstr.split(':')
74
raise ValueError('More than 2 pieces not supported for --revision: %r' % revstr)
79
revs[0] = int(revs[0])
84
revs[1] = int(revs[1])
91
def _get_cmd_dict(plugins_override=True):
93
for k, v in globals().iteritems():
94
if k.startswith("cmd_"):
95
d[_unsquish_command_name(k)] = v
96
# If we didn't load plugins, the plugin_cmds dict will be empty
100
d2 = plugin_cmds.copy()
106
def get_all_cmds(plugins_override=True):
107
"""Return canonical name and class for all registered commands."""
108
for k, v in _get_cmd_dict(plugins_override=plugins_override).iteritems():
112
def get_cmd_class(cmd, plugins_override=True):
113
"""Return the canonical name and command class for a command.
115
cmd = str(cmd) # not unicode
117
# first look up this command under the specified name
118
cmds = _get_cmd_dict(plugins_override=plugins_override)
120
return cmd, cmds[cmd]
124
# look for any command which claims this as an alias
125
for cmdname, cmdclass in cmds.iteritems():
126
if cmd in cmdclass.aliases:
127
return cmdname, cmdclass
129
cmdclass = ExternalCommand.find_command(cmd)
133
raise BzrCommandError("unknown command %r" % cmd)
136
class Command(object):
137
"""Base class for commands.
139
The docstring for an actual command should give a single-line
140
summary, then a complete description of the command. A grammar
141
description will be inserted.
144
List of argument forms, marked with whether they are optional,
148
List of options that may be given for this command.
151
If true, this command isn't advertised.
160
def __init__(self, options, arguments):
161
"""Construct and run the command.
163
Sets self.status to the return value of run()."""
164
assert isinstance(options, dict)
165
assert isinstance(arguments, dict)
166
cmdargs = options.copy()
167
cmdargs.update(arguments)
168
assert self.__doc__ != Command.__doc__, \
169
("No help message set for %r" % self)
170
self.status = self.run(**cmdargs)
174
"""Override this in sub-classes.
176
This is invoked with the options and arguments bound to
179
Return 0 or None if the command was successful, or a shell
185
class ExternalCommand(Command):
186
"""Class to wrap external commands.
188
We cheat a little here, when get_cmd_class() calls us we actually give it back
189
an object we construct that has the appropriate path, help, options etc for the
192
When run_bzr() tries to instantiate that 'class' it gets caught by the __call__
193
method, which we override to call the Command.__init__ method. That then calls
194
our run method which is pretty straight forward.
196
The only wrinkle is that we have to map bzr's dictionary of options and arguments
197
back into command line options and arguments for the script.
200
def find_command(cls, cmd):
202
bzrpath = os.environ.get('BZRPATH', '')
204
for dir in bzrpath.split(os.pathsep):
205
path = os.path.join(dir, cmd)
206
if os.path.isfile(path):
207
return ExternalCommand(path)
211
find_command = classmethod(find_command)
213
def __init__(self, path):
216
pipe = os.popen('%s --bzr-usage' % path, 'r')
217
self.takes_options = pipe.readline().split()
219
for opt in self.takes_options:
220
if not opt in OPTIONS:
221
raise BzrError("Unknown option '%s' returned by external command %s"
224
# TODO: Is there any way to check takes_args is valid here?
225
self.takes_args = pipe.readline().split()
227
if pipe.close() is not None:
228
raise BzrError("Failed funning '%s --bzr-usage'" % path)
230
pipe = os.popen('%s --bzr-help' % path, 'r')
231
self.__doc__ = pipe.read()
232
if pipe.close() is not None:
233
raise BzrError("Failed funning '%s --bzr-help'" % path)
235
def __call__(self, options, arguments):
236
Command.__init__(self, options, arguments)
239
def run(self, **kargs):
246
optname = name.replace('_','-')
248
if OPTIONS.has_key(optname):
250
opts.append('--%s' % optname)
251
if value is not None and value is not True:
252
opts.append(str(value))
254
# it's an arg, or arg list
255
if type(value) is not list:
261
self.status = os.spawnv(os.P_WAIT, self.path, [self.path] + opts + args)
265
class cmd_status(Command):
266
"""Display status summary.
268
This reports on versioned and unknown files, reporting them
269
grouped by state. Possible states are:
272
Versioned in the working copy but not in the previous revision.
275
Versioned in the previous revision but removed or deleted
279
Path of this file changed from the previous revision;
280
the text may also have changed. This includes files whose
281
parent directory was renamed.
284
Text has changed since the previous revision.
287
Nothing about this file has changed since the previous revision.
288
Only shown with --all.
291
Not versioned and not matching an ignore pattern.
293
To see ignored files use 'bzr ignored'. For details in the
294
changes to file texts, use 'bzr diff'.
296
If no arguments are specified, the status of the entire working
297
directory is shown. Otherwise, only the status of the specified
298
files or directories is reported. If a directory is given, status
299
is reported for everything inside that directory.
301
takes_args = ['file*']
302
takes_options = ['all', 'show-ids']
303
aliases = ['st', 'stat']
305
def run(self, all=False, show_ids=False, file_list=None):
307
b = Branch(file_list[0])
308
file_list = [b.relpath(x) for x in file_list]
309
# special case: only one path was given and it's the root
311
if file_list == ['']:
316
status.show_status(b, show_unchanged=all, show_ids=show_ids,
317
specific_files=file_list)
320
class cmd_cat_revision(Command):
321
"""Write out metadata for a revision."""
324
takes_args = ['revision_id']
326
def run(self, revision_id):
327
Branch('.').get_revision(revision_id).write_xml(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 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
bzrlib.add.smart_add(file_list, verbose, not no_recurse)
367
class cmd_mkdir(Command):
368
"""Create a new versioned directory.
370
This is equivalent to creating the directory and then adding it.
372
takes_args = ['dir+']
374
def run(self, dir_list):
383
b = bzrlib.branch.Branch(d)
384
b.add([d], verbose=True)
387
class cmd_relpath(Command):
388
"""Show path of a file relative to root"""
389
takes_args = ['filename']
392
def run(self, filename):
393
print Branch(filename).relpath(filename)
397
class cmd_inventory(Command):
398
"""Show inventory of the current working copy or a revision."""
399
takes_options = ['revision', 'show-ids']
401
def run(self, revision=None, show_ids=False):
404
inv = b.read_working_inventory()
406
inv = b.get_revision_inventory(b.lookup_revision(revision))
408
for path, entry in inv.entries():
410
print '%-50s %s' % (path, entry.file_id)
415
class cmd_move(Command):
416
"""Move files to a different directory.
421
The destination must be a versioned directory in the same branch.
423
takes_args = ['source$', 'dest']
424
def run(self, source_list, dest):
427
b.move([b.relpath(s) for s in source_list], b.relpath(dest))
430
class cmd_rename(Command):
431
"""Change the name of an entry.
434
bzr rename frob.c frobber.c
435
bzr rename src/frob.c lib/frob.c
437
It is an error if the destination name exists.
439
See also the 'move' command, which moves files into a different
440
directory without changing their name.
442
TODO: Some way to rename multiple files without invoking bzr for each
444
takes_args = ['from_name', 'to_name']
446
def run(self, from_name, to_name):
448
b.rename_one(b.relpath(from_name), b.relpath(to_name))
454
class cmd_pull(Command):
455
"""Pull any changes from another branch into the current one.
457
If the location is omitted, the last-used location will be used.
458
Both the revision history and the working directory will be
461
This command only works on branches that have not diverged. Branches are
462
considered diverged if both branches have had commits without first
463
pulling from the other.
465
If branches have diverged, you can use 'bzr merge' to pull the text changes
466
from one into the other.
468
takes_args = ['location?']
470
def run(self, location=None):
471
from bzrlib.merge import merge
473
from shutil import rmtree
479
stored_loc = br_to.controlfile("x-pull", "rb").read().rstrip('\n')
481
if e.errno != errno.ENOENT:
484
if stored_loc is None:
485
raise BzrCommandError("No pull location known or specified.")
487
print "Using last location: %s" % stored_loc
488
location = stored_loc
489
cache_root = tempfile.mkdtemp()
491
from branch import find_cached_branch, DivergedBranches
492
br_from = find_cached_branch(location, cache_root)
493
location = pull_loc(br_from)
494
old_revno = br_to.revno()
496
br_to.update_revisions(br_from)
497
except DivergedBranches:
498
raise BzrCommandError("These branches have diverged."
501
merge(('.', -1), ('.', old_revno), check_clean=False)
502
if location != stored_loc:
503
br_to.controlfile("x-pull", "wb").write(location + "\n")
509
class cmd_branch(Command):
510
"""Create a new copy of a branch.
512
If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
513
be used. In other words, "branch ../foo/bar" will attempt to create ./bar.
515
To retrieve the branch as of a particular revision, supply the --revision
516
parameter, as in "branch foo/bar -r 5".
518
takes_args = ['from_location', 'to_location?']
519
takes_options = ['revision']
521
def run(self, from_location, to_location=None, revision=None):
523
from bzrlib.merge import merge
524
from branch import find_cached_branch, DivergedBranches, NoSuchRevision
525
from shutil import rmtree
526
from meta_store import CachedStore
528
cache_root = tempfile.mkdtemp()
531
br_from = find_cached_branch(from_location, cache_root)
533
if e.errno == errno.ENOENT:
534
raise BzrCommandError('Source location "%s" does not'
535
' exist.' % to_location)
539
if to_location is None:
540
to_location = os.path.basename(from_location.rstrip("/\\"))
543
os.mkdir(to_location)
545
if e.errno == errno.EEXIST:
546
raise BzrCommandError('Target directory "%s" already'
547
' exists.' % to_location)
548
if e.errno == errno.ENOENT:
549
raise BzrCommandError('Parent of "%s" does not exist.' %
553
br_to = Branch(to_location, init=True)
556
br_to.update_revisions(br_from, stop_revision=revision)
557
except NoSuchRevision:
559
msg = "The branch %s has no revision %d." % (from_location,
561
raise BzrCommandError(msg)
562
merge((to_location, -1), (to_location, 0), this_dir=to_location,
563
check_clean=False, ignore_zero=True)
564
from_location = pull_loc(br_from)
565
br_to.controlfile("x-pull", "wb").write(from_location + "\n")
570
def pull_loc(branch):
571
# TODO: Should perhaps just make attribute be 'base' in
572
# RemoteBranch and Branch?
573
if hasattr(branch, "baseurl"):
574
return branch.baseurl
580
class cmd_renames(Command):
581
"""Show list of renamed files.
583
TODO: Option to show renames between two historical versions.
585
TODO: Only show renames under dir, rather than in the whole branch.
587
takes_args = ['dir?']
589
def run(self, dir='.'):
591
old_inv = b.basis_tree().inventory
592
new_inv = b.read_working_inventory()
594
renames = list(bzrlib.tree.find_renames(old_inv, new_inv))
596
for old_name, new_name in renames:
597
print "%s => %s" % (old_name, new_name)
600
class cmd_info(Command):
601
"""Show statistical information about a branch."""
602
takes_args = ['branch?']
604
def run(self, branch=None):
607
from branch import find_branch
608
b = find_branch(branch)
612
class cmd_remove(Command):
613
"""Make a file unversioned.
615
This makes bzr stop tracking changes to a versioned file. It does
616
not delete the working copy.
618
takes_args = ['file+']
619
takes_options = ['verbose']
621
def run(self, file_list, verbose=False):
622
b = Branch(file_list[0])
623
b.remove([b.relpath(f) for f in file_list], verbose=verbose)
626
class cmd_file_id(Command):
627
"""Print file_id of a particular file or directory.
629
The file_id is assigned when the file is first added and remains the
630
same through all revisions where the file exists, even when it is
634
takes_args = ['filename']
635
def run(self, filename):
637
i = b.inventory.path2id(b.relpath(filename))
639
raise BzrError("%r is not a versioned file" % filename)
644
class cmd_file_path(Command):
645
"""Print path of file_ids to a file or directory.
647
This prints one line for each directory down to the target,
648
starting at the branch root."""
650
takes_args = ['filename']
651
def run(self, filename):
654
fid = inv.path2id(b.relpath(filename))
656
raise BzrError("%r is not a versioned file" % filename)
657
for fip in inv.get_idpath(fid):
661
class cmd_revision_history(Command):
662
"""Display list of revision ids on this branch."""
665
for patchid in Branch('.').revision_history():
669
class cmd_directories(Command):
670
"""Display list of versioned directories in this branch."""
672
for name, ie in Branch('.').read_working_inventory().directories():
679
class cmd_init(Command):
680
"""Make a directory into a versioned branch.
682
Use this to create an empty branch, or before importing an
685
Recipe for importing a tree of files:
690
bzr commit -m 'imported project'
693
Branch('.', init=True)
696
class cmd_diff(Command):
697
"""Show differences in working tree.
699
If files are listed, only the changes in those files are listed.
700
Otherwise, all changes for the tree are listed.
702
TODO: Given two revision arguments, show the difference between them.
704
TODO: Allow diff across branches.
706
TODO: Option to use external diff command; could be GNU diff, wdiff,
709
TODO: Python difflib is not exactly the same as unidiff; should
710
either fix it up or prefer to use an external diff.
712
TODO: If a directory is given, diff everything under that.
714
TODO: Selected-file diff is inefficient and doesn't show you
717
TODO: This probably handles non-Unix newlines poorly.
720
takes_args = ['file*']
721
takes_options = ['revision', 'diff-options']
722
aliases = ['di', 'dif']
724
def run(self, revision=None, file_list=None, diff_options=None):
725
from bzrlib.diff import show_diff
726
from bzrlib import find_branch
729
b = find_branch(file_list[0])
730
file_list = [b.relpath(f) for f in file_list]
731
if file_list == ['']:
732
# just pointing to top-of-tree
737
show_diff(b, revision, specific_files=file_list,
738
external_diff_options=diff_options)
744
class cmd_deleted(Command):
745
"""List files deleted in the working tree.
747
TODO: Show files deleted since a previous revision, or between two revisions.
749
def run(self, show_ids=False):
752
new = b.working_tree()
754
## TODO: Much more efficient way to do this: read in new
755
## directories with readdir, rather than stating each one. Same
756
## level of effort but possibly much less IO. (Or possibly not,
757
## if the directories are very large...)
759
for path, ie in old.inventory.iter_entries():
760
if not new.has_id(ie.file_id):
762
print '%-50s %s' % (path, ie.file_id)
767
class cmd_modified(Command):
768
"""List files modified in working tree."""
773
inv = b.read_working_inventory()
774
sc = statcache.update_cache(b, inv)
775
basis = b.basis_tree()
776
basis_inv = basis.inventory
778
# We used to do this through iter_entries(), but that's slow
779
# when most of the files are unmodified, as is usually the
780
# case. So instead we iterate by inventory entry, and only
781
# calculate paths as necessary.
783
for file_id in basis_inv:
784
cacheentry = sc.get(file_id)
785
if not cacheentry: # deleted
787
ie = basis_inv[file_id]
788
if cacheentry[statcache.SC_SHA1] != ie.text_sha1:
789
path = inv.id2path(file_id)
794
class cmd_added(Command):
795
"""List files added in working tree."""
799
wt = b.working_tree()
800
basis_inv = b.basis_tree().inventory
803
if file_id in basis_inv:
805
path = inv.id2path(file_id)
806
if not os.access(b.abspath(path), os.F_OK):
812
class cmd_root(Command):
813
"""Show the tree root directory.
815
The root is the nearest enclosing directory with a .bzr control
817
takes_args = ['filename?']
818
def run(self, filename=None):
819
"""Print the branch root."""
820
from branch import find_branch
821
b = find_branch(filename)
822
print getattr(b, 'base', None) or getattr(b, 'baseurl')
825
class cmd_log(Command):
826
"""Show log of this branch.
828
To request a range of logs, you can use the command -r begin:end
829
-r revision requests a specific revision, -r :end or -r begin: are
832
TODO: Make --revision support uuid: and hash: [future tag:] notation.
836
takes_args = ['filename?']
837
takes_options = ['forward', 'timezone', 'verbose', 'show-ids', 'revision']
839
def run(self, filename=None, timezone='original',
844
from bzrlib import show_log, find_branch
845
from bzrlib.log import log_formatter
848
direction = (forward and 'forward') or 'reverse'
851
b = find_branch(filename)
852
fp = b.relpath(filename)
854
file_id = b.read_working_inventory().path2id(fp)
856
file_id = None # points to branch root
862
revision = [None, None]
863
elif isinstance(revision, int):
864
revision = [revision, revision]
869
assert len(revision) == 2
871
mutter('encoding log as %r' % bzrlib.user_encoding)
873
# use 'replace' so that we don't abort if trying to write out
874
# in e.g. the default C locale.
875
outf = codecs.getwriter(bzrlib.user_encoding)(sys.stdout, errors='replace')
877
lf = log_formatter('short',
880
show_timezone=timezone)
887
start_revision=revision[0],
888
end_revision=revision[1])
892
class cmd_touching_revisions(Command):
893
"""Return revision-ids which affected a particular file.
895
A more user-friendly interface is "bzr log FILE"."""
897
takes_args = ["filename"]
898
def run(self, filename):
900
inv = b.read_working_inventory()
901
file_id = inv.path2id(b.relpath(filename))
902
for revno, revision_id, what in bzrlib.log.find_touching_revisions(b, file_id):
903
print "%6d %s" % (revno, what)
906
class cmd_ls(Command):
907
"""List files in a tree.
909
TODO: Take a revision or remote path and list that tree instead.
912
def run(self, revision=None, verbose=False):
915
tree = b.working_tree()
917
tree = b.revision_tree(b.lookup_revision(revision))
919
for fp, fc, kind, fid in tree.list_files():
921
if kind == 'directory':
928
print '%-8s %s%s' % (fc, fp, kindch)
934
class cmd_unknowns(Command):
935
"""List unknown files."""
937
for f in Branch('.').unknowns():
942
class cmd_ignore(Command):
943
"""Ignore a command or pattern.
945
To remove patterns from the ignore list, edit the .bzrignore file.
947
If the pattern contains a slash, it is compared to the whole path
948
from the branch root. Otherwise, it is comapred to only the last
949
component of the path.
951
Ignore patterns are case-insensitive on case-insensitive systems.
953
Note: wildcards must be quoted from the shell on Unix.
956
bzr ignore ./Makefile
959
takes_args = ['name_pattern']
961
def run(self, name_pattern):
962
from bzrlib.atomicfile import AtomicFile
966
ifn = b.abspath('.bzrignore')
968
if os.path.exists(ifn):
971
igns = f.read().decode('utf-8')
977
# TODO: If the file already uses crlf-style termination, maybe
978
# we should use that for the newly added lines?
980
if igns and igns[-1] != '\n':
982
igns += name_pattern + '\n'
985
f = AtomicFile(ifn, 'wt')
986
f.write(igns.encode('utf-8'))
991
inv = b.working_tree().inventory
992
if inv.path2id('.bzrignore'):
993
mutter('.bzrignore is already versioned')
995
mutter('need to make new .bzrignore file versioned')
996
b.add(['.bzrignore'])
1000
class cmd_ignored(Command):
1001
"""List ignored files and the patterns that matched them.
1003
See also: bzr ignore"""
1005
tree = Branch('.').working_tree()
1006
for path, file_class, kind, file_id in tree.list_files():
1007
if file_class != 'I':
1009
## XXX: Slightly inefficient since this was already calculated
1010
pat = tree.is_ignored(path)
1011
print '%-50s %s' % (path, pat)
1014
class cmd_lookup_revision(Command):
1015
"""Lookup the revision-id from a revision-number
1018
bzr lookup-revision 33
1021
takes_args = ['revno']
1023
def run(self, revno):
1027
raise BzrCommandError("not a valid revision-number: %r" % revno)
1029
print Branch('.').lookup_revision(revno)
1032
class cmd_export(Command):
1033
"""Export past revision to destination directory.
1035
If no revision is specified this exports the last committed revision.
1037
Format may be an "exporter" name, such as tar, tgz, tbz2. If none is
1038
given, exports to a directory (equivalent to --format=dir)."""
1039
# TODO: list known exporters
1040
takes_args = ['dest']
1041
takes_options = ['revision', 'format']
1042
def run(self, dest, revision=None, format='dir'):
1044
if revision == None:
1045
rh = b.revision_history()[-1]
1047
rh = b.lookup_revision(int(revision))
1048
t = b.revision_tree(rh)
1049
t.export(dest, format)
1052
class cmd_cat(Command):
1053
"""Write a file's text from a previous revision."""
1055
takes_options = ['revision']
1056
takes_args = ['filename']
1058
def run(self, filename, revision=None):
1059
if revision == None:
1060
raise BzrCommandError("bzr cat requires a revision number")
1062
b.print_file(b.relpath(filename), int(revision))
1065
class cmd_local_time_offset(Command):
1066
"""Show the offset in seconds from GMT to local time."""
1069
print bzrlib.osutils.local_time_offset()
1073
class cmd_commit(Command):
1074
"""Commit changes into a new revision.
1076
If selected files are specified, only changes to those files are
1077
committed. If a directory is specified then its contents are also
1080
A selected-file commit may fail in some cases where the committed
1081
tree would be invalid, such as trying to commit a file in a
1082
newly-added directory that is not itself committed.
1084
TODO: Run hooks on tree to-be-committed, and after commit.
1086
TODO: Strict commit that fails if there are unknown or deleted files.
1088
takes_args = ['selected*']
1089
takes_options = ['message', 'file', 'verbose']
1090
aliases = ['ci', 'checkin']
1092
def run(self, message=None, file=None, verbose=True, selected_list=None):
1093
from bzrlib.commit import commit
1094
from bzrlib.osutils import get_text_message
1096
## Warning: shadows builtin file()
1097
if not message and not file:
1100
catcher = cStringIO.StringIO()
1101
sys.stdout = catcher
1102
cmd_status({"file_list":selected_list}, {})
1103
info = catcher.getvalue()
1105
message = get_text_message(info)
1108
raise BzrCommandError("please specify a commit message",
1109
["use either --message or --file"])
1110
elif message and file:
1111
raise BzrCommandError("please specify either --message or --file")
1115
message = codecs.open(file, 'rt', bzrlib.user_encoding).read()
1118
commit(b, message, verbose=verbose, specific_files=selected_list)
1121
class cmd_check(Command):
1122
"""Validate consistency of branch history.
1124
This command checks various invariants about the branch storage to
1125
detect data corruption or bzr bugs.
1127
If given the --update flag, it will update some optional fields
1128
to help ensure data consistency.
1130
takes_args = ['dir?']
1132
def run(self, dir='.'):
1134
bzrlib.check.check(Branch(dir))
1138
class cmd_upgrade(Command):
1139
"""Upgrade branch storage to current format.
1141
This should normally be used only after the check command tells
1144
takes_args = ['dir?']
1146
def run(self, dir='.'):
1147
from bzrlib.upgrade import upgrade
1148
upgrade(Branch(dir))
1152
class cmd_whoami(Command):
1153
"""Show bzr user id."""
1154
takes_options = ['email']
1156
def run(self, email=False):
1158
print bzrlib.osutils.user_email()
1160
print bzrlib.osutils.username()
1163
class cmd_selftest(Command):
1164
"""Run internal test suite"""
1167
from bzrlib.selftest import selftest
1168
return int(not selftest())
1171
class cmd_version(Command):
1172
"""Show version of bzr."""
1177
print "bzr (bazaar-ng) %s" % bzrlib.__version__
1178
# is bzrlib itself in a branch?
1179
bzrrev = bzrlib.get_bzr_revision()
1181
print " (bzr checkout, revision %d {%s})" % bzrrev
1182
print bzrlib.__copyright__
1183
print "http://bazaar-ng.org/"
1185
print "bzr comes with ABSOLUTELY NO WARRANTY. bzr is free software, and"
1186
print "you may use, modify and redistribute it under the terms of the GNU"
1187
print "General Public License version 2 or later."
1190
class cmd_rocks(Command):
1191
"""Statement of optimism."""
1194
print "it sure does!"
1196
def parse_spec(spec):
1198
>>> parse_spec(None)
1200
>>> parse_spec("./")
1202
>>> parse_spec("../@")
1204
>>> parse_spec("../f/@35")
1210
parsed = spec.split('/@')
1211
assert len(parsed) == 2
1215
parsed[1] = int(parsed[1])
1216
assert parsed[1] >=0
1218
parsed = [spec, None]
1223
class cmd_merge(Command):
1224
"""Perform a three-way merge of trees.
1226
The SPEC parameters are working tree or revision specifiers. Working trees
1227
are specified using standard paths or urls. No component of a directory
1228
path may begin with '@'.
1230
Working tree examples: '.', '..', 'foo@', but NOT 'foo/@bar'
1232
Revisions are specified using a dirname/@revno pair, where dirname is the
1233
branch directory and revno is the revision within that branch. If no revno
1234
is specified, the latest revision is used.
1236
Revision examples: './@127', 'foo/@', '../@1'
1238
The OTHER_SPEC parameter is required. If the BASE_SPEC parameter is
1239
not supplied, the common ancestor of OTHER_SPEC the current branch is used
1242
merge refuses to run if there are any uncommitted changes, unless
1245
takes_args = ['other_spec', 'base_spec?']
1246
takes_options = ['force']
1248
def run(self, other_spec, base_spec=None, force=False):
1249
from bzrlib.merge import merge
1250
merge(parse_spec(other_spec), parse_spec(base_spec),
1251
check_clean=(not force))
1255
class cmd_revert(Command):
1256
"""Restore selected files from a previous revision.
1258
takes_args = ['file+']
1259
def run(self, file_list):
1260
from bzrlib.branch import find_branch
1265
b = find_branch(file_list[0])
1267
b.revert([b.relpath(f) for f in file_list])
1270
class cmd_merge_revert(Command):
1271
"""Reverse all changes since the last commit.
1273
Only versioned files are affected.
1275
TODO: Store backups of any files that will be reverted, so
1276
that the revert can be undone.
1278
takes_options = ['revision']
1280
def run(self, revision=-1):
1281
from bzrlib.merge import merge
1282
merge(('.', revision), parse_spec('.'),
1287
class cmd_assert_fail(Command):
1288
"""Test reporting of assertion failures"""
1291
assert False, "always fails"
1294
class cmd_help(Command):
1295
"""Show help on a command or other topic.
1297
For a list of all available commands, say 'bzr help commands'."""
1298
takes_args = ['topic?']
1301
def run(self, topic=None):
1306
class cmd_update_stat_cache(Command):
1307
"""Update stat-cache mapping inodes to SHA-1 hashes.
1309
For testing only."""
1314
statcache.update_cache(b.base, b.read_working_inventory())
1318
class cmd_plugins(Command):
1322
import bzrlib.plugin
1323
from pprint import pprint
1324
pprint(bzrlib.plugin.all_plugins)
1328
# list of all available options; the rhs can be either None for an
1329
# option that takes no argument, or a constructor function that checks
1333
'diff-options': str,
1342
'revision': _parse_revision_str,
1360
def parse_args(argv):
1361
"""Parse command line.
1363
Arguments and options are parsed at this level before being passed
1364
down to specific command handlers. This routine knows, from a
1365
lookup table, something about the available options, what optargs
1366
they take, and which commands will accept them.
1368
>>> parse_args('--help'.split())
1369
([], {'help': True})
1370
>>> parse_args('--version'.split())
1371
([], {'version': True})
1372
>>> parse_args('status --all'.split())
1373
(['status'], {'all': True})
1374
>>> parse_args('commit --message=biter'.split())
1375
(['commit'], {'message': u'biter'})
1376
>>> parse_args('log -r 500'.split())
1377
(['log'], {'revision': 500})
1378
>>> parse_args('log -r500:600'.split())
1379
(['log'], {'revision': [500, 600]})
1380
>>> parse_args('log -vr500:600'.split())
1381
(['log'], {'verbose': True, 'revision': [500, 600]})
1382
>>> parse_args('log -rv500:600'.split()) #the r takes an argument
1383
Traceback (most recent call last):
1385
ValueError: invalid literal for int(): v500
1390
# TODO: Maybe handle '--' to end options?
1395
# option names must not be unicode
1399
mutter(" got option %r" % a)
1401
optname, optarg = a[2:].split('=', 1)
1404
if optname not in OPTIONS:
1405
raise BzrError('unknown long option %r' % a)
1408
if shortopt in SHORT_OPTIONS:
1409
# Multi-character options must have a space to delimit
1411
optname = SHORT_OPTIONS[shortopt]
1413
# Single character short options, can be chained,
1414
# and have their value appended to their name
1416
if shortopt not in SHORT_OPTIONS:
1417
# We didn't find the multi-character name, and we
1418
# didn't find the single char name
1419
raise BzrError('unknown short option %r' % a)
1420
optname = SHORT_OPTIONS[shortopt]
1423
# There are extra things on this option
1424
# see if it is the value, or if it is another
1426
optargfn = OPTIONS[optname]
1427
if optargfn is None:
1428
# This option does not take an argument, so the
1429
# next entry is another short option, pack it back
1431
argv.insert(0, '-' + a[2:])
1433
# This option takes an argument, so pack it
1438
# XXX: Do we ever want to support this, e.g. for -r?
1439
raise BzrError('repeated option %r' % a)
1441
optargfn = OPTIONS[optname]
1445
raise BzrError('option %r needs an argument' % a)
1447
optarg = argv.pop(0)
1448
opts[optname] = optargfn(optarg)
1451
raise BzrError('option %r takes no argument' % optname)
1452
opts[optname] = True
1461
def _match_argform(cmd, takes_args, args):
1464
# step through args and takes_args, allowing appropriate 0-many matches
1465
for ap in takes_args:
1469
argdict[argname] = args.pop(0)
1470
elif ap[-1] == '*': # all remaining arguments
1472
argdict[argname + '_list'] = args[:]
1475
argdict[argname + '_list'] = None
1478
raise BzrCommandError("command %r needs one or more %s"
1479
% (cmd, argname.upper()))
1481
argdict[argname + '_list'] = args[:]
1483
elif ap[-1] == '$': # all but one
1485
raise BzrCommandError("command %r needs one or more %s"
1486
% (cmd, argname.upper()))
1487
argdict[argname + '_list'] = args[:-1]
1493
raise BzrCommandError("command %r requires argument %s"
1494
% (cmd, argname.upper()))
1496
argdict[argname] = args.pop(0)
1499
raise BzrCommandError("extra argument to command %s: %s"
1505
def _parse_master_args(argv):
1506
"""Parse the arguments that always go with the original command.
1507
These are things like bzr --no-plugins, etc.
1509
There are now 2 types of option flags. Ones that come *before* the command,
1510
and ones that come *after* the command.
1511
Ones coming *before* the command are applied against all possible commands.
1512
And are generally applied before plugins are loaded.
1514
The current list are:
1515
--builtin Allow plugins to load, but don't let them override builtin commands,
1516
they will still be allowed if they do not override a builtin.
1517
--no-plugins Don't load any plugins. This lets you get back to official source
1519
--profile Enable the hotspot profile before running the command.
1520
For backwards compatibility, this is also a non-master option.
1521
--version Spit out the version of bzr that is running and exit.
1522
This is also a non-master option.
1523
--help Run help and exit, also a non-master option (I think that should stay, though)
1525
>>> argv, opts = _parse_master_args(['bzr', '--test'])
1526
Traceback (most recent call last):
1528
BzrCommandError: Invalid master option: 'test'
1529
>>> argv, opts = _parse_master_args(['bzr', '--version', 'command'])
1532
>>> print opts['version']
1534
>>> argv, opts = _parse_master_args(['bzr', '--profile', 'command', '--more-options'])
1536
['command', '--more-options']
1537
>>> print opts['profile']
1539
>>> argv, opts = _parse_master_args(['bzr', '--no-plugins', 'command'])
1542
>>> print opts['no-plugins']
1544
>>> print opts['profile']
1546
>>> argv, opts = _parse_master_args(['bzr', 'command', '--profile'])
1548
['command', '--profile']
1549
>>> print opts['profile']
1552
master_opts = {'builtin':False,
1559
# This is the point where we could hook into argv[0] to determine
1560
# what front-end is supposed to be run
1561
# For now, we are just ignoring it.
1562
cmd_name = argv.pop(0)
1564
if arg[:2] != '--': # at the first non-option, we return the rest
1566
arg = arg[2:] # Remove '--'
1567
if arg not in master_opts:
1568
# We could say that this is not an error, that we should
1569
# just let it be handled by the main section instead
1570
raise BzrCommandError('Invalid master option: %r' % arg)
1571
argv.pop(0) # We are consuming this entry
1572
master_opts[arg] = True
1573
return argv, master_opts
1578
"""Execute a command.
1580
This is similar to main(), but without all the trappings for
1581
logging and error handling.
1583
argv = [a.decode(bzrlib.user_encoding) for a in argv]
1586
# some options like --builtin and --no-plugins have special effects
1587
argv, master_opts = _parse_master_args(argv)
1588
if not master_opts['no-plugins']:
1589
bzrlib.load_plugins()
1591
args, opts = parse_args(argv)
1593
if master_opts['help']:
1594
from bzrlib.help import help
1602
from bzrlib.help import help
1608
elif 'version' in opts:
1611
elif args and args[0] == 'builtin':
1612
include_plugins=False
1614
cmd = str(args.pop(0))
1621
plugins_override = not (master_opts['builtin'])
1622
canonical_cmd, cmd_class = get_cmd_class(cmd, plugins_override=plugins_override)
1624
profile = master_opts['profile']
1625
# For backwards compatibility, I would rather stick with --profile being a
1626
# master/global option
1627
if 'profile' in opts:
1631
# check options are reasonable
1632
allowed = cmd_class.takes_options
1634
if oname not in allowed:
1635
raise BzrCommandError("option '--%s' is not allowed for command %r"
1638
# mix arguments and options into one dictionary
1639
cmdargs = _match_argform(cmd, cmd_class.takes_args, args)
1641
for k, v in opts.items():
1642
cmdopts[k.replace('-', '_')] = v
1645
import hotshot, tempfile
1646
pffileno, pfname = tempfile.mkstemp()
1648
prof = hotshot.Profile(pfname)
1649
ret = prof.runcall(cmd_class, cmdopts, cmdargs) or 0
1652
import hotshot.stats
1653
stats = hotshot.stats.load(pfname)
1655
stats.sort_stats('time')
1656
## XXX: Might like to write to stderr or the trace file instead but
1657
## print_stats seems hardcoded to stdout
1658
stats.print_stats(20)
1666
return cmd_class(cmdopts, cmdargs).status
1669
def _report_exception(summary, quiet=False):
1671
log_error('bzr: ' + summary)
1672
bzrlib.trace.log_exception()
1675
tb = sys.exc_info()[2]
1676
exinfo = traceback.extract_tb(tb)
1678
sys.stderr.write(' at %s:%d in %s()\n' % exinfo[-1][:3])
1679
sys.stderr.write(' see ~/.bzr.log for debug information\n')
1686
bzrlib.open_tracefile(argv)
1691
return run_bzr(argv)
1693
# do this here inside the exception wrappers to catch EPIPE
1696
quiet = isinstance(e, (BzrCommandError))
1697
_report_exception('error: ' + e.args[0], quiet=quiet)
1700
# some explanation or hints
1703
except AssertionError, e:
1704
msg = 'assertion failed'
1706
msg += ': ' + str(e)
1707
_report_exception(msg)
1709
except KeyboardInterrupt, e:
1710
_report_exception('interrupted', quiet=True)
1712
except Exception, e:
1714
if (isinstance(e, IOError)
1715
and hasattr(e, 'errno')
1716
and e.errno == errno.EPIPE):
1720
msg = str(e).rstrip('\n')
1721
_report_exception(msg, quiet)
1724
bzrlib.trace.close_trace()
1727
if __name__ == '__main__':
1728
sys.exit(main(sys.argv))
added
removed
bzrlib/commands.py
