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
pipe = os.popen('%s --bzr-usage' % path, 'r')
149
self.takes_options = pipe.readline().split()
150
self.takes_args = pipe.readline().split()
153
pipe = os.popen('%s --bzr-help' % path, 'r')
154
self.__doc__ = pipe.read()
157
def __call__(self, options, arguments):
158
Command.__init__(self, options, arguments)
161
def run(self, **kargs):
169
if OPTIONS.has_key(name):
171
opts.append('--%s' % name)
172
if value is not None and value is not True:
173
opts.append(str(value))
175
# it's an arg, or arg list
176
if type(value) is not list:
182
self.status = os.spawnv(os.P_WAIT, self.path, [self.path] + opts + args)
186
class cmd_status(Command):
187
"""Display status summary.
189
For each file there is a single line giving its file state and name.
190
The name is that in the current revision unless it is deleted or
191
missing, in which case the old name is shown.
193
takes_args = ['file*']
194
takes_options = ['all']
195
aliases = ['st', 'stat']
197
def run(self, all=False, file_list=None):
198
b = Branch('.', lock_mode='r')
199
b.show_status(show_all=all, file_list=file_list)
202
class cmd_cat_revision(Command):
203
"""Write out metadata for a revision."""
206
takes_args = ['revision_id']
208
def run(self, revision_id):
209
Branch('.').get_revision(revision_id).write_xml(sys.stdout)
212
class cmd_revno(Command):
213
"""Show current revision number.
215
This is equal to the number of revisions on this branch."""
217
print Branch('.').revno()
220
class cmd_add(Command):
221
"""Add specified files or directories.
223
In non-recursive mode, all the named items are added, regardless
224
of whether they were previously ignored. A warning is given if
225
any of the named files are already versioned.
227
In recursive mode (the default), files are treated the same way
228
but the behaviour for directories is different. Directories that
229
are already versioned do not give a warning. All directories,
230
whether already versioned or not, are searched for files or
231
subdirectories that are neither versioned or ignored, and these
232
are added. This search proceeds recursively into versioned
235
Therefore simply saying 'bzr add .' will version all files that
236
are currently unknown.
238
TODO: Perhaps adding a file whose directly is not versioned should
239
recursively add that parent, rather than giving an error?
241
takes_args = ['file+']
242
takes_options = ['verbose']
244
def run(self, file_list, verbose=False):
245
bzrlib.add.smart_add(file_list, verbose)
248
class cmd_relpath(Command):
249
"""Show path of a file relative to root"""
250
takes_args = ['filename']
252
def run(self, filename):
253
print Branch(filename).relpath(filename)
257
class cmd_inventory(Command):
258
"""Show inventory of the current working copy or a revision."""
259
takes_options = ['revision']
261
def run(self, revision=None):
264
inv = b.read_working_inventory()
266
inv = b.get_revision_inventory(b.lookup_revision(revision))
268
for path, entry in inv.iter_entries():
269
print '%-50s %s' % (entry.file_id, path)
272
class cmd_move(Command):
273
"""Move files to a different directory.
278
The destination must be a versioned directory in the same branch.
280
takes_args = ['source$', 'dest']
281
def run(self, source_list, dest):
284
b.move([b.relpath(s) for s in source_list], b.relpath(dest))
287
class cmd_rename(Command):
288
"""Change the name of an entry.
291
bzr rename frob.c frobber.c
292
bzr rename src/frob.c lib/frob.c
294
It is an error if the destination name exists.
296
See also the 'move' command, which moves files into a different
297
directory without changing their name.
299
TODO: Some way to rename multiple files without invoking bzr for each
301
takes_args = ['from_name', 'to_name']
303
def run(self, from_name, to_name):
305
b.rename_one(b.relpath(from_name), b.relpath(to_name))
309
class cmd_renames(Command):
310
"""Show list of renamed files.
312
TODO: Option to show renames between two historical versions.
314
TODO: Only show renames under dir, rather than in the whole branch.
316
takes_args = ['dir?']
318
def run(self, dir='.'):
320
old_inv = b.basis_tree().inventory
321
new_inv = b.read_working_inventory()
323
renames = list(bzrlib.tree.find_renames(old_inv, new_inv))
325
for old_name, new_name in renames:
326
print "%s => %s" % (old_name, new_name)
329
class cmd_info(Command):
330
"""Show statistical information for this branch"""
333
info.show_info(Branch('.'))
336
class cmd_remove(Command):
337
"""Make a file unversioned.
339
This makes bzr stop tracking changes to a versioned file. It does
340
not delete the working copy.
342
takes_args = ['file+']
343
takes_options = ['verbose']
345
def run(self, file_list, verbose=False):
346
b = Branch(file_list[0])
347
b.remove([b.relpath(f) for f in file_list], verbose=verbose)
350
class cmd_file_id(Command):
351
"""Print file_id of a particular file or directory.
353
The file_id is assigned when the file is first added and remains the
354
same through all revisions where the file exists, even when it is
358
takes_args = ['filename']
359
def run(self, filename):
361
i = b.inventory.path2id(b.relpath(filename))
363
bailout("%r is not a versioned file" % filename)
368
class cmd_file_path(Command):
369
"""Print path of file_ids to a file or directory.
371
This prints one line for each directory down to the target,
372
starting at the branch root."""
374
takes_args = ['filename']
375
def run(self, filename):
378
fid = inv.path2id(b.relpath(filename))
380
bailout("%r is not a versioned file" % filename)
381
for fip in inv.get_idpath(fid):
385
class cmd_revision_history(Command):
386
"""Display list of revision ids on this branch."""
388
for patchid in Branch('.').revision_history():
392
class cmd_directories(Command):
393
"""Display list of versioned directories in this branch."""
395
for name, ie in Branch('.').read_working_inventory().directories():
402
class cmd_init(Command):
403
"""Make a directory into a versioned branch.
405
Use this to create an empty branch, or before importing an
408
Recipe for importing a tree of files:
413
bzr commit -m 'imported project'
416
Branch('.', init=True)
419
class cmd_diff(Command):
420
"""Show differences in working tree.
422
If files are listed, only the changes in those files are listed.
423
Otherwise, all changes for the tree are listed.
425
TODO: Given two revision arguments, show the difference between them.
427
TODO: Allow diff across branches.
429
TODO: Option to use external diff command; could be GNU diff, wdiff,
432
TODO: Python difflib is not exactly the same as unidiff; should
433
either fix it up or prefer to use an external diff.
435
TODO: If a directory is given, diff everything under that.
437
TODO: Selected-file diff is inefficient and doesn't show you
440
TODO: This probably handles non-Unix newlines poorly.
443
takes_args = ['file*']
444
takes_options = ['revision']
447
def run(self, revision=None, file_list=None):
448
from bzrlib.diff import show_diff
450
show_diff(Branch('.'), revision, file_list)
453
class cmd_deleted(Command):
454
"""List files deleted in the working tree.
456
TODO: Show files deleted since a previous revision, or between two revisions.
458
def run(self, show_ids=False):
461
new = b.working_tree()
463
## TODO: Much more efficient way to do this: read in new
464
## directories with readdir, rather than stating each one. Same
465
## level of effort but possibly much less IO. (Or possibly not,
466
## if the directories are very large...)
468
for path, ie in old.inventory.iter_entries():
469
if not new.has_id(ie.file_id):
471
print '%-50s %s' % (path, ie.file_id)
475
class cmd_root(Command):
476
"""Show the tree root directory.
478
The root is the nearest enclosing directory with a .bzr control
480
takes_args = ['filename?']
481
def run(self, filename=None):
482
"""Print the branch root."""
483
from branch import find_branch
484
b = find_branch(filename)
485
print getattr(b, 'base', None) or getattr(b, 'baseurl')
488
class cmd_log(Command):
489
"""Show log of this branch.
491
TODO: Option to limit range.
493
TODO: Perhaps show most-recent first with an option for last.
495
takes_args = ['filename?']
496
takes_options = ['timezone', 'verbose', 'show-ids']
497
def run(self, filename=None, timezone='original', verbose=False, show_ids=False):
498
from branch import find_branch
499
b = find_branch((filename or '.'), lock_mode='r')
501
filename = b.relpath(filename)
502
bzrlib.show_log(b, filename,
503
show_timezone=timezone,
509
class cmd_touching_revisions(Command):
510
"""Return revision-ids which affected a particular file."""
512
takes_args = ["filename"]
513
def run(self, filename):
514
b = Branch(filename, lock_mode='r')
515
inv = b.read_working_inventory()
516
file_id = inv.path2id(b.relpath(filename))
517
for revno, revision_id, what in bzrlib.log.find_touching_revisions(b, file_id):
518
print "%6d %s" % (revno, what)
521
class cmd_ls(Command):
522
"""List files in a tree.
524
TODO: Take a revision or remote path and list that tree instead.
527
def run(self, revision=None, verbose=False):
530
tree = b.working_tree()
532
tree = b.revision_tree(b.lookup_revision(revision))
534
for fp, fc, kind, fid in tree.list_files():
536
if kind == 'directory':
543
print '%-8s %s%s' % (fc, fp, kindch)
549
class cmd_unknowns(Command):
550
"""List unknown files"""
552
for f in Branch('.').unknowns():
557
class cmd_ignore(Command):
558
"""Ignore a command or pattern
560
To remove patterns from the ignore list, edit the .bzrignore file.
562
If the pattern contains a slash, it is compared to the whole path
563
from the branch root. Otherwise, it is comapred to only the last
564
component of the path.
566
Ignore patterns are case-insensitive on case-insensitive systems.
568
Note: wildcards must be quoted from the shell on Unix.
571
bzr ignore ./Makefile
574
takes_args = ['name_pattern']
576
def run(self, name_pattern):
577
from bzrlib.atomicfile import AtomicFile
581
ifn = b.abspath('.bzrignore')
583
# FIXME: probably doesn't handle non-ascii patterns
585
if os.path.exists(ifn):
586
f = b.controlfile(ifn, 'rt')
592
if igns and igns[-1] != '\n':
594
igns += name_pattern + '\n'
596
f = AtomicFile(ifn, 'wt')
600
inv = b.working_tree().inventory
601
if inv.path2id('.bzrignore'):
602
mutter('.bzrignore is already versioned')
604
mutter('need to make new .bzrignore file versioned')
605
b.add(['.bzrignore'])
609
class cmd_ignored(Command):
610
"""List ignored files and the patterns that matched them.
612
See also: bzr ignore"""
614
tree = Branch('.').working_tree()
615
for path, file_class, kind, file_id in tree.list_files():
616
if file_class != 'I':
618
## XXX: Slightly inefficient since this was already calculated
619
pat = tree.is_ignored(path)
620
print '%-50s %s' % (path, pat)
623
class cmd_lookup_revision(Command):
624
"""Lookup the revision-id from a revision-number
627
bzr lookup-revision 33
630
takes_args = ['revno']
632
def run(self, revno):
636
raise BzrCommandError("not a valid revision-number: %r" % revno)
638
print Branch('.').lookup_revision(revno)
641
class cmd_export(Command):
642
"""Export past revision to destination directory.
644
If no revision is specified this exports the last committed revision."""
645
takes_args = ['dest']
646
takes_options = ['revision']
647
def run(self, dest, revision=None):
650
rh = b.revision_history()[-1]
652
rh = b.lookup_revision(int(revision))
653
t = b.revision_tree(rh)
657
class cmd_cat(Command):
658
"""Write a file's text from a previous revision."""
660
takes_options = ['revision']
661
takes_args = ['filename']
663
def run(self, filename, revision=None):
665
raise BzrCommandError("bzr cat requires a revision number")
667
b.print_file(b.relpath(filename), int(revision))
670
class cmd_local_time_offset(Command):
671
"""Show the offset in seconds from GMT to local time."""
674
print bzrlib.osutils.local_time_offset()
678
class cmd_commit(Command):
679
"""Commit changes into a new revision.
681
TODO: Commit only selected files.
683
TODO: Run hooks on tree to-be-committed, and after commit.
685
TODO: Strict commit that fails if there are unknown or deleted files.
687
takes_options = ['message', 'file', 'verbose']
688
aliases = ['ci', 'checkin']
690
def run(self, message=None, file=None, verbose=False):
691
## Warning: shadows builtin file()
692
if not message and not file:
693
raise BzrCommandError("please specify a commit message",
694
["use either --message or --file"])
695
elif message and file:
696
raise BzrCommandError("please specify either --message or --file")
700
message = codecs.open(file, 'rt', bzrlib.user_encoding).read()
702
Branch('.').commit(message, verbose=verbose)
705
class cmd_check(Command):
706
"""Validate consistency of branch history.
708
This command checks various invariants about the branch storage to
709
detect data corruption or bzr bugs.
711
takes_args = ['dir?']
712
def run(self, dir='.'):
714
bzrlib.check.check(Branch(dir, find_root=False))
718
class cmd_whoami(Command):
719
"""Show bzr user id."""
720
takes_options = ['email']
722
def run(self, email=False):
724
print bzrlib.osutils.user_email()
726
print bzrlib.osutils.username()
729
class cmd_selftest(Command):
730
"""Run internal test suite"""
733
failures, tests = 0, 0
735
import doctest, bzrlib.store, bzrlib.tests
736
bzrlib.trace.verbose = False
738
for m in bzrlib.store, bzrlib.inventory, bzrlib.branch, bzrlib.osutils, \
739
bzrlib.tree, bzrlib.tests, bzrlib.commands, bzrlib.add:
740
mf, mt = doctest.testmod(m)
743
print '%-40s %3d tests' % (m.__name__, mt),
745
print '%3d FAILED!' % mf
749
print '%-40s %3d tests' % ('total', tests),
751
print '%3d FAILED!' % failures
757
class cmd_version(Command):
758
"""Show version of bzr"""
763
print "bzr (bazaar-ng) %s" % bzrlib.__version__
764
print bzrlib.__copyright__
765
print "http://bazaar-ng.org/"
767
print "bzr comes with ABSOLUTELY NO WARRANTY. bzr is free software, and"
768
print "you may use, modify and redistribute it under the terms of the GNU"
769
print "General Public License version 2 or later."
772
class cmd_rocks(Command):
773
"""Statement of optimism."""
776
print "it sure does!"
779
class cmd_assert_fail(Command):
780
"""Test reporting of assertion failures"""
783
assert False, "always fails"
786
class cmd_help(Command):
787
"""Show help on a command or other topic.
789
For a list of all available commands, say 'bzr help commands'."""
790
takes_args = ['topic?']
793
def run(self, topic=None):
798
######################################################################
802
# list of all available options; the rhs can be either None for an
803
# option that takes no argument, or a constructor function that checks
827
def parse_args(argv):
828
"""Parse command line.
830
Arguments and options are parsed at this level before being passed
831
down to specific command handlers. This routine knows, from a
832
lookup table, something about the available options, what optargs
833
they take, and which commands will accept them.
835
>>> parse_args('--help'.split())
837
>>> parse_args('--version'.split())
838
([], {'version': True})
839
>>> parse_args('status --all'.split())
840
(['status'], {'all': True})
841
>>> parse_args('commit --message=biter'.split())
842
(['commit'], {'message': u'biter'})
847
# TODO: Maybe handle '--' to end options?
852
# option names must not be unicode
856
mutter(" got option %r" % a)
858
optname, optarg = a[2:].split('=', 1)
861
if optname not in OPTIONS:
862
bailout('unknown long option %r' % a)
865
if shortopt not in SHORT_OPTIONS:
866
bailout('unknown short option %r' % a)
867
optname = SHORT_OPTIONS[shortopt]
870
# XXX: Do we ever want to support this, e.g. for -r?
871
bailout('repeated option %r' % a)
873
optargfn = OPTIONS[optname]
877
bailout('option %r needs an argument' % a)
880
opts[optname] = optargfn(optarg)
883
bailout('option %r takes no argument' % optname)
893
def _match_argform(cmd, takes_args, args):
896
# step through args and takes_args, allowing appropriate 0-many matches
897
for ap in takes_args:
901
argdict[argname] = args.pop(0)
902
elif ap[-1] == '*': # all remaining arguments
904
argdict[argname + '_list'] = args[:]
907
argdict[argname + '_list'] = None
910
raise BzrCommandError("command %r needs one or more %s"
911
% (cmd, argname.upper()))
913
argdict[argname + '_list'] = args[:]
915
elif ap[-1] == '$': # all but one
917
raise BzrCommandError("command %r needs one or more %s"
918
% (cmd, argname.upper()))
919
argdict[argname + '_list'] = args[:-1]
925
raise BzrCommandError("command %r requires argument %s"
926
% (cmd, argname.upper()))
928
argdict[argname] = args.pop(0)
931
raise BzrCommandError("extra argument to command %s: %s"
939
"""Execute a command.
941
This is similar to main(), but without all the trappings for
942
logging and error handling.
944
argv = [a.decode(bzrlib.user_encoding) for a in argv]
947
args, opts = parse_args(argv[1:])
955
elif 'version' in opts:
958
cmd = str(args.pop(0))
960
log_error('usage: bzr COMMAND')
961
log_error(' try "bzr help"')
964
canonical_cmd, cmd_class = get_cmd_class(cmd)
967
if 'profile' in opts:
973
# check options are reasonable
974
allowed = cmd_class.takes_options
976
if oname not in allowed:
977
raise BzrCommandError("option '--%s' is not allowed for command %r"
980
# mix arguments and options into one dictionary
981
cmdargs = _match_argform(cmd, cmd_class.takes_args, args)
983
for k, v in opts.items():
984
cmdopts[k.replace('-', '_')] = v
987
import hotshot, tempfile
988
pffileno, pfname = tempfile.mkstemp()
990
prof = hotshot.Profile(pfname)
991
ret = prof.runcall(cmd_class, cmdopts, cmdargs) or 0
995
stats = hotshot.stats.load(pfname)
997
stats.sort_stats('time')
998
## XXX: Might like to write to stderr or the trace file instead but
999
## print_stats seems hardcoded to stdout
1000
stats.print_stats(20)
1008
cmdobj = cmd_class(cmdopts, cmdargs).status
1011
def _report_exception(summary, quiet=False):
1013
log_error('bzr: ' + summary)
1014
bzrlib.trace.log_exception()
1017
tb = sys.exc_info()[2]
1018
exinfo = traceback.extract_tb(tb)
1020
sys.stderr.write(' at %s:%d in %s()\n' % exinfo[-1][:3])
1021
sys.stderr.write(' see ~/.bzr.log for debug information\n')
1028
bzrlib.open_tracefile(argv)
1033
return run_bzr(argv)
1035
# do this here inside the exception wrappers to catch EPIPE
1038
quiet = isinstance(e, (BzrCommandError))
1039
_report_exception('error: ' + e.args[0], quiet=quiet)
1042
# some explanation or hints
1045
except AssertionError, e:
1046
msg = 'assertion failed'
1048
msg += ': ' + str(e)
1049
_report_exception(msg)
1051
except KeyboardInterrupt, e:
1052
_report_exception('interrupted', quiet=True)
1054
except Exception, e:
1056
if (isinstance(e, IOError)
1057
and hasattr(e, 'errno')
1058
and e.errno == errno.EPIPE):
1062
msg = str(e).rstrip('\n')
1063
_report_exception(msg, quiet)
1066
bzrlib.trace.close_trace()
1069
if __name__ == '__main__':
1070
sys.exit(main(sys.argv))
added
removed
bzrlib/commands.py
