36
128
def _unsquish_command_name(cmd):
37
assert cmd.startswith("cmd_")
38
129
return cmd[4:].replace('_','-')
132
def _builtin_commands():
133
import bzrlib.builtins
135
builtins = bzrlib.builtins.__dict__
136
for name in builtins:
137
if name.startswith("cmd_"):
138
real_name = _unsquish_command_name(name)
139
r[real_name] = builtins[name]
143
def builtin_command_names():
144
"""Return list of builtin command names."""
145
return _builtin_commands().keys()
148
def plugin_command_names():
149
return plugin_cmds.keys()
152
def _get_cmd_dict(plugins_override=True):
153
"""Return name->class mapping for all commands."""
154
d = _builtin_commands()
156
d.update(plugin_cmds.iteritems())
160
def get_all_cmds(plugins_override=True):
41
161
"""Return canonical name and class for all registered commands."""
42
for k, v in globals().iteritems():
43
if k.startswith("cmd_"):
44
yield _unsquish_command_name(k), v
46
def get_cmd_class(cmd):
162
for k, v in _get_cmd_dict(plugins_override=plugins_override).iteritems():
166
def get_cmd_object(cmd_name, plugins_override=True):
47
167
"""Return the canonical name and command class for a command.
170
If true, plugin commands can override builtins.
49
cmd = str(cmd) # not unicode
173
return _get_cmd_object(cmd_name, plugins_override)
175
raise errors.BzrCommandError('unknown command "%s"' % cmd_name)
178
def _get_cmd_object(cmd_name, plugins_override=True):
179
"""Worker for get_cmd_object which raises KeyError rather than BzrCommandError."""
180
from bzrlib.externalcommand import ExternalCommand
182
# We want only 'ascii' command names, but the user may have typed
183
# in a Unicode name. In that case, they should just get a
184
# 'command not found' error later.
185
# In the future, we may actually support Unicode command names.
51
187
# first look up this command under the specified name
190
return plugin_cmds.get(cmd_name)()
193
cmds = _get_cmd_dict(plugins_override=False)
53
return cmd, globals()[_squish_command_name(cmd)]
195
return cmds[cmd_name]()
199
for key in plugin_cmds.keys():
200
info = plugin_cmds.get_info(key)
201
if cmd_name in info.aliases:
202
return plugin_cmds.get(key)()
57
203
# look for any command which claims this as an alias
58
for cmdname, cmdclass in get_all_cmds():
59
if cmd in cmdclass.aliases:
60
return cmdname, cmdclass
62
raise BzrCommandError("unknown command %r" % cmd)
204
for real_cmd_name, cmd_class in cmds.iteritems():
205
if cmd_name in cmd_class.aliases:
208
cmd_obj = ExternalCommand.find_command(cmd_name)
212
# look for plugins that provide this command but aren't installed
213
for provider in command_providers_registry:
215
plugin_metadata = provider.plugin_for_command(cmd_name)
216
except errors.NoPluginAvailable:
219
raise errors.CommandAvailableInPlugin(cmd_name,
220
plugin_metadata, provider)
225
class Command(object):
66
226
"""Base class for commands.
228
Commands are the heart of the command-line bzr interface.
230
The command object mostly handles the mapping of command-line
231
parameters into one or more bzrlib operations, and of the results
234
Commands normally don't have any state. All their arguments are
235
passed in to the run method. (Subclasses may take a different
236
policy if the behaviour of the instance needs to depend on e.g. a
237
shell plugin and not just its Python class.)
68
239
The docstring for an actual command should give a single-line
69
240
summary, then a complete description of the command. A grammar
70
241
description will be inserted.
244
Other accepted names for this command.
73
247
List of argument forms, marked with whether they are optional,
252
['to_location', 'from_branch?', 'file*']
254
'to_location' is required
255
'from_branch' is optional
256
'file' can be specified 0 or more times
77
List of options that may be given for this command.
259
List of options that may be given for this command. These can
260
be either strings, referring to globally-defined options,
261
or option objects. Retrieve through options().
80
If true, this command isn't advertised.
264
If true, this command isn't advertised. This is typically
265
for commands intended for expert users.
268
Command objects will get a 'outf' attribute, which has been
269
setup to properly handle encoding of unicode strings.
270
encoding_type determines what will happen when characters cannot
272
strict - abort if we cannot decode
273
replace - put in a bogus character (typically '?')
274
exact - do not encode sys.stdout
276
NOTE: by default on Windows, sys.stdout is opened as a text
277
stream, therefore LF line-endings are converted to CRLF.
278
When a command uses encoding_type = 'exact', then
279
sys.stdout is forced to be a binary stream, and line-endings
85
285
takes_options = []
286
encoding_type = 'strict'
89
def __init__(self, options, arguments):
90
"""Construct and run the command.
92
Sets self.status to the return value of run()."""
93
assert isinstance(options, dict)
94
assert isinstance(arguments, dict)
95
cmdargs = options.copy()
96
cmdargs.update(arguments)
97
assert self.__doc__ != Command.__doc__, \
98
("No help message set for %r" % self)
99
self.status = self.run(**cmdargs)
291
"""Construct an instance of this command."""
292
if self.__doc__ == Command.__doc__:
293
warn("No help message set for %r" % self)
294
# List of standard options directly supported
295
self.supported_std_options = []
297
def _maybe_expand_globs(self, file_list):
298
"""Glob expand file_list if the platform does not do that itself.
300
:return: A possibly empty list of unicode paths.
302
Introduced in bzrlib 0.18.
306
if sys.platform == 'win32':
307
file_list = win32utils.glob_expand(file_list)
308
return list(file_list)
311
"""Return single-line grammar for this command.
313
Only describes arguments, not options.
315
s = 'bzr ' + self.name() + ' '
316
for aname in self.takes_args:
317
aname = aname.upper()
318
if aname[-1] in ['$', '+']:
319
aname = aname[:-1] + '...'
320
elif aname[-1] == '?':
321
aname = '[' + aname[:-1] + ']'
322
elif aname[-1] == '*':
323
aname = '[' + aname[:-1] + '...]'
325
s = s[:-1] # remove last space
328
def get_help_text(self, additional_see_also=None, plain=True,
329
see_also_as_links=False):
330
"""Return a text string with help for this command.
332
:param additional_see_also: Additional help topics to be
334
:param plain: if False, raw help (reStructuredText) is
335
returned instead of plain text.
336
:param see_also_as_links: if True, convert items in 'See also'
337
list to internal links (used by bzr_man rstx generator)
341
raise NotImplementedError("sorry, no detailed help yet for %r" % self.name())
343
# Extract the summary (purpose) and sections out from the text
344
purpose,sections = self._get_help_parts(doc)
346
# If a custom usage section was provided, use it
347
if sections.has_key('Usage'):
348
usage = sections.pop('Usage')
350
usage = self._usage()
352
# The header is the purpose and usage
354
result += ':Purpose: %s\n' % purpose
355
if usage.find('\n') >= 0:
356
result += ':Usage:\n%s\n' % usage
358
result += ':Usage: %s\n' % usage
362
options = option.get_optparser(self.options()).format_option_help()
363
if options.startswith('Options:'):
364
result += ':' + options
365
elif options.startswith('options:'):
366
# Python 2.4 version of optparse
367
result += ':Options:' + options[len('options:'):]
372
# Add the description, indenting it 2 spaces
373
# to match the indentation of the options
374
if sections.has_key(None):
375
text = sections.pop(None)
376
text = '\n '.join(text.splitlines())
377
result += ':%s:\n %s\n\n' % ('Description',text)
379
# Add the custom sections (e.g. Examples). Note that there's no need
380
# to indent these as they must be indented already in the source.
382
labels = sorted(sections.keys())
384
result += ':%s:\n%s\n\n' % (label,sections[label])
386
# Add the aliases, source (plug-in) and see also links, if any
388
result += ':Aliases: '
389
result += ', '.join(self.aliases) + '\n'
390
plugin_name = self.plugin_name()
391
if plugin_name is not None:
392
result += ':From: plugin "%s"\n' % plugin_name
393
see_also = self.get_see_also(additional_see_also)
395
if not plain and see_also_as_links:
397
for item in see_also:
399
# topics doesn't have an independent section
400
# so don't create a real link
401
see_also_links.append(item)
403
# Use a reST link for this entry
404
see_also_links.append("`%s`_" % (item,))
405
see_also = see_also_links
406
result += ':See also: '
407
result += ', '.join(see_also) + '\n'
409
# If this will be rendered as plain text, convert it
411
import bzrlib.help_topics
412
result = bzrlib.help_topics.help_as_plain_text(result)
416
def _get_help_parts(text):
417
"""Split help text into a summary and named sections.
419
:return: (summary,sections) where summary is the top line and
420
sections is a dictionary of the rest indexed by section name.
421
A section starts with a heading line of the form ":xxx:".
422
Indented text on following lines is the section value.
423
All text found outside a named section is assigned to the
424
default section which is given the key of None.
426
def save_section(sections, label, section):
428
if sections.has_key(label):
429
sections[label] += '\n' + section
431
sections[label] = section
433
lines = text.rstrip().splitlines()
434
summary = lines.pop(0)
436
label,section = None,''
438
if line.startswith(':') and line.endswith(':') and len(line) > 2:
439
save_section(sections, label, section)
440
label,section = line[1:-1],''
441
elif (label is not None) and len(line) > 1 and not line[0].isspace():
442
save_section(sections, label, section)
443
label,section = None,line
446
section += '\n' + line
449
save_section(sections, label, section)
450
return summary, sections
452
def get_help_topic(self):
453
"""Return the commands help topic - its name."""
456
def get_see_also(self, additional_terms=None):
457
"""Return a list of help topics that are related to this command.
459
The list is derived from the content of the _see_also attribute. Any
460
duplicates are removed and the result is in lexical order.
461
:param additional_terms: Additional help topics to cross-reference.
462
:return: A list of help topics.
464
see_also = set(getattr(self, '_see_also', []))
466
see_also.update(additional_terms)
467
return sorted(see_also)
470
"""Return dict of valid options for this command.
472
Maps from long option name to option object."""
473
r = Option.STD_OPTIONS.copy()
475
for o in self.takes_options:
476
if isinstance(o, basestring):
477
o = option.Option.OPTIONS[o]
479
if o.name in std_names:
480
self.supported_std_options.append(o.name)
483
def _setup_outf(self):
484
"""Return a file linked to stdout, which has proper encoding."""
485
# Originally I was using self.stdout, but that looks
486
# *way* too much like sys.stdout
487
if self.encoding_type == 'exact':
488
# force sys.stdout to be binary stream on win32
489
if sys.platform == 'win32':
490
fileno = getattr(sys.stdout, 'fileno', None)
493
msvcrt.setmode(fileno(), os.O_BINARY)
494
self.outf = sys.stdout
497
output_encoding = osutils.get_terminal_encoding()
499
self.outf = codecs.getwriter(output_encoding)(sys.stdout,
500
errors=self.encoding_type)
501
# For whatever reason codecs.getwriter() does not advertise its encoding
502
# it just returns the encoding of the wrapped file, which is completely
503
# bogus. So set the attribute, so we can find the correct encoding later.
504
self.outf.encoding = output_encoding
506
def run_argv_aliases(self, argv, alias_argv=None):
507
"""Parse the command line and run with extra aliases in alias_argv."""
509
warn("Passing None for [] is deprecated from bzrlib 0.10",
510
DeprecationWarning, stacklevel=2)
512
args, opts = parse_args(self, argv, alias_argv)
514
# Process the standard options
515
if 'help' in opts: # e.g. bzr add --help
516
sys.stdout.write(self.get_help_text())
518
trace.set_verbosity_level(option._verbosity_level)
519
if 'verbose' in self.supported_std_options:
520
opts['verbose'] = trace.is_verbose()
521
elif opts.has_key('verbose'):
523
if 'quiet' in self.supported_std_options:
524
opts['quiet'] = trace.is_quiet()
525
elif opts.has_key('quiet'):
528
# mix arguments and options into one dictionary
529
cmdargs = _match_argform(self.name(), self.takes_args, args)
531
for k, v in opts.items():
532
cmdopts[k.replace('-', '_')] = v
534
all_cmd_args = cmdargs.copy()
535
all_cmd_args.update(cmdopts)
539
return self.run(**all_cmd_args)
103
"""Override this in sub-classes.
542
"""Actually run the command.
105
544
This is invoked with the options and arguments bound to
106
545
keyword parameters.
108
Return 0 or None if the command was successful, or a shell
115
class cmd_status(Command):
116
"""Display status summary.
118
For each file there is a single line giving its file state and name.
119
The name is that in the current revision unless it is deleted or
120
missing, in which case the old name is shown.
122
takes_args = ['file*']
123
takes_options = ['all']
124
aliases = ['st', 'stat']
126
def run(self, all=False, file_list=None):
127
b = Branch('.', lock_mode='r')
128
b.show_status(show_all=all, file_list=file_list)
131
class cmd_cat_revision(Command):
132
"""Write out metadata for a revision."""
135
takes_args = ['revision_id']
137
def run(self, revision_id):
138
Branch('.').get_revision(revision_id).write_xml(sys.stdout)
141
class cmd_revno(Command):
142
"""Show current revision number.
144
This is equal to the number of revisions on this branch."""
146
print Branch('.').revno()
149
class cmd_add(Command):
150
"""Add specified files or directories.
152
In non-recursive mode, all the named items are added, regardless
153
of whether they were previously ignored. A warning is given if
154
any of the named files are already versioned.
156
In recursive mode (the default), files are treated the same way
157
but the behaviour for directories is different. Directories that
158
are already versioned do not give a warning. All directories,
159
whether already versioned or not, are searched for files or
160
subdirectories that are neither versioned or ignored, and these
161
are added. This search proceeds recursively into versioned
164
Therefore simply saying 'bzr add .' will version all files that
165
are currently unknown.
167
TODO: Perhaps adding a file whose directly is not versioned should
168
recursively add that parent, rather than giving an error?
170
takes_args = ['file+']
171
takes_options = ['verbose']
173
def run(self, file_list, verbose=False):
174
bzrlib.add.smart_add(file_list, verbose)
177
class cmd_relpath(Command):
178
"""Show path of a file relative to root"""
179
takes_args = ['filename']
181
def run(self, filename):
182
print Branch(filename).relpath(filename)
186
class cmd_inventory(Command):
187
"""Show inventory of the current working copy or a revision."""
188
takes_options = ['revision']
190
def run(self, revision=None):
193
inv = b.read_working_inventory()
195
inv = b.get_revision_inventory(b.lookup_revision(revision))
197
for path, entry in inv.iter_entries():
198
print '%-50s %s' % (entry.file_id, path)
201
class cmd_move(Command):
202
"""Move files to a different directory.
207
The destination must be a versioned directory in the same branch.
209
takes_args = ['source$', 'dest']
210
def run(self, source_list, dest):
213
b.move([b.relpath(s) for s in source_list], b.relpath(dest))
216
class cmd_rename(Command):
217
"""Change the name of an entry.
220
bzr rename frob.c frobber.c
221
bzr rename src/frob.c lib/frob.c
223
It is an error if the destination name exists.
225
See also the 'move' command, which moves files into a different
226
directory without changing their name.
228
TODO: Some way to rename multiple files without invoking bzr for each
230
takes_args = ['from_name', 'to_name']
232
def run(self, from_name, to_name):
234
b.rename_one(b.relpath(from_name), b.relpath(to_name))
238
class cmd_renames(Command):
239
"""Show list of renamed files.
241
TODO: Option to show renames between two historical versions.
243
TODO: Only show renames under dir, rather than in the whole branch.
245
takes_args = ['dir?']
247
def run(self, dir='.'):
249
old_inv = b.basis_tree().inventory
250
new_inv = b.read_working_inventory()
252
renames = list(bzrlib.tree.find_renames(old_inv, new_inv))
254
for old_name, new_name in renames:
255
print "%s => %s" % (old_name, new_name)
258
class cmd_info(Command):
259
"""Show statistical information for this branch"""
262
info.show_info(Branch('.'))
265
class cmd_remove(Command):
266
"""Make a file unversioned.
268
This makes bzr stop tracking changes to a versioned file. It does
269
not delete the working copy.
271
takes_args = ['file+']
272
takes_options = ['verbose']
274
def run(self, file_list, verbose=False):
275
b = Branch(file_list[0])
276
b.remove([b.relpath(f) for f in file_list], verbose=verbose)
279
class cmd_file_id(Command):
280
"""Print file_id of a particular file or directory.
282
The file_id is assigned when the file is first added and remains the
283
same through all revisions where the file exists, even when it is
287
takes_args = ['filename']
288
def run(self, filename):
290
i = b.inventory.path2id(b.relpath(filename))
292
bailout("%r is not a versioned file" % filename)
297
class cmd_file_path(Command):
298
"""Print path of file_ids to a file or directory.
300
This prints one line for each directory down to the target,
301
starting at the branch root."""
303
takes_args = ['filename']
304
def run(self, filename):
307
fid = inv.path2id(b.relpath(filename))
309
bailout("%r is not a versioned file" % filename)
310
for fip in inv.get_idpath(fid):
314
class cmd_revision_history(Command):
315
"""Display list of revision ids on this branch."""
317
for patchid in Branch('.').revision_history():
321
class cmd_directories(Command):
322
"""Display list of versioned directories in this branch."""
324
for name, ie in Branch('.').read_working_inventory().directories():
331
class cmd_init(Command):
332
"""Make a directory into a versioned branch.
334
Use this to create an empty branch, or before importing an
337
Recipe for importing a tree of files:
342
bzr commit -m 'imported project'
345
Branch('.', init=True)
348
class cmd_diff(Command):
349
"""Show differences in working tree.
351
If files are listed, only the changes in those files are listed.
352
Otherwise, all changes for the tree are listed.
354
TODO: Given two revision arguments, show the difference between them.
356
TODO: Allow diff across branches.
358
TODO: Option to use external diff command; could be GNU diff, wdiff,
361
TODO: Python difflib is not exactly the same as unidiff; should
362
either fix it up or prefer to use an external diff.
364
TODO: If a directory is given, diff everything under that.
366
TODO: Selected-file diff is inefficient and doesn't show you
369
TODO: This probably handles non-Unix newlines poorly.
372
takes_args = ['file*']
373
takes_options = ['revision']
376
def run(self, revision=None, file_list=None):
377
from bzrlib.diff import show_diff
379
show_diff(Branch('.'), revision, file_list)
382
class cmd_deleted(Command):
383
"""List files deleted in the working tree.
385
TODO: Show files deleted since a previous revision, or between two revisions.
387
def run(self, show_ids=False):
390
new = b.working_tree()
392
## TODO: Much more efficient way to do this: read in new
393
## directories with readdir, rather than stating each one. Same
394
## level of effort but possibly much less IO. (Or possibly not,
395
## if the directories are very large...)
397
for path, ie in old.inventory.iter_entries():
398
if not new.has_id(ie.file_id):
400
print '%-50s %s' % (path, ie.file_id)
404
class cmd_root(Command):
405
"""Show the tree root directory.
407
The root is the nearest enclosing directory with a .bzr control
409
takes_args = ['filename?']
410
def run(self, filename=None):
411
"""Print the branch root."""
412
print bzrlib.branch.find_branch_root(filename)
416
class cmd_log(Command):
417
"""Show log of this branch.
419
TODO: Option to limit range.
421
TODO: Perhaps show most-recent first with an option for last.
423
takes_args = ['filename?']
424
takes_options = ['timezone', 'verbose', 'show-ids']
425
def run(self, filename=None, timezone='original', verbose=False, show_ids=False):
426
b = Branch((filename or '.'), lock_mode='r')
428
filename = b.relpath(filename)
429
bzrlib.show_log(b, filename,
430
show_timezone=timezone,
436
class cmd_touching_revisions(Command):
437
"""Return revision-ids which affected a particular file."""
439
takes_args = ["filename"]
440
def run(self, filename):
441
b = Branch(filename, lock_mode='r')
442
inv = b.read_working_inventory()
443
file_id = inv.path2id(b.relpath(filename))
444
for revno, revision_id, what in bzrlib.log.find_touching_revisions(b, file_id):
445
print "%6d %s" % (revno, what)
448
class cmd_ls(Command):
449
"""List files in a tree.
451
TODO: Take a revision or remote path and list that tree instead.
454
def run(self, revision=None, verbose=False):
457
tree = b.working_tree()
459
tree = b.revision_tree(b.lookup_revision(revision))
461
for fp, fc, kind, fid in tree.list_files():
463
if kind == 'directory':
470
print '%-8s %s%s' % (fc, fp, kindch)
476
class cmd_unknowns(Command):
477
"""List unknown files"""
479
for f in Branch('.').unknowns():
484
class cmd_ignore(Command):
485
"""Ignore a command or pattern"""
486
takes_args = ['name_pattern']
488
def run(self, name_pattern):
491
# XXX: This will fail if it's a hardlink; should use an AtomicFile class.
492
f = open(b.abspath('.bzrignore'), 'at')
493
f.write(name_pattern + '\n')
496
inv = b.working_tree().inventory
497
if inv.path2id('.bzrignore'):
498
mutter('.bzrignore is already versioned')
500
mutter('need to make new .bzrignore file versioned')
501
b.add(['.bzrignore'])
505
class cmd_ignored(Command):
506
"""List ignored files and the patterns that matched them."""
508
tree = Branch('.').working_tree()
509
for path, file_class, kind, file_id in tree.list_files():
510
if file_class != 'I':
512
## XXX: Slightly inefficient since this was already calculated
513
pat = tree.is_ignored(path)
514
print '%-50s %s' % (path, pat)
517
class cmd_lookup_revision(Command):
518
"""Lookup the revision-id from a revision-number
521
bzr lookup-revision 33
524
takes_args = ['revno']
526
def run(self, revno):
530
raise BzrCommandError("not a valid revision-number: %r" % revno)
532
print Branch('.').lookup_revision(revno)
535
class cmd_export(Command):
536
"""Export past revision to destination directory.
538
If no revision is specified this exports the last committed revision."""
539
takes_args = ['dest']
540
takes_options = ['revision']
541
def run(self, dest, revision=None):
544
rh = b.revision_history()[-1]
546
rh = b.lookup_revision(int(revision))
547
t = b.revision_tree(rh)
551
class cmd_cat(Command):
552
"""Write a file's text from a previous revision."""
554
takes_options = ['revision']
555
takes_args = ['filename']
557
def run(self, filename, revision=None):
559
raise BzrCommandError("bzr cat requires a revision number")
561
b.print_file(b.relpath(filename), int(revision))
564
class cmd_local_time_offset(Command):
565
"""Show the offset in seconds from GMT to local time."""
568
print bzrlib.osutils.local_time_offset()
572
class cmd_commit(Command):
573
"""Commit changes into a new revision.
575
TODO: Commit only selected files.
577
TODO: Run hooks on tree to-be-committed, and after commit.
579
TODO: Strict commit that fails if there are unknown or deleted files.
581
takes_options = ['message', 'file', 'verbose']
582
aliases = ['ci', 'checkin']
584
def run(self, message=None, file=None, verbose=False):
585
## Warning: shadows builtin file()
586
if not message and not file:
587
raise BzrCommandError("please specify a commit message",
588
["use either --message or --file"])
589
elif message and file:
590
raise BzrCommandError("please specify either --message or --file")
594
message = codecs.open(file, 'rt', bzrlib.user_encoding).read()
596
Branch('.').commit(message, verbose=verbose)
599
class cmd_check(Command):
600
"""Validate consistency of branch history.
602
This command checks various invariants about the branch storage to
603
detect data corruption or bzr bugs.
605
takes_args = ['dir?']
606
def run(self, dir='.'):
608
bzrlib.check.check(Branch(dir, find_root=False))
612
class cmd_whoami(Command):
613
"""Show bzr user id."""
614
takes_options = ['email']
616
def run(self, email=False):
618
print bzrlib.osutils.user_email()
620
print bzrlib.osutils.username()
623
class cmd_selftest(Command):
624
"""Run internal test suite"""
627
failures, tests = 0, 0
629
import doctest, bzrlib.store, bzrlib.tests
630
bzrlib.trace.verbose = False
632
for m in bzrlib.store, bzrlib.inventory, bzrlib.branch, bzrlib.osutils, \
633
bzrlib.tree, bzrlib.tests, bzrlib.commands, bzrlib.add:
634
mf, mt = doctest.testmod(m)
637
print '%-40s %3d tests' % (m.__name__, mt),
639
print '%3d FAILED!' % mf
643
print '%-40s %3d tests' % ('total', tests),
645
print '%3d FAILED!' % failures
651
class cmd_version(Command):
652
"""Show version of bzr"""
657
print "bzr (bazaar-ng) %s" % bzrlib.__version__
658
print bzrlib.__copyright__
659
print "http://bazaar-ng.org/"
661
print "bzr comes with ABSOLUTELY NO WARRANTY. bzr is free software, and"
662
print "you may use, modify and redistribute it under the terms of the GNU"
663
print "General Public License version 2 or later."
666
class cmd_rocks(Command):
667
"""Statement of optimism."""
670
print "it sure does!"
673
class cmd_assert_fail(Command):
674
"""Test reporting of assertion failures"""
677
assert False, "always fails"
680
class cmd_help(Command):
681
"""Show help on a command or other topic.
683
For a list of all available commands, say 'bzr help commands'."""
684
takes_args = ['topic?']
687
def run(self, topic=None):
692
######################################################################
696
# list of all available options; the rhs can be either None for an
697
# option that takes no argument, or a constructor function that checks
721
def parse_args(argv):
547
Return 0 or None if the command was successful, or a non-zero
548
shell error code if not. It's OK for this method to allow
549
an exception to raise up.
551
raise NotImplementedError('no implementation of command %r'
555
"""Return help message for this class."""
556
from inspect import getdoc
557
if self.__doc__ is Command.__doc__:
562
return _unsquish_command_name(self.__class__.__name__)
564
def plugin_name(self):
565
"""Get the name of the plugin that provides this command.
567
:return: The name of the plugin or None if the command is builtin.
569
mod_parts = self.__module__.split('.')
570
if len(mod_parts) >= 3 and mod_parts[1] == 'plugins':
576
def parse_args(command, argv, alias_argv=None):
722
577
"""Parse command line.
724
579
Arguments and options are parsed at this level before being passed
725
580
down to specific command handlers. This routine knows, from a
726
581
lookup table, something about the available options, what optargs
727
582
they take, and which commands will accept them.
729
>>> parse_args('--help'.split())
731
>>> parse_args('--version'.split())
732
([], {'version': True})
733
>>> parse_args('status --all'.split())
734
(['status'], {'all': True})
735
>>> parse_args('commit --message=biter'.split())
736
(['commit'], {'message': u'biter'})
741
# TODO: Maybe handle '--' to end options?
746
# option names must not be unicode
750
mutter(" got option %r" % a)
752
optname, optarg = a[2:].split('=', 1)
755
if optname not in OPTIONS:
756
bailout('unknown long option %r' % a)
759
if shortopt not in SHORT_OPTIONS:
760
bailout('unknown short option %r' % a)
761
optname = SHORT_OPTIONS[shortopt]
764
# XXX: Do we ever want to support this, e.g. for -r?
765
bailout('repeated option %r' % a)
767
optargfn = OPTIONS[optname]
771
bailout('option %r needs an argument' % a)
774
opts[optname] = optargfn(optarg)
777
bailout('option %r takes no argument' % optname)
584
# TODO: make it a method of the Command?
585
parser = option.get_optparser(command.options())
586
if alias_argv is not None:
587
args = alias_argv + argv
591
options, args = parser.parse_args(args)
592
opts = dict([(k, v) for k, v in options.__dict__.iteritems() if
593
v is not option.OptionParser.DEFAULT_VALUE])
782
594
return args, opts
787
597
def _match_argform(cmd, takes_args, args):
801
611
argdict[argname + '_list'] = None
802
612
elif ap[-1] == '+':
804
raise BzrCommandError("command %r needs one or more %s"
805
% (cmd, argname.upper()))
614
raise errors.BzrCommandError("command %r needs one or more %s"
615
% (cmd, argname.upper()))
807
617
argdict[argname + '_list'] = args[:]
809
619
elif ap[-1] == '$': # all but one
810
620
if len(args) < 2:
811
raise BzrCommandError("command %r needs one or more %s"
812
% (cmd, argname.upper()))
621
raise errors.BzrCommandError("command %r needs one or more %s"
622
% (cmd, argname.upper()))
813
623
argdict[argname + '_list'] = args[:-1]
816
626
# just a plain arg
819
raise BzrCommandError("command %r requires argument %s"
820
% (cmd, argname.upper()))
629
raise errors.BzrCommandError("command %r requires argument %s"
630
% (cmd, argname.upper()))
822
632
argdict[argname] = args.pop(0)
825
raise BzrCommandError("extra argument to command %s: %s"
635
raise errors.BzrCommandError("extra argument to command %s: %s"
640
def apply_coveraged(dirname, the_callable, *args, **kwargs):
641
# Cannot use "import trace", as that would import bzrlib.trace instead of
642
# the standard library's trace.
643
trace = __import__('trace')
645
tracer = trace.Trace(count=1, trace=0)
646
sys.settrace(tracer.globaltrace)
648
ret = the_callable(*args, **kwargs)
651
results = tracer.results()
652
results.write_results(show_missing=1, summary=False,
656
def apply_profiled(the_callable, *args, **kwargs):
660
pffileno, pfname = tempfile.mkstemp()
662
prof = hotshot.Profile(pfname)
664
ret = prof.runcall(the_callable, *args, **kwargs) or 0
667
stats = hotshot.stats.load(pfname)
669
stats.sort_stats('cum') # 'time'
670
## XXX: Might like to write to stderr or the trace file instead but
671
## print_stats seems hardcoded to stdout
672
stats.print_stats(20)
679
def apply_lsprofiled(filename, the_callable, *args, **kwargs):
680
from bzrlib.lsprof import profile
681
ret, stats = profile(the_callable, *args, **kwargs)
687
trace.note('Profile data written to "%s".', filename)
691
def shlex_split_unicode(unsplit):
693
return [u.decode('utf-8') for u in shlex.split(unsplit.encode('utf-8'))]
696
def get_alias(cmd, config=None):
697
"""Return an expanded alias, or None if no alias exists.
700
Command to be checked for an alias.
702
Used to specify an alternative config to use,
703
which is especially useful for testing.
704
If it is unspecified, the global config will be used.
708
config = bzrlib.config.GlobalConfig()
709
alias = config.get_alias(cmd)
711
return shlex_split_unicode(alias)
832
715
def run_bzr(argv):
833
716
"""Execute a command.
835
This is similar to main(), but without all the trappings for
836
logging and error handling.
719
The command-line arguments, without the program name from argv[0]
720
These should already be decoded. All library/test code calling
721
run_bzr should be passing valid strings (don't need decoding).
723
Returns a command status or raises an exception.
725
Special master options: these must come before the command because
726
they control how the command is interpreted.
729
Do not load plugin modules at all
735
Only use builtin commands. (Plugins are still allowed to change
739
Run under the Python hotshot profiler.
742
Run under the Python lsprof profiler.
745
Generate line coverage report in the specified directory.
838
argv = [a.decode(bzrlib.user_encoding) for a in argv]
748
trace.mutter("bzr arguments: %r", argv)
750
opt_lsprof = opt_profile = opt_no_plugins = opt_builtin = \
751
opt_no_aliases = False
752
opt_lsprof_file = opt_coverage_dir = None
754
# --no-plugins is handled specially at a very early stage. We need
755
# to load plugins before doing other command parsing so that they
756
# can override commands, but this needs to happen first.
764
elif a == '--lsprof':
766
elif a == '--lsprof-file':
768
opt_lsprof_file = argv[i + 1]
770
elif a == '--no-plugins':
771
opt_no_plugins = True
772
elif a == '--no-aliases':
773
opt_no_aliases = True
774
elif a == '--builtin':
776
elif a == '--coverage':
777
opt_coverage_dir = argv[i + 1]
779
elif a.startswith('-D'):
780
debug.debug_flags.add(a[2:])
787
from bzrlib.builtins import cmd_help
788
cmd_help().run_argv_aliases([])
791
if argv[0] == '--version':
792
from bzrlib.builtins import cmd_version
793
cmd_version().run_argv_aliases([])
796
if not opt_no_plugins:
797
from bzrlib.plugin import load_plugins
800
from bzrlib.plugin import disable_plugins
805
if not opt_no_aliases:
806
alias_argv = get_alias(argv[0])
808
user_encoding = osutils.get_user_encoding()
809
alias_argv = [a.decode(user_encoding) for a in alias_argv]
810
argv[0] = alias_argv.pop(0)
813
# We want only 'ascii' command names, but the user may have typed
814
# in a Unicode name. In that case, they should just get a
815
# 'command not found' error later.
817
cmd_obj = get_cmd_object(cmd, plugins_override=not opt_builtin)
818
run = cmd_obj.run_argv_aliases
819
run_argv = [argv, alias_argv]
841
args, opts = parse_args(argv[1:])
849
elif 'version' in opts:
852
cmd = str(args.pop(0))
854
log_error('usage: bzr COMMAND')
855
log_error(' try "bzr help"')
858
canonical_cmd, cmd_class = get_cmd_class(cmd)
861
if 'profile' in opts:
867
# check options are reasonable
868
allowed = cmd_class.takes_options
870
if oname not in allowed:
871
raise BzrCommandError("option '--%s' is not allowed for command %r"
874
# mix arguments and options into one dictionary
875
cmdargs = _match_argform(cmd, cmd_class.takes_args, args)
877
for k, v in opts.items():
878
cmdopts[k.replace('-', '_')] = v
881
import hotshot, tempfile
882
pffileno, pfname = tempfile.mkstemp()
822
# We can be called recursively (tests for example), but we don't want
823
# the verbosity level to propagate.
824
saved_verbosity_level = option._verbosity_level
825
option._verbosity_level = 0
829
'--coverage ignored, because --lsprof is in use.')
830
ret = apply_lsprofiled(opt_lsprof_file, run, *run_argv)
834
'--coverage ignored, because --profile is in use.')
835
ret = apply_profiled(run, *run_argv)
836
elif opt_coverage_dir:
837
ret = apply_coveraged(opt_coverage_dir, run, *run_argv)
840
if 'memory' in debug.debug_flags:
841
trace.debug_memory('Process status after command:', short=False)
844
# reset, in case we may do other commands later within the same
845
# process. Commands that want to execute sub-commands must propagate
846
# --verbose in their own way.
847
option._verbosity_level = saved_verbosity_level
849
def display_command(func):
850
"""Decorator that suppresses pipe/interrupt errors."""
851
def ignore_pipe(*args, **kwargs):
884
prof = hotshot.Profile(pfname)
885
ret = prof.runcall(cmd_class, cmdopts, cmdargs) or 0
889
stats = hotshot.stats.load(pfname)
891
stats.sort_stats('time')
892
## XXX: Might like to write to stderr or the trace file instead but
893
## print_stats seems hardcoded to stdout
894
stats.print_stats(20)
902
cmdobj = cmd_class(cmdopts, cmdargs).status
905
def _report_exception(summary, quiet=False):
907
log_error('bzr: ' + summary)
908
bzrlib.trace.log_exception()
911
tb = sys.exc_info()[2]
912
exinfo = traceback.extract_tb(tb)
914
sys.stderr.write(' at %s:%d in %s()\n' % exinfo[-1][:3])
915
sys.stderr.write(' see ~/.bzr.log for debug information\n')
853
result = func(*args, **kwargs)
857
if getattr(e, 'errno', None) is None:
859
if e.errno != errno.EPIPE:
860
# Win32 raises IOError with errno=0 on a broken pipe
861
if sys.platform != 'win32' or (e.errno not in (0, errno.EINVAL)):
864
except KeyboardInterrupt:
922
bzrlib.open_tracefile(argv)
871
from bzrlib.ui.text import TextUIFactory
872
bzrlib.ui.ui_factory = TextUIFactory()
874
# Is this a final release version? If so, we should suppress warnings
875
if bzrlib.version_info[3] == 'final':
876
from bzrlib import symbol_versioning
877
symbol_versioning.suppress_deprecation_warnings(override=False)
879
user_encoding = osutils.get_user_encoding()
880
argv = [a.decode(user_encoding) for a in argv[1:]]
881
except UnicodeDecodeError:
882
raise errors.BzrError(("Parameter '%r' is unsupported by the current "
884
ret = run_bzr_catch_errors(argv)
885
trace.mutter("return code %d", ret)
889
def run_bzr_catch_errors(argv):
890
# Note: The except clause logic below should be kept in sync with the
891
# profile() routine in lsprof.py.
894
except (KeyboardInterrupt, Exception), e:
895
# used to handle AssertionError and KeyboardInterrupt
896
# specially here, but hopefully they're handled ok by the logger now
897
exitcode = trace.report_exception(sys.exc_info(), sys.stderr)
898
if os.environ.get('BZR_PDB'):
899
print '**** entering debugger'
901
pdb.post_mortem(sys.exc_traceback)
905
def run_bzr_catch_user_errors(argv):
906
"""Run bzr and report user errors, but let internal errors propagate.
908
This is used for the test suite, and might be useful for other programs
909
that want to wrap the commandline interface.
914
if (isinstance(e, (OSError, IOError))
915
or not getattr(e, 'internal_error', True)):
916
trace.report_exception(sys.exc_info(), sys.stderr)
922
class HelpCommandIndex(object):
923
"""A index for bzr help that returns commands."""
926
self.prefix = 'commands/'
928
def get_topics(self, topic):
929
"""Search for topic amongst commands.
931
:param topic: A topic to search for.
932
:return: A list which is either empty or contains a single
935
if topic and topic.startswith(self.prefix):
936
topic = topic[len(self.prefix):]
929
# do this here inside the exception wrappers to catch EPIPE
932
quiet = isinstance(e, (BzrCommandError))
933
_report_exception('error: ' + e.args[0], quiet=quiet)
936
# some explanation or hints
939
except AssertionError, e:
940
msg = 'assertion failed'
943
_report_exception(msg)
945
except KeyboardInterrupt, e:
946
_report_exception('interrupted', quiet=True)
950
if isinstance(e, IOError) and e.errno == errno.EPIPE:
954
msg = str(e).rstrip('\n')
955
_report_exception(msg, quiet)
958
bzrlib.trace.close_trace()
938
cmd = _get_cmd_object(topic)
945
class Provider(object):
946
'''Generic class to be overriden by plugins'''
948
def plugin_for_command(self, cmd_name):
949
'''Takes a command and returns the information for that plugin
951
:return: A dictionary with all the available information
952
for the requested plugin
954
raise NotImplementedError
957
class ProvidersRegistry(registry.Registry):
958
'''This registry exists to allow other providers to exist'''
961
for key, provider in self.iteritems():
964
command_providers_registry = ProvidersRegistry()
961
967
if __name__ == '__main__':
added
removed
bzrlib/commands.py
