24
26
# TODO: Specific "examples" property on commands for consistent formatting.
28
# TODO: "--profile=cum", to change sort order. Is there any value in leaving
29
# the profile output behind so it can be interactively examined?
29
from .lazy_import import lazy_import
34
from bzrlib.lazy_import import lazy_import
30
35
lazy_import(globals(), """
38
from warnings import warn
48
from .hooks import Hooks
49
from .i18n import gettext
50
# Compatibility - Option used to be in commands.
51
from .option import Option
52
from .plugin import disable_plugins, load_plugins, plugin_name
53
from . import errors, registry
51
from bzrlib.symbol_versioning import (
60
class BzrOptionError(errors.BzrCommandError):
62
_fmt = "Error in command line options"
65
class CommandAvailableInPlugin(Exception):
67
internal_error = False
69
def __init__(self, cmd_name, plugin_metadata, provider):
71
self.plugin_metadata = plugin_metadata
72
self.cmd_name = cmd_name
73
self.provider = provider
77
_fmt = ('"%s" is not a standard brz command. \n'
78
'However, the following official plugin provides this command: %s\n'
79
'You can install it by going to: %s'
80
% (self.cmd_name, self.plugin_metadata['name'],
81
self.plugin_metadata['url']))
86
class CommandInfo(object):
87
"""Information about a command."""
89
def __init__(self, aliases):
90
"""The list of aliases for the command."""
91
self.aliases = aliases
94
def from_command(klass, command):
95
"""Factory to construct a CommandInfo from a command."""
96
return klass(command.aliases)
99
class CommandRegistry(registry.Registry):
100
"""Special registry mapping command names to command classes.
102
:ivar overridden_registry: Look in this registry for commands being
103
overridden by this registry. This can be used to tell plugin commands
104
about the builtin they're decorating.
108
registry.Registry.__init__(self)
109
self.overridden_registry = None
110
# map from aliases to the real command that implements the name
111
self._alias_dict = {}
113
def get(self, command_name):
114
real_name = self._alias_dict.get(command_name, command_name)
115
return registry.Registry.get(self, real_name)
118
def _get_name(command_name):
119
if command_name.startswith("cmd_"):
120
return _unsquish_command_name(command_name)
124
def register(self, cmd, decorate=False):
125
"""Utility function to help register a command
127
:param cmd: Command subclass to register
128
:param decorate: If true, allow overriding an existing command
129
of the same name; the old command is returned by this function.
130
Otherwise it is an error to try to override an existing command.
133
k_unsquished = self._get_name(k)
135
previous = self.get(k_unsquished)
138
if self.overridden_registry:
140
previous = self.overridden_registry.get(k_unsquished)
143
info = CommandInfo.from_command(cmd)
145
registry.Registry.register(self, k_unsquished, cmd,
146
override_existing=decorate, info=info)
148
trace.warning('Two plugins defined the same command: %r' % k)
149
trace.warning('Not loading the one in %r' %
150
sys.modules[cmd.__module__])
151
trace.warning('Previously this command was registered from %r' %
152
sys.modules[previous.__module__])
153
for a in cmd.aliases:
154
self._alias_dict[a] = k_unsquished
157
def register_lazy(self, command_name, aliases, module_name):
158
"""Register a command without loading its module.
160
:param command_name: The primary name of the command.
161
:param aliases: A list of aliases for the command.
162
:module_name: The module that the command lives in.
164
key = self._get_name(command_name)
165
registry.Registry.register_lazy(self, key, module_name, command_name,
166
info=CommandInfo(aliases))
168
self._alias_dict[a] = key
171
plugin_cmds = CommandRegistry()
172
builtin_command_registry = CommandRegistry()
173
plugin_cmds.overridden_registry = builtin_command_registry
56
from bzrlib.option import Option
176
62
def register_command(cmd, decorate=False):
177
"""Register a plugin command.
63
"""Utility function to help register a command
179
Should generally be avoided in favor of lazy registration.
65
:param cmd: Command subclass to register
66
:param decorate: If true, allow overriding an existing command
67
of the same name; the old command is returned by this function.
68
Otherwise it is an error to try to override an existing command.
181
70
global plugin_cmds
182
return plugin_cmds.register(cmd, decorate)
72
if k.startswith("cmd_"):
73
k_unsquished = _unsquish_command_name(k)
76
if k_unsquished not in plugin_cmds:
77
plugin_cmds[k_unsquished] = cmd
78
## trace.mutter('registered plugin command %s', k_unsquished)
79
if decorate and k_unsquished in builtin_command_names():
80
return _builtin_commands()[k_unsquished]
82
result = plugin_cmds[k_unsquished]
83
plugin_cmds[k_unsquished] = cmd
86
trace.log_error('Two plugins defined the same command: %r' % k)
87
trace.log_error('Not loading the one in %r' % sys.modules[cmd.__module__])
88
trace.log_error('Previously this command was registered from %r' %
89
sys.modules[plugin_cmds[k_unsquished].__module__])
185
92
def _squish_command_name(cmd):
189
96
def _unsquish_command_name(cmd):
190
return cmd[4:].replace('_', '-')
193
def _register_builtin_commands():
194
if builtin_command_registry.keys():
197
import breezy.builtins
198
for cmd_class in _scan_module_for_commands(breezy.builtins):
199
builtin_command_registry.register(cmd_class)
200
breezy.builtins._register_lazy_builtins()
203
def _scan_module_for_commands(module):
204
module_dict = module.__dict__
205
for name in module_dict:
97
assert cmd.startswith("cmd_")
98
return cmd[4:].replace('_','-')
101
def _builtin_commands():
102
import bzrlib.builtins
104
builtins = bzrlib.builtins.__dict__
105
for name in builtins:
206
106
if name.startswith("cmd_"):
207
yield module_dict[name]
210
def _list_bzr_commands(names):
211
"""Find commands from bzr's core and plugins.
213
This is not the public interface, just the default hook called by all_command_names.
215
# to eliminate duplicates
216
names.update(builtin_command_names())
217
names.update(plugin_command_names())
221
def all_command_names():
222
"""Return a set of all command names."""
224
for hook in Command.hooks['list_commands']:
227
raise AssertionError(
228
'hook %s returned None' % Command.hooks.get_hook_name(hook))
107
real_name = _unsquish_command_name(name)
108
r[real_name] = builtins[name]
232
112
def builtin_command_names():
233
"""Return list of builtin command names.
113
"""Return list of builtin command names."""
114
return _builtin_commands().keys()
235
Use of all_command_names() is encouraged rather than builtin_command_names
236
and/or plugin_command_names.
238
_register_builtin_commands()
239
return builtin_command_registry.keys()
242
117
def plugin_command_names():
243
"""Returns command names from commands registered by plugins."""
244
118
return plugin_cmds.keys()
247
# Overrides for common mispellings that heuristics get wrong
249
'ic': {'ci': 0}, # heuristic finds nick
253
def guess_command(cmd_name):
254
"""Guess what command a user typoed.
256
:param cmd_name: Command to search for
257
:return: None if no command was found, name of a command otherwise
260
for name in all_command_names():
262
cmd = get_cmd_object(name)
263
names.update(cmd.aliases)
264
# candidate: modified levenshtein distance against cmd_name.
266
from . import patiencediff
267
for name in sorted(names):
268
matcher = patiencediff.PatienceSequenceMatcher(None, cmd_name, name)
270
opcodes = matcher.get_opcodes()
271
for opcode, l1, l2, r1, r2 in opcodes:
272
if opcode == 'delete':
274
elif opcode == 'replace':
275
distance += max(l2-l1, r2-l1)
276
elif opcode == 'insert':
278
elif opcode == 'equal':
279
# Score equal ranges lower, making similar commands of equal
280
# length closer than arbitrary same length commands.
281
distance -= 0.1 * (l2-l1)
282
costs[name] = distance
283
costs.update(_GUESS_OVERRIDES.get(cmd_name, {}))
284
costs = sorted((costs[key], key) for key in costs)
289
candidate = costs[0][1]
121
def _get_cmd_dict(plugins_override=True):
122
"""Return name->class mapping for all commands."""
123
d = _builtin_commands()
125
d.update(plugin_cmds)
129
def get_all_cmds(plugins_override=True):
130
"""Return canonical name and class for all registered commands."""
131
for k, v in _get_cmd_dict(plugins_override=plugins_override).iteritems():
293
135
def get_cmd_object(cmd_name, plugins_override=True):
294
"""Return the command object for a command.
136
"""Return the canonical name and command class for a command.
297
139
If true, plugin commands can override builtins.
300
142
return _get_cmd_object(cmd_name, plugins_override)
302
# No command found, see if this was a typo
303
candidate = guess_command(cmd_name)
304
if candidate is not None:
305
raise errors.BzrCommandError(
306
gettext('unknown command "%s". Perhaps you meant "%s"')
307
% (cmd_name, candidate))
308
raise errors.BzrCommandError(gettext('unknown command "%s"')
312
def _get_cmd_object(cmd_name, plugins_override=True, check_missing=True):
313
"""Get a command object.
315
:param cmd_name: The name of the command.
316
:param plugins_override: Allow plugins to override builtins.
317
:param check_missing: Look up commands not found in the regular index via
318
the get_missing_command hook.
319
:return: A Command object instance
320
:raises KeyError: If no command is found.
144
raise errors.BzrCommandError('unknown command "%s"' % cmd_name)
147
def _get_cmd_object(cmd_name, plugins_override=True):
148
"""Worker for get_cmd_object which raises KeyError rather than BzrCommandError."""
149
from bzrlib.externalcommand import ExternalCommand
322
151
# We want only 'ascii' command names, but the user may have typed
323
152
# in a Unicode name. In that case, they should just get a
324
153
# 'command not found' error later.
325
154
# In the future, we may actually support Unicode command names.
328
for hook in Command.hooks['get_command']:
329
cmd = hook(cmd, cmd_name)
330
if cmd is not None and not plugins_override and not cmd.plugin_name():
331
# We've found a non-plugin command, don't permit it to be
334
if cmd is None and check_missing:
335
for hook in Command.hooks['get_missing_command']:
342
# Allow plugins to extend commands
343
for hook in Command.hooks['extend_command']:
345
if getattr(cmd, 'invoked_as', None) is None:
346
cmd.invoked_as = cmd_name
350
class NoPluginAvailable(errors.BzrError):
354
def _try_plugin_provider(cmd_name):
355
"""Probe for a plugin provider having cmd_name."""
357
plugin_metadata, provider = probe_for_provider(cmd_name)
358
raise CommandAvailableInPlugin(cmd_name, plugin_metadata, provider)
359
except NoPluginAvailable:
363
def probe_for_provider(cmd_name):
364
"""Look for a provider for cmd_name.
366
:param cmd_name: The command name.
367
:return: plugin_metadata, provider for getting cmd_name.
368
:raises NoPluginAvailable: When no provider can supply the plugin.
370
# look for providers that provide this command but aren't installed
371
for provider in command_providers_registry:
373
return provider.plugin_for_command(cmd_name), provider
374
except NoPluginAvailable:
376
raise NoPluginAvailable(cmd_name)
379
def _get_bzr_command(cmd_or_None, cmd_name):
380
"""Get a command from bzr's core."""
382
cmd_class = builtin_command_registry.get(cmd_name)
156
# first look up this command under the specified name
157
cmds = _get_cmd_dict(plugins_override=plugins_override)
159
return cmds[cmd_name]()
390
def _get_external_command(cmd_or_None, cmd_name):
391
"""Lookup a command that is a shell script."""
392
# Only do external command lookups when no command is found so far.
393
if cmd_or_None is not None:
395
from breezy.externalcommand import ExternalCommand
163
# look for any command which claims this as an alias
164
for real_cmd_name, cmd_class in cmds.iteritems():
165
if cmd_name in cmd_class.aliases:
396
168
cmd_obj = ExternalCommand.find_command(cmd_name)
401
def _get_plugin_command(cmd_or_None, cmd_name):
402
"""Get a command from brz's plugins."""
404
return plugin_cmds.get(cmd_name)()
407
for key in plugin_cmds.keys():
408
info = plugin_cmds.get_info(key)
409
if cmd_name in info.aliases:
410
return plugin_cmds.get(key)()
414
174
class Command(object):
415
175
"""Base class for commands.
417
Commands are the heart of the command-line brz interface.
177
Commands are the heart of the command-line bzr interface.
419
179
The command object mostly handles the mapping of command-line
420
parameters into one or more breezy operations, and of the results
180
parameters into one or more bzrlib operations, and of the results
421
181
into textual output.
423
183
Commands normally don't have any state. All their arguments are
429
189
summary, then a complete description of the command. A grammar
430
190
description will be inserted.
432
:cvar aliases: Other accepted names for this command.
434
:cvar takes_args: List of argument forms, marked with whether they are
435
optional, repeated, etc. Examples::
437
['to_location', 'from_branch?', 'file*']
439
* 'to_location' is required
440
* 'from_branch' is optional
441
* 'file' can be specified 0 or more times
443
:cvar takes_options: List of options that may be given for this command.
444
These can be either strings, referring to globally-defined options, or
445
option objects. Retrieve through options().
447
:cvar hidden: If true, this command isn't advertised. This is typically
193
Other accepted names for this command.
196
List of argument forms, marked with whether they are optional,
201
['to_location', 'from_branch?', 'file*']
203
'to_location' is required
204
'from_branch' is optional
205
'file' can be specified 0 or more times
208
List of options that may be given for this command. These can
209
be either strings, referring to globally-defined options,
210
or option objects. Retrieve through options().
213
If true, this command isn't advertised. This is typically
448
214
for commands intended for expert users.
450
:cvar encoding_type: Command objects will get a 'outf' attribute, which has
451
been setup to properly handle encoding of unicode strings.
452
encoding_type determines what will happen when characters cannot be
455
* strict - abort if we cannot decode
456
* replace - put in a bogus character (typically '?')
457
* exact - do not encode sys.stdout
459
NOTE: by default on Windows, sys.stdout is opened as a text stream,
460
therefore LF line-endings are converted to CRLF. When a command uses
461
encoding_type = 'exact', then sys.stdout is forced to be a binary
462
stream, and line-endings will not mangled.
465
A string indicating the real name under which this command was
466
invoked, before expansion of aliases.
467
(This may be None if the command was constructed and run in-process.)
469
:cvar hooks: An instance of CommandHooks.
471
:cvar __doc__: The help shown by 'brz help command' for this command.
472
This is set by assigning explicitly to __doc__ so that -OO can
476
__doc__ = "My help goes here"
217
Command objects will get a 'outf' attribute, which has been
218
setup to properly handle encoding of unicode strings.
219
encoding_type determines what will happen when characters cannot
221
strict - abort if we cannot decode
222
replace - put in a bogus character (typically '?')
223
exact - do not encode sys.stdout
225
NOTE: by default on Windows, sys.stdout is opened as a text
226
stream, therefore LF line-endings are converted to CRLF.
227
When a command uses encoding_type = 'exact', then
228
sys.stdout is forced to be a binary stream, and line-endings
480
234
takes_options = []
481
235
encoding_type = 'strict'
487
239
def __init__(self):
488
240
"""Construct an instance of this command."""
241
if self.__doc__ == Command.__doc__:
242
warn("No help message set for %r" % self)
489
243
# List of standard options directly supported
490
244
self.supported_std_options = []
493
def add_cleanup(self, cleanup_func, *args, **kwargs):
494
"""Register a function to call after self.run returns or raises.
496
Functions will be called in LIFO order.
498
self._operation.add_cleanup(cleanup_func, *args, **kwargs)
500
def cleanup_now(self):
501
"""Execute and empty pending cleanup functions immediately.
503
After cleanup_now all registered cleanups are forgotten. add_cleanup
504
may be called again after cleanup_now; these cleanups will be called
505
after self.run returns or raises (or when cleanup_now is next called).
507
This is useful for releasing expensive or contentious resources (such
508
as write locks) before doing further work that does not require those
509
resources (such as writing results to self.outf). Note though, that
510
as it releases all resources, this may release locks that the command
511
wants to hold, so use should be done with care.
513
self._operation.cleanup_now()
246
def _maybe_expand_globs(self, file_list):
247
"""Glob expand file_list if the platform does not do that itself.
249
:return: A possibly empty list of unicode paths.
251
Introduced in bzrlib 0.18.
255
if sys.platform == 'win32':
256
file_list = win32utils.glob_expand(file_list)
257
return list(file_list)
515
259
def _usage(self):
516
260
"""Return single-line grammar for this command.
518
262
Only describes arguments, not options.
520
s = 'brz ' + self.name() + ' '
264
s = 'bzr ' + self.name() + ' '
521
265
for aname in self.takes_args:
522
266
aname = aname.upper()
523
267
if aname[-1] in ['$', '+']:
527
271
elif aname[-1] == '*':
528
272
aname = '[' + aname[:-1] + '...]'
530
s = s[:-1] # remove last space
533
279
def get_help_text(self, additional_see_also=None, plain=True,
534
see_also_as_links=False, verbose=True):
280
see_also_as_links=False):
535
281
"""Return a text string with help for this command.
537
283
:param additional_see_also: Additional help topics to be
538
284
cross-referenced.
539
285
:param plain: if False, raw help (reStructuredText) is
540
286
returned instead of plain text.
541
287
:param see_also_as_links: if True, convert items in 'See also'
542
288
list to internal links (used by bzr_man rstx generator)
543
:param verbose: if True, display the full help, otherwise
544
leave out the descriptive sections and just display
545
usage help (e.g. Purpose, Usage, Options) with a
546
message explaining how to obtain full help.
549
i18n.install() # Install i18n only for get_help_text for now.
550
290
doc = self.help()
552
# Note: If self.gettext() translates ':Usage:\n', the section will
553
# be shown after "Description" section and we don't want to
554
# translate the usage string.
555
# Though, brz export-pot don't exports :Usage: section and it must
557
doc = self.gettext(doc)
559
doc = gettext("No help for this command.")
292
raise NotImplementedError("sorry, no detailed help yet for %r" % self.name())
561
294
# Extract the summary (purpose) and sections out from the text
562
purpose, sections, order = self._get_help_parts(doc)
295
purpose,sections = self._get_help_parts(doc)
564
297
# If a custom usage section was provided, use it
565
if 'Usage' in sections:
298
if sections.has_key('Usage'):
566
299
usage = sections.pop('Usage')
568
301
usage = self._usage()
570
303
# The header is the purpose and usage
572
result += gettext(':Purpose: %s\n') % (purpose,)
305
result += ':Purpose: %s\n' % purpose
573
306
if usage.find('\n') >= 0:
574
result += gettext(':Usage:\n%s\n') % (usage,)
307
result += ':Usage:\n%s\n' % usage
576
result += gettext(':Usage: %s\n') % (usage,)
309
result += ':Usage: %s\n' % usage
579
312
# Add the options
581
# XXX: optparse implicitly rewraps the help, and not always perfectly,
582
# so we get <https://bugs.launchpad.net/bzr/+bug/249908>. -- mbp
584
parser = option.get_optparser(self.options())
585
options = parser.format_option_help()
586
# FIXME: According to the spec, ReST option lists actually don't
587
# support options like --1.14 so that causes syntax errors (in Sphinx
588
# at least). As that pattern always appears in the commands that
589
# break, we trap on that and then format that block of 'format' options
590
# as a literal block. We use the most recent format still listed so we
591
# don't have to do that too often -- vila 20110514
592
if not plain and options.find(' --1.14 ') != -1:
593
options = options.replace(' format:\n', ' format::\n\n', 1)
313
options = option.get_optparser(self.options()).format_option_help()
594
314
if options.startswith('Options:'):
595
result += gettext(':Options:%s') % (options[len('options:'):],)
315
result += ':' + options
316
elif options.startswith('options:'):
317
# Python 2.4 version of optparse
318
result += ':Options:' + options[len('options:'):]
597
320
result += options
601
# Add the description, indenting it 2 spaces
602
# to match the indentation of the options
604
text = sections.pop(None)
605
text = '\n '.join(text.splitlines())
606
result += gettext(':Description:\n %s\n\n') % (text,)
323
# Add the description, indenting it 2 spaces
324
# to match the indentation of the options
325
if sections.has_key(None):
326
text = sections.pop(None)
327
text = '\n '.join(text.splitlines())
328
result += ':%s:\n %s\n\n' % ('Description',text)
608
# Add the custom sections (e.g. Examples). Note that there's no need
609
# to indent these as they must be indented already in the source.
612
if label in sections:
613
result += ':%s:\n%s\n' % (label, sections[label])
616
result += (gettext("See brz help %s for more details and examples.\n\n")
330
# Add the custom sections (e.g. Examples). Note that there's no need
331
# to indent these as they must be indented already in the source.
333
labels = sorted(sections.keys())
335
result += ':%s:\n%s\n\n' % (label,sections[label])
619
337
# Add the aliases, source (plug-in) and see also links, if any
621
result += gettext(':Aliases: ')
339
result += ':Aliases: '
622
340
result += ', '.join(self.aliases) + '\n'
623
341
plugin_name = self.plugin_name()
624
342
if plugin_name is not None:
625
result += gettext(':From: plugin "%s"\n') % plugin_name
343
result += ':From: plugin "%s"\n' % plugin_name
626
344
see_also = self.get_see_also(additional_see_also)
628
346
if not plain and see_also_as_links:
633
351
# so don't create a real link
634
352
see_also_links.append(item)
636
# Use a Sphinx link for this entry
637
link_text = gettext(":doc:`{0} <{1}-help>`").format(
639
see_also_links.append(link_text)
354
# Use a reST link for this entry
355
see_also_links.append("`%s`_" % (item,))
640
356
see_also = see_also_links
641
result += gettext(':See also: %s') % ', '.join(see_also) + '\n'
357
result += ':See also: '
358
result += ', '.join(see_also) + '\n'
643
# If this will be rendered as plain text, convert it
360
# If this will be rendered as plan text, convert it
645
import breezy.help_topics
646
result = breezy.help_topics.help_as_plain_text(result)
362
import bzrlib.help_topics
363
result = bzrlib.help_topics.help_as_plain_text(result)
650
367
def _get_help_parts(text):
651
368
"""Split help text into a summary and named sections.
653
:return: (summary,sections,order) where summary is the top line and
370
:return: (summary,sections) where summary is the top line and
654
371
sections is a dictionary of the rest indexed by section name.
655
order is the order the section appear in the text.
656
372
A section starts with a heading line of the form ":xxx:".
657
373
Indented text on following lines is the section value.
658
374
All text found outside a named section is assigned to the
659
375
default section which is given the key of None.
661
def save_section(sections, order, label, section):
377
def save_section(sections, label, section):
662
378
if len(section) > 0:
663
if label in sections:
379
if sections.has_key(label):
664
380
sections[label] += '\n' + section
667
382
sections[label] = section
669
384
lines = text.rstrip().splitlines()
670
385
summary = lines.pop(0)
673
label, section = None, ''
387
label,section = None,''
674
388
for line in lines:
675
389
if line.startswith(':') and line.endswith(':') and len(line) > 2:
676
save_section(sections, order, label, section)
677
label, section = line[1:-1], ''
678
elif (label is not None) and len(line) > 1 and not line[0].isspace():
679
save_section(sections, order, label, section)
680
label, section = None, line
390
save_section(sections, label, section)
391
label,section = line[1:-1],''
392
elif label != None and len(line) > 1 and not line[0].isspace():
393
save_section(sections, label, section)
394
label,section = None,line
682
396
if len(section) > 0:
683
397
section += '\n' + line
686
save_section(sections, order, label, section)
687
return summary, sections, order
400
save_section(sections, label, section)
401
return summary, sections
689
403
def get_help_topic(self):
690
404
"""Return the commands help topic - its name."""
720
434
def _setup_outf(self):
721
435
"""Return a file linked to stdout, which has proper encoding."""
722
self.outf = ui.ui_factory.make_output_stream(
723
encoding_type=self.encoding_type)
436
assert self.encoding_type in ['strict', 'exact', 'replace']
438
# Originally I was using self.stdout, but that looks
439
# *way* too much like sys.stdout
440
if self.encoding_type == 'exact':
441
# force sys.stdout to be binary stream on win32
442
if sys.platform == 'win32':
443
fileno = getattr(sys.stdout, 'fileno', None)
446
msvcrt.setmode(fileno(), os.O_BINARY)
447
self.outf = sys.stdout
450
output_encoding = osutils.get_terminal_encoding()
452
self.outf = codecs.getwriter(output_encoding)(sys.stdout,
453
errors=self.encoding_type)
454
# For whatever reason codecs.getwriter() does not advertise its encoding
455
# it just returns the encoding of the wrapped file, which is completely
456
# bogus. So set the attribute, so we can find the correct encoding later.
457
self.outf.encoding = output_encoding
725
459
def run_argv_aliases(self, argv, alias_argv=None):
726
460
"""Parse the command line and run with extra aliases in alias_argv."""
462
warn("Passing None for [] is deprecated from bzrlib 0.10",
463
DeprecationWarning, stacklevel=2)
727
465
args, opts = parse_args(self, argv, alias_argv)
730
467
# Process the standard options
731
if 'help' in opts: # e.g. brz add --help
732
self.outf.write(self.get_help_text())
734
if 'usage' in opts: # e.g. brz add --usage
735
self.outf.write(self.get_help_text(verbose=False))
468
if 'help' in opts: # e.g. bzr add --help
469
sys.stdout.write(self.get_help_text())
737
471
trace.set_verbosity_level(option._verbosity_level)
738
472
if 'verbose' in self.supported_std_options:
739
473
opts['verbose'] = trace.is_verbose()
740
elif 'verbose' in opts:
474
elif opts.has_key('verbose'):
741
475
del opts['verbose']
742
476
if 'quiet' in self.supported_std_options:
743
477
opts['quiet'] = trace.is_quiet()
744
elif 'quiet' in opts:
478
elif opts.has_key('quiet'):
745
479
del opts['quiet']
746
481
# mix arguments and options into one dictionary
747
482
cmdargs = _match_argform(self.name(), self.takes_args, args)
752
487
all_cmd_args = cmdargs.copy()
753
488
all_cmd_args.update(cmdopts)
756
return self.run(**all_cmd_args)
758
# reset it, so that other commands run in the same process won't
759
# inherit state. Before we reset it, log any activity, so that it
760
# gets properly tracked.
761
ui.ui_factory.log_transport_activity(
762
display=('bytes' in debug.debug_flags))
763
trace.set_verbosity_level(0)
765
def _setup_run(self):
766
"""Wrap the defined run method on self with a cleanup.
768
This is called by __init__ to make the Command be able to be run
769
by just calling run(), as it could be before cleanups were added.
771
If a different form of cleanups are in use by your Command subclass,
772
you can override this method.
775
def run(*args, **kwargs):
776
for hook in Command.hooks['pre_command']:
778
self._operation = cleanup.OperationWithCleanups(class_run)
780
return self._operation.run_simple(*args, **kwargs)
783
for hook in Command.hooks['post_command']:
492
return self.run(**all_cmd_args)
788
495
"""Actually run the command.
836
520
:return: The name of the plugin or None if the command is builtin.
838
return plugin_name(self.__module__)
841
class CommandHooks(Hooks):
842
"""Hooks related to Command object creation/enumeration."""
845
"""Create the default hooks.
847
These are all empty initially, because by default nothing should get
850
Hooks.__init__(self, "breezy.commands", "Command.hooks")
851
self.add_hook('extend_command',
852
"Called after creating a command object to allow modifications "
853
"such as adding or removing options, docs etc. Called with the "
854
"new breezy.commands.Command object.", (1, 13))
855
self.add_hook('get_command',
856
"Called when creating a single command. Called with "
857
"(cmd_or_None, command_name). get_command should either return "
858
"the cmd_or_None parameter, or a replacement Command object that "
859
"should be used for the command. Note that the Command.hooks "
860
"hooks are core infrastructure. Many users will prefer to use "
861
"breezy.commands.register_command or plugin_cmds.register_lazy.",
863
self.add_hook('get_missing_command',
864
"Called when creating a single command if no command could be "
865
"found. Called with (command_name). get_missing_command should "
866
"either return None, or a Command object to be used for the "
868
self.add_hook('list_commands',
869
"Called when enumerating commands. Called with a set of "
870
"cmd_name strings for all the commands found so far. This set "
871
" is safe to mutate - e.g. to remove a command. "
872
"list_commands should return the updated set of command names.",
874
self.add_hook('pre_command',
875
"Called prior to executing a command. Called with the command "
877
self.add_hook('post_command',
878
"Called after executing a command. Called with the command "
881
Command.hooks = CommandHooks()
522
mod_parts = self.__module__.split('.')
523
if len(mod_parts) >= 3 and mod_parts[1] == 'plugins':
884
529
def parse_args(command, argv, alias_argv=None):
885
530
"""Parse command line.
887
532
Arguments and options are parsed at this level before being passed
888
533
down to specific command handlers. This routine knows, from a
889
534
lookup table, something about the available options, what optargs
926
564
argdict[argname + '_list'] = None
927
565
elif ap[-1] == '+':
929
raise errors.BzrCommandError(gettext(
930
"command {0!r} needs one or more {1}").format(
931
cmd, argname.upper()))
567
raise errors.BzrCommandError("command %r needs one or more %s"
568
% (cmd, argname.upper()))
933
570
argdict[argname + '_list'] = args[:]
935
572
elif ap[-1] == '$': # all but one
936
573
if len(args) < 2:
937
raise errors.BzrCommandError(
938
gettext("command {0!r} needs one or more {1}").format(
939
cmd, argname.upper()))
574
raise errors.BzrCommandError("command %r needs one or more %s"
575
% (cmd, argname.upper()))
940
576
argdict[argname + '_list'] = args[:-1]
943
579
# just a plain arg
946
raise errors.BzrCommandError(
947
gettext("command {0!r} requires argument {1}").format(
948
cmd, argname.upper()))
582
raise errors.BzrCommandError("command %r requires argument %s"
583
% (cmd, argname.upper()))
950
585
argdict[argname] = args.pop(0)
953
raise errors.BzrCommandError( gettext(
954
"extra argument to command {0}: {1}").format(
588
raise errors.BzrCommandError("extra argument to command %s: %s"
960
def apply_coveraged(the_callable, *args, **kwargs):
962
cov = coverage.Coverage()
963
os.environ['COVERAGE_PROCESS_START'] = cov.config_file
966
return exception_to_return_code(the_callable, *args, **kwargs)
972
595
def apply_profiled(the_callable, *args, **kwargs):
993
615
os.remove(pfname)
996
def exception_to_return_code(the_callable, *args, **kwargs):
997
"""UI level helper for profiling and coverage.
999
This transforms exceptions into a return value of 3. As such its only
1000
relevant to the UI layer, and should never be called where catching
1001
exceptions may be desirable.
1004
return the_callable(*args, **kwargs)
1005
except (KeyboardInterrupt, Exception) as e:
1006
# used to handle AssertionError and KeyboardInterrupt
1007
# specially here, but hopefully they're handled ok by the logger now
1008
exc_info = sys.exc_info()
1009
exitcode = trace.report_exception(exc_info, sys.stderr)
1010
if os.environ.get('BRZ_PDB'):
1011
print('**** entering debugger')
1013
pdb.post_mortem(exc_info[2])
1017
618
def apply_lsprofiled(filename, the_callable, *args, **kwargs):
1018
from breezy.lsprof import profile
1019
ret, stats = profile(exception_to_return_code, the_callable,
619
from bzrlib.lsprof import profile
620
ret, stats = profile(the_callable, *args, **kwargs)
1022
622
if filename is None:
1025
625
stats.save(filename)
1026
trace.note(gettext('Profile data written to "%s".'), filename)
626
trace.note('Profile data written to "%s".', filename)
1038
638
If it is unspecified, the global config will be used.
1040
640
if config is None:
1041
import breezy.config
1042
config = breezy.config.GlobalConfig()
642
config = bzrlib.config.GlobalConfig()
1043
643
alias = config.get_alias(cmd)
1045
return cmdline.split(alias)
646
return [a.decode('utf-8') for a in shlex.split(alias.encode('utf-8'))]
1049
def run_bzr(argv, load_plugins=load_plugins, disable_plugins=disable_plugins):
1050
651
"""Execute a command.
1052
:param argv: The command-line arguments, without the program name from
1053
argv[0] These should already be decoded. All library/test code calling
1054
run_bzr should be passing valid strings (don't need decoding).
1055
:param load_plugins: What function to call when triggering plugin loading.
1056
This function should take no arguments and cause all plugins to be
1058
:param disable_plugins: What function to call when disabling plugin
1059
loading. This function should take no arguments and cause all plugin
1060
loading to be prohibited (so that code paths in your application that
1061
know about some plugins possibly being present will fail to import
1062
those plugins even if they are installed.)
1063
:return: Returns a command exit code or raises an exception.
653
This is similar to main(), but without all the trappings for
654
logging and error handling.
657
The command-line arguments, without the program name from argv[0]
658
These should already be decoded. All library/test code calling
659
run_bzr should be passing valid strings (don't need decoding).
661
Returns a command status or raises an exception.
1065
663
Special master options: these must come before the command because
1066
664
they control how the command is interpreted.
1116
706
opt_no_plugins = True
1117
707
elif a == '--no-aliases':
1118
708
opt_no_aliases = True
1119
elif a == '--no-l10n':
1121
709
elif a == '--builtin':
1122
710
opt_builtin = True
1123
elif a == '--concurrency':
1124
os.environ['BRZ_CONCURRENCY'] = argv[i + 1]
1126
elif a == '--coverage':
1128
elif a == '--profile-imports':
1129
pass # already handled in startup script Bug #588277
1130
711
elif a.startswith('-D'):
1131
712
debug.debug_flags.add(a[2:])
1132
elif a.startswith('-O'):
1133
override_config.append(a[2:])
1135
714
argv_copy.append(a)
1138
cmdline_overrides = breezy.get_global_state().cmdline_overrides
1139
cmdline_overrides._from_cmdline(override_config)
1141
debug.set_debug_flags_from_config()
719
from bzrlib.builtins import cmd_help
720
cmd_help().run_argv_aliases([])
723
if argv[0] == '--version':
724
from bzrlib.builtins import cmd_version
725
cmd_version().run_argv_aliases([])
1143
728
if not opt_no_plugins:
729
from bzrlib.plugin import load_plugins
732
from bzrlib.plugin import disable_plugins
1146
733
disable_plugins()
1150
get_cmd_object('help').run_argv_aliases([])
1153
if argv[0] == '--version':
1154
get_cmd_object('version').run_argv_aliases([])
1157
735
alias_argv = None
1159
737
if not opt_no_aliases:
1160
738
alias_argv = get_alias(argv[0])
740
alias_argv = [a.decode(bzrlib.user_encoding) for a in alias_argv]
1162
741
argv[0] = alias_argv.pop(0)
1164
743
cmd = argv.pop(0)
744
# We want only 'ascii' command names, but the user may have typed
745
# in a Unicode name. In that case, they should just get a
746
# 'command not found' error later.
1165
748
cmd_obj = get_cmd_object(cmd, plugins_override=not opt_builtin)
1167
cmd_obj.l10n = False
1168
749
run = cmd_obj.run_argv_aliases
1169
750
run_argv = [argv, alias_argv]
1172
# We can be called recursively (tests for example), but we don't want
1173
# the verbosity level to propagate.
1174
saved_verbosity_level = option._verbosity_level
1175
option._verbosity_level = 0
1179
'--coverage ignored, because --lsprof is in use.')
1180
754
ret = apply_lsprofiled(opt_lsprof_file, run, *run_argv)
1181
755
elif opt_profile:
1184
'--coverage ignored, because --profile is in use.')
1185
756
ret = apply_profiled(run, *run_argv)
1187
ret = apply_coveraged(run, *run_argv)
1189
758
ret = run(*run_argv)
1192
# reset, in case we may do other commands later within the same
1193
# process. Commands that want to execute sub-commands must propagate
1194
# --verbose in their own way.
1195
if 'memory' in debug.debug_flags:
1196
trace.debug_memory('Process status after command:', short=False)
1197
option._verbosity_level = saved_verbosity_level
1198
# Reset the overrides
1199
cmdline_overrides._reset()
761
# reset, in case we may do other commands later within the same process
762
option._verbosity_level = 0
1202
764
def display_command(func):
1203
765
"""Decorator that suppresses pipe/interrupt errors."""
1219
781
return ignore_pipe
1222
def install_bzr_command_hooks():
1223
"""Install the hooks to supply bzr's own commands."""
1224
if _list_bzr_commands in Command.hooks["list_commands"]:
1226
Command.hooks.install_named_hook("list_commands", _list_bzr_commands,
1228
Command.hooks.install_named_hook("get_command", _get_bzr_command,
1230
Command.hooks.install_named_hook("get_command", _get_plugin_command,
1231
"bzr plugin commands")
1232
Command.hooks.install_named_hook("get_command", _get_external_command,
1233
"bzr external command lookup")
1234
Command.hooks.install_named_hook("get_missing_command",
1235
_try_plugin_provider,
1236
"bzr plugin-provider-db check")
1240
def _specified_or_unicode_argv(argv):
1241
# For internal or testing use, argv can be passed. Otherwise, get it from
1242
# the process arguments in a unicode-safe way.
1244
return osutils.get_unicode_argv()
786
from bzrlib.ui.text import TextUIFactory
787
bzrlib.ui.ui_factory = TextUIFactory()
1247
# ensure all arguments are unicode strings
1249
if not isinstance(a, string_types):
1250
raise ValueError('not native str or unicode: %r' % (a,))
1251
if isinstance(a, bytes):
1252
# For Python 2 only allow ascii native strings
1253
a = a.decode('ascii')
1255
except (ValueError, UnicodeDecodeError):
1256
raise errors.BzrError("argv should be list of unicode strings.")
1260
def main(argv=None):
1261
"""Main entry point of command-line interface.
1263
Typically `breezy.initialize` should be called first.
1265
:param argv: list of unicode command-line arguments similar to sys.argv.
1266
argv[0] is script name usually, it will be ignored.
1267
Don't pass here sys.argv because this list contains plain strings
1268
and not unicode; pass None instead.
1270
:return: exit code of brz command.
1272
if argv is not None:
1274
_register_builtin_commands()
789
argv = [a.decode(bzrlib.user_encoding) for a in argv[1:]]
790
except UnicodeDecodeError:
791
raise errors.BzrError(("Parameter '%r' is unsupported by the current "
1275
793
ret = run_bzr_catch_errors(argv)
1276
794
trace.mutter("return code %d", ret)
1280
798
def run_bzr_catch_errors(argv):
1281
"""Run a bzr command with parameters as described by argv.
1283
This function assumed that that UI layer is setup, that symbol deprecations
1284
are already applied, and that unicode decoding has already been performed on argv.
1286
# done here so that they're covered for every test run
1287
install_bzr_command_hooks()
1288
return exception_to_return_code(run_bzr, argv)
799
# Note: The except clause logic below should be kept in sync with the
800
# profile() routine in lsprof.py.
803
except (KeyboardInterrupt, Exception), e:
804
# used to handle AssertionError and KeyboardInterrupt
805
# specially here, but hopefully they're handled ok by the logger now
806
exitcode = trace.report_exception(sys.exc_info(), sys.stderr)
807
if os.environ.get('BZR_PDB'):
808
print '**** entering debugger'
810
pdb.post_mortem(sys.exc_traceback)
1291
814
def run_bzr_catch_user_errors(argv):
1292
"""Run brz and report user errors, but let internal errors propagate.
815
"""Run bzr and report user errors, but let internal errors propagate.
1294
817
This is used for the test suite, and might be useful for other programs
1295
818
that want to wrap the commandline interface.
1297
# done here so that they're covered for every test run
1298
install_bzr_command_hooks()
1300
821
return run_bzr(argv)
1301
except Exception as e:
1302
823
if (isinstance(e, (OSError, IOError))
1303
824
or not getattr(e, 'internal_error', True)):
1304
825
trace.report_exception(sys.exc_info(), sys.stderr)
added
removed
bzrlib/commands.py
