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, warning
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('_','-')
55
def _parse_revision_str(revstr):
56
"""This handles a revision string -> revno.
58
This always returns a list. The list will have one element for
60
It supports integers directly, but everything else it
61
defers for passing to Branch.get_revision_info()
63
>>> _parse_revision_str('234')
65
>>> _parse_revision_str('234..567')
67
>>> _parse_revision_str('..')
69
>>> _parse_revision_str('..234')
71
>>> _parse_revision_str('234..')
73
>>> _parse_revision_str('234..456..789') # Maybe this should be an error
75
>>> _parse_revision_str('234....789') # Error?
77
>>> _parse_revision_str('revid:test@other.com-234234')
78
['revid:test@other.com-234234']
79
>>> _parse_revision_str('revid:test@other.com-234234..revid:test@other.com-234235')
80
['revid:test@other.com-234234', 'revid:test@other.com-234235']
81
>>> _parse_revision_str('revid:test@other.com-234234..23')
82
['revid:test@other.com-234234', 23]
83
>>> _parse_revision_str('date:2005-04-12')
85
>>> _parse_revision_str('date:2005-04-12 12:24:33')
86
['date:2005-04-12 12:24:33']
87
>>> _parse_revision_str('date:2005-04-12T12:24:33')
88
['date:2005-04-12T12:24:33']
89
>>> _parse_revision_str('date:2005-04-12,12:24:33')
90
['date:2005-04-12,12:24:33']
91
>>> _parse_revision_str('-5..23')
93
>>> _parse_revision_str('-5')
95
>>> _parse_revision_str('123a')
97
>>> _parse_revision_str('abc')
101
old_format_re = re.compile('\d*:\d*')
102
m = old_format_re.match(revstr)
104
warning('Colon separator for revision numbers is deprecated.'
107
for rev in revstr.split(':'):
109
revs.append(int(rev))
114
for x in revstr.split('..'):
126
def _get_cmd_dict(plugins_override=True):
128
for k, v in globals().iteritems():
129
if k.startswith("cmd_"):
130
d[_unsquish_command_name(k)] = v
131
# If we didn't load plugins, the plugin_cmds dict will be empty
133
d.update(plugin_cmds)
135
d2 = plugin_cmds.copy()
141
def get_all_cmds(plugins_override=True):
142
"""Return canonical name and class for all registered commands."""
143
for k, v in _get_cmd_dict(plugins_override=plugins_override).iteritems():
147
def get_cmd_class(cmd, plugins_override=True):
148
"""Return the canonical name and command class for a command.
150
cmd = str(cmd) # not unicode
152
# first look up this command under the specified name
153
cmds = _get_cmd_dict(plugins_override=plugins_override)
155
return cmd, cmds[cmd]
159
# look for any command which claims this as an alias
160
for cmdname, cmdclass in cmds.iteritems():
161
if cmd in cmdclass.aliases:
162
return cmdname, cmdclass
164
cmdclass = ExternalCommand.find_command(cmd)
168
raise BzrCommandError("unknown command %r" % cmd)
171
class Command(object):
172
"""Base class for commands.
174
The docstring for an actual command should give a single-line
175
summary, then a complete description of the command. A grammar
176
description will be inserted.
179
List of argument forms, marked with whether they are optional,
183
List of options that may be given for this command.
186
If true, this command isn't advertised.
195
def __init__(self, options, arguments):
196
"""Construct and run the command.
198
Sets self.status to the return value of run()."""
199
assert isinstance(options, dict)
200
assert isinstance(arguments, dict)
201
cmdargs = options.copy()
202
cmdargs.update(arguments)
203
if self.__doc__ == Command.__doc__:
204
from warnings import warn
205
warn("No help message set for %r" % self)
206
self.status = self.run(**cmdargs)
207
if self.status is None:
212
"""Override this in sub-classes.
214
This is invoked with the options and arguments bound to
217
Return 0 or None if the command was successful, or a shell
223
class ExternalCommand(Command):
224
"""Class to wrap external commands.
226
We cheat a little here, when get_cmd_class() calls us we actually
227
give it back an object we construct that has the appropriate path,
228
help, options etc for the specified command.
230
When run_bzr() tries to instantiate that 'class' it gets caught by
231
the __call__ method, which we override to call the Command.__init__
232
method. That then calls our run method which is pretty straight
235
The only wrinkle is that we have to map bzr's dictionary of options
236
and arguments back into command line options and arguments for the
240
def find_command(cls, cmd):
242
bzrpath = os.environ.get('BZRPATH', '')
244
for dir in bzrpath.split(os.pathsep):
245
path = os.path.join(dir, cmd)
246
if os.path.isfile(path):
247
return ExternalCommand(path)
251
find_command = classmethod(find_command)
253
def __init__(self, path):
256
pipe = os.popen('%s --bzr-usage' % path, 'r')
257
self.takes_options = pipe.readline().split()
259
for opt in self.takes_options:
260
if not opt in OPTIONS:
261
raise BzrError("Unknown option '%s' returned by external command %s"
264
# TODO: Is there any way to check takes_args is valid here?
265
self.takes_args = pipe.readline().split()
267
if pipe.close() is not None:
268
raise BzrError("Failed funning '%s --bzr-usage'" % path)
270
pipe = os.popen('%s --bzr-help' % path, 'r')
271
self.__doc__ = pipe.read()
272
if pipe.close() is not None:
273
raise BzrError("Failed funning '%s --bzr-help'" % path)
275
def __call__(self, options, arguments):
276
Command.__init__(self, options, arguments)
279
def run(self, **kargs):
286
optname = name.replace('_','-')
288
if OPTIONS.has_key(optname):
290
opts.append('--%s' % optname)
291
if value is not None and value is not True:
292
opts.append(str(value))
294
# it's an arg, or arg list
295
if type(value) is not list:
301
self.status = os.spawnv(os.P_WAIT, self.path, [self.path] + opts + args)
305
class cmd_status(Command):
306
"""Display status summary.
308
This reports on versioned and unknown files, reporting them
309
grouped by state. Possible states are:
312
Versioned in the working copy but not in the previous revision.
315
Versioned in the previous revision but removed or deleted
319
Path of this file changed from the previous revision;
320
the text may also have changed. This includes files whose
321
parent directory was renamed.
324
Text has changed since the previous revision.
327
Nothing about this file has changed since the previous revision.
328
Only shown with --all.
331
Not versioned and not matching an ignore pattern.
333
To see ignored files use 'bzr ignored'. For details in the
334
changes to file texts, use 'bzr diff'.
336
If no arguments are specified, the status of the entire working
337
directory is shown. Otherwise, only the status of the specified
338
files or directories is reported. If a directory is given, status
339
is reported for everything inside that directory.
341
If a revision is specified, the changes since that revision are shown.
343
takes_args = ['file*']
344
takes_options = ['all', 'show-ids', 'revision']
345
aliases = ['st', 'stat']
347
def run(self, all=False, show_ids=False, file_list=None):
349
b = find_branch(file_list[0])
350
file_list = [b.relpath(x) for x in file_list]
351
# special case: only one path was given and it's the root
353
if file_list == ['']:
358
from bzrlib.status import show_status
359
show_status(b, show_unchanged=all, show_ids=show_ids,
360
specific_files=file_list)
363
class cmd_cat_revision(Command):
364
"""Write out metadata for a revision."""
367
takes_args = ['revision_id']
369
def run(self, revision_id):
370
from bzrlib.xml import pack_xml
371
pack_xml(find_branch('.').get_revision(revision_id), sys.stdout)
374
class cmd_revno(Command):
375
"""Show current revision number.
377
This is equal to the number of revisions on this branch."""
379
print find_branch('.').revno()
381
class cmd_revision_info(Command):
382
"""Show revision number and revision id for a given revision identifier.
385
takes_args = ['revision_info*']
386
takes_options = ['revision']
387
def run(self, revision=None, revision_info_list=None):
388
from bzrlib.branch import find_branch
391
if revision is not None:
392
revs.extend(revision)
393
if revision_info_list is not None:
394
revs.extend(revision_info_list)
396
raise BzrCommandError('You must supply a revision identifier')
401
print '%4d %s' % b.get_revision_info(rev)
404
class cmd_add(Command):
405
"""Add specified files or directories.
407
In non-recursive mode, all the named items are added, regardless
408
of whether they were previously ignored. A warning is given if
409
any of the named files are already versioned.
411
In recursive mode (the default), files are treated the same way
412
but the behaviour for directories is different. Directories that
413
are already versioned do not give a warning. All directories,
414
whether already versioned or not, are searched for files or
415
subdirectories that are neither versioned or ignored, and these
416
are added. This search proceeds recursively into versioned
417
directories. If no names are given '.' is assumed.
419
Therefore simply saying 'bzr add' will version all files that
420
are currently unknown.
422
TODO: Perhaps adding a file whose directly is not versioned should
423
recursively add that parent, rather than giving an error?
425
takes_args = ['file*']
426
takes_options = ['verbose', 'no-recurse']
428
def run(self, file_list, verbose=False, no_recurse=False):
429
from bzrlib.add import smart_add
430
smart_add(file_list, verbose, not no_recurse)
434
class cmd_mkdir(Command):
435
"""Create a new versioned directory.
437
This is equivalent to creating the directory and then adding it.
439
takes_args = ['dir+']
441
def run(self, dir_list):
448
b.add([d], verbose=True)
451
class cmd_relpath(Command):
452
"""Show path of a file relative to root"""
453
takes_args = ['filename']
456
def run(self, filename):
457
print find_branch(filename).relpath(filename)
461
class cmd_inventory(Command):
462
"""Show inventory of the current working copy or a revision."""
463
takes_options = ['revision', 'show-ids']
465
def run(self, revision=None, show_ids=False):
468
inv = b.read_working_inventory()
470
if len(revision) > 1:
471
raise BzrCommandError('bzr inventory --revision takes'
472
' exactly one revision identifier')
473
inv = b.get_revision_inventory(b.lookup_revision(revision[0]))
475
for path, entry in inv.entries():
477
print '%-50s %s' % (path, entry.file_id)
482
class cmd_move(Command):
483
"""Move files to a different directory.
488
The destination must be a versioned directory in the same branch.
490
takes_args = ['source$', 'dest']
491
def run(self, source_list, dest):
494
b.move([b.relpath(s) for s in source_list], b.relpath(dest))
497
class cmd_rename(Command):
498
"""Change the name of an entry.
501
bzr rename frob.c frobber.c
502
bzr rename src/frob.c lib/frob.c
504
It is an error if the destination name exists.
506
See also the 'move' command, which moves files into a different
507
directory without changing their name.
509
TODO: Some way to rename multiple files without invoking bzr for each
511
takes_args = ['from_name', 'to_name']
513
def run(self, from_name, to_name):
515
b.rename_one(b.relpath(from_name), b.relpath(to_name))
521
class cmd_pull(Command):
522
"""Pull any changes from another branch into the current one.
524
If the location is omitted, the last-used location will be used.
525
Both the revision history and the working directory will be
528
This command only works on branches that have not diverged. Branches are
529
considered diverged if both branches have had commits without first
530
pulling from the other.
532
If branches have diverged, you can use 'bzr merge' to pull the text changes
533
from one into the other.
535
takes_args = ['location?']
537
def run(self, location=None):
538
from bzrlib.merge import merge
540
from shutil import rmtree
543
br_to = find_branch('.')
546
stored_loc = br_to.controlfile("x-pull", "rb").read().rstrip('\n')
548
if e.errno != errno.ENOENT:
551
if stored_loc is None:
552
raise BzrCommandError("No pull location known or specified.")
554
print "Using last location: %s" % stored_loc
555
location = stored_loc
556
cache_root = tempfile.mkdtemp()
557
from bzrlib.branch import DivergedBranches
558
br_from = find_branch(location)
559
location = pull_loc(br_from)
560
old_revno = br_to.revno()
562
from branch import find_cached_branch, DivergedBranches
563
br_from = find_cached_branch(location, cache_root)
564
location = pull_loc(br_from)
565
old_revno = br_to.revno()
567
br_to.update_revisions(br_from)
568
except DivergedBranches:
569
raise BzrCommandError("These branches have diverged."
572
merge(('.', -1), ('.', old_revno), check_clean=False)
573
if location != stored_loc:
574
br_to.controlfile("x-pull", "wb").write(location + "\n")
580
class cmd_branch(Command):
581
"""Create a new copy of a branch.
583
If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
584
be used. In other words, "branch ../foo/bar" will attempt to create ./bar.
586
To retrieve the branch as of a particular revision, supply the --revision
587
parameter, as in "branch foo/bar -r 5".
589
takes_args = ['from_location', 'to_location?']
590
takes_options = ['revision']
591
aliases = ['get', 'clone']
593
def run(self, from_location, to_location=None, revision=None):
595
from bzrlib.merge import merge
596
from bzrlib.branch import DivergedBranches, NoSuchRevision, \
597
find_cached_branch, Branch
598
from shutil import rmtree
599
from meta_store import CachedStore
601
cache_root = tempfile.mkdtemp()
605
elif len(revision) > 1:
606
raise BzrCommandError('bzr branch --revision takes exactly 1 revision value')
610
br_from = find_cached_branch(from_location, cache_root)
612
if e.errno == errno.ENOENT:
613
raise BzrCommandError('Source location "%s" does not'
614
' exist.' % to_location)
618
if to_location is None:
619
to_location = os.path.basename(from_location.rstrip("/\\"))
622
os.mkdir(to_location)
624
if e.errno == errno.EEXIST:
625
raise BzrCommandError('Target directory "%s" already'
626
' exists.' % to_location)
627
if e.errno == errno.ENOENT:
628
raise BzrCommandError('Parent of "%s" does not exist.' %
632
br_to = Branch(to_location, init=True)
634
br_to.set_root_id(br_from.get_root_id())
637
if revision[0] is None:
638
revno = br_from.revno()
640
revno, rev_id = br_from.get_revision_info(revision[0])
642
br_to.update_revisions(br_from, stop_revision=revno)
643
except NoSuchRevision:
645
msg = "The branch %s has no revision %d." % (from_location,
647
raise BzrCommandError(msg)
649
merge((to_location, -1), (to_location, 0), this_dir=to_location,
650
check_clean=False, ignore_zero=True)
651
from_location = pull_loc(br_from)
652
br_to.controlfile("x-pull", "wb").write(from_location + "\n")
657
def pull_loc(branch):
658
# TODO: Should perhaps just make attribute be 'base' in
659
# RemoteBranch and Branch?
660
if hasattr(branch, "baseurl"):
661
return branch.baseurl
667
class cmd_renames(Command):
668
"""Show list of renamed files.
670
TODO: Option to show renames between two historical versions.
672
TODO: Only show renames under dir, rather than in the whole branch.
674
takes_args = ['dir?']
676
def run(self, dir='.'):
678
old_inv = b.basis_tree().inventory
679
new_inv = b.read_working_inventory()
681
renames = list(bzrlib.tree.find_renames(old_inv, new_inv))
683
for old_name, new_name in renames:
684
print "%s => %s" % (old_name, new_name)
687
class cmd_info(Command):
688
"""Show statistical information about a branch."""
689
takes_args = ['branch?']
691
def run(self, branch=None):
694
b = find_branch(branch)
698
class cmd_remove(Command):
699
"""Make a file unversioned.
701
This makes bzr stop tracking changes to a versioned file. It does
702
not delete the working copy.
704
takes_args = ['file+']
705
takes_options = ['verbose']
707
def run(self, file_list, verbose=False):
708
b = find_branch(file_list[0])
709
b.remove([b.relpath(f) for f in file_list], verbose=verbose)
712
class cmd_file_id(Command):
713
"""Print file_id of a particular file or directory.
715
The file_id is assigned when the file is first added and remains the
716
same through all revisions where the file exists, even when it is
720
takes_args = ['filename']
721
def run(self, filename):
722
b = find_branch(filename)
723
i = b.inventory.path2id(b.relpath(filename))
725
raise BzrError("%r is not a versioned file" % filename)
730
class cmd_file_path(Command):
731
"""Print path of file_ids to a file or directory.
733
This prints one line for each directory down to the target,
734
starting at the branch root."""
736
takes_args = ['filename']
737
def run(self, filename):
738
b = find_branch(filename)
740
fid = inv.path2id(b.relpath(filename))
742
raise BzrError("%r is not a versioned file" % filename)
743
for fip in inv.get_idpath(fid):
747
class cmd_revision_history(Command):
748
"""Display list of revision ids on this branch."""
751
for patchid in find_branch('.').revision_history():
755
class cmd_directories(Command):
756
"""Display list of versioned directories in this branch."""
758
for name, ie in find_branch('.').read_working_inventory().directories():
765
class cmd_init(Command):
766
"""Make a directory into a versioned branch.
768
Use this to create an empty branch, or before importing an
771
Recipe for importing a tree of files:
776
bzr commit -m 'imported project'
779
from bzrlib.branch import Branch
780
Branch('.', init=True)
783
class cmd_diff(Command):
784
"""Show differences in working tree.
786
If files are listed, only the changes in those files are listed.
787
Otherwise, all changes for the tree are listed.
789
TODO: Given two revision arguments, show the difference between them.
791
TODO: Allow diff across branches.
793
TODO: Option to use external diff command; could be GNU diff, wdiff,
796
TODO: Python difflib is not exactly the same as unidiff; should
797
either fix it up or prefer to use an external diff.
799
TODO: If a directory is given, diff everything under that.
801
TODO: Selected-file diff is inefficient and doesn't show you
804
TODO: This probably handles non-Unix newlines poorly.
807
takes_args = ['file*']
808
takes_options = ['revision', 'diff-options']
809
aliases = ['di', 'dif']
811
def run(self, revision=None, file_list=None, diff_options=None):
812
from bzrlib.diff import show_diff
815
b = find_branch(file_list[0])
816
file_list = [b.relpath(f) for f in file_list]
817
if file_list == ['']:
818
# just pointing to top-of-tree
823
# TODO: Make show_diff support taking 2 arguments
825
if revision is not None:
826
if len(revision) != 1:
827
raise BzrCommandError('bzr diff --revision takes exactly one revision identifier')
828
base_rev = revision[0]
830
show_diff(b, base_rev, specific_files=file_list,
831
external_diff_options=diff_options)
837
class cmd_deleted(Command):
838
"""List files deleted in the working tree.
840
TODO: Show files deleted since a previous revision, or between two revisions.
842
def run(self, show_ids=False):
845
new = b.working_tree()
847
## TODO: Much more efficient way to do this: read in new
848
## directories with readdir, rather than stating each one. Same
849
## level of effort but possibly much less IO. (Or possibly not,
850
## if the directories are very large...)
852
for path, ie in old.inventory.iter_entries():
853
if not new.has_id(ie.file_id):
855
print '%-50s %s' % (path, ie.file_id)
860
class cmd_modified(Command):
861
"""List files modified in working tree."""
864
from bzrlib.delta import compare_trees
867
td = compare_trees(b.basis_tree(), b.working_tree())
869
for path, id, kind in td.modified:
874
class cmd_added(Command):
875
"""List files added in working tree."""
879
wt = b.working_tree()
880
basis_inv = b.basis_tree().inventory
883
if file_id in basis_inv:
885
path = inv.id2path(file_id)
886
if not os.access(b.abspath(path), os.F_OK):
892
class cmd_root(Command):
893
"""Show the tree root directory.
895
The root is the nearest enclosing directory with a .bzr control
897
takes_args = ['filename?']
898
def run(self, filename=None):
899
"""Print the branch root."""
900
b = find_branch(filename)
901
print getattr(b, 'base', None) or getattr(b, 'baseurl')
904
class cmd_log(Command):
905
"""Show log of this branch.
907
To request a range of logs, you can use the command -r begin:end
908
-r revision requests a specific revision, -r :end or -r begin: are
911
--message allows you to give a regular expression, which will be evaluated
912
so that only matching entries will be displayed.
914
TODO: Make --revision support uuid: and hash: [future tag:] notation.
918
takes_args = ['filename?']
919
takes_options = ['forward', 'timezone', 'verbose', 'show-ids', 'revision','long', 'message']
921
def run(self, filename=None, timezone='original',
928
from bzrlib.branch import find_branch
929
from bzrlib.log import log_formatter, show_log
932
direction = (forward and 'forward') or 'reverse'
935
b = find_branch(filename)
936
fp = b.relpath(filename)
938
file_id = b.read_working_inventory().path2id(fp)
940
file_id = None # points to branch root
948
elif len(revision) == 1:
949
rev1 = rev2 = b.get_revision_info(revision[0])[0]
950
elif len(revision) == 2:
951
rev1 = b.get_revision_info(revision[0])[0]
952
rev2 = b.get_revision_info(revision[1])[0]
954
raise BzrCommandError('bzr log --revision takes one or two values.')
961
mutter('encoding log as %r' % bzrlib.user_encoding)
963
# use 'replace' so that we don't abort if trying to write out
964
# in e.g. the default C locale.
965
outf = codecs.getwriter(bzrlib.user_encoding)(sys.stdout, errors='replace')
971
lf = log_formatter(log_format,
974
show_timezone=timezone)
987
class cmd_touching_revisions(Command):
988
"""Return revision-ids which affected a particular file.
990
A more user-friendly interface is "bzr log FILE"."""
992
takes_args = ["filename"]
993
def run(self, filename):
994
b = find_branch(filename)
995
inv = b.read_working_inventory()
996
file_id = inv.path2id(b.relpath(filename))
997
for revno, revision_id, what in bzrlib.log.find_touching_revisions(b, file_id):
998
print "%6d %s" % (revno, what)
1001
class cmd_ls(Command):
1002
"""List files in a tree.
1004
TODO: Take a revision or remote path and list that tree instead.
1007
def run(self, revision=None, verbose=False):
1008
b = find_branch('.')
1009
if revision == None:
1010
tree = b.working_tree()
1012
tree = b.revision_tree(b.lookup_revision(revision))
1014
for fp, fc, kind, fid in tree.list_files():
1016
if kind == 'directory':
1018
elif kind == 'file':
1023
print '%-8s %s%s' % (fc, fp, kindch)
1029
class cmd_unknowns(Command):
1030
"""List unknown files."""
1032
from bzrlib.osutils import quotefn
1033
for f in find_branch('.').unknowns():
1038
class cmd_ignore(Command):
1039
"""Ignore a command or pattern.
1041
To remove patterns from the ignore list, edit the .bzrignore file.
1043
If the pattern contains a slash, it is compared to the whole path
1044
from the branch root. Otherwise, it is comapred to only the last
1045
component of the path.
1047
Ignore patterns are case-insensitive on case-insensitive systems.
1049
Note: wildcards must be quoted from the shell on Unix.
1052
bzr ignore ./Makefile
1053
bzr ignore '*.class'
1055
takes_args = ['name_pattern']
1057
def run(self, name_pattern):
1058
from bzrlib.atomicfile import AtomicFile
1061
b = find_branch('.')
1062
ifn = b.abspath('.bzrignore')
1064
if os.path.exists(ifn):
1067
igns = f.read().decode('utf-8')
1073
# TODO: If the file already uses crlf-style termination, maybe
1074
# we should use that for the newly added lines?
1076
if igns and igns[-1] != '\n':
1078
igns += name_pattern + '\n'
1081
f = AtomicFile(ifn, 'wt')
1082
f.write(igns.encode('utf-8'))
1087
inv = b.working_tree().inventory
1088
if inv.path2id('.bzrignore'):
1089
mutter('.bzrignore is already versioned')
1091
mutter('need to make new .bzrignore file versioned')
1092
b.add(['.bzrignore'])
1096
class cmd_ignored(Command):
1097
"""List ignored files and the patterns that matched them.
1099
See also: bzr ignore"""
1101
tree = find_branch('.').working_tree()
1102
for path, file_class, kind, file_id in tree.list_files():
1103
if file_class != 'I':
1105
## XXX: Slightly inefficient since this was already calculated
1106
pat = tree.is_ignored(path)
1107
print '%-50s %s' % (path, pat)
1110
class cmd_lookup_revision(Command):
1111
"""Lookup the revision-id from a revision-number
1114
bzr lookup-revision 33
1117
takes_args = ['revno']
1119
def run(self, revno):
1123
raise BzrCommandError("not a valid revision-number: %r" % revno)
1125
print find_branch('.').lookup_revision(revno)
1128
class cmd_export(Command):
1129
"""Export past revision to destination directory.
1131
If no revision is specified this exports the last committed revision.
1133
Format may be an "exporter" name, such as tar, tgz, tbz2. If none is
1134
given, try to find the format with the extension. If no extension
1135
is found exports to a directory (equivalent to --format=dir).
1137
Root may be the top directory for tar, tgz and tbz2 formats. If none
1138
is given, the top directory will be the root name of the file."""
1139
# TODO: list known exporters
1140
takes_args = ['dest']
1141
takes_options = ['revision', 'format', 'root']
1142
def run(self, dest, revision=None, format=None, root=None):
1144
b = find_branch('.')
1145
if revision is None:
1146
rev_id = b.last_patch()
1148
if len(revision) != 1:
1149
raise BzrError('bzr export --revision takes exactly 1 argument')
1150
revno, rev_id = b.get_revision_info(revision[0])
1151
t = b.revision_tree(rev_id)
1152
root, ext = os.path.splitext(dest)
1154
if ext in (".tar",):
1156
elif ext in (".gz", ".tgz"):
1158
elif ext in (".bz2", ".tbz2"):
1162
t.export(dest, format, root)
1165
class cmd_cat(Command):
1166
"""Write a file's text from a previous revision."""
1168
takes_options = ['revision']
1169
takes_args = ['filename']
1171
def run(self, filename, revision=None):
1172
if revision == None:
1173
raise BzrCommandError("bzr cat requires a revision number")
1174
elif len(revision) != 1:
1175
raise BzrCommandError("bzr cat --revision takes exactly one number")
1176
b = find_branch('.')
1177
b.print_file(b.relpath(filename), revision[0])
1180
class cmd_local_time_offset(Command):
1181
"""Show the offset in seconds from GMT to local time."""
1184
print bzrlib.osutils.local_time_offset()
1188
class cmd_commit(Command):
1189
"""Commit changes into a new revision.
1191
If no arguments are given, the entire tree is committed.
1193
If selected files are specified, only changes to those files are
1194
committed. If a directory is specified then the directory and everything
1195
within it is committed.
1197
A selected-file commit may fail in some cases where the committed
1198
tree would be invalid, such as trying to commit a file in a
1199
newly-added directory that is not itself committed.
1201
TODO: Run hooks on tree to-be-committed, and after commit.
1203
TODO: Strict commit that fails if there are unknown or deleted files.
1205
takes_args = ['selected*']
1206
takes_options = ['message', 'file', 'verbose', 'unchanged']
1207
aliases = ['ci', 'checkin']
1209
# TODO: Give better message for -s, --summary, used by tla people
1211
def run(self, message=None, file=None, verbose=True, selected_list=None,
1213
from bzrlib.errors import PointlessCommit
1214
from bzrlib.osutils import get_text_message
1216
## Warning: shadows builtin file()
1217
if not message and not file:
1218
# FIXME: Ugly; change status code to send to a provided function?
1222
catcher = cStringIO.StringIO()
1223
sys.stdout = catcher
1224
cmd_status({"file_list":selected_list}, {})
1225
info = catcher.getvalue()
1227
message = get_text_message(info)
1230
raise BzrCommandError("please specify a commit message",
1231
["use either --message or --file"])
1232
elif message and file:
1233
raise BzrCommandError("please specify either --message or --file")
1237
message = codecs.open(file, 'rt', bzrlib.user_encoding).read()
1239
b = find_branch('.')
1241
selected_list = [b.relpath(s) for s in selected_list]
1244
b.commit(message, verbose=verbose,
1245
specific_files=selected_list,
1246
allow_pointless=unchanged)
1247
except PointlessCommit:
1248
# FIXME: This should really happen before the file is read in;
1249
# perhaps prepare the commit; get the message; then actually commit
1250
raise BzrCommandError("no changes to commit",
1251
["use --unchanged to commit anyhow"])
1254
class cmd_check(Command):
1255
"""Validate consistency of branch history.
1257
This command checks various invariants about the branch storage to
1258
detect data corruption or bzr bugs.
1260
If given the --update flag, it will update some optional fields
1261
to help ensure data consistency.
1263
takes_args = ['dir?']
1265
def run(self, dir='.'):
1266
from bzrlib.check import check
1267
check(find_branch(dir))
1271
class cmd_scan_cache(Command):
1274
from bzrlib.hashcache import HashCache
1281
print '%6d stats' % c.stat_count
1282
print '%6d in hashcache' % len(c._cache)
1283
print '%6d files removed from cache' % c.removed_count
1284
print '%6d hashes updated' % c.update_count
1285
print '%6d files changed too recently to cache' % c.danger_count
1292
class cmd_upgrade(Command):
1293
"""Upgrade branch storage to current format.
1295
This should normally be used only after the check command tells
1298
takes_args = ['dir?']
1300
def run(self, dir='.'):
1301
from bzrlib.upgrade import upgrade
1302
upgrade(find_branch(dir))
1306
class cmd_whoami(Command):
1307
"""Show bzr user id."""
1308
takes_options = ['email']
1310
def run(self, email=False):
1312
print bzrlib.osutils.user_email()
1314
print bzrlib.osutils.username()
1317
class cmd_selftest(Command):
1318
"""Run internal test suite"""
1320
takes_options = ['verbose']
1321
def run(self, verbose=False):
1322
from bzrlib.selftest import selftest
1323
return int(not selftest(verbose=verbose))
1326
class cmd_version(Command):
1327
"""Show version of bzr."""
1332
print "bzr (bazaar-ng) %s" % bzrlib.__version__
1333
# is bzrlib itself in a branch?
1334
bzrrev = bzrlib.get_bzr_revision()
1336
print " (bzr checkout, revision %d {%s})" % bzrrev
1337
print bzrlib.__copyright__
1338
print "http://bazaar-ng.org/"
1340
print "bzr comes with ABSOLUTELY NO WARRANTY. bzr is free software, and"
1341
print "you may use, modify and redistribute it under the terms of the GNU"
1342
print "General Public License version 2 or later."
1345
class cmd_rocks(Command):
1346
"""Statement of optimism."""
1349
print "it sure does!"
1351
def parse_spec(spec):
1353
>>> parse_spec(None)
1355
>>> parse_spec("./")
1357
>>> parse_spec("../@")
1359
>>> parse_spec("../f/@35")
1361
>>> parse_spec('./@revid:john@arbash-meinel.com-20050711044610-3ca0327c6a222f67')
1362
['.', 'revid:john@arbash-meinel.com-20050711044610-3ca0327c6a222f67']
1367
parsed = spec.split('/@')
1368
assert len(parsed) == 2
1373
parsed[1] = int(parsed[1])
1375
pass # We can allow stuff like ./@revid:blahblahblah
1377
assert parsed[1] >=0
1379
parsed = [spec, None]
1384
class cmd_merge(Command):
1385
"""Perform a three-way merge of trees.
1387
The SPEC parameters are working tree or revision specifiers. Working trees
1388
are specified using standard paths or urls. No component of a directory
1389
path may begin with '@'.
1391
Working tree examples: '.', '..', 'foo@', but NOT 'foo/@bar'
1393
Revisions are specified using a dirname/@revno pair, where dirname is the
1394
branch directory and revno is the revision within that branch. If no revno
1395
is specified, the latest revision is used.
1397
Revision examples: './@127', 'foo/@', '../@1'
1399
The OTHER_SPEC parameter is required. If the BASE_SPEC parameter is
1400
not supplied, the common ancestor of OTHER_SPEC the current branch is used
1403
merge refuses to run if there are any uncommitted changes, unless
1406
takes_args = ['other_spec', 'base_spec?']
1407
takes_options = ['force']
1409
def run(self, other_spec, base_spec=None, force=False):
1410
from bzrlib.merge import merge
1411
merge(parse_spec(other_spec), parse_spec(base_spec),
1412
check_clean=(not force))
1416
class cmd_revert(Command):
1417
"""Restore selected files from a previous revision.
1419
takes_args = ['file+']
1420
def run(self, file_list):
1421
from bzrlib.branch import find_branch
1426
b = find_branch(file_list[0])
1428
b.revert([b.relpath(f) for f in file_list])
1431
class cmd_merge_revert(Command):
1432
"""Reverse all changes since the last commit.
1434
Only versioned files are affected.
1436
TODO: Store backups of any files that will be reverted, so
1437
that the revert can be undone.
1439
takes_options = ['revision']
1441
def run(self, revision=None):
1442
from bzrlib.merge import merge
1443
if revision is None:
1445
elif len(revision) != 1:
1446
raise BzrCommandError('bzr merge-revert --revision takes exactly 1 argument')
1447
merge(('.', revision[0]), parse_spec('.'),
1452
class cmd_assert_fail(Command):
1453
"""Test reporting of assertion failures"""
1456
assert False, "always fails"
1459
class cmd_help(Command):
1460
"""Show help on a command or other topic.
1462
For a list of all available commands, say 'bzr help commands'."""
1463
takes_args = ['topic?']
1466
def run(self, topic=None):
1473
class cmd_plugins(Command):
1477
import bzrlib.plugin
1478
from inspect import getdoc
1479
from pprint import pprint
1480
for plugin in bzrlib.plugin.all_plugins:
1481
print plugin.__path__[0]
1484
print '\t', d.split('\n')[0]
1486
#pprint(bzrlib.plugin.all_plugins)
1490
# list of all available options; the rhs can be either None for an
1491
# option that takes no argument, or a constructor function that checks
1495
'diff-options': str,
1504
'revision': _parse_revision_str,
1526
def parse_args(argv):
1527
"""Parse command line.
1529
Arguments and options are parsed at this level before being passed
1530
down to specific command handlers. This routine knows, from a
1531
lookup table, something about the available options, what optargs
1532
they take, and which commands will accept them.
1534
>>> parse_args('--help'.split())
1535
([], {'help': True})
1536
>>> parse_args('--version'.split())
1537
([], {'version': True})
1538
>>> parse_args('status --all'.split())
1539
(['status'], {'all': True})
1540
>>> parse_args('commit --message=biter'.split())
1541
(['commit'], {'message': u'biter'})
1542
>>> parse_args('log -r 500'.split())
1543
(['log'], {'revision': [500]})
1544
>>> parse_args('log -r500..600'.split())
1545
(['log'], {'revision': [500, 600]})
1546
>>> parse_args('log -vr500..600'.split())
1547
(['log'], {'verbose': True, 'revision': [500, 600]})
1548
>>> parse_args('log -rv500..600'.split()) #the r takes an argument
1549
(['log'], {'revision': ['v500', 600]})
1554
# TODO: Maybe handle '--' to end options?
1559
# option names must not be unicode
1563
mutter(" got option %r" % a)
1565
optname, optarg = a[2:].split('=', 1)
1568
if optname not in OPTIONS:
1569
raise BzrError('unknown long option %r' % a)
1572
if shortopt in SHORT_OPTIONS:
1573
# Multi-character options must have a space to delimit
1575
optname = SHORT_OPTIONS[shortopt]
1577
# Single character short options, can be chained,
1578
# and have their value appended to their name
1580
if shortopt not in SHORT_OPTIONS:
1581
# We didn't find the multi-character name, and we
1582
# didn't find the single char name
1583
raise BzrError('unknown short option %r' % a)
1584
optname = SHORT_OPTIONS[shortopt]
1587
# There are extra things on this option
1588
# see if it is the value, or if it is another
1590
optargfn = OPTIONS[optname]
1591
if optargfn is None:
1592
# This option does not take an argument, so the
1593
# next entry is another short option, pack it back
1595
argv.insert(0, '-' + a[2:])
1597
# This option takes an argument, so pack it
1602
# XXX: Do we ever want to support this, e.g. for -r?
1603
raise BzrError('repeated option %r' % a)
1605
optargfn = OPTIONS[optname]
1609
raise BzrError('option %r needs an argument' % a)
1611
optarg = argv.pop(0)
1612
opts[optname] = optargfn(optarg)
1615
raise BzrError('option %r takes no argument' % optname)
1616
opts[optname] = True
1625
def _match_argform(cmd, takes_args, args):
1628
# step through args and takes_args, allowing appropriate 0-many matches
1629
for ap in takes_args:
1633
argdict[argname] = args.pop(0)
1634
elif ap[-1] == '*': # all remaining arguments
1636
argdict[argname + '_list'] = args[:]
1639
argdict[argname + '_list'] = None
1642
raise BzrCommandError("command %r needs one or more %s"
1643
% (cmd, argname.upper()))
1645
argdict[argname + '_list'] = args[:]
1647
elif ap[-1] == '$': # all but one
1649
raise BzrCommandError("command %r needs one or more %s"
1650
% (cmd, argname.upper()))
1651
argdict[argname + '_list'] = args[:-1]
1657
raise BzrCommandError("command %r requires argument %s"
1658
% (cmd, argname.upper()))
1660
argdict[argname] = args.pop(0)
1663
raise BzrCommandError("extra argument to command %s: %s"
1671
"""Execute a command.
1673
This is similar to main(), but without all the trappings for
1674
logging and error handling.
1677
The command-line arguments, without the program name from argv[0]
1679
Returns a command status or raises an exception.
1681
Special master options: these must come before the command because
1682
they control how the command is interpreted.
1685
Do not load plugin modules at all
1688
Only use builtin commands. (Plugins are still allowed to change
1692
Run under the Python profiler.
1695
argv = [a.decode(bzrlib.user_encoding) for a in argv]
1697
opt_profile = opt_no_plugins = opt_builtin = False
1699
# --no-plugins is handled specially at a very early stage. We need
1700
# to load plugins before doing other command parsing so that they
1701
# can override commands, but this needs to happen first.
1704
if a == '--profile':
1706
elif a == '--no-plugins':
1707
opt_no_plugins = True
1708
elif a == '--builtin':
1714
if not opt_no_plugins:
1715
from bzrlib.plugin import load_plugins
1718
args, opts = parse_args(argv)
1721
from bzrlib.help import help
1728
if 'version' in opts:
1733
print >>sys.stderr, "please try 'bzr help' for help"
1736
cmd = str(args.pop(0))
1738
canonical_cmd, cmd_class = \
1739
get_cmd_class(cmd, plugins_override=not opt_builtin)
1741
# check options are reasonable
1742
allowed = cmd_class.takes_options
1744
if oname not in allowed:
1745
raise BzrCommandError("option '--%s' is not allowed for command %r"
1748
# mix arguments and options into one dictionary
1749
cmdargs = _match_argform(cmd, cmd_class.takes_args, args)
1751
for k, v in opts.items():
1752
cmdopts[k.replace('-', '_')] = v
1755
import hotshot, tempfile
1756
pffileno, pfname = tempfile.mkstemp()
1758
prof = hotshot.Profile(pfname)
1759
ret = prof.runcall(cmd_class, cmdopts, cmdargs) or 0
1762
import hotshot.stats
1763
stats = hotshot.stats.load(pfname)
1765
stats.sort_stats('time')
1766
## XXX: Might like to write to stderr or the trace file instead but
1767
## print_stats seems hardcoded to stdout
1768
stats.print_stats(20)
1776
return cmd_class(cmdopts, cmdargs).status
1779
def _report_exception(summary, quiet=False):
1781
log_error('bzr: ' + summary)
1782
bzrlib.trace.log_exception()
1785
tb = sys.exc_info()[2]
1786
exinfo = traceback.extract_tb(tb)
1788
sys.stderr.write(' at %s:%d in %s()\n' % exinfo[-1][:3])
1789
sys.stderr.write(' see ~/.bzr.log for debug information\n')
1795
bzrlib.trace.open_tracefile(argv)
1800
return run_bzr(argv[1:])
1802
# do this here inside the exception wrappers to catch EPIPE
1805
quiet = isinstance(e, (BzrCommandError))
1806
_report_exception('error: ' + str(e), quiet=quiet)
1809
# some explanation or hints
1812
except AssertionError, e:
1813
msg = 'assertion failed'
1815
msg += ': ' + str(e)
1816
_report_exception(msg)
1818
except KeyboardInterrupt, e:
1819
_report_exception('interrupted', quiet=True)
1821
except Exception, e:
1824
if (isinstance(e, IOError)
1825
and hasattr(e, 'errno')
1826
and e.errno == errno.EPIPE):
1830
msg = str(e).rstrip('\n')
1831
_report_exception(msg, quiet)
1834
bzrlib.trace.close_trace()
1837
if __name__ == '__main__':
1838
sys.exit(main(sys.argv))
added
removed
bzrlib/commands.py
