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
19
import sys, os, time, os.path
23
from bzrlib.trace import mutter, note, log_error
24
from bzrlib.errors import bailout, BzrError, BzrCheckError, BzrCommandError
25
from bzrlib.osutils import quotefn, pumpfile, isdir, isfile
26
from bzrlib.tree import RevisionTree, EmptyTree, WorkingTree, Tree
27
from bzrlib.revision import Revision
28
from bzrlib import Branch, Inventory, InventoryEntry, ScratchBranch, BZRDIR, \
32
def _squish_command_name(cmd):
33
return 'cmd_' + cmd.replace('-', '_')
36
def _unsquish_command_name(cmd):
37
assert cmd.startswith("cmd_")
38
return cmd[4:].replace('_','-')
41
"""Return canonical name and class for all registered commands."""
42
for k, v in globals().iteritems():
43
if k.startswith("cmd_"):
44
yield _unsquish_command_name(k), v
46
def get_cmd_class(cmd):
47
"""Return the canonical name and command class for a command.
49
cmd = str(cmd) # not unicode
51
# first look up this command under the specified name
53
return cmd, globals()[_squish_command_name(cmd)]
57
# look for any command which claims this as an alias
58
for cmdname, cmdclass in get_all_cmds():
59
if cmd in cmdclass.aliases:
60
return cmdname, cmdclass
62
cmdclass = ExternalCommand.find_command(cmd)
66
raise BzrCommandError("unknown command %r" % cmd)
70
"""Base class for commands.
72
The docstring for an actual command should give a single-line
73
summary, then a complete description of the command. A grammar
74
description will be inserted.
77
List of argument forms, marked with whether they are optional,
81
List of options that may be given for this command.
84
If true, this command isn't advertised.
93
def __init__(self, options, arguments):
94
"""Construct and run the command.
96
Sets self.status to the return value of run()."""
97
assert isinstance(options, dict)
98
assert isinstance(arguments, dict)
99
cmdargs = options.copy()
100
cmdargs.update(arguments)
101
assert self.__doc__ != Command.__doc__, \
102
("No help message set for %r" % self)
103
self.status = self.run(**cmdargs)
107
"""Override this in sub-classes.
109
This is invoked with the options and arguments bound to
112
Return 0 or None if the command was successful, or a shell
118
class ExternalCommand(Command):
119
"""Class to wrap external commands.
121
We cheat a little here, when get_cmd_class() calls us we actually give it back
122
an object we construct that has the appropriate path, help, options etc for the
125
When run_bzr() tries to instantiate that 'class' it gets caught by the __call__
126
method, which we override to call the Command.__init__ method. That then calls
127
our run method which is pretty straight forward.
129
The only wrinkle is that we have to map bzr's dictionary of options and arguments
130
back into command line options and arguments for the script.
133
def find_command(cls, cmd):
134
bzrpath = os.environ.get('BZRPATH', '')
136
for dir in bzrpath.split(':'):
137
path = os.path.join(dir, cmd)
138
if os.path.isfile(path):
139
return ExternalCommand(path)
143
find_command = classmethod(find_command)
145
def __init__(self, path):
148
# TODO: If either of these fail, we should detect that and
149
# assume that path is not really a bzr plugin after all.
151
pipe = os.popen('%s --bzr-usage' % path, 'r')
152
self.takes_options = pipe.readline().split()
153
self.takes_args = pipe.readline().split()
156
pipe = os.popen('%s --bzr-help' % path, 'r')
157
self.__doc__ = pipe.read()
160
def __call__(self, options, arguments):
161
Command.__init__(self, options, arguments)
164
def run(self, **kargs):
172
if OPTIONS.has_key(name):
174
opts.append('--%s' % name)
175
if value is not None and value is not True:
176
opts.append(str(value))
178
# it's an arg, or arg list
179
if type(value) is not list:
185
self.status = os.spawnv(os.P_WAIT, self.path, [self.path] + opts + args)
189
class cmd_status(Command):
190
"""Display status summary.
192
For each file there is a single line giving its file state and name.
193
The name is that in the current revision unless it is deleted or
194
missing, in which case the old name is shown.
196
takes_args = ['file*']
197
takes_options = ['all']
198
aliases = ['st', 'stat']
200
def run(self, all=False, file_list=None):
201
b = Branch('.', lock_mode='r')
202
b.show_status(show_all=all, file_list=file_list)
205
class cmd_cat_revision(Command):
206
"""Write out metadata for a revision."""
209
takes_args = ['revision_id']
211
def run(self, revision_id):
212
Branch('.').get_revision(revision_id).write_xml(sys.stdout)
215
class cmd_revno(Command):
216
"""Show current revision number.
218
This is equal to the number of revisions on this branch."""
220
print Branch('.').revno()
223
class cmd_add(Command):
224
"""Add specified files or directories.
226
In non-recursive mode, all the named items are added, regardless
227
of whether they were previously ignored. A warning is given if
228
any of the named files are already versioned.
230
In recursive mode (the default), files are treated the same way
231
but the behaviour for directories is different. Directories that
232
are already versioned do not give a warning. All directories,
233
whether already versioned or not, are searched for files or
234
subdirectories that are neither versioned or ignored, and these
235
are added. This search proceeds recursively into versioned
238
Therefore simply saying 'bzr add .' will version all files that
239
are currently unknown.
241
TODO: Perhaps adding a file whose directly is not versioned should
242
recursively add that parent, rather than giving an error?
244
takes_args = ['file+']
245
takes_options = ['verbose']
247
def run(self, file_list, verbose=False):
248
bzrlib.add.smart_add(file_list, verbose)
251
class cmd_relpath(Command):
252
"""Show path of a file relative to root"""
253
takes_args = ['filename']
255
def run(self, filename):
256
print Branch(filename).relpath(filename)
260
class cmd_inventory(Command):
261
"""Show inventory of the current working copy or a revision."""
262
takes_options = ['revision']
264
def run(self, revision=None):
267
inv = b.read_working_inventory()
269
inv = b.get_revision_inventory(b.lookup_revision(revision))
271
for path, entry in inv.iter_entries():
272
print '%-50s %s' % (entry.file_id, path)
275
class cmd_move(Command):
276
"""Move files to a different directory.
281
The destination must be a versioned directory in the same branch.
283
takes_args = ['source$', 'dest']
284
def run(self, source_list, dest):
287
b.move([b.relpath(s) for s in source_list], b.relpath(dest))
290
class cmd_rename(Command):
291
"""Change the name of an entry.
294
bzr rename frob.c frobber.c
295
bzr rename src/frob.c lib/frob.c
297
It is an error if the destination name exists.
299
See also the 'move' command, which moves files into a different
300
directory without changing their name.
302
TODO: Some way to rename multiple files without invoking bzr for each
304
takes_args = ['from_name', 'to_name']
306
def run(self, from_name, to_name):
308
b.rename_one(b.relpath(from_name), b.relpath(to_name))
312
class cmd_renames(Command):
313
"""Show list of renamed files.
315
TODO: Option to show renames between two historical versions.
317
TODO: Only show renames under dir, rather than in the whole branch.
319
takes_args = ['dir?']
321
def run(self, dir='.'):
323
old_inv = b.basis_tree().inventory
324
new_inv = b.read_working_inventory()
326
renames = list(bzrlib.tree.find_renames(old_inv, new_inv))
328
for old_name, new_name in renames:
329
print "%s => %s" % (old_name, new_name)
332
class cmd_info(Command):
333
"""Show statistical information for this branch"""
336
info.show_info(Branch('.'))
339
class cmd_remove(Command):
340
"""Make a file unversioned.
342
This makes bzr stop tracking changes to a versioned file. It does
343
not delete the working copy.
345
takes_args = ['file+']
346
takes_options = ['verbose']
348
def run(self, file_list, verbose=False):
349
b = Branch(file_list[0])
350
b.remove([b.relpath(f) for f in file_list], verbose=verbose)
353
class cmd_file_id(Command):
354
"""Print file_id of a particular file or directory.
356
The file_id is assigned when the file is first added and remains the
357
same through all revisions where the file exists, even when it is
361
takes_args = ['filename']
362
def run(self, filename):
364
i = b.inventory.path2id(b.relpath(filename))
366
bailout("%r is not a versioned file" % filename)
371
class cmd_file_path(Command):
372
"""Print path of file_ids to a file or directory.
374
This prints one line for each directory down to the target,
375
starting at the branch root."""
377
takes_args = ['filename']
378
def run(self, filename):
381
fid = inv.path2id(b.relpath(filename))
383
bailout("%r is not a versioned file" % filename)
384
for fip in inv.get_idpath(fid):
388
class cmd_revision_history(Command):
389
"""Display list of revision ids on this branch."""
391
for patchid in Branch('.').revision_history():
395
class cmd_directories(Command):
396
"""Display list of versioned directories in this branch."""
398
for name, ie in Branch('.').read_working_inventory().directories():
405
class cmd_init(Command):
406
"""Make a directory into a versioned branch.
408
Use this to create an empty branch, or before importing an
411
Recipe for importing a tree of files:
416
bzr commit -m 'imported project'
419
Branch('.', init=True)
422
class cmd_diff(Command):
423
"""Show differences in working tree.
425
If files are listed, only the changes in those files are listed.
426
Otherwise, all changes for the tree are listed.
428
TODO: Given two revision arguments, show the difference between them.
430
TODO: Allow diff across branches.
432
TODO: Option to use external diff command; could be GNU diff, wdiff,
435
TODO: Python difflib is not exactly the same as unidiff; should
436
either fix it up or prefer to use an external diff.
438
TODO: If a directory is given, diff everything under that.
440
TODO: Selected-file diff is inefficient and doesn't show you
443
TODO: This probably handles non-Unix newlines poorly.
446
takes_args = ['file*']
447
takes_options = ['revision']
450
def run(self, revision=None, file_list=None):
451
from bzrlib.diff import show_diff
453
show_diff(Branch('.'), revision, file_list)
456
class cmd_deleted(Command):
457
"""List files deleted in the working tree.
459
TODO: Show files deleted since a previous revision, or between two revisions.
461
def run(self, show_ids=False):
464
new = b.working_tree()
466
## TODO: Much more efficient way to do this: read in new
467
## directories with readdir, rather than stating each one. Same
468
## level of effort but possibly much less IO. (Or possibly not,
469
## if the directories are very large...)
471
for path, ie in old.inventory.iter_entries():
472
if not new.has_id(ie.file_id):
474
print '%-50s %s' % (path, ie.file_id)
478
class cmd_root(Command):
479
"""Show the tree root directory.
481
The root is the nearest enclosing directory with a .bzr control
483
takes_args = ['filename?']
484
def run(self, filename=None):
485
"""Print the branch root."""
486
from branch import find_branch
487
b = find_branch(filename)
488
print getattr(b, 'base', None) or getattr(b, 'baseurl')
491
class cmd_log(Command):
492
"""Show log of this branch.
494
TODO: Option to limit range.
496
TODO: Perhaps show most-recent first with an option for last.
498
takes_args = ['filename?']
499
takes_options = ['timezone', 'verbose', 'show-ids']
500
def run(self, filename=None, timezone='original', verbose=False, show_ids=False):
501
from branch import find_branch
502
b = find_branch((filename or '.'), lock_mode='r')
504
filename = b.relpath(filename)
505
bzrlib.show_log(b, filename,
506
show_timezone=timezone,
512
class cmd_touching_revisions(Command):
513
"""Return revision-ids which affected a particular file."""
515
takes_args = ["filename"]
516
def run(self, filename):
517
b = Branch(filename, lock_mode='r')
518
inv = b.read_working_inventory()
519
file_id = inv.path2id(b.relpath(filename))
520
for revno, revision_id, what in bzrlib.log.find_touching_revisions(b, file_id):
521
print "%6d %s" % (revno, what)
524
class cmd_ls(Command):
525
"""List files in a tree.
527
TODO: Take a revision or remote path and list that tree instead.
530
def run(self, revision=None, verbose=False):
533
tree = b.working_tree()
535
tree = b.revision_tree(b.lookup_revision(revision))
537
for fp, fc, kind, fid in tree.list_files():
539
if kind == 'directory':
546
print '%-8s %s%s' % (fc, fp, kindch)
552
class cmd_unknowns(Command):
553
"""List unknown files"""
555
for f in Branch('.').unknowns():
560
class cmd_ignore(Command):
561
"""Ignore a command or pattern
563
To remove patterns from the ignore list, edit the .bzrignore file.
565
If the pattern contains a slash, it is compared to the whole path
566
from the branch root. Otherwise, it is comapred to only the last
567
component of the path.
569
Ignore patterns are case-insensitive on case-insensitive systems.
571
Note: wildcards must be quoted from the shell on Unix.
574
bzr ignore ./Makefile
577
takes_args = ['name_pattern']
579
def run(self, name_pattern):
580
from bzrlib.atomicfile import AtomicFile
584
ifn = b.abspath('.bzrignore')
586
# FIXME: probably doesn't handle non-ascii patterns
588
if os.path.exists(ifn):
589
f = b.controlfile(ifn, 'rt')
595
if igns and igns[-1] != '\n':
597
igns += name_pattern + '\n'
599
f = AtomicFile(ifn, 'wt')
603
inv = b.working_tree().inventory
604
if inv.path2id('.bzrignore'):
605
mutter('.bzrignore is already versioned')
607
mutter('need to make new .bzrignore file versioned')
608
b.add(['.bzrignore'])
612
class cmd_ignored(Command):
613
"""List ignored files and the patterns that matched them.
615
See also: bzr ignore"""
617
tree = Branch('.').working_tree()
618
for path, file_class, kind, file_id in tree.list_files():
619
if file_class != 'I':
621
## XXX: Slightly inefficient since this was already calculated
622
pat = tree.is_ignored(path)
623
print '%-50s %s' % (path, pat)
626
class cmd_lookup_revision(Command):
627
"""Lookup the revision-id from a revision-number
630
bzr lookup-revision 33
633
takes_args = ['revno']
635
def run(self, revno):
639
raise BzrCommandError("not a valid revision-number: %r" % revno)
641
print Branch('.').lookup_revision(revno)
644
class cmd_export(Command):
645
"""Export past revision to destination directory.
647
If no revision is specified this exports the last committed revision."""
648
takes_args = ['dest']
649
takes_options = ['revision']
650
def run(self, dest, revision=None):
653
rh = b.revision_history()[-1]
655
rh = b.lookup_revision(int(revision))
656
t = b.revision_tree(rh)
660
class cmd_cat(Command):
661
"""Write a file's text from a previous revision."""
663
takes_options = ['revision']
664
takes_args = ['filename']
666
def run(self, filename, revision=None):
668
raise BzrCommandError("bzr cat requires a revision number")
670
b.print_file(b.relpath(filename), int(revision))
673
class cmd_local_time_offset(Command):
674
"""Show the offset in seconds from GMT to local time."""
677
print bzrlib.osutils.local_time_offset()
681
class cmd_commit(Command):
682
"""Commit changes into a new revision.
684
TODO: Commit only selected files.
686
TODO: Run hooks on tree to-be-committed, and after commit.
688
TODO: Strict commit that fails if there are unknown or deleted files.
690
takes_options = ['message', 'file', 'verbose']
691
aliases = ['ci', 'checkin']
693
def run(self, message=None, file=None, verbose=False):
694
## Warning: shadows builtin file()
695
if not message and not file:
696
raise BzrCommandError("please specify a commit message",
697
["use either --message or --file"])
698
elif message and file:
699
raise BzrCommandError("please specify either --message or --file")
703
message = codecs.open(file, 'rt', bzrlib.user_encoding).read()
705
Branch('.').commit(message, verbose=verbose)
708
class cmd_check(Command):
709
"""Validate consistency of branch history.
711
This command checks various invariants about the branch storage to
712
detect data corruption or bzr bugs.
714
takes_args = ['dir?']
715
def run(self, dir='.'):
717
bzrlib.check.check(Branch(dir, find_root=False))
721
class cmd_whoami(Command):
722
"""Show bzr user id."""
723
takes_options = ['email']
725
def run(self, email=False):
727
print bzrlib.osutils.user_email()
729
print bzrlib.osutils.username()
732
class cmd_selftest(Command):
733
"""Run internal test suite"""
736
failures, tests = 0, 0
738
import doctest, bzrlib.store, bzrlib.tests
739
bzrlib.trace.verbose = False
741
for m in bzrlib.store, bzrlib.inventory, bzrlib.branch, bzrlib.osutils, \
742
bzrlib.tree, bzrlib.tests, bzrlib.commands, bzrlib.add:
743
mf, mt = doctest.testmod(m)
746
print '%-40s %3d tests' % (m.__name__, mt),
748
print '%3d FAILED!' % mf
752
print '%-40s %3d tests' % ('total', tests),
754
print '%3d FAILED!' % failures
760
class cmd_version(Command):
761
"""Show version of bzr"""
766
print "bzr (bazaar-ng) %s" % bzrlib.__version__
767
print bzrlib.__copyright__
768
print "http://bazaar-ng.org/"
770
print "bzr comes with ABSOLUTELY NO WARRANTY. bzr is free software, and"
771
print "you may use, modify and redistribute it under the terms of the GNU"
772
print "General Public License version 2 or later."
775
class cmd_rocks(Command):
776
"""Statement of optimism."""
779
print "it sure does!"
782
class cmd_assert_fail(Command):
783
"""Test reporting of assertion failures"""
786
assert False, "always fails"
789
class cmd_help(Command):
790
"""Show help on a command or other topic.
792
For a list of all available commands, say 'bzr help commands'."""
793
takes_args = ['topic?']
796
def run(self, topic=None):
801
######################################################################
805
# list of all available options; the rhs can be either None for an
806
# option that takes no argument, or a constructor function that checks
830
def parse_args(argv):
831
"""Parse command line.
833
Arguments and options are parsed at this level before being passed
834
down to specific command handlers. This routine knows, from a
835
lookup table, something about the available options, what optargs
836
they take, and which commands will accept them.
838
>>> parse_args('--help'.split())
840
>>> parse_args('--version'.split())
841
([], {'version': True})
842
>>> parse_args('status --all'.split())
843
(['status'], {'all': True})
844
>>> parse_args('commit --message=biter'.split())
845
(['commit'], {'message': u'biter'})
850
# TODO: Maybe handle '--' to end options?
855
# option names must not be unicode
859
mutter(" got option %r" % a)
861
optname, optarg = a[2:].split('=', 1)
864
if optname not in OPTIONS:
865
bailout('unknown long option %r' % a)
868
if shortopt not in SHORT_OPTIONS:
869
bailout('unknown short option %r' % a)
870
optname = SHORT_OPTIONS[shortopt]
873
# XXX: Do we ever want to support this, e.g. for -r?
874
bailout('repeated option %r' % a)
876
optargfn = OPTIONS[optname]
880
bailout('option %r needs an argument' % a)
883
opts[optname] = optargfn(optarg)
886
bailout('option %r takes no argument' % optname)
896
def _match_argform(cmd, takes_args, args):
899
# step through args and takes_args, allowing appropriate 0-many matches
900
for ap in takes_args:
904
argdict[argname] = args.pop(0)
905
elif ap[-1] == '*': # all remaining arguments
907
argdict[argname + '_list'] = args[:]
910
argdict[argname + '_list'] = None
913
raise BzrCommandError("command %r needs one or more %s"
914
% (cmd, argname.upper()))
916
argdict[argname + '_list'] = args[:]
918
elif ap[-1] == '$': # all but one
920
raise BzrCommandError("command %r needs one or more %s"
921
% (cmd, argname.upper()))
922
argdict[argname + '_list'] = args[:-1]
928
raise BzrCommandError("command %r requires argument %s"
929
% (cmd, argname.upper()))
931
argdict[argname] = args.pop(0)
934
raise BzrCommandError("extra argument to command %s: %s"
942
"""Execute a command.
944
This is similar to main(), but without all the trappings for
945
logging and error handling.
947
argv = [a.decode(bzrlib.user_encoding) for a in argv]
950
args, opts = parse_args(argv[1:])
958
elif 'version' in opts:
961
cmd = str(args.pop(0))
963
log_error('usage: bzr COMMAND')
964
log_error(' try "bzr help"')
967
canonical_cmd, cmd_class = get_cmd_class(cmd)
970
if 'profile' in opts:
976
# check options are reasonable
977
allowed = cmd_class.takes_options
979
if oname not in allowed:
980
raise BzrCommandError("option '--%s' is not allowed for command %r"
983
# mix arguments and options into one dictionary
984
cmdargs = _match_argform(cmd, cmd_class.takes_args, args)
986
for k, v in opts.items():
987
cmdopts[k.replace('-', '_')] = v
990
import hotshot, tempfile
991
pffileno, pfname = tempfile.mkstemp()
993
prof = hotshot.Profile(pfname)
994
ret = prof.runcall(cmd_class, cmdopts, cmdargs) or 0
998
stats = hotshot.stats.load(pfname)
1000
stats.sort_stats('time')
1001
## XXX: Might like to write to stderr or the trace file instead but
1002
## print_stats seems hardcoded to stdout
1003
stats.print_stats(20)
1011
cmdobj = cmd_class(cmdopts, cmdargs).status
1014
def _report_exception(summary, quiet=False):
1016
log_error('bzr: ' + summary)
1017
bzrlib.trace.log_exception()
1020
tb = sys.exc_info()[2]
1021
exinfo = traceback.extract_tb(tb)
1023
sys.stderr.write(' at %s:%d in %s()\n' % exinfo[-1][:3])
1024
sys.stderr.write(' see ~/.bzr.log for debug information\n')
1031
bzrlib.open_tracefile(argv)
1036
return run_bzr(argv)
1038
# do this here inside the exception wrappers to catch EPIPE
1041
quiet = isinstance(e, (BzrCommandError))
1042
_report_exception('error: ' + e.args[0], quiet=quiet)
1045
# some explanation or hints
1048
except AssertionError, e:
1049
msg = 'assertion failed'
1051
msg += ': ' + str(e)
1052
_report_exception(msg)
1054
except KeyboardInterrupt, e:
1055
_report_exception('interrupted', quiet=True)
1057
except Exception, e:
1059
if (isinstance(e, IOError)
1060
and hasattr(e, 'errno')
1061
and e.errno == errno.EPIPE):
1065
msg = str(e).rstrip('\n')
1066
_report_exception(msg, quiet)
1069
bzrlib.trace.close_trace()
1072
if __name__ == '__main__':
1073
sys.exit(main(sys.argv))
added
removed
bzrlib/commands.py
