1
# Copyright (C) 2004, 2005 by Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
22
from bzrlib.trace import mutter, note, log_error
23
from bzrlib.errors import BzrError, BzrCheckError, BzrCommandError
24
from bzrlib.osutils import quotefn
25
from bzrlib import Branch, Inventory, InventoryEntry, BZRDIR, \
29
def _squish_command_name(cmd):
30
return 'cmd_' + cmd.replace('-', '_')
33
def _unsquish_command_name(cmd):
34
assert cmd.startswith("cmd_")
35
return cmd[4:].replace('_','-')
37
def _parse_revision_str(revstr):
38
"""This handles a revision string -> revno.
40
There are several possibilities:
43
'234:345' -> [234, 345]
47
In the future we will also support:
48
'uuid:blah-blah-blah' -> ?
49
'hash:blahblahblah' -> ?
53
if revstr.find(':') != -1:
54
revs = revstr.split(':')
56
raise ValueError('More than 2 pieces not supported for --revision: %r' % revstr)
61
revs[0] = int(revs[0])
66
revs[1] = int(revs[1])
72
"""Find all python files which are plugins, and load their commands
73
to add to the list of "all commands"
75
The environment variable BZRPATH is considered a delimited set of
76
paths to look through. Each entry is searched for *.py files.
77
If a directory is found, it is also searched, but they are
78
not searched recursively. This allows you to revctl the plugins.
80
Inside the plugin should be a series of cmd_* function, which inherit from
81
the bzrlib.commands.Command class.
83
bzrpath = os.environ.get('BZRPLUGINPATH', '')
88
_platform_extensions = {
94
if _platform_extensions.has_key(sys.platform):
95
platform_extension = _platform_extensions[sys.platform]
97
platform_extension = None
98
for d in bzrpath.split(os.pathsep):
99
plugin_names = {} # This should really be a set rather than a dict
100
for f in os.listdir(d):
101
if f.endswith('.py'):
103
elif f.endswith('.pyc') or f.endswith('.pyo'):
105
elif platform_extension and f.endswith(platform_extension):
106
f = f[:-len(platform_extension)]
107
if f.endswidth('module'):
108
f = f[:-len('module')]
111
if not plugin_names.has_key(f):
112
plugin_names[f] = True
114
plugin_names = plugin_names.keys()
117
sys.path.insert(0, d)
118
for name in plugin_names:
122
if sys.modules.has_key(name):
123
old_module = sys.modules[name]
124
del sys.modules[name]
125
plugin = __import__(name, locals())
126
for k in dir(plugin):
127
if k.startswith('cmd_'):
128
k_unsquished = _unsquish_command_name(k)
129
if not plugin_cmds.has_key(k_unsquished):
130
plugin_cmds[k_unsquished] = getattr(plugin, k)
132
log_error('Two plugins defined the same command: %r' % k)
133
log_error('Not loading the one in %r in dir %r' % (name, d))
136
sys.modules[name] = old_module
137
except ImportError, e:
138
log_error('Unable to load plugin: %r from %r\n%s' % (name, d, e))
143
def _get_cmd_dict(include_plugins=True):
145
for k, v in globals().iteritems():
146
if k.startswith("cmd_"):
147
d[_unsquish_command_name(k)] = v
149
d.update(_find_plugins())
152
def get_all_cmds(include_plugins=True):
153
"""Return canonical name and class for all registered commands."""
154
for k, v in _get_cmd_dict(include_plugins=include_plugins).iteritems():
158
def get_cmd_class(cmd,include_plugins=True):
159
"""Return the canonical name and command class for a command.
161
cmd = str(cmd) # not unicode
163
# first look up this command under the specified name
164
cmds = _get_cmd_dict(include_plugins=include_plugins)
166
return cmd, cmds[cmd]
170
# look for any command which claims this as an alias
171
for cmdname, cmdclass in cmds.iteritems():
172
if cmd in cmdclass.aliases:
173
return cmdname, cmdclass
175
cmdclass = ExternalCommand.find_command(cmd)
179
raise BzrCommandError("unknown command %r" % cmd)
182
class Command(object):
183
"""Base class for commands.
185
The docstring for an actual command should give a single-line
186
summary, then a complete description of the command. A grammar
187
description will be inserted.
190
List of argument forms, marked with whether they are optional,
194
List of options that may be given for this command.
197
If true, this command isn't advertised.
206
def __init__(self, options, arguments):
207
"""Construct and run the command.
209
Sets self.status to the return value of run()."""
210
assert isinstance(options, dict)
211
assert isinstance(arguments, dict)
212
cmdargs = options.copy()
213
cmdargs.update(arguments)
214
assert self.__doc__ != Command.__doc__, \
215
("No help message set for %r" % self)
216
self.status = self.run(**cmdargs)
220
"""Override this in sub-classes.
222
This is invoked with the options and arguments bound to
225
Return 0 or None if the command was successful, or a shell
231
class ExternalCommand(Command):
232
"""Class to wrap external commands.
234
We cheat a little here, when get_cmd_class() calls us we actually give it back
235
an object we construct that has the appropriate path, help, options etc for the
238
When run_bzr() tries to instantiate that 'class' it gets caught by the __call__
239
method, which we override to call the Command.__init__ method. That then calls
240
our run method which is pretty straight forward.
242
The only wrinkle is that we have to map bzr's dictionary of options and arguments
243
back into command line options and arguments for the script.
246
def find_command(cls, cmd):
248
bzrpath = os.environ.get('BZRPATH', '')
250
for dir in bzrpath.split(os.pathsep):
251
path = os.path.join(dir, cmd)
252
if os.path.isfile(path):
253
return ExternalCommand(path)
257
find_command = classmethod(find_command)
259
def __init__(self, path):
262
pipe = os.popen('%s --bzr-usage' % path, 'r')
263
self.takes_options = pipe.readline().split()
265
for opt in self.takes_options:
266
if not opt in OPTIONS:
267
raise BzrError("Unknown option '%s' returned by external command %s"
270
# TODO: Is there any way to check takes_args is valid here?
271
self.takes_args = pipe.readline().split()
273
if pipe.close() is not None:
274
raise BzrError("Failed funning '%s --bzr-usage'" % path)
276
pipe = os.popen('%s --bzr-help' % path, 'r')
277
self.__doc__ = pipe.read()
278
if pipe.close() is not None:
279
raise BzrError("Failed funning '%s --bzr-help'" % path)
281
def __call__(self, options, arguments):
282
Command.__init__(self, options, arguments)
285
def run(self, **kargs):
292
optname = name.replace('_','-')
294
if OPTIONS.has_key(optname):
296
opts.append('--%s' % optname)
297
if value is not None and value is not True:
298
opts.append(str(value))
300
# it's an arg, or arg list
301
if type(value) is not list:
307
self.status = os.spawnv(os.P_WAIT, self.path, [self.path] + opts + args)
311
class cmd_status(Command):
312
"""Display status summary.
314
This reports on versioned and unknown files, reporting them
315
grouped by state. Possible states are:
318
Versioned in the working copy but not in the previous revision.
321
Versioned in the previous revision but removed or deleted
325
Path of this file changed from the previous revision;
326
the text may also have changed. This includes files whose
327
parent directory was renamed.
330
Text has changed since the previous revision.
333
Nothing about this file has changed since the previous revision.
334
Only shown with --all.
337
Not versioned and not matching an ignore pattern.
339
To see ignored files use 'bzr ignored'. For details in the
340
changes to file texts, use 'bzr diff'.
342
If no arguments are specified, the status of the entire working
343
directory is shown. Otherwise, only the status of the specified
344
files or directories is reported. If a directory is given, status
345
is reported for everything inside that directory.
347
takes_args = ['file*']
348
takes_options = ['all', 'show-ids']
349
aliases = ['st', 'stat']
351
def run(self, all=False, show_ids=False, file_list=None):
353
b = Branch(file_list[0])
354
file_list = [b.relpath(x) for x in file_list]
355
# special case: only one path was given and it's the root
357
if file_list == ['']:
362
status.show_status(b, show_unchanged=all, show_ids=show_ids,
363
specific_files=file_list)
366
class cmd_cat_revision(Command):
367
"""Write out metadata for a revision."""
370
takes_args = ['revision_id']
372
def run(self, revision_id):
373
Branch('.').get_revision(revision_id).write_xml(sys.stdout)
376
class cmd_revno(Command):
377
"""Show current revision number.
379
This is equal to the number of revisions on this branch."""
381
print Branch('.').revno()
384
class cmd_add(Command):
385
"""Add specified files or directories.
387
In non-recursive mode, all the named items are added, regardless
388
of whether they were previously ignored. A warning is given if
389
any of the named files are already versioned.
391
In recursive mode (the default), files are treated the same way
392
but the behaviour for directories is different. Directories that
393
are already versioned do not give a warning. All directories,
394
whether already versioned or not, are searched for files or
395
subdirectories that are neither versioned or ignored, and these
396
are added. This search proceeds recursively into versioned
399
Therefore simply saying 'bzr add .' will version all files that
400
are currently unknown.
402
TODO: Perhaps adding a file whose directly is not versioned should
403
recursively add that parent, rather than giving an error?
405
takes_args = ['file+']
406
takes_options = ['verbose', 'no-recurse']
408
def run(self, file_list, verbose=False, no_recurse=False):
409
bzrlib.add.smart_add(file_list, verbose, not no_recurse)
412
class cmd_relpath(Command):
413
"""Show path of a file relative to root"""
414
takes_args = ['filename']
417
def run(self, filename):
418
print Branch(filename).relpath(filename)
422
class cmd_inventory(Command):
423
"""Show inventory of the current working copy or a revision."""
424
takes_options = ['revision', 'show-ids']
426
def run(self, revision=None, show_ids=False):
429
inv = b.read_working_inventory()
431
inv = b.get_revision_inventory(b.lookup_revision(revision))
433
for path, entry in inv.entries():
435
print '%-50s %s' % (path, entry.file_id)
440
class cmd_move(Command):
441
"""Move files to a different directory.
446
The destination must be a versioned directory in the same branch.
448
takes_args = ['source$', 'dest']
449
def run(self, source_list, dest):
452
b.move([b.relpath(s) for s in source_list], b.relpath(dest))
455
class cmd_rename(Command):
456
"""Change the name of an entry.
459
bzr rename frob.c frobber.c
460
bzr rename src/frob.c lib/frob.c
462
It is an error if the destination name exists.
464
See also the 'move' command, which moves files into a different
465
directory without changing their name.
467
TODO: Some way to rename multiple files without invoking bzr for each
469
takes_args = ['from_name', 'to_name']
471
def run(self, from_name, to_name):
473
b.rename_one(b.relpath(from_name), b.relpath(to_name))
479
class cmd_pull(Command):
480
"""Pull any changes from another branch into the current one.
482
If the location is omitted, the last-used location will be used.
483
Both the revision history and the working directory will be
486
This command only works on branches that have not diverged. Branches are
487
considered diverged if both branches have had commits without first
488
pulling from the other.
490
If branches have diverged, you can use 'bzr merge' to pull the text changes
491
from one into the other.
493
takes_args = ['location?']
495
def run(self, location=None):
496
from bzrlib.merge import merge
502
stored_loc = br_to.controlfile("x-pull", "rb").read().rstrip('\n')
504
if errno == errno.ENOENT:
507
if stored_loc is None:
508
raise BzrCommandError("No pull location known or specified.")
510
print "Using last location: %s" % stored_loc
511
location = stored_loc
512
from branch import find_branch, DivergedBranches
513
br_from = find_branch(location)
514
location = pull_loc(br_from)
515
old_revno = br_to.revno()
517
br_to.update_revisions(br_from)
518
except DivergedBranches:
519
raise BzrCommandError("These branches have diverged. Try merge.")
521
merge(('.', -1), ('.', old_revno), check_clean=False)
522
if location != stored_loc:
523
br_to.controlfile("x-pull", "wb").write(location + "\n")
527
class cmd_branch(Command):
528
"""Create a new copy of a branch.
530
If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
531
be used. In other words, "branch ../foo/bar" will attempt to create ./bar.
533
To retrieve the branch as of a particular revision, supply the --revision
534
parameter, as in "branch foo/bar -r 5".
536
takes_args = ['from_location', 'to_location?']
537
takes_options = ['revision']
539
def run(self, from_location, to_location=None, revision=None):
541
from bzrlib.merge import merge
542
from branch import find_branch, DivergedBranches, NoSuchRevision
543
from shutil import rmtree
545
br_from = find_branch(from_location)
547
if e.errno == errno.ENOENT:
548
raise BzrCommandError('Source location "%s" does not exist.' %
553
if to_location is None:
554
to_location = os.path.basename(from_location.rstrip("/\\"))
557
os.mkdir(to_location)
559
if e.errno == errno.EEXIST:
560
raise BzrCommandError('Target directory "%s" already exists.' %
562
if e.errno == errno.ENOENT:
563
raise BzrCommandError('Parent of "%s" does not exist.' %
567
br_to = Branch(to_location, init=True)
570
br_to.update_revisions(br_from, stop_revision=revision)
571
except NoSuchRevision:
573
msg = "The branch %s has no revision %d." % (from_location,
575
raise BzrCommandError(msg)
576
merge((to_location, -1), (to_location, 0), this_dir=to_location,
577
check_clean=False, ignore_zero=True)
578
from_location = pull_loc(br_from)
579
br_to.controlfile("x-pull", "wb").write(from_location + "\n")
582
def pull_loc(branch):
583
# TODO: Should perhaps just make attribute be 'base' in
584
# RemoteBranch and Branch?
585
if hasattr(branch, "baseurl"):
586
return branch.baseurl
592
class cmd_renames(Command):
593
"""Show list of renamed files.
595
TODO: Option to show renames between two historical versions.
597
TODO: Only show renames under dir, rather than in the whole branch.
599
takes_args = ['dir?']
601
def run(self, dir='.'):
603
old_inv = b.basis_tree().inventory
604
new_inv = b.read_working_inventory()
606
renames = list(bzrlib.tree.find_renames(old_inv, new_inv))
608
for old_name, new_name in renames:
609
print "%s => %s" % (old_name, new_name)
612
class cmd_info(Command):
613
"""Show statistical information about a branch."""
614
takes_args = ['branch?']
616
def run(self, branch=None):
619
from branch import find_branch
620
b = find_branch(branch)
624
class cmd_remove(Command):
625
"""Make a file unversioned.
627
This makes bzr stop tracking changes to a versioned file. It does
628
not delete the working copy.
630
takes_args = ['file+']
631
takes_options = ['verbose']
633
def run(self, file_list, verbose=False):
634
b = Branch(file_list[0])
635
b.remove([b.relpath(f) for f in file_list], verbose=verbose)
638
class cmd_file_id(Command):
639
"""Print file_id of a particular file or directory.
641
The file_id is assigned when the file is first added and remains the
642
same through all revisions where the file exists, even when it is
646
takes_args = ['filename']
647
def run(self, filename):
649
i = b.inventory.path2id(b.relpath(filename))
651
raise BzrError("%r is not a versioned file" % filename)
656
class cmd_file_path(Command):
657
"""Print path of file_ids to a file or directory.
659
This prints one line for each directory down to the target,
660
starting at the branch root."""
662
takes_args = ['filename']
663
def run(self, filename):
666
fid = inv.path2id(b.relpath(filename))
668
raise BzrError("%r is not a versioned file" % filename)
669
for fip in inv.get_idpath(fid):
673
class cmd_revision_history(Command):
674
"""Display list of revision ids on this branch."""
677
for patchid in Branch('.').revision_history():
681
class cmd_directories(Command):
682
"""Display list of versioned directories in this branch."""
684
for name, ie in Branch('.').read_working_inventory().directories():
691
class cmd_init(Command):
692
"""Make a directory into a versioned branch.
694
Use this to create an empty branch, or before importing an
697
Recipe for importing a tree of files:
702
bzr commit -m 'imported project'
705
Branch('.', init=True)
708
class cmd_diff(Command):
709
"""Show differences in working tree.
711
If files are listed, only the changes in those files are listed.
712
Otherwise, all changes for the tree are listed.
714
TODO: Given two revision arguments, show the difference between them.
716
TODO: Allow diff across branches.
718
TODO: Option to use external diff command; could be GNU diff, wdiff,
721
TODO: Python difflib is not exactly the same as unidiff; should
722
either fix it up or prefer to use an external diff.
724
TODO: If a directory is given, diff everything under that.
726
TODO: Selected-file diff is inefficient and doesn't show you
729
TODO: This probably handles non-Unix newlines poorly.
732
takes_args = ['file*']
733
takes_options = ['revision', 'diff-options']
734
aliases = ['di', 'dif']
736
def run(self, revision=None, file_list=None, diff_options=None):
737
from bzrlib.diff import show_diff
738
from bzrlib import find_branch
741
b = find_branch(file_list[0])
742
file_list = [b.relpath(f) for f in file_list]
743
if file_list == ['']:
744
# just pointing to top-of-tree
749
show_diff(b, revision, specific_files=file_list,
750
external_diff_options=diff_options)
756
class cmd_deleted(Command):
757
"""List files deleted in the working tree.
759
TODO: Show files deleted since a previous revision, or between two revisions.
761
def run(self, show_ids=False):
764
new = b.working_tree()
766
## TODO: Much more efficient way to do this: read in new
767
## directories with readdir, rather than stating each one. Same
768
## level of effort but possibly much less IO. (Or possibly not,
769
## if the directories are very large...)
771
for path, ie in old.inventory.iter_entries():
772
if not new.has_id(ie.file_id):
774
print '%-50s %s' % (path, ie.file_id)
779
class cmd_modified(Command):
780
"""List files modified in working tree."""
785
inv = b.read_working_inventory()
786
sc = statcache.update_cache(b, inv)
787
basis = b.basis_tree()
788
basis_inv = basis.inventory
790
# We used to do this through iter_entries(), but that's slow
791
# when most of the files are unmodified, as is usually the
792
# case. So instead we iterate by inventory entry, and only
793
# calculate paths as necessary.
795
for file_id in basis_inv:
796
cacheentry = sc.get(file_id)
797
if not cacheentry: # deleted
799
ie = basis_inv[file_id]
800
if cacheentry[statcache.SC_SHA1] != ie.text_sha1:
801
path = inv.id2path(file_id)
806
class cmd_added(Command):
807
"""List files added in working tree."""
811
wt = b.working_tree()
812
basis_inv = b.basis_tree().inventory
815
if file_id in basis_inv:
817
path = inv.id2path(file_id)
818
if not os.access(b.abspath(path), os.F_OK):
824
class cmd_root(Command):
825
"""Show the tree root directory.
827
The root is the nearest enclosing directory with a .bzr control
829
takes_args = ['filename?']
830
def run(self, filename=None):
831
"""Print the branch root."""
832
from branch import find_branch
833
b = find_branch(filename)
834
print getattr(b, 'base', None) or getattr(b, 'baseurl')
837
class cmd_log(Command):
838
"""Show log of this branch.
840
To request a range of logs, you can use the command -r begin:end
841
-r revision requests a specific revision, -r :end or -r begin: are
844
TODO: Make --revision support uuid: and hash: [future tag:] notation.
848
takes_args = ['filename?']
849
takes_options = ['forward', 'timezone', 'verbose', 'show-ids', 'revision']
851
def run(self, filename=None, timezone='original',
856
from bzrlib import show_log, find_branch
859
direction = (forward and 'forward') or 'reverse'
862
b = find_branch(filename)
863
fp = b.relpath(filename)
865
file_id = b.read_working_inventory().path2id(fp)
867
file_id = None # points to branch root
873
revision = [None, None]
874
elif isinstance(revision, int):
875
revision = [revision, revision]
880
assert len(revision) == 2
882
mutter('encoding log as %r' % bzrlib.user_encoding)
884
# use 'replace' so that we don't abort if trying to write out
885
# in e.g. the default C locale.
886
outf = codecs.getwriter(bzrlib.user_encoding)(sys.stdout, errors='replace')
889
show_timezone=timezone,
894
start_revision=revision[0],
895
end_revision=revision[1])
899
class cmd_touching_revisions(Command):
900
"""Return revision-ids which affected a particular file.
902
A more user-friendly interface is "bzr log FILE"."""
904
takes_args = ["filename"]
905
def run(self, filename):
907
inv = b.read_working_inventory()
908
file_id = inv.path2id(b.relpath(filename))
909
for revno, revision_id, what in bzrlib.log.find_touching_revisions(b, file_id):
910
print "%6d %s" % (revno, what)
913
class cmd_ls(Command):
914
"""List files in a tree.
916
TODO: Take a revision or remote path and list that tree instead.
919
def run(self, revision=None, verbose=False):
922
tree = b.working_tree()
924
tree = b.revision_tree(b.lookup_revision(revision))
926
for fp, fc, kind, fid in tree.list_files():
928
if kind == 'directory':
935
print '%-8s %s%s' % (fc, fp, kindch)
941
class cmd_unknowns(Command):
942
"""List unknown files."""
944
for f in Branch('.').unknowns():
949
class cmd_ignore(Command):
950
"""Ignore a command or pattern.
952
To remove patterns from the ignore list, edit the .bzrignore file.
954
If the pattern contains a slash, it is compared to the whole path
955
from the branch root. Otherwise, it is comapred to only the last
956
component of the path.
958
Ignore patterns are case-insensitive on case-insensitive systems.
960
Note: wildcards must be quoted from the shell on Unix.
963
bzr ignore ./Makefile
966
takes_args = ['name_pattern']
968
def run(self, name_pattern):
969
from bzrlib.atomicfile import AtomicFile
973
ifn = b.abspath('.bzrignore')
975
if os.path.exists(ifn):
978
igns = f.read().decode('utf-8')
984
# TODO: If the file already uses crlf-style termination, maybe
985
# we should use that for the newly added lines?
987
if igns and igns[-1] != '\n':
989
igns += name_pattern + '\n'
992
f = AtomicFile(ifn, 'wt')
993
f.write(igns.encode('utf-8'))
998
inv = b.working_tree().inventory
999
if inv.path2id('.bzrignore'):
1000
mutter('.bzrignore is already versioned')
1002
mutter('need to make new .bzrignore file versioned')
1003
b.add(['.bzrignore'])
1007
class cmd_ignored(Command):
1008
"""List ignored files and the patterns that matched them.
1010
See also: bzr ignore"""
1012
tree = Branch('.').working_tree()
1013
for path, file_class, kind, file_id in tree.list_files():
1014
if file_class != 'I':
1016
## XXX: Slightly inefficient since this was already calculated
1017
pat = tree.is_ignored(path)
1018
print '%-50s %s' % (path, pat)
1021
class cmd_lookup_revision(Command):
1022
"""Lookup the revision-id from a revision-number
1025
bzr lookup-revision 33
1028
takes_args = ['revno']
1030
def run(self, revno):
1034
raise BzrCommandError("not a valid revision-number: %r" % revno)
1036
print Branch('.').lookup_revision(revno)
1039
class cmd_export(Command):
1040
"""Export past revision to destination directory.
1042
If no revision is specified this exports the last committed revision.
1044
Format may be an "exporter" name, such as tar, tgz, tbz2. If none is
1045
given, exports to a directory (equivalent to --format=dir)."""
1046
# TODO: list known exporters
1047
takes_args = ['dest']
1048
takes_options = ['revision', 'format']
1049
def run(self, dest, revision=None, format='dir'):
1051
if revision == None:
1052
rh = b.revision_history()[-1]
1054
rh = b.lookup_revision(int(revision))
1055
t = b.revision_tree(rh)
1056
t.export(dest, format)
1059
class cmd_cat(Command):
1060
"""Write a file's text from a previous revision."""
1062
takes_options = ['revision']
1063
takes_args = ['filename']
1065
def run(self, filename, revision=None):
1066
if revision == None:
1067
raise BzrCommandError("bzr cat requires a revision number")
1069
b.print_file(b.relpath(filename), int(revision))
1072
class cmd_local_time_offset(Command):
1073
"""Show the offset in seconds from GMT to local time."""
1076
print bzrlib.osutils.local_time_offset()
1080
class cmd_commit(Command):
1081
"""Commit changes into a new revision.
1083
If selected files are specified, only changes to those files are
1084
committed. If a directory is specified then its contents are also
1087
A selected-file commit may fail in some cases where the committed
1088
tree would be invalid, such as trying to commit a file in a
1089
newly-added directory that is not itself committed.
1091
TODO: Run hooks on tree to-be-committed, and after commit.
1093
TODO: Strict commit that fails if there are unknown or deleted files.
1095
takes_args = ['selected*']
1096
takes_options = ['message', 'file', 'verbose']
1097
aliases = ['ci', 'checkin']
1099
def run(self, message=None, file=None, verbose=True, selected_list=None):
1100
from bzrlib.commit import commit
1102
## Warning: shadows builtin file()
1103
if not message and not file:
1104
raise BzrCommandError("please specify a commit message",
1105
["use either --message or --file"])
1106
elif message and file:
1107
raise BzrCommandError("please specify either --message or --file")
1111
message = codecs.open(file, 'rt', bzrlib.user_encoding).read()
1114
commit(b, message, verbose=verbose, specific_files=selected_list)
1117
class cmd_check(Command):
1118
"""Validate consistency of branch history.
1120
This command checks various invariants about the branch storage to
1121
detect data corruption or bzr bugs.
1123
If given the --update flag, it will update some optional fields
1124
to help ensure data consistency.
1126
takes_args = ['dir?']
1128
def run(self, dir='.'):
1130
bzrlib.check.check(Branch(dir))
1134
class cmd_upgrade(Command):
1135
"""Upgrade branch storage to current format.
1137
This should normally be used only after the check command tells
1140
takes_args = ['dir?']
1142
def run(self, dir='.'):
1143
from bzrlib.upgrade import upgrade
1144
upgrade(Branch(dir))
1148
class cmd_whoami(Command):
1149
"""Show bzr user id."""
1150
takes_options = ['email']
1152
def run(self, email=False):
1154
print bzrlib.osutils.user_email()
1156
print bzrlib.osutils.username()
1159
class cmd_selftest(Command):
1160
"""Run internal test suite"""
1163
from bzrlib.selftest import selftest
1164
return int(not selftest())
1167
class cmd_version(Command):
1168
"""Show version of bzr."""
1173
print "bzr (bazaar-ng) %s" % bzrlib.__version__
1174
# is bzrlib itself in a branch?
1175
bzrrev = bzrlib.get_bzr_revision()
1177
print " (bzr checkout, revision %d {%s})" % bzrrev
1178
print bzrlib.__copyright__
1179
print "http://bazaar-ng.org/"
1181
print "bzr comes with ABSOLUTELY NO WARRANTY. bzr is free software, and"
1182
print "you may use, modify and redistribute it under the terms of the GNU"
1183
print "General Public License version 2 or later."
1186
class cmd_rocks(Command):
1187
"""Statement of optimism."""
1190
print "it sure does!"
1192
def parse_spec(spec):
1194
>>> parse_spec(None)
1196
>>> parse_spec("./")
1198
>>> parse_spec("../@")
1200
>>> parse_spec("../f/@35")
1206
parsed = spec.split('/@')
1207
assert len(parsed) == 2
1211
parsed[1] = int(parsed[1])
1212
assert parsed[1] >=0
1214
parsed = [spec, None]
1219
class cmd_merge(Command):
1220
"""Perform a three-way merge of trees.
1222
The SPEC parameters are working tree or revision specifiers. Working trees
1223
are specified using standard paths or urls. No component of a directory
1224
path may begin with '@'.
1226
Working tree examples: '.', '..', 'foo@', but NOT 'foo/@bar'
1228
Revisions are specified using a dirname/@revno pair, where dirname is the
1229
branch directory and revno is the revision within that branch. If no revno
1230
is specified, the latest revision is used.
1232
Revision examples: './@127', 'foo/@', '../@1'
1234
The OTHER_SPEC parameter is required. If the BASE_SPEC parameter is
1235
not supplied, the common ancestor of OTHER_SPEC the current branch is used
1238
merge refuses to run if there are any uncommitted changes, unless
1241
takes_args = ['other_spec', 'base_spec?']
1242
takes_options = ['force']
1244
def run(self, other_spec, base_spec=None, force=False):
1245
from bzrlib.merge import merge
1246
merge(parse_spec(other_spec), parse_spec(base_spec),
1247
check_clean=(not force))
1250
class cmd_revert(Command):
1251
"""Reverse all changes since the last commit.
1253
Only versioned files are affected.
1255
TODO: Store backups of any files that will be reverted, so
1256
that the revert can be undone.
1258
takes_options = ['revision']
1260
def run(self, revision=-1):
1261
from bzrlib.merge import merge
1262
merge(('.', revision), parse_spec('.'),
1267
class cmd_assert_fail(Command):
1268
"""Test reporting of assertion failures"""
1271
assert False, "always fails"
1274
class cmd_help(Command):
1275
"""Show help on a command or other topic.
1277
For a list of all available commands, say 'bzr help commands'."""
1278
takes_args = ['topic?']
1281
def run(self, topic=None):
1286
class cmd_update_stat_cache(Command):
1287
"""Update stat-cache mapping inodes to SHA-1 hashes.
1289
For testing only."""
1294
statcache.update_cache(b.base, b.read_working_inventory())
1298
# list of all available options; the rhs can be either None for an
1299
# option that takes no argument, or a constructor function that checks
1303
'diff-options': str,
1312
'revision': _parse_revision_str,
1330
def parse_args(argv):
1331
"""Parse command line.
1333
Arguments and options are parsed at this level before being passed
1334
down to specific command handlers. This routine knows, from a
1335
lookup table, something about the available options, what optargs
1336
they take, and which commands will accept them.
1338
>>> parse_args('--help'.split())
1339
([], {'help': True})
1340
>>> parse_args('--version'.split())
1341
([], {'version': True})
1342
>>> parse_args('status --all'.split())
1343
(['status'], {'all': True})
1344
>>> parse_args('commit --message=biter'.split())
1345
(['commit'], {'message': u'biter'})
1346
>>> parse_args('log -r 500'.split())
1347
(['log'], {'revision': 500})
1348
>>> parse_args('log -r500:600'.split())
1349
(['log'], {'revision': [500, 600]})
1350
>>> parse_args('log -vr500:600'.split())
1351
(['log'], {'verbose': True, 'revision': [500, 600]})
1352
>>> parse_args('log -rv500:600'.split()) #the r takes an argument
1353
Traceback (most recent call last):
1355
ValueError: invalid literal for int(): v500
1360
# TODO: Maybe handle '--' to end options?
1365
# option names must not be unicode
1369
mutter(" got option %r" % a)
1371
optname, optarg = a[2:].split('=', 1)
1374
if optname not in OPTIONS:
1375
raise BzrError('unknown long option %r' % a)
1378
if shortopt in SHORT_OPTIONS:
1379
# Multi-character options must have a space to delimit
1381
optname = SHORT_OPTIONS[shortopt]
1383
# Single character short options, can be chained,
1384
# and have their value appended to their name
1386
if shortopt not in SHORT_OPTIONS:
1387
# We didn't find the multi-character name, and we
1388
# didn't find the single char name
1389
raise BzrError('unknown short option %r' % a)
1390
optname = SHORT_OPTIONS[shortopt]
1393
# There are extra things on this option
1394
# see if it is the value, or if it is another
1396
optargfn = OPTIONS[optname]
1397
if optargfn is None:
1398
# This option does not take an argument, so the
1399
# next entry is another short option, pack it back
1401
argv.insert(0, '-' + a[2:])
1403
# This option takes an argument, so pack it
1408
# XXX: Do we ever want to support this, e.g. for -r?
1409
raise BzrError('repeated option %r' % a)
1411
optargfn = OPTIONS[optname]
1415
raise BzrError('option %r needs an argument' % a)
1417
optarg = argv.pop(0)
1418
opts[optname] = optargfn(optarg)
1421
raise BzrError('option %r takes no argument' % optname)
1422
opts[optname] = True
1431
def _match_argform(cmd, takes_args, args):
1434
# step through args and takes_args, allowing appropriate 0-many matches
1435
for ap in takes_args:
1439
argdict[argname] = args.pop(0)
1440
elif ap[-1] == '*': # all remaining arguments
1442
argdict[argname + '_list'] = args[:]
1445
argdict[argname + '_list'] = None
1448
raise BzrCommandError("command %r needs one or more %s"
1449
% (cmd, argname.upper()))
1451
argdict[argname + '_list'] = args[:]
1453
elif ap[-1] == '$': # all but one
1455
raise BzrCommandError("command %r needs one or more %s"
1456
% (cmd, argname.upper()))
1457
argdict[argname + '_list'] = args[:-1]
1463
raise BzrCommandError("command %r requires argument %s"
1464
% (cmd, argname.upper()))
1466
argdict[argname] = args.pop(0)
1469
raise BzrCommandError("extra argument to command %s: %s"
1477
"""Execute a command.
1479
This is similar to main(), but without all the trappings for
1480
logging and error handling.
1482
argv = [a.decode(bzrlib.user_encoding) for a in argv]
1484
include_plugins=True
1486
args, opts = parse_args(argv[1:])
1494
elif 'version' in opts:
1497
elif args and args[0] == 'builtin':
1498
include_plugins=False
1500
cmd = str(args.pop(0))
1507
canonical_cmd, cmd_class = get_cmd_class(cmd,include_plugins=include_plugins)
1510
if 'profile' in opts:
1516
# check options are reasonable
1517
allowed = cmd_class.takes_options
1519
if oname not in allowed:
1520
raise BzrCommandError("option '--%s' is not allowed for command %r"
1523
# mix arguments and options into one dictionary
1524
cmdargs = _match_argform(cmd, cmd_class.takes_args, args)
1526
for k, v in opts.items():
1527
cmdopts[k.replace('-', '_')] = v
1530
import hotshot, tempfile
1531
pffileno, pfname = tempfile.mkstemp()
1533
prof = hotshot.Profile(pfname)
1534
ret = prof.runcall(cmd_class, cmdopts, cmdargs) or 0
1537
import hotshot.stats
1538
stats = hotshot.stats.load(pfname)
1540
stats.sort_stats('time')
1541
## XXX: Might like to write to stderr or the trace file instead but
1542
## print_stats seems hardcoded to stdout
1543
stats.print_stats(20)
1551
return cmd_class(cmdopts, cmdargs).status
1554
def _report_exception(summary, quiet=False):
1556
log_error('bzr: ' + summary)
1557
bzrlib.trace.log_exception()
1560
tb = sys.exc_info()[2]
1561
exinfo = traceback.extract_tb(tb)
1563
sys.stderr.write(' at %s:%d in %s()\n' % exinfo[-1][:3])
1564
sys.stderr.write(' see ~/.bzr.log for debug information\n')
1571
bzrlib.open_tracefile(argv)
1576
return run_bzr(argv)
1578
# do this here inside the exception wrappers to catch EPIPE
1581
quiet = isinstance(e, (BzrCommandError))
1582
_report_exception('error: ' + e.args[0], quiet=quiet)
1585
# some explanation or hints
1588
except AssertionError, e:
1589
msg = 'assertion failed'
1591
msg += ': ' + str(e)
1592
_report_exception(msg)
1594
except KeyboardInterrupt, e:
1595
_report_exception('interrupted', quiet=True)
1597
except Exception, e:
1599
if (isinstance(e, IOError)
1600
and hasattr(e, 'errno')
1601
and e.errno == errno.EPIPE):
1605
msg = str(e).rstrip('\n')
1606
_report_exception(msg, quiet)
1609
bzrlib.trace.close_trace()
1612
if __name__ == '__main__':
1613
sys.exit(main(sys.argv))
added
removed
bzrlib/commands.py
