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 give it back
227
an object we construct that has the appropriate path, help, options etc for the
230
When run_bzr() tries to instantiate that 'class' it gets caught by the __call__
231
method, which we override to call the Command.__init__ method. That then calls
232
our run method which is pretty straight forward.
234
The only wrinkle is that we have to map bzr's dictionary of options and arguments
235
back into command line options and arguments for the script.
238
def find_command(cls, cmd):
240
bzrpath = os.environ.get('BZRPATH', '')
242
for dir in bzrpath.split(os.pathsep):
243
path = os.path.join(dir, cmd)
244
if os.path.isfile(path):
245
return ExternalCommand(path)
249
find_command = classmethod(find_command)
251
def __init__(self, path):
254
pipe = os.popen('%s --bzr-usage' % path, 'r')
255
self.takes_options = pipe.readline().split()
257
for opt in self.takes_options:
258
if not opt in OPTIONS:
259
raise BzrError("Unknown option '%s' returned by external command %s"
262
# TODO: Is there any way to check takes_args is valid here?
263
self.takes_args = pipe.readline().split()
265
if pipe.close() is not None:
266
raise BzrError("Failed funning '%s --bzr-usage'" % path)
268
pipe = os.popen('%s --bzr-help' % path, 'r')
269
self.__doc__ = pipe.read()
270
if pipe.close() is not None:
271
raise BzrError("Failed funning '%s --bzr-help'" % path)
273
def __call__(self, options, arguments):
274
Command.__init__(self, options, arguments)
277
def run(self, **kargs):
284
optname = name.replace('_','-')
286
if OPTIONS.has_key(optname):
288
opts.append('--%s' % optname)
289
if value is not None and value is not True:
290
opts.append(str(value))
292
# it's an arg, or arg list
293
if type(value) is not list:
299
self.status = os.spawnv(os.P_WAIT, self.path, [self.path] + opts + args)
303
class cmd_status(Command):
304
"""Display status summary.
306
This reports on versioned and unknown files, reporting them
307
grouped by state. Possible states are:
310
Versioned in the working copy but not in the previous revision.
313
Versioned in the previous revision but removed or deleted
317
Path of this file changed from the previous revision;
318
the text may also have changed. This includes files whose
319
parent directory was renamed.
322
Text has changed since the previous revision.
325
Nothing about this file has changed since the previous revision.
326
Only shown with --all.
329
Not versioned and not matching an ignore pattern.
331
To see ignored files use 'bzr ignored'. For details in the
332
changes to file texts, use 'bzr diff'.
334
If no arguments are specified, the status of the entire working
335
directory is shown. Otherwise, only the status of the specified
336
files or directories is reported. If a directory is given, status
337
is reported for everything inside that directory.
339
If a revision is specified, the changes since that revision are shown.
341
takes_args = ['file*']
342
takes_options = ['all', 'show-ids', 'revision']
343
aliases = ['st', 'stat']
345
def run(self, all=False, show_ids=False, file_list=None):
347
b = find_branch(file_list[0])
348
file_list = [b.relpath(x) for x in file_list]
349
# special case: only one path was given and it's the root
351
if file_list == ['']:
356
from bzrlib.status import show_status
357
show_status(b, show_unchanged=all, show_ids=show_ids,
358
specific_files=file_list)
361
class cmd_cat_revision(Command):
362
"""Write out metadata for a revision."""
365
takes_args = ['revision_id']
367
def run(self, revision_id):
368
from bzrlib.xml import pack_xml
369
pack_xml(find_branch('.').get_revision(revision_id), sys.stdout)
372
class cmd_revno(Command):
373
"""Show current revision number.
375
This is equal to the number of revisions on this branch."""
377
print find_branch('.').revno()
379
class cmd_revision_info(Command):
380
"""Show revision number and revision id for a given revision identifier.
383
takes_args = ['revision_info*']
384
takes_options = ['revision']
385
def run(self, revision=None, revision_info_list=None):
386
from bzrlib.branch import find_branch
389
if revision is not None:
390
revs.extend(revision)
391
if revision_info_list is not None:
392
revs.extend(revision_info_list)
394
raise BzrCommandError('You must supply a revision identifier')
399
print '%4d %s' % b.get_revision_info(rev)
402
class cmd_add(Command):
403
"""Add specified files or directories.
405
In non-recursive mode, all the named items are added, regardless
406
of whether they were previously ignored. A warning is given if
407
any of the named files are already versioned.
409
In recursive mode (the default), files are treated the same way
410
but the behaviour for directories is different. Directories that
411
are already versioned do not give a warning. All directories,
412
whether already versioned or not, are searched for files or
413
subdirectories that are neither versioned or ignored, and these
414
are added. This search proceeds recursively into versioned
415
directories. If no names are given '.' is assumed.
417
Therefore simply saying 'bzr add' will version all files that
418
are currently unknown.
420
TODO: Perhaps adding a file whose directly is not versioned should
421
recursively add that parent, rather than giving an error?
423
takes_args = ['file*']
424
takes_options = ['verbose', 'no-recurse']
426
def run(self, file_list, verbose=False, no_recurse=False):
427
from bzrlib.add import smart_add
428
smart_add(file_list, verbose, not no_recurse)
432
class cmd_mkdir(Command):
433
"""Create a new versioned directory.
435
This is equivalent to creating the directory and then adding it.
437
takes_args = ['dir+']
439
def run(self, dir_list):
446
b.add([d], verbose=True)
449
class cmd_relpath(Command):
450
"""Show path of a file relative to root"""
451
takes_args = ['filename']
454
def run(self, filename):
455
print find_branch(filename).relpath(filename)
459
class cmd_inventory(Command):
460
"""Show inventory of the current working copy or a revision."""
461
takes_options = ['revision', 'show-ids']
463
def run(self, revision=None, show_ids=False):
466
inv = b.read_working_inventory()
468
if len(revision) > 1:
469
raise BzrCommandError('bzr inventory --revision takes'
470
' exactly one revision identifier')
471
inv = b.get_revision_inventory(b.lookup_revision(revision[0]))
473
for path, entry in inv.entries():
475
print '%-50s %s' % (path, entry.file_id)
480
class cmd_move(Command):
481
"""Move files to a different directory.
486
The destination must be a versioned directory in the same branch.
488
takes_args = ['source$', 'dest']
489
def run(self, source_list, dest):
492
b.move([b.relpath(s) for s in source_list], b.relpath(dest))
495
class cmd_rename(Command):
496
"""Change the name of an entry.
499
bzr rename frob.c frobber.c
500
bzr rename src/frob.c lib/frob.c
502
It is an error if the destination name exists.
504
See also the 'move' command, which moves files into a different
505
directory without changing their name.
507
TODO: Some way to rename multiple files without invoking bzr for each
509
takes_args = ['from_name', 'to_name']
511
def run(self, from_name, to_name):
513
b.rename_one(b.relpath(from_name), b.relpath(to_name))
519
class cmd_pull(Command):
520
"""Pull any changes from another branch into the current one.
522
If the location is omitted, the last-used location will be used.
523
Both the revision history and the working directory will be
526
This command only works on branches that have not diverged. Branches are
527
considered diverged if both branches have had commits without first
528
pulling from the other.
530
If branches have diverged, you can use 'bzr merge' to pull the text changes
531
from one into the other.
533
takes_args = ['location?']
535
def run(self, location=None):
536
from bzrlib.merge import merge
538
from shutil import rmtree
541
br_to = find_branch('.')
544
stored_loc = br_to.controlfile("x-pull", "rb").read().rstrip('\n')
546
if e.errno != errno.ENOENT:
549
if stored_loc is None:
550
raise BzrCommandError("No pull location known or specified.")
552
print "Using last location: %s" % stored_loc
553
location = stored_loc
554
cache_root = tempfile.mkdtemp()
555
from bzrlib.branch import DivergedBranches
556
br_from = find_branch(location)
557
location = pull_loc(br_from)
558
old_revno = br_to.revno()
560
from branch import find_cached_branch, DivergedBranches
561
br_from = find_cached_branch(location, cache_root)
562
location = pull_loc(br_from)
563
old_revno = br_to.revno()
565
br_to.update_revisions(br_from)
566
except DivergedBranches:
567
raise BzrCommandError("These branches have diverged."
570
merge(('.', -1), ('.', old_revno), check_clean=False)
571
if location != stored_loc:
572
br_to.controlfile("x-pull", "wb").write(location + "\n")
578
class cmd_branch(Command):
579
"""Create a new copy of a branch.
581
If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
582
be used. In other words, "branch ../foo/bar" will attempt to create ./bar.
584
To retrieve the branch as of a particular revision, supply the --revision
585
parameter, as in "branch foo/bar -r 5".
587
takes_args = ['from_location', 'to_location?']
588
takes_options = ['revision']
590
def run(self, from_location, to_location=None, revision=None):
592
from bzrlib.merge import merge
593
from bzrlib.branch import DivergedBranches, NoSuchRevision, \
594
find_cached_branch, Branch
595
from shutil import rmtree
596
from meta_store import CachedStore
598
cache_root = tempfile.mkdtemp()
602
elif len(revision) > 1:
603
raise BzrCommandError('bzr branch --revision takes exactly 1 revision value')
607
br_from = find_cached_branch(from_location, cache_root)
609
if e.errno == errno.ENOENT:
610
raise BzrCommandError('Source location "%s" does not'
611
' exist.' % to_location)
615
if to_location is None:
616
to_location = os.path.basename(from_location.rstrip("/\\"))
619
os.mkdir(to_location)
621
if e.errno == errno.EEXIST:
622
raise BzrCommandError('Target directory "%s" already'
623
' exists.' % to_location)
624
if e.errno == errno.ENOENT:
625
raise BzrCommandError('Parent of "%s" does not exist.' %
629
br_to = Branch(to_location, init=True)
631
br_to.set_root_id(br_from.get_root_id())
634
if revision[0] is None:
635
revno = br_from.revno()
637
revno, rev_id = br_from.get_revision_info(revision[0])
639
br_to.update_revisions(br_from, stop_revision=revno)
640
except NoSuchRevision:
642
msg = "The branch %s has no revision %d." % (from_location,
644
raise BzrCommandError(msg)
646
merge((to_location, -1), (to_location, 0), this_dir=to_location,
647
check_clean=False, ignore_zero=True)
648
from_location = pull_loc(br_from)
649
br_to.controlfile("x-pull", "wb").write(from_location + "\n")
654
def pull_loc(branch):
655
# TODO: Should perhaps just make attribute be 'base' in
656
# RemoteBranch and Branch?
657
if hasattr(branch, "baseurl"):
658
return branch.baseurl
664
class cmd_renames(Command):
665
"""Show list of renamed files.
667
TODO: Option to show renames between two historical versions.
669
TODO: Only show renames under dir, rather than in the whole branch.
671
takes_args = ['dir?']
673
def run(self, dir='.'):
675
old_inv = b.basis_tree().inventory
676
new_inv = b.read_working_inventory()
678
renames = list(bzrlib.tree.find_renames(old_inv, new_inv))
680
for old_name, new_name in renames:
681
print "%s => %s" % (old_name, new_name)
684
class cmd_info(Command):
685
"""Show statistical information about a branch."""
686
takes_args = ['branch?']
688
def run(self, branch=None):
691
b = find_branch(branch)
695
class cmd_remove(Command):
696
"""Make a file unversioned.
698
This makes bzr stop tracking changes to a versioned file. It does
699
not delete the working copy.
701
takes_args = ['file+']
702
takes_options = ['verbose']
704
def run(self, file_list, verbose=False):
705
b = find_branch(file_list[0])
706
b.remove([b.relpath(f) for f in file_list], verbose=verbose)
709
class cmd_file_id(Command):
710
"""Print file_id of a particular file or directory.
712
The file_id is assigned when the file is first added and remains the
713
same through all revisions where the file exists, even when it is
717
takes_args = ['filename']
718
def run(self, filename):
719
b = find_branch(filename)
720
i = b.inventory.path2id(b.relpath(filename))
722
raise BzrError("%r is not a versioned file" % filename)
727
class cmd_file_path(Command):
728
"""Print path of file_ids to a file or directory.
730
This prints one line for each directory down to the target,
731
starting at the branch root."""
733
takes_args = ['filename']
734
def run(self, filename):
735
b = find_branch(filename)
737
fid = inv.path2id(b.relpath(filename))
739
raise BzrError("%r is not a versioned file" % filename)
740
for fip in inv.get_idpath(fid):
744
class cmd_revision_history(Command):
745
"""Display list of revision ids on this branch."""
748
for patchid in find_branch('.').revision_history():
752
class cmd_directories(Command):
753
"""Display list of versioned directories in this branch."""
755
for name, ie in find_branch('.').read_working_inventory().directories():
762
class cmd_init(Command):
763
"""Make a directory into a versioned branch.
765
Use this to create an empty branch, or before importing an
768
Recipe for importing a tree of files:
773
bzr commit -m 'imported project'
776
from bzrlib.branch import Branch
777
Branch('.', init=True)
780
class cmd_diff(Command):
781
"""Show differences in working tree.
783
If files are listed, only the changes in those files are listed.
784
Otherwise, all changes for the tree are listed.
786
TODO: Given two revision arguments, show the difference between them.
788
TODO: Allow diff across branches.
790
TODO: Option to use external diff command; could be GNU diff, wdiff,
793
TODO: Python difflib is not exactly the same as unidiff; should
794
either fix it up or prefer to use an external diff.
796
TODO: If a directory is given, diff everything under that.
798
TODO: Selected-file diff is inefficient and doesn't show you
801
TODO: This probably handles non-Unix newlines poorly.
804
takes_args = ['file*']
805
takes_options = ['revision', 'diff-options']
806
aliases = ['di', 'dif']
808
def run(self, revision=None, file_list=None, diff_options=None):
809
from bzrlib.diff import show_diff
812
b = find_branch(file_list[0])
813
file_list = [b.relpath(f) for f in file_list]
814
if file_list == ['']:
815
# just pointing to top-of-tree
820
# TODO: Make show_diff support taking 2 arguments
822
if revision is not None:
823
if len(revision) != 1:
824
raise BzrCommandError('bzr diff --revision takes exactly one revision identifier')
825
base_rev = revision[0]
827
show_diff(b, base_rev, specific_files=file_list,
828
external_diff_options=diff_options)
834
class cmd_deleted(Command):
835
"""List files deleted in the working tree.
837
TODO: Show files deleted since a previous revision, or between two revisions.
839
def run(self, show_ids=False):
842
new = b.working_tree()
844
## TODO: Much more efficient way to do this: read in new
845
## directories with readdir, rather than stating each one. Same
846
## level of effort but possibly much less IO. (Or possibly not,
847
## if the directories are very large...)
849
for path, ie in old.inventory.iter_entries():
850
if not new.has_id(ie.file_id):
852
print '%-50s %s' % (path, ie.file_id)
857
class cmd_modified(Command):
858
"""List files modified in working tree."""
861
from bzrlib.diff import compare_trees
864
td = compare_trees(b.basis_tree(), b.working_tree())
866
for path, id, kind in td.modified:
871
class cmd_added(Command):
872
"""List files added in working tree."""
876
wt = b.working_tree()
877
basis_inv = b.basis_tree().inventory
880
if file_id in basis_inv:
882
path = inv.id2path(file_id)
883
if not os.access(b.abspath(path), os.F_OK):
889
class cmd_root(Command):
890
"""Show the tree root directory.
892
The root is the nearest enclosing directory with a .bzr control
894
takes_args = ['filename?']
895
def run(self, filename=None):
896
"""Print the branch root."""
897
b = find_branch(filename)
898
print getattr(b, 'base', None) or getattr(b, 'baseurl')
901
class cmd_log(Command):
902
"""Show log of this branch.
904
To request a range of logs, you can use the command -r begin:end
905
-r revision requests a specific revision, -r :end or -r begin: are
908
--message allows you to give a regular expression, which will be evaluated
909
so that only matching entries will be displayed.
911
TODO: Make --revision support uuid: and hash: [future tag:] notation.
915
takes_args = ['filename?']
916
takes_options = ['forward', 'timezone', 'verbose', 'show-ids', 'revision','long', 'message']
918
def run(self, filename=None, timezone='original',
925
from bzrlib.branch import find_branch
926
from bzrlib.log import log_formatter, show_log
929
direction = (forward and 'forward') or 'reverse'
932
b = find_branch(filename)
933
fp = b.relpath(filename)
935
file_id = b.read_working_inventory().path2id(fp)
937
file_id = None # points to branch root
945
elif len(revision) == 1:
946
rev1 = rev2 = b.get_revision_info(revision[0])[0]
947
elif len(revision) == 2:
948
rev1 = b.get_revision_info(revision[0])[0]
949
rev2 = b.get_revision_info(revision[1])[0]
951
raise BzrCommandError('bzr log --revision takes one or two values.')
958
mutter('encoding log as %r' % bzrlib.user_encoding)
960
# use 'replace' so that we don't abort if trying to write out
961
# in e.g. the default C locale.
962
outf = codecs.getwriter(bzrlib.user_encoding)(sys.stdout, errors='replace')
968
lf = log_formatter(log_format,
971
show_timezone=timezone)
984
class cmd_touching_revisions(Command):
985
"""Return revision-ids which affected a particular file.
987
A more user-friendly interface is "bzr log FILE"."""
989
takes_args = ["filename"]
990
def run(self, filename):
991
b = find_branch(filename)
992
inv = b.read_working_inventory()
993
file_id = inv.path2id(b.relpath(filename))
994
for revno, revision_id, what in bzrlib.log.find_touching_revisions(b, file_id):
995
print "%6d %s" % (revno, what)
998
class cmd_ls(Command):
999
"""List files in a tree.
1001
TODO: Take a revision or remote path and list that tree instead.
1004
def run(self, revision=None, verbose=False):
1005
b = find_branch('.')
1006
if revision == None:
1007
tree = b.working_tree()
1009
tree = b.revision_tree(b.lookup_revision(revision))
1011
for fp, fc, kind, fid in tree.list_files():
1013
if kind == 'directory':
1015
elif kind == 'file':
1020
print '%-8s %s%s' % (fc, fp, kindch)
1026
class cmd_unknowns(Command):
1027
"""List unknown files."""
1029
from bzrlib.osutils import quotefn
1030
for f in find_branch('.').unknowns():
1035
class cmd_ignore(Command):
1036
"""Ignore a command or pattern.
1038
To remove patterns from the ignore list, edit the .bzrignore file.
1040
If the pattern contains a slash, it is compared to the whole path
1041
from the branch root. Otherwise, it is comapred to only the last
1042
component of the path.
1044
Ignore patterns are case-insensitive on case-insensitive systems.
1046
Note: wildcards must be quoted from the shell on Unix.
1049
bzr ignore ./Makefile
1050
bzr ignore '*.class'
1052
takes_args = ['name_pattern']
1054
def run(self, name_pattern):
1055
from bzrlib.atomicfile import AtomicFile
1058
b = find_branch('.')
1059
ifn = b.abspath('.bzrignore')
1061
if os.path.exists(ifn):
1064
igns = f.read().decode('utf-8')
1070
# TODO: If the file already uses crlf-style termination, maybe
1071
# we should use that for the newly added lines?
1073
if igns and igns[-1] != '\n':
1075
igns += name_pattern + '\n'
1078
f = AtomicFile(ifn, 'wt')
1079
f.write(igns.encode('utf-8'))
1084
inv = b.working_tree().inventory
1085
if inv.path2id('.bzrignore'):
1086
mutter('.bzrignore is already versioned')
1088
mutter('need to make new .bzrignore file versioned')
1089
b.add(['.bzrignore'])
1093
class cmd_ignored(Command):
1094
"""List ignored files and the patterns that matched them.
1096
See also: bzr ignore"""
1098
tree = find_branch('.').working_tree()
1099
for path, file_class, kind, file_id in tree.list_files():
1100
if file_class != 'I':
1102
## XXX: Slightly inefficient since this was already calculated
1103
pat = tree.is_ignored(path)
1104
print '%-50s %s' % (path, pat)
1107
class cmd_lookup_revision(Command):
1108
"""Lookup the revision-id from a revision-number
1111
bzr lookup-revision 33
1114
takes_args = ['revno']
1116
def run(self, revno):
1120
raise BzrCommandError("not a valid revision-number: %r" % revno)
1122
print find_branch('.').lookup_revision(revno)
1125
class cmd_export(Command):
1126
"""Export past revision to destination directory.
1128
If no revision is specified this exports the last committed revision.
1130
Format may be an "exporter" name, such as tar, tgz, tbz2. If none is
1131
given, try to find the format with the extension. If no extension
1132
is found exports to a directory (equivalent to --format=dir).
1134
Root may be the top directory for tar, tgz and tbz2 formats. If none
1135
is given, the top directory will be the root name of the file."""
1136
# TODO: list known exporters
1137
takes_args = ['dest']
1138
takes_options = ['revision', 'format', 'root']
1139
def run(self, dest, revision=None, format=None, root=None):
1141
b = find_branch('.')
1142
if revision is None:
1143
rev_id = b.last_patch()
1145
if len(revision) != 1:
1146
raise BzrError('bzr export --revision takes exactly 1 argument')
1147
revno, rev_id = b.get_revision_info(revision[0])
1148
t = b.revision_tree(rev_id)
1149
root, ext = os.path.splitext(dest)
1151
if ext in (".tar",):
1153
elif ext in (".gz", ".tgz"):
1155
elif ext in (".bz2", ".tbz2"):
1159
t.export(dest, format, root)
1162
class cmd_cat(Command):
1163
"""Write a file's text from a previous revision."""
1165
takes_options = ['revision']
1166
takes_args = ['filename']
1168
def run(self, filename, revision=None):
1169
if revision == None:
1170
raise BzrCommandError("bzr cat requires a revision number")
1171
elif len(revision) != 1:
1172
raise BzrCommandError("bzr cat --revision takes exactly one number")
1173
b = find_branch('.')
1174
b.print_file(b.relpath(filename), revision[0])
1177
class cmd_local_time_offset(Command):
1178
"""Show the offset in seconds from GMT to local time."""
1181
print bzrlib.osutils.local_time_offset()
1185
class cmd_commit(Command):
1186
"""Commit changes into a new revision.
1188
If no arguments are given, the entire tree is committed.
1190
If selected files are specified, only changes to those files are
1191
committed. If a directory is specified then the directory and everything
1192
within it is committed.
1194
A selected-file commit may fail in some cases where the committed
1195
tree would be invalid, such as trying to commit a file in a
1196
newly-added directory that is not itself committed.
1198
TODO: Run hooks on tree to-be-committed, and after commit.
1200
TODO: Strict commit that fails if there are unknown or deleted files.
1202
takes_args = ['selected*']
1203
takes_options = ['message', 'file', 'verbose', 'unchanged']
1204
aliases = ['ci', 'checkin']
1206
# TODO: Give better message for -s, --summary, used by tla people
1208
def run(self, message=None, file=None, verbose=True, selected_list=None,
1210
from bzrlib.errors import PointlessCommit
1211
from bzrlib.osutils import get_text_message
1213
## Warning: shadows builtin file()
1214
if not message and not file:
1215
# FIXME: Ugly; change status code to send to a provided function?
1219
catcher = cStringIO.StringIO()
1220
sys.stdout = catcher
1221
cmd_status({"file_list":selected_list}, {})
1222
info = catcher.getvalue()
1224
message = get_text_message(info)
1227
raise BzrCommandError("please specify a commit message",
1228
["use either --message or --file"])
1229
elif message and file:
1230
raise BzrCommandError("please specify either --message or --file")
1234
message = codecs.open(file, 'rt', bzrlib.user_encoding).read()
1236
b = find_branch('.')
1238
selected_list = [b.relpath(s) for s in selected_list]
1240
selected_list = [b.relpath('.')]
1241
if selected_list == ['.']:
1242
selected_list = None
1245
b.commit(message, verbose=verbose,
1246
specific_files=selected_list,
1247
allow_pointless=unchanged)
1248
except PointlessCommit:
1249
# FIXME: This should really happen before the file is read in;
1250
# perhaps prepare the commit; get the message; then actually commit
1251
raise BzrCommandError("no changes to commit",
1252
["use --unchanged to commit anyhow"])
1255
class cmd_check(Command):
1256
"""Validate consistency of branch history.
1258
This command checks various invariants about the branch storage to
1259
detect data corruption or bzr bugs.
1261
If given the --update flag, it will update some optional fields
1262
to help ensure data consistency.
1264
takes_args = ['dir?']
1266
def run(self, dir='.'):
1267
from bzrlib.check import check
1268
check(find_branch(dir))
1272
class cmd_scan_cache(Command):
1275
from bzrlib.hashcache import HashCache
1282
print '%6d stats' % c.stat_count
1283
print '%6d in hashcache' % len(c._cache)
1284
print '%6d files removed from cache' % c.removed_count
1285
print '%6d hashes updated' % c.update_count
1286
print '%6d files changed too recently to cache' % c.danger_count
1293
class cmd_upgrade(Command):
1294
"""Upgrade branch storage to current format.
1296
This should normally be used only after the check command tells
1299
takes_args = ['dir?']
1301
def run(self, dir='.'):
1302
from bzrlib.upgrade import upgrade
1303
upgrade(find_branch(dir))
1307
class cmd_whoami(Command):
1308
"""Show bzr user id."""
1309
takes_options = ['email']
1311
def run(self, email=False):
1313
print bzrlib.osutils.user_email()
1315
print bzrlib.osutils.username()
1318
class cmd_selftest(Command):
1319
"""Run internal test suite"""
1321
takes_options = ['verbose']
1322
def run(self, verbose=False):
1323
from bzrlib.selftest import selftest
1324
return int(not selftest(verbose=verbose))
1327
class cmd_version(Command):
1328
"""Show version of bzr."""
1333
print "bzr (bazaar-ng) %s" % bzrlib.__version__
1334
# is bzrlib itself in a branch?
1335
bzrrev = bzrlib.get_bzr_revision()
1337
print " (bzr checkout, revision %d {%s})" % bzrrev
1338
print bzrlib.__copyright__
1339
print "http://bazaar-ng.org/"
1341
print "bzr comes with ABSOLUTELY NO WARRANTY. bzr is free software, and"
1342
print "you may use, modify and redistribute it under the terms of the GNU"
1343
print "General Public License version 2 or later."
1346
class cmd_rocks(Command):
1347
"""Statement of optimism."""
1350
print "it sure does!"
1352
def parse_spec(spec):
1354
>>> parse_spec(None)
1356
>>> parse_spec("./")
1358
>>> parse_spec("../@")
1360
>>> parse_spec("../f/@35")
1362
>>> parse_spec('./@revid:john@arbash-meinel.com-20050711044610-3ca0327c6a222f67')
1363
['.', 'revid:john@arbash-meinel.com-20050711044610-3ca0327c6a222f67']
1368
parsed = spec.split('/@')
1369
assert len(parsed) == 2
1374
parsed[1] = int(parsed[1])
1376
pass # We can allow stuff like ./@revid:blahblahblah
1378
assert parsed[1] >=0
1380
parsed = [spec, None]
1385
class cmd_merge(Command):
1386
"""Perform a three-way merge of trees.
1388
The SPEC parameters are working tree or revision specifiers. Working trees
1389
are specified using standard paths or urls. No component of a directory
1390
path may begin with '@'.
1392
Working tree examples: '.', '..', 'foo@', but NOT 'foo/@bar'
1394
Revisions are specified using a dirname/@revno pair, where dirname is the
1395
branch directory and revno is the revision within that branch. If no revno
1396
is specified, the latest revision is used.
1398
Revision examples: './@127', 'foo/@', '../@1'
1400
The OTHER_SPEC parameter is required. If the BASE_SPEC parameter is
1401
not supplied, the common ancestor of OTHER_SPEC the current branch is used
1404
merge refuses to run if there are any uncommitted changes, unless
1407
takes_args = ['other_spec', 'base_spec?']
1408
takes_options = ['force']
1410
def run(self, other_spec, base_spec=None, force=False):
1411
from bzrlib.merge import merge
1412
merge(parse_spec(other_spec), parse_spec(base_spec),
1413
check_clean=(not force))
1417
class cmd_revert(Command):
1418
"""Restore selected files from a previous revision.
1420
takes_args = ['file+']
1421
def run(self, file_list):
1422
from bzrlib.branch import find_branch
1427
b = find_branch(file_list[0])
1429
b.revert([b.relpath(f) for f in file_list])
1432
class cmd_merge_revert(Command):
1433
"""Reverse all changes since the last commit.
1435
Only versioned files are affected.
1437
TODO: Store backups of any files that will be reverted, so
1438
that the revert can be undone.
1440
takes_options = ['revision']
1442
def run(self, revision=None):
1443
from bzrlib.merge import merge
1444
if revision is None:
1446
elif len(revision) != 1:
1447
raise BzrCommandError('bzr merge-revert --revision takes exactly 1 argument')
1448
merge(('.', revision[0]), parse_spec('.'),
1453
class cmd_assert_fail(Command):
1454
"""Test reporting of assertion failures"""
1457
assert False, "always fails"
1460
class cmd_help(Command):
1461
"""Show help on a command or other topic.
1463
For a list of all available commands, say 'bzr help commands'."""
1464
takes_args = ['topic?']
1467
def run(self, topic=None):
1474
class cmd_plugins(Command):
1478
import bzrlib.plugin
1479
from inspect import getdoc
1480
from pprint import pprint
1481
for plugin in bzrlib.plugin.all_plugins:
1482
print plugin.__path__[0]
1485
print '\t', d.split('\n')[0]
1487
#pprint(bzrlib.plugin.all_plugins)
1491
# list of all available options; the rhs can be either None for an
1492
# option that takes no argument, or a constructor function that checks
1496
'diff-options': str,
1505
'revision': _parse_revision_str,
1527
def parse_args(argv):
1528
"""Parse command line.
1530
Arguments and options are parsed at this level before being passed
1531
down to specific command handlers. This routine knows, from a
1532
lookup table, something about the available options, what optargs
1533
they take, and which commands will accept them.
1535
>>> parse_args('--help'.split())
1536
([], {'help': True})
1537
>>> parse_args('--version'.split())
1538
([], {'version': True})
1539
>>> parse_args('status --all'.split())
1540
(['status'], {'all': True})
1541
>>> parse_args('commit --message=biter'.split())
1542
(['commit'], {'message': u'biter'})
1543
>>> parse_args('log -r 500'.split())
1544
(['log'], {'revision': [500]})
1545
>>> parse_args('log -r500..600'.split())
1546
(['log'], {'revision': [500, 600]})
1547
>>> parse_args('log -vr500..600'.split())
1548
(['log'], {'verbose': True, 'revision': [500, 600]})
1549
>>> parse_args('log -rv500..600'.split()) #the r takes an argument
1550
(['log'], {'revision': ['v500', 600]})
1555
# TODO: Maybe handle '--' to end options?
1560
# option names must not be unicode
1564
mutter(" got option %r" % a)
1566
optname, optarg = a[2:].split('=', 1)
1569
if optname not in OPTIONS:
1570
raise BzrError('unknown long option %r' % a)
1573
if shortopt in SHORT_OPTIONS:
1574
# Multi-character options must have a space to delimit
1576
optname = SHORT_OPTIONS[shortopt]
1578
# Single character short options, can be chained,
1579
# and have their value appended to their name
1581
if shortopt not in SHORT_OPTIONS:
1582
# We didn't find the multi-character name, and we
1583
# didn't find the single char name
1584
raise BzrError('unknown short option %r' % a)
1585
optname = SHORT_OPTIONS[shortopt]
1588
# There are extra things on this option
1589
# see if it is the value, or if it is another
1591
optargfn = OPTIONS[optname]
1592
if optargfn is None:
1593
# This option does not take an argument, so the
1594
# next entry is another short option, pack it back
1596
argv.insert(0, '-' + a[2:])
1598
# This option takes an argument, so pack it
1603
# XXX: Do we ever want to support this, e.g. for -r?
1604
raise BzrError('repeated option %r' % a)
1606
optargfn = OPTIONS[optname]
1610
raise BzrError('option %r needs an argument' % a)
1612
optarg = argv.pop(0)
1613
opts[optname] = optargfn(optarg)
1616
raise BzrError('option %r takes no argument' % optname)
1617
opts[optname] = True
1626
def _match_argform(cmd, takes_args, args):
1629
# step through args and takes_args, allowing appropriate 0-many matches
1630
for ap in takes_args:
1634
argdict[argname] = args.pop(0)
1635
elif ap[-1] == '*': # all remaining arguments
1637
argdict[argname + '_list'] = args[:]
1640
argdict[argname + '_list'] = None
1643
raise BzrCommandError("command %r needs one or more %s"
1644
% (cmd, argname.upper()))
1646
argdict[argname + '_list'] = args[:]
1648
elif ap[-1] == '$': # all but one
1650
raise BzrCommandError("command %r needs one or more %s"
1651
% (cmd, argname.upper()))
1652
argdict[argname + '_list'] = args[:-1]
1658
raise BzrCommandError("command %r requires argument %s"
1659
% (cmd, argname.upper()))
1661
argdict[argname] = args.pop(0)
1664
raise BzrCommandError("extra argument to command %s: %s"
1670
def _parse_master_args(argv):
1671
"""Parse the arguments that always go with the original command.
1672
These are things like bzr --no-plugins, etc.
1674
There are now 2 types of option flags. Ones that come *before* the command,
1675
and ones that come *after* the command.
1676
Ones coming *before* the command are applied against all possible commands.
1677
And are generally applied before plugins are loaded.
1679
The current list are:
1680
--builtin Allow plugins to load, but don't let them override builtin commands,
1681
they will still be allowed if they do not override a builtin.
1682
--no-plugins Don't load any plugins. This lets you get back to official source
1684
--profile Enable the hotspot profile before running the command.
1685
For backwards compatibility, this is also a non-master option.
1686
--version Spit out the version of bzr that is running and exit.
1687
This is also a non-master option.
1688
--help Run help and exit, also a non-master option (I think that should stay, though)
1690
>>> argv, opts = _parse_master_args(['--test'])
1691
Traceback (most recent call last):
1693
BzrCommandError: Invalid master option: 'test'
1694
>>> argv, opts = _parse_master_args(['--version', 'command'])
1697
>>> print opts['version']
1699
>>> argv, opts = _parse_master_args(['--profile', 'command', '--more-options'])
1701
['command', '--more-options']
1702
>>> print opts['profile']
1704
>>> argv, opts = _parse_master_args(['--no-plugins', 'command'])
1707
>>> print opts['no-plugins']
1709
>>> print opts['profile']
1711
>>> argv, opts = _parse_master_args(['command', '--profile'])
1713
['command', '--profile']
1714
>>> print opts['profile']
1717
master_opts = {'builtin':False,
1725
if arg[:2] != '--': # at the first non-option, we return the rest
1727
arg = arg[2:] # Remove '--'
1728
if arg not in master_opts:
1729
# We could say that this is not an error, that we should
1730
# just let it be handled by the main section instead
1731
raise BzrCommandError('Invalid master option: %r' % arg)
1732
argv.pop(0) # We are consuming this entry
1733
master_opts[arg] = True
1734
return argv, master_opts
1739
"""Execute a command.
1741
This is similar to main(), but without all the trappings for
1742
logging and error handling.
1745
The command-line arguments, without the program name.
1747
Returns a command status or raises an exception.
1749
argv = [a.decode(bzrlib.user_encoding) for a in argv]
1751
# some options like --builtin and --no-plugins have special effects
1752
argv, master_opts = _parse_master_args(argv)
1753
if not master_opts['no-plugins']:
1754
from bzrlib.plugin import load_plugins
1757
args, opts = parse_args(argv)
1759
if master_opts.get('help') or 'help' in opts:
1760
from bzrlib.help import help
1767
if 'version' in opts:
1771
if args and args[0] == 'builtin':
1772
include_plugins=False
1776
cmd = str(args.pop(0))
1778
print >>sys.stderr, "please try 'bzr help' for help"
1781
plugins_override = not (master_opts['builtin'])
1782
canonical_cmd, cmd_class = get_cmd_class(cmd, plugins_override=plugins_override)
1784
profile = master_opts['profile']
1785
# For backwards compatibility, I would rather stick with --profile being a
1786
# master/global option
1787
if 'profile' in opts:
1791
# check options are reasonable
1792
allowed = cmd_class.takes_options
1794
if oname not in allowed:
1795
raise BzrCommandError("option '--%s' is not allowed for command %r"
1798
# mix arguments and options into one dictionary
1799
cmdargs = _match_argform(cmd, cmd_class.takes_args, args)
1801
for k, v in opts.items():
1802
cmdopts[k.replace('-', '_')] = v
1805
import hotshot, tempfile
1806
pffileno, pfname = tempfile.mkstemp()
1808
prof = hotshot.Profile(pfname)
1809
ret = prof.runcall(cmd_class, cmdopts, cmdargs) or 0
1812
import hotshot.stats
1813
stats = hotshot.stats.load(pfname)
1815
stats.sort_stats('time')
1816
## XXX: Might like to write to stderr or the trace file instead but
1817
## print_stats seems hardcoded to stdout
1818
stats.print_stats(20)
1826
return cmd_class(cmdopts, cmdargs).status
1829
def _report_exception(summary, quiet=False):
1831
log_error('bzr: ' + summary)
1832
bzrlib.trace.log_exception()
1835
tb = sys.exc_info()[2]
1836
exinfo = traceback.extract_tb(tb)
1838
sys.stderr.write(' at %s:%d in %s()\n' % exinfo[-1][:3])
1839
sys.stderr.write(' see ~/.bzr.log for debug information\n')
1845
bzrlib.trace.open_tracefile(argv)
1850
return run_bzr(argv[1:])
1852
# do this here inside the exception wrappers to catch EPIPE
1855
quiet = isinstance(e, (BzrCommandError))
1856
_report_exception('error: ' + e.args[0], quiet=quiet)
1859
# some explanation or hints
1862
except AssertionError, e:
1863
msg = 'assertion failed'
1865
msg += ': ' + str(e)
1866
_report_exception(msg)
1868
except KeyboardInterrupt, e:
1869
_report_exception('interrupted', quiet=True)
1871
except Exception, e:
1874
if (isinstance(e, IOError)
1875
and hasattr(e, 'errno')
1876
and e.errno == errno.EPIPE):
1880
msg = str(e).rstrip('\n')
1881
_report_exception(msg, quiet)
1884
bzrlib.trace.close_trace()
1887
if __name__ == '__main__':
1888
sys.exit(main(sys.argv))
added
removed
bzrlib/commands.py
