14
14
# along with this program; if not, write to the Free Software
15
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17
"""Bazaar-NG -- a free distributed version-control tool
20
**WARNING: THIS IS AN UNSTABLE DEVELOPMENT VERSION**
22
* Metadata format is not stable yet -- you may need to
23
discard history in the future.
25
* Many commands unimplemented or partially implemented.
27
* Space-inefficient storage.
29
* No merge operators yet.
36
Show software version/licence/non-warranty.
38
Start versioning the current directory
42
Show revision history.
45
bzr move FROM... DESTDIR
46
Move one or more files to a different directory.
48
Show changes from last revision to working copy.
49
bzr commit -m 'MESSAGE'
50
Store current state as new revision.
51
bzr export [-r REVNO] DESTINATION
52
Export the branch state at a previous version.
54
Show summary of pending changes.
56
Make a file not versioned.
58
Show statistics about this branch.
60
Verify history is stored safely.
61
(for more type 'bzr help commands')
67
import sys, os, time, types, shutil, tempfile, fnmatch, difflib, os.path
69
from pprint import pprint
74
from bzrlib.store import ImmutableStore
22
75
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, \
76
from bzrlib.errors import bailout, BzrError, BzrCheckError, BzrCommandError
77
from bzrlib.osutils import quotefn, pumpfile, isdir, isfile
78
from bzrlib.tree import RevisionTree, EmptyTree, WorkingTree, Tree
79
from bzrlib.revision import Revision
80
from bzrlib import Branch, Inventory, InventoryEntry, ScratchBranch, BZRDIR, \
32
def register_plugin_command(cmd):
33
"Utility function to help register a command"
36
if k.startswith("cmd_"):
37
k_unsquished = _unsquish_command_name(k)
40
if not plugin_cmds.has_key(k_unsquished):
41
plugin_cmds[k_unsquished] = cmd
43
log_error('Two plugins defined the same command: %r' % k)
44
log_error('Not loading the one in %r' % sys.modules[cmd.__module__])
47
def _squish_command_name(cmd):
48
return 'cmd_' + cmd.replace('-', '_')
51
def _unsquish_command_name(cmd):
52
assert cmd.startswith("cmd_")
53
return cmd[4:].replace('_','-')
55
def _parse_revision_str(revstr):
56
"""This handles a revision string -> revno.
58
There are several possibilities:
61
'234:345' -> [234, 345]
65
In the future we will also support:
66
'uuid:blah-blah-blah' -> ?
67
'hash:blahblahblah' -> ?
71
if revstr.find(':') != -1:
72
revs = revstr.split(':')
74
raise ValueError('More than 2 pieces not supported for --revision: %r' % revstr)
79
revs[0] = int(revs[0])
84
revs[1] = int(revs[1])
91
def _get_cmd_dict(plugins_override=True):
93
for k, v in globals().iteritems():
94
if k.startswith("cmd_"):
95
d[_unsquish_command_name(k)] = v
96
# If we didn't load plugins, the plugin_cmds dict will be empty
100
d2 = plugin_cmds.copy()
106
def get_all_cmds(plugins_override=True):
107
"""Return canonical name and class for all registered commands."""
108
for k, v in _get_cmd_dict(plugins_override=plugins_override).iteritems():
112
def get_cmd_class(cmd, plugins_override=True):
113
"""Return the canonical name and command class for a command.
115
cmd = str(cmd) # not unicode
117
# first look up this command under the specified name
118
cmds = _get_cmd_dict(plugins_override=plugins_override)
83
BZR_DIFF_FORMAT = "## Bazaar-NG diff, format 0 ##\n"
84
BZR_PATCHNAME_FORMAT = 'cset:sha1:%s'
86
## standard representation
87
NONE_STRING = '(none)'
101
def get_cmd_class(cmd):
104
cmd = CMD_ALIASES.get(cmd, cmd)
120
return cmd, cmds[cmd]
107
cmd_class = globals()['cmd_' + cmd.replace('-', '_')]
124
# look for any command which claims this as an alias
125
for cmdname, cmdclass in cmds.iteritems():
126
if cmd in cmdclass.aliases:
127
return cmdname, cmdclass
129
cmdclass = ExternalCommand.find_command(cmd)
133
raise BzrCommandError("unknown command %r" % cmd)
136
class Command(object):
109
raise BzrError("unknown command %r" % cmd)
111
return cmd, cmd_class
137
116
"""Base class for commands.
139
118
The docstring for an actual command should give a single-line
176
155
This is invoked with the options and arguments bound to
177
156
keyword parameters.
179
Return 0 or None if the command was successful, or a shell
158
Return True if the command was successful, False if not.
185
class ExternalCommand(Command):
186
"""Class to wrap external commands.
188
We cheat a little here, when get_cmd_class() calls us we actually give it back
189
an object we construct that has the appropriate path, help, options etc for the
192
When run_bzr() tries to instantiate that 'class' it gets caught by the __call__
193
method, which we override to call the Command.__init__ method. That then calls
194
our run method which is pretty straight forward.
196
The only wrinkle is that we have to map bzr's dictionary of options and arguments
197
back into command line options and arguments for the script.
200
def find_command(cls, cmd):
202
bzrpath = os.environ.get('BZRPATH', '')
204
for dir in bzrpath.split(os.pathsep):
205
path = os.path.join(dir, cmd)
206
if os.path.isfile(path):
207
return ExternalCommand(path)
211
find_command = classmethod(find_command)
213
def __init__(self, path):
216
pipe = os.popen('%s --bzr-usage' % path, 'r')
217
self.takes_options = pipe.readline().split()
219
for opt in self.takes_options:
220
if not opt in OPTIONS:
221
raise BzrError("Unknown option '%s' returned by external command %s"
224
# TODO: Is there any way to check takes_args is valid here?
225
self.takes_args = pipe.readline().split()
227
if pipe.close() is not None:
228
raise BzrError("Failed funning '%s --bzr-usage'" % path)
230
pipe = os.popen('%s --bzr-help' % path, 'r')
231
self.__doc__ = pipe.read()
232
if pipe.close() is not None:
233
raise BzrError("Failed funning '%s --bzr-help'" % path)
235
def __call__(self, options, arguments):
236
Command.__init__(self, options, arguments)
239
def run(self, **kargs):
246
optname = name.replace('_','-')
248
if OPTIONS.has_key(optname):
250
opts.append('--%s' % optname)
251
if value is not None and value is not True:
252
opts.append(str(value))
254
# it's an arg, or arg list
255
if type(value) is not list:
261
self.status = os.spawnv(os.P_WAIT, self.path, [self.path] + opts + args)
265
164
class cmd_status(Command):
266
165
"""Display status summary.
268
This reports on versioned and unknown files, reporting them
269
grouped by state. Possible states are:
272
Versioned in the working copy but not in the previous revision.
275
Versioned in the previous revision but removed or deleted
279
Path of this file changed from the previous revision;
280
the text may also have changed. This includes files whose
281
parent directory was renamed.
284
Text has changed since the previous revision.
287
Nothing about this file has changed since the previous revision.
288
Only shown with --all.
291
Not versioned and not matching an ignore pattern.
293
To see ignored files use 'bzr ignored'. For details in the
294
changes to file texts, use 'bzr diff'.
296
If no arguments are specified, the status of the entire working
297
directory is shown. Otherwise, only the status of the specified
298
files or directories is reported. If a directory is given, status
299
is reported for everything inside that directory.
167
For each file there is a single line giving its file state and name.
168
The name is that in the current revision unless it is deleted or
169
missing, in which case the old name is shown.
301
takes_args = ['file*']
302
takes_options = ['all', 'show-ids']
303
aliases = ['st', 'stat']
171
takes_options = ['all']
305
def run(self, all=False, show_ids=False, file_list=None):
307
b = Branch(file_list[0])
308
file_list = [b.relpath(x) for x in file_list]
309
# special case: only one path was given and it's the root
311
if file_list == ['']:
316
status.show_status(b, show_unchanged=all, show_ids=show_ids,
317
specific_files=file_list)
173
def run(self, all=False):
174
#import bzrlib.status
175
#bzrlib.status.tree_status(Branch('.'))
176
Branch('.').show_status(show_all=all)
320
179
class cmd_cat_revision(Command):
357
216
recursively add that parent, rather than giving an error?
359
218
takes_args = ['file+']
360
takes_options = ['verbose', 'no-recurse']
219
takes_options = ['verbose']
362
def run(self, file_list, verbose=False, no_recurse=False):
363
bzrlib.add.smart_add(file_list, verbose, not no_recurse)
366
class cmd_relpath(Command):
221
def run(self, file_list, verbose=False):
222
bzrlib.add.smart_add(file_list, verbose)
225
def Relpath(Command):
367
226
"""Show path of a file relative to root"""
368
takes_args = ['filename']
227
takes_args = ('filename')
371
def run(self, filename):
372
print Branch(filename).relpath(filename)
230
print Branch(self.args['filename']).relpath(filename)
376
234
class cmd_inventory(Command):
377
235
"""Show inventory of the current working copy or a revision."""
378
takes_options = ['revision', 'show-ids']
236
takes_options = ['revision']
380
def run(self, revision=None, show_ids=False):
238
def run(self, revision=None):
382
240
if revision == None:
383
241
inv = b.read_working_inventory()
385
243
inv = b.get_revision_inventory(b.lookup_revision(revision))
387
for path, entry in inv.entries():
389
print '%-50s %s' % (path, entry.file_id)
245
for path, entry in inv.iter_entries():
246
print '%-50s %s' % (entry.file_id, path)
394
249
class cmd_move(Command):
433
class cmd_pull(Command):
434
"""Pull any changes from another branch into the current one.
436
If the location is omitted, the last-used location will be used.
437
Both the revision history and the working directory will be
440
This command only works on branches that have not diverged. Branches are
441
considered diverged if both branches have had commits without first
442
pulling from the other.
444
If branches have diverged, you can use 'bzr merge' to pull the text changes
445
from one into the other.
447
takes_args = ['location?']
449
def run(self, location=None):
450
from bzrlib.merge import merge
456
stored_loc = br_to.controlfile("x-pull", "rb").read().rstrip('\n')
458
if errno == errno.ENOENT:
461
if stored_loc is None:
462
raise BzrCommandError("No pull location known or specified.")
464
print "Using last location: %s" % stored_loc
465
location = stored_loc
466
from branch import find_branch, DivergedBranches
467
br_from = find_branch(location)
468
location = pull_loc(br_from)
469
old_revno = br_to.revno()
471
br_to.update_revisions(br_from)
472
except DivergedBranches:
473
raise BzrCommandError("These branches have diverged. Try merge.")
475
merge(('.', -1), ('.', old_revno), check_clean=False)
476
if location != stored_loc:
477
br_to.controlfile("x-pull", "wb").write(location + "\n")
481
class cmd_branch(Command):
482
"""Create a new copy of a branch.
484
If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
485
be used. In other words, "branch ../foo/bar" will attempt to create ./bar.
487
To retrieve the branch as of a particular revision, supply the --revision
488
parameter, as in "branch foo/bar -r 5".
490
takes_args = ['from_location', 'to_location?']
491
takes_options = ['revision']
493
def run(self, from_location, to_location=None, revision=None):
495
from bzrlib.merge import merge
496
from branch import find_branch, DivergedBranches, NoSuchRevision
497
from shutil import rmtree
499
br_from = find_branch(from_location)
501
if e.errno == errno.ENOENT:
502
raise BzrCommandError('Source location "%s" does not exist.' %
507
if to_location is None:
508
to_location = os.path.basename(from_location.rstrip("/\\"))
511
os.mkdir(to_location)
513
if e.errno == errno.EEXIST:
514
raise BzrCommandError('Target directory "%s" already exists.' %
516
if e.errno == errno.ENOENT:
517
raise BzrCommandError('Parent of "%s" does not exist.' %
521
br_to = Branch(to_location, init=True)
524
br_to.update_revisions(br_from, stop_revision=revision)
525
except NoSuchRevision:
527
msg = "The branch %s has no revision %d." % (from_location,
529
raise BzrCommandError(msg)
530
merge((to_location, -1), (to_location, 0), this_dir=to_location,
531
check_clean=False, ignore_zero=True)
532
from_location = pull_loc(br_from)
533
br_to.controlfile("x-pull", "wb").write(from_location + "\n")
536
def pull_loc(branch):
537
# TODO: Should perhaps just make attribute be 'base' in
538
# RemoteBranch and Branch?
539
if hasattr(branch, "baseurl"):
540
return branch.baseurl
546
286
class cmd_renames(Command):
547
287
"""Show list of renamed files.
686
420
takes_args = ['file*']
687
takes_options = ['revision', 'diff-options']
688
aliases = ['di', 'dif']
421
takes_options = ['revision']
690
def run(self, revision=None, file_list=None, diff_options=None):
423
def run(self, revision=None, file_list=None):
691
424
from bzrlib.diff import show_diff
692
from bzrlib import find_branch
695
b = find_branch(file_list[0])
696
file_list = [b.relpath(f) for f in file_list]
697
if file_list == ['']:
698
# just pointing to top-of-tree
703
show_diff(b, revision, specific_files=file_list,
704
external_diff_options=diff_options)
426
show_diff(Branch('.'), revision, file_list)
710
429
class cmd_deleted(Command):
733
class cmd_modified(Command):
734
"""List files modified in working tree."""
739
inv = b.read_working_inventory()
740
sc = statcache.update_cache(b, inv)
741
basis = b.basis_tree()
742
basis_inv = basis.inventory
744
# We used to do this through iter_entries(), but that's slow
745
# when most of the files are unmodified, as is usually the
746
# case. So instead we iterate by inventory entry, and only
747
# calculate paths as necessary.
749
for file_id in basis_inv:
750
cacheentry = sc.get(file_id)
751
if not cacheentry: # deleted
753
ie = basis_inv[file_id]
754
if cacheentry[statcache.SC_SHA1] != ie.text_sha1:
755
path = inv.id2path(file_id)
760
class cmd_added(Command):
761
"""List files added in working tree."""
765
wt = b.working_tree()
766
basis_inv = b.basis_tree().inventory
769
if file_id in basis_inv:
771
path = inv.id2path(file_id)
772
if not os.access(b.abspath(path), os.F_OK):
778
451
class cmd_root(Command):
779
452
"""Show the tree root directory.
783
456
takes_args = ['filename?']
784
457
def run(self, filename=None):
785
458
"""Print the branch root."""
786
from branch import find_branch
787
b = find_branch(filename)
788
print getattr(b, 'base', None) or getattr(b, 'baseurl')
459
print bzrlib.branch.find_branch_root(filename)
791
463
class cmd_log(Command):
792
464
"""Show log of this branch.
794
To request a range of logs, you can use the command -r begin:end
795
-r revision requests a specific revision, -r :end or -r begin: are
798
TODO: Make --revision support uuid: and hash: [future tag:] notation.
466
TODO: Options to show ids; to limit range; etc.
802
takes_args = ['filename?']
803
takes_options = ['forward', 'timezone', 'verbose', 'show-ids', 'revision']
805
def run(self, filename=None, timezone='original',
810
from bzrlib import show_log, find_branch
813
direction = (forward and 'forward') or 'reverse'
816
b = find_branch(filename)
817
fp = b.relpath(filename)
819
file_id = b.read_working_inventory().path2id(fp)
821
file_id = None # points to branch root
827
revision = [None, None]
828
elif isinstance(revision, int):
829
revision = [revision, revision]
834
assert len(revision) == 2
836
mutter('encoding log as %r' % bzrlib.user_encoding)
838
# use 'replace' so that we don't abort if trying to write out
839
# in e.g. the default C locale.
840
outf = codecs.getwriter(bzrlib.user_encoding)(sys.stdout, errors='replace')
843
show_timezone=timezone,
848
start_revision=revision[0],
849
end_revision=revision[1])
853
class cmd_touching_revisions(Command):
854
"""Return revision-ids which affected a particular file.
856
A more user-friendly interface is "bzr log FILE"."""
858
takes_args = ["filename"]
859
def run(self, filename):
861
inv = b.read_working_inventory()
862
file_id = inv.path2id(b.relpath(filename))
863
for revno, revision_id, what in bzrlib.log.find_touching_revisions(b, file_id):
864
print "%6d %s" % (revno, what)
468
takes_options = ['timezone', 'verbose']
469
def run(self, timezone='original', verbose=False):
470
Branch('.').write_log(show_timezone=timezone, verbose=verbose)
867
473
class cmd_ls(Command):
903
509
class cmd_ignore(Command):
904
"""Ignore a command or pattern.
906
To remove patterns from the ignore list, edit the .bzrignore file.
908
If the pattern contains a slash, it is compared to the whole path
909
from the branch root. Otherwise, it is comapred to only the last
910
component of the path.
912
Ignore patterns are case-insensitive on case-insensitive systems.
914
Note: wildcards must be quoted from the shell on Unix.
917
bzr ignore ./Makefile
510
"""Ignore a command or pattern"""
920
511
takes_args = ['name_pattern']
922
513
def run(self, name_pattern):
923
from bzrlib.atomicfile import AtomicFile
927
ifn = b.abspath('.bzrignore')
929
if os.path.exists(ifn):
932
igns = f.read().decode('utf-8')
938
# TODO: If the file already uses crlf-style termination, maybe
939
# we should use that for the newly added lines?
941
if igns and igns[-1] != '\n':
943
igns += name_pattern + '\n'
946
f = AtomicFile(ifn, 'wt')
947
f.write(igns.encode('utf-8'))
516
# XXX: This will fail if it's a hardlink; should use an AtomicFile class.
517
f = open(b.abspath('.bzrignore'), 'at')
518
f.write(name_pattern + '\n')
952
521
inv = b.working_tree().inventory
953
522
if inv.path2id('.bzrignore'):
979
546
bzr lookup-revision 33
982
takes_args = ['revno']
984
549
def run(self, revno):
986
551
revno = int(revno)
987
552
except ValueError:
988
raise BzrCommandError("not a valid revision-number: %r" % revno)
990
print Branch('.').lookup_revision(revno)
553
raise BzrError("not a valid revision-number: %r" % revno)
555
print Branch('.').lookup_revision(revno) or NONE_STRING
993
559
class cmd_export(Command):
994
560
"""Export past revision to destination directory.
996
If no revision is specified this exports the last committed revision.
998
Format may be an "exporter" name, such as tar, tgz, tbz2. If none is
999
given, exports to a directory (equivalent to --format=dir)."""
1000
# TODO: list known exporters
562
If no revision is specified this exports the last committed revision."""
1001
563
takes_args = ['dest']
1002
takes_options = ['revision', 'format']
1003
def run(self, dest, revision=None, format='dir'):
564
takes_options = ['revision']
565
def run(self, dest, revno=None):
1005
if revision == None:
1006
rh = b.revision_history()[-1]
568
rh = b.revision_history[-1]
1008
rh = b.lookup_revision(int(revision))
570
rh = b.lookup_revision(int(revno))
1009
571
t = b.revision_tree(rh)
1010
t.export(dest, format)
1013
575
class cmd_cat(Command):
1034
596
class cmd_commit(Command):
1035
597
"""Commit changes into a new revision.
1037
If selected files are specified, only changes to those files are
1038
committed. If a directory is specified then its contents are also
1041
A selected-file commit may fail in some cases where the committed
1042
tree would be invalid, such as trying to commit a file in a
1043
newly-added directory that is not itself committed.
599
TODO: Commit only selected files.
1045
601
TODO: Run hooks on tree to-be-committed, and after commit.
1047
603
TODO: Strict commit that fails if there are unknown or deleted files.
1049
takes_args = ['selected*']
1050
takes_options = ['message', 'file', 'verbose']
1051
aliases = ['ci', 'checkin']
1053
def run(self, message=None, file=None, verbose=True, selected_list=None):
1054
from bzrlib.commit import commit
1056
## Warning: shadows builtin file()
1057
if not message and not file:
1058
raise BzrCommandError("please specify a commit message",
1059
["use either --message or --file"])
1060
elif message and file:
1061
raise BzrCommandError("please specify either --message or --file")
1065
message = codecs.open(file, 'rt', bzrlib.user_encoding).read()
1068
commit(b, message, verbose=verbose, specific_files=selected_list)
605
takes_options = ['message', 'verbose']
607
def run(self, message=None, verbose=False):
609
raise BzrCommandError("please specify a commit message")
610
Branch('.').commit(message, verbose=verbose)
1071
613
class cmd_check(Command):
1114
638
"""Run internal test suite"""
1117
from bzrlib.selftest import selftest
1118
return int(not selftest())
641
failures, tests = 0, 0
643
import doctest, bzrlib.store, bzrlib.tests
644
bzrlib.trace.verbose = False
646
for m in bzrlib.store, bzrlib.inventory, bzrlib.branch, bzrlib.osutils, \
647
bzrlib.tree, bzrlib.tests, bzrlib.commands, bzrlib.add:
648
mf, mt = doctest.testmod(m)
651
print '%-40s %3d tests' % (m.__name__, mt),
653
print '%3d FAILED!' % mf
657
print '%-40s %3d tests' % ('total', tests),
659
print '%3d FAILED!' % failures
1121
665
class cmd_version(Command):
1122
"""Show version of bzr."""
666
"""Show version of bzr"""
1126
670
def show_version():
1127
671
print "bzr (bazaar-ng) %s" % bzrlib.__version__
1128
# is bzrlib itself in a branch?
1129
bzrrev = bzrlib.get_bzr_revision()
1131
print " (bzr checkout, revision %d {%s})" % bzrrev
1132
672
print bzrlib.__copyright__
1133
673
print "http://bazaar-ng.org/"
1144
684
print "it sure does!"
1146
def parse_spec(spec):
1148
>>> parse_spec(None)
1150
>>> parse_spec("./")
1152
>>> parse_spec("../@")
1154
>>> parse_spec("../f/@35")
1160
parsed = spec.split('/@')
1161
assert len(parsed) == 2
1165
parsed[1] = int(parsed[1])
1166
assert parsed[1] >=0
1168
parsed = [spec, None]
1173
class cmd_merge(Command):
1174
"""Perform a three-way merge of trees.
1176
The SPEC parameters are working tree or revision specifiers. Working trees
1177
are specified using standard paths or urls. No component of a directory
1178
path may begin with '@'.
1180
Working tree examples: '.', '..', 'foo@', but NOT 'foo/@bar'
1182
Revisions are specified using a dirname/@revno pair, where dirname is the
1183
branch directory and revno is the revision within that branch. If no revno
1184
is specified, the latest revision is used.
1186
Revision examples: './@127', 'foo/@', '../@1'
1188
The OTHER_SPEC parameter is required. If the BASE_SPEC parameter is
1189
not supplied, the common ancestor of OTHER_SPEC the current branch is used
1192
merge refuses to run if there are any uncommitted changes, unless
1195
takes_args = ['other_spec', 'base_spec?']
1196
takes_options = ['force']
1198
def run(self, other_spec, base_spec=None, force=False):
1199
from bzrlib.merge import merge
1200
merge(parse_spec(other_spec), parse_spec(base_spec),
1201
check_clean=(not force))
1204
class cmd_revert(Command):
1205
"""Reverse all changes since the last commit.
1207
Only versioned files are affected.
1209
TODO: Store backups of any files that will be reverted, so
1210
that the revert can be undone.
1212
takes_options = ['revision']
1214
def run(self, revision=-1):
1215
from bzrlib.merge import merge
1216
merge(('.', revision), parse_spec('.'),
1221
687
class cmd_assert_fail(Command):
1222
688
"""Test reporting of assertion failures"""
1231
697
For a list of all available commands, say 'bzr help commands'."""
1232
698
takes_args = ['topic?']
1235
700
def run(self, topic=None):
1240
class cmd_update_stat_cache(Command):
1241
"""Update stat-cache mapping inodes to SHA-1 hashes.
1243
For testing only."""
1248
statcache.update_cache(b.base, b.read_working_inventory())
704
def help(topic=None):
707
elif topic == 'commands':
710
help_on_command(topic)
713
def help_on_command(cmdname):
714
cmdname = str(cmdname)
716
from inspect import getdoc
717
topic, cmdclass = get_cmd_class(cmdname)
719
doc = getdoc(cmdclass)
721
raise NotImplementedError("sorry, no detailed help yet for %r" % cmdname)
724
short, rest = doc.split('\n', 1)
729
print 'usage: bzr ' + topic,
730
for aname in cmdclass.takes_args:
731
aname = aname.upper()
732
if aname[-1] in ['$', '+']:
733
aname = aname[:-1] + '...'
734
elif aname[-1] == '?':
735
aname = '[' + aname[:-1] + ']'
736
elif aname[-1] == '*':
737
aname = '[' + aname[:-1] + '...]'
744
if cmdclass.takes_options:
747
for on in cmdclass.takes_options:
752
"""List all commands"""
756
for k, v in globals().items():
757
if k.startswith('cmd_'):
758
accu.append((k[4:].replace('_','-'), v))
760
for cmdname, cmdclass in accu:
764
help = inspect.getdoc(cmdclass)
766
print " " + help.split('\n', 1)[0]
769
######################################################################
1252
773
# list of all available options; the rhs can be either None for an
1328
830
if optname not in OPTIONS:
1329
raise BzrError('unknown long option %r' % a)
831
bailout('unknown long option %r' % a)
1331
833
shortopt = a[1:]
1332
if shortopt in SHORT_OPTIONS:
1333
# Multi-character options must have a space to delimit
1335
optname = SHORT_OPTIONS[shortopt]
1337
# Single character short options, can be chained,
1338
# and have their value appended to their name
1340
if shortopt not in SHORT_OPTIONS:
1341
# We didn't find the multi-character name, and we
1342
# didn't find the single char name
1343
raise BzrError('unknown short option %r' % a)
1344
optname = SHORT_OPTIONS[shortopt]
1347
# There are extra things on this option
1348
# see if it is the value, or if it is another
1350
optargfn = OPTIONS[optname]
1351
if optargfn is None:
1352
# This option does not take an argument, so the
1353
# next entry is another short option, pack it back
1355
argv.insert(0, '-' + a[2:])
1357
# This option takes an argument, so pack it
834
if shortopt not in SHORT_OPTIONS:
835
bailout('unknown short option %r' % a)
836
optname = SHORT_OPTIONS[shortopt]
1361
838
if optname in opts:
1362
839
# XXX: Do we ever want to support this, e.g. for -r?
1363
raise BzrError('repeated option %r' % a)
840
bailout('repeated option %r' % a)
1365
842
optargfn = OPTIONS[optname]
1367
844
if optarg == None:
1369
raise BzrError('option %r needs an argument' % a)
846
bailout('option %r needs an argument' % a)
1371
848
optarg = argv.pop(0)
1372
849
opts[optname] = optargfn(optarg)
1374
851
if optarg != None:
1375
raise BzrError('option %r takes no argument' % optname)
852
bailout('option %r takes no argument' % optname)
1376
853
opts[optname] = True
1429
def _parse_master_args(argv):
1430
"""Parse the arguments that always go with the original command.
1431
These are things like bzr --no-plugins, etc.
1433
There are now 2 types of option flags. Ones that come *before* the command,
1434
and ones that come *after* the command.
1435
Ones coming *before* the command are applied against all possible commands.
1436
And are generally applied before plugins are loaded.
1438
The current list are:
1439
--builtin Allow plugins to load, but don't let them override builtin commands,
1440
they will still be allowed if they do not override a builtin.
1441
--no-plugins Don't load any plugins. This lets you get back to official source
1443
--profile Enable the hotspot profile before running the command.
1444
For backwards compatibility, this is also a non-master option.
1445
--version Spit out the version of bzr that is running and exit.
1446
This is also a non-master option.
1447
--help Run help and exit, also a non-master option (I think that should stay, though)
1449
>>> argv, opts = _parse_master_args(['bzr', '--test'])
1450
Traceback (most recent call last):
1452
BzrCommandError: Invalid master option: 'test'
1453
>>> argv, opts = _parse_master_args(['bzr', '--version', 'command'])
1456
>>> print opts['version']
1458
>>> argv, opts = _parse_master_args(['bzr', '--profile', 'command', '--more-options'])
1460
['command', '--more-options']
1461
>>> print opts['profile']
1463
>>> argv, opts = _parse_master_args(['bzr', '--no-plugins', 'command'])
1466
>>> print opts['no-plugins']
1468
>>> print opts['profile']
1470
>>> argv, opts = _parse_master_args(['bzr', 'command', '--profile'])
1472
['command', '--profile']
1473
>>> print opts['profile']
1476
master_opts = {'builtin':False,
1483
# This is the point where we could hook into argv[0] to determine
1484
# what front-end is supposed to be run
1485
# For now, we are just ignoring it.
1486
cmd_name = argv.pop(0)
1488
if arg[:2] != '--': # at the first non-option, we return the rest
1490
arg = arg[2:] # Remove '--'
1491
if arg not in master_opts:
1492
# We could say that this is not an error, that we should
1493
# just let it be handled by the main section instead
1494
raise BzrCommandError('Invalid master option: %r' % arg)
1495
argv.pop(0) # We are consuming this entry
1496
master_opts[arg] = True
1497
return argv, master_opts
1501
907
def run_bzr(argv):
1502
908
"""Execute a command.
1504
910
This is similar to main(), but without all the trappings for
1505
911
logging and error handling.
1507
914
argv = [a.decode(bzrlib.user_encoding) for a in argv]
1510
# some options like --builtin and --no-plugins have special effects
1511
argv, master_opts = _parse_master_args(argv)
1512
if 'no-plugins' not in master_opts:
1513
bzrlib.load_plugins()
1515
args, opts = parse_args(argv)
1517
if master_opts['help']:
1518
from bzrlib.help import help
917
args, opts = parse_args(argv[1:])
1525
918
if 'help' in opts:
1526
from bzrlib.help import help
1532
924
elif 'version' in opts:
1535
elif args and args[0] == 'builtin':
1536
include_plugins=False
1538
927
cmd = str(args.pop(0))
1539
928
except IndexError:
929
log_error('usage: bzr COMMAND')
930
log_error(' try "bzr help"')
1545
plugins_override = not (master_opts['builtin'])
1546
canonical_cmd, cmd_class = get_cmd_class(cmd, plugins_override=plugins_override)
1548
profile = master_opts['profile']
1549
# For backwards compatibility, I would rather stick with --profile being a
1550
# master/global option
933
canonical_cmd, cmd_class = get_cmd_class(cmd)
1551
936
if 'profile' in opts:
1553
938
del opts['profile']
1555
942
# check options are reasonable
1556
943
allowed = cmd_class.takes_options
1557
944
for oname in opts:
1558
945
if oname not in allowed:
1559
raise BzrCommandError("option '--%s' is not allowed for command %r"
946
raise BzrCommandError("option %r is not allowed for command %r"
1562
949
# mix arguments and options into one dictionary