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(), """
39
from warnings import warn
48
from .hooks import Hooks
49
from .i18n import gettext
54
from bzrlib.hooks import HookPoint, Hooks
50
55
# 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
56
from bzrlib.option import Option
57
from bzrlib import registry
58
from bzrlib.symbol_versioning import (
62
suppress_deprecation_warnings,
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
66
class CommandInfo(object):
87
67
"""Information about a command."""
99
79
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
82
def _get_name(command_name):
164
121
key = self._get_name(command_name)
165
122
registry.Registry.register_lazy(self, key, module_name, command_name,
166
123
info=CommandInfo(aliases))
168
self._alias_dict[a] = key
171
126
plugin_cmds = CommandRegistry()
172
builtin_command_registry = CommandRegistry()
173
plugin_cmds.overridden_registry = builtin_command_registry
176
129
def register_command(cmd, decorate=False):
177
"""Register a plugin command.
179
Should generally be avoided in favor of lazy registration.
181
130
global plugin_cmds
182
131
return plugin_cmds.register(cmd, decorate)
189
138
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()
139
return cmd[4:].replace('_','-')
142
def _builtin_commands():
143
import bzrlib.builtins
144
return _scan_module_for_commands(bzrlib.builtins)
203
147
def _scan_module_for_commands(module):
204
module_dict = module.__dict__
205
for name in module_dict:
149
for name, obj in module.__dict__.iteritems():
206
150
if name.startswith("cmd_"):
207
yield module_dict[name]
151
real_name = _unsquish_command_name(name)
210
156
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.
157
"""Find commands from bzr's core and plugins."""
215
158
# to eliminate duplicates
216
159
names.update(builtin_command_names())
217
160
names.update(plugin_command_names())
244
186
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
189
@deprecated_function(deprecated_in((1, 17, 0)))
190
def get_all_cmds(plugins_override=False):
191
"""Return canonical name and class for most commands.
193
NB: This does not return all commands since the introduction of
194
command hooks, and returning the class is not sufficient to
195
get correctly setup commands, which is why it is deprecated.
197
Use 'all_command_names' + 'get_cmd_object' instead.
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]
199
d = _builtin_commands()
201
d.update(plugin_cmds.iteritems())
202
for k, v in d.iteritems():
293
206
def get_cmd_object(cmd_name, plugins_override=True):
300
213
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):
215
raise errors.BzrCommandError('unknown command "%s"' % cmd_name)
218
def _get_cmd_object(cmd_name, plugins_override=True):
313
219
"""Get a command object.
315
221
:param cmd_name: The name of the command.
316
222
: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
223
:return: A Command object instance
320
224
:raises KeyError: If no command is found.
342
246
# Allow plugins to extend commands
343
247
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
252
def _try_plugin_provider(cmd_name):
355
253
"""Probe for a plugin provider having cmd_name."""
357
255
plugin_metadata, provider = probe_for_provider(cmd_name)
358
raise CommandAvailableInPlugin(cmd_name, plugin_metadata, provider)
359
except NoPluginAvailable:
256
raise errors.CommandAvailableInPlugin(cmd_name,
257
plugin_metadata, provider)
258
except errors.NoPluginAvailable:
371
270
for provider in command_providers_registry:
373
272
return provider.plugin_for_command(cmd_name), provider
374
except NoPluginAvailable:
273
except errors.NoPluginAvailable:
376
raise NoPluginAvailable(cmd_name)
275
raise errors.NoPluginAvailable(cmd_name)
379
278
def _get_bzr_command(cmd_or_None, cmd_name):
380
279
"""Get a command from bzr's core."""
280
cmds = _builtin_commands()
382
cmd_class = builtin_command_registry.get(cmd_name)
282
return cmds[cmd_name]()
285
# look for any command which claims this as an alias
286
for real_cmd_name, cmd_class in cmds.iteritems():
287
if cmd_name in cmd_class.aliases:
387
289
return cmd_or_None
429
331
summary, then a complete description of the command. A grammar
430
332
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
335
Other accepted names for this command.
338
List of argument forms, marked with whether they are optional,
343
['to_location', 'from_branch?', 'file*']
345
'to_location' is required
346
'from_branch' is optional
347
'file' can be specified 0 or more times
350
List of options that may be given for this command. These can
351
be either strings, referring to globally-defined options,
352
or option objects. Retrieve through options().
355
If true, this command isn't advertised. This is typically
448
356
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.)
359
Command objects will get a 'outf' attribute, which has been
360
setup to properly handle encoding of unicode strings.
361
encoding_type determines what will happen when characters cannot
363
strict - abort if we cannot decode
364
replace - put in a bogus character (typically '?')
365
exact - do not encode sys.stdout
367
NOTE: by default on Windows, sys.stdout is opened as a text
368
stream, therefore LF line-endings are converted to CRLF.
369
When a command uses encoding_type = 'exact', then
370
sys.stdout is forced to be a binary stream, and line-endings
469
373
: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"
480
377
takes_options = []
481
378
encoding_type = 'strict'
487
382
def __init__(self):
488
383
"""Construct an instance of this command."""
384
if self.__doc__ == Command.__doc__:
385
warn("No help message set for %r" % self)
489
386
# List of standard options directly supported
490
387
self.supported_std_options = []
388
self._operation = cleanup.OperationWithCleanups(self.run)
493
390
def add_cleanup(self, cleanup_func, *args, **kwargs):
494
391
"""Register a function to call after self.run returns or raises.
507
404
This is useful for releasing expensive or contentious resources (such
508
405
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.
406
resources (such as writing results to self.outf).
513
408
self._operation.cleanup_now()
410
@deprecated_method(deprecated_in((2, 1, 0)))
411
def _maybe_expand_globs(self, file_list):
412
"""Glob expand file_list if the platform does not do that itself.
414
Not used anymore, now that the bzr command-line parser globs on
417
:return: A possibly empty list of unicode paths.
419
Introduced in bzrlib 0.18.
515
423
def _usage(self):
516
424
"""Return single-line grammar for this command.
518
426
Only describes arguments, not options.
520
s = 'brz ' + self.name() + ' '
428
s = 'bzr ' + self.name() + ' '
521
429
for aname in self.takes_args:
522
430
aname = aname.upper()
523
431
if aname[-1] in ['$', '+']:
545
453
usage help (e.g. Purpose, Usage, Options) with a
546
454
message explaining how to obtain full help.
549
i18n.install() # Install i18n only for get_help_text for now.
550
456
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.")
458
raise NotImplementedError("sorry, no detailed help yet for %r" % self.name())
561
460
# Extract the summary (purpose) and sections out from the text
562
purpose, sections, order = self._get_help_parts(doc)
461
purpose,sections,order = self._get_help_parts(doc)
564
463
# If a custom usage section was provided, use it
565
if 'Usage' in sections:
464
if sections.has_key('Usage'):
566
465
usage = sections.pop('Usage')
568
467
usage = self._usage()
570
469
# The header is the purpose and usage
572
result += gettext(':Purpose: %s\n') % (purpose,)
471
result += ':Purpose: %s\n' % purpose
573
472
if usage.find('\n') >= 0:
574
result += gettext(':Usage:\n%s\n') % (usage,)
473
result += ':Usage:\n%s\n' % usage
576
result += gettext(':Usage: %s\n') % (usage,)
475
result += ':Usage: %s\n' % usage
579
478
# Add the options
581
480
# XXX: optparse implicitly rewraps the help, and not always perfectly,
582
481
# 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:
483
options = option.get_optparser(self.options()).format_option_help()
484
# XXX: According to the spec, ReST option lists actually don't support
485
# options like --1.9 so that causes syntax errors (in Sphinx at least).
486
# As that pattern always appears in the commands that break, we trap
487
# on that and then format that block of 'format' options as a literal
489
if not plain and options.find(' --1.9 ') != -1:
593
490
options = options.replace(' format:\n', ' format::\n\n', 1)
594
491
if options.startswith('Options:'):
595
result += gettext(':Options:%s') % (options[len('options:'):],)
492
result += ':' + options
493
elif options.startswith('options:'):
494
# Python 2.4 version of optparse
495
result += ':Options:' + options[len('options:'):]
597
497
result += options
601
501
# Add the description, indenting it 2 spaces
602
502
# to match the indentation of the options
503
if sections.has_key(None):
604
504
text = sections.pop(None)
605
505
text = '\n '.join(text.splitlines())
606
result += gettext(':Description:\n %s\n\n') % (text,)
506
result += ':%s:\n %s\n\n' % ('Description',text)
608
508
# Add the custom sections (e.g. Examples). Note that there's no need
609
509
# to indent these as they must be indented already in the source.
611
511
for label in order:
612
if label in sections:
613
result += ':%s:\n%s\n' % (label, sections[label])
512
if sections.has_key(label):
513
result += ':%s:\n%s\n' % (label,sections[label])
616
result += (gettext("See brz help %s for more details and examples.\n\n")
516
result += ("See bzr help %s for more details and examples.\n\n"
619
519
# Add the aliases, source (plug-in) and see also links, if any
621
result += gettext(':Aliases: ')
521
result += ':Aliases: '
622
522
result += ', '.join(self.aliases) + '\n'
623
523
plugin_name = self.plugin_name()
624
524
if plugin_name is not None:
625
result += gettext(':From: plugin "%s"\n') % plugin_name
525
result += ':From: plugin "%s"\n' % plugin_name
626
526
see_also = self.get_see_also(additional_see_also)
628
528
if not plain and see_also_as_links:
634
534
see_also_links.append(item)
636
536
# Use a Sphinx link for this entry
637
link_text = gettext(":doc:`{0} <{1}-help>`").format(
537
link_text = ":doc:`%s <%s-help>`" % (item, item)
639
538
see_also_links.append(link_text)
640
539
see_also = see_also_links
641
result += gettext(':See also: %s') % ', '.join(see_also) + '\n'
540
result += ':See also: '
541
result += ', '.join(see_also) + '\n'
643
543
# If this will be rendered as plain text, convert it
645
import breezy.help_topics
646
result = breezy.help_topics.help_as_plain_text(result)
545
import bzrlib.help_topics
546
result = bzrlib.help_topics.help_as_plain_text(result)
670
570
summary = lines.pop(0)
673
label, section = None, ''
573
label,section = None,''
674
574
for line in lines:
675
575
if line.startswith(':') and line.endswith(':') and len(line) > 2:
676
576
save_section(sections, order, label, section)
677
label, section = line[1:-1], ''
577
label,section = line[1:-1],''
678
578
elif (label is not None) and len(line) > 1 and not line[0].isspace():
679
579
save_section(sections, order, label, section)
680
label, section = None, line
580
label,section = None,line
682
582
if len(section) > 0:
683
583
section += '\n' + line
725
625
def run_argv_aliases(self, argv, alias_argv=None):
726
626
"""Parse the command line and run with extra aliases in alias_argv."""
628
warn("Passing None for [] is deprecated from bzrlib 0.10",
629
DeprecationWarning, stacklevel=2)
727
631
args, opts = parse_args(self, argv, alias_argv)
730
633
# Process the standard options
731
if 'help' in opts: # e.g. brz add --help
732
self.outf.write(self.get_help_text())
634
if 'help' in opts: # e.g. bzr add --help
635
sys.stdout.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))
637
if 'usage' in opts: # e.g. bzr add --usage
638
sys.stdout.write(self.get_help_text(verbose=False))
737
640
trace.set_verbosity_level(option._verbosity_level)
738
641
if 'verbose' in self.supported_std_options:
739
642
opts['verbose'] = trace.is_verbose()
740
elif 'verbose' in opts:
643
elif opts.has_key('verbose'):
741
644
del opts['verbose']
742
645
if 'quiet' in self.supported_std_options:
743
646
opts['quiet'] = trace.is_quiet()
744
elif 'quiet' in opts:
647
elif opts.has_key('quiet'):
745
648
del opts['quiet']
746
650
# mix arguments and options into one dictionary
747
651
cmdargs = _match_argform(self.name(), self.takes_args, args)
752
656
all_cmd_args = cmdargs.copy()
753
657
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']:
661
return self.run_direct(**all_cmd_args)
663
def run_direct(self, *args, **kwargs):
664
"""Call run directly with objects (without parsing an argv list)."""
665
return self._operation.run_simple(*args, **kwargs)
788
668
"""Actually run the command.
793
673
Return 0 or None if the command was successful, or a non-zero
794
674
shell error code if not. It's OK for this method to allow
795
675
an exception to raise up.
797
This method is automatically wrapped by Command.__init__ with a
798
cleanup operation, stored as self._operation. This can be used
799
via self.add_cleanup to perform automatic cleanups at the end of
802
The argument for run are assembled by introspection. So for instance,
803
if your command takes an argument files, you would declare::
805
def run(self, files=None):
808
677
raise NotImplementedError('no implementation of command %r'
847
708
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',
712
self.create_hook(HookPoint('extend_command',
852
713
"Called after creating a command object to allow modifications "
853
714
"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',
715
"new bzrlib.commands.Command object.", (1, 13), None))
716
self.create_hook(HookPoint('get_command',
856
717
"Called when creating a single command. Called with "
857
718
"(cmd_or_None, command_name). get_command should either return "
858
719
"the cmd_or_None parameter, or a replacement Command object that "
859
720
"should be used for the command. Note that the Command.hooks "
860
721
"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',
722
"bzrlib.commands.register_command or plugin_cmds.register_lazy.",
724
self.create_hook(HookPoint('get_missing_command',
864
725
"Called when creating a single command if no command could be "
865
726
"found. Called with (command_name). get_missing_command should "
866
727
"either return None, or a Command object to be used for the "
868
self.add_hook('list_commands',
728
"command.", (1, 17), None))
729
self.create_hook(HookPoint('list_commands',
869
730
"Called when enumerating commands. Called with a set of "
870
731
"cmd_name strings for all the commands found so far. This set "
871
732
" is safe to mutate - e.g. to remove a command. "
872
733
"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
736
Command.hooks = CommandHooks()
899
# for python 2.5 and later, optparse raises this exception if a non-ascii
900
# option name is given. See http://bugs.python.org/issue2931
902
options, args = parser.parse_args(args)
903
except UnicodeEncodeError as e:
904
raise errors.BzrCommandError(
905
gettext('Only ASCII permitted in option names'))
907
opts = dict((k, v) for k, v in options.__dict__.items() if
908
v is not option.OptionParser.DEFAULT_VALUE)
754
options, args = parser.parse_args(args)
755
opts = dict([(k, v) for k, v in options.__dict__.iteritems() if
756
v is not option.OptionParser.DEFAULT_VALUE])
909
757
return args, opts
926
774
argdict[argname + '_list'] = None
927
775
elif ap[-1] == '+':
929
raise errors.BzrCommandError(gettext(
930
"command {0!r} needs one or more {1}").format(
931
cmd, argname.upper()))
777
raise errors.BzrCommandError("command %r needs one or more %s"
778
% (cmd, argname.upper()))
933
780
argdict[argname + '_list'] = args[:]
935
782
elif ap[-1] == '$': # all but one
936
783
if len(args) < 2:
937
raise errors.BzrCommandError(
938
gettext("command {0!r} needs one or more {1}").format(
939
cmd, argname.upper()))
784
raise errors.BzrCommandError("command %r needs one or more %s"
785
% (cmd, argname.upper()))
940
786
argdict[argname + '_list'] = args[:-1]
943
789
# just a plain arg
946
raise errors.BzrCommandError(
947
gettext("command {0!r} requires argument {1}").format(
948
cmd, argname.upper()))
792
raise errors.BzrCommandError("command %r requires argument %s"
793
% (cmd, argname.upper()))
950
795
argdict[argname] = args.pop(0)
953
raise errors.BzrCommandError( gettext(
954
"extra argument to command {0}: {1}").format(
798
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
803
def apply_coveraged(dirname, the_callable, *args, **kwargs):
804
# Cannot use "import trace", as that would import bzrlib.trace instead of
805
# the standard library's trace.
806
trace = __import__('trace')
808
tracer = trace.Trace(count=1, trace=0)
809
sys.settrace(tracer.globaltrace)
810
threading.settrace(tracer.globaltrace)
966
813
return exception_to_return_code(the_callable, *args, **kwargs)
816
results = tracer.results()
817
results.write_results(show_missing=1, summary=False,
972
821
def apply_profiled(the_callable, *args, **kwargs):
1004
853
return the_callable(*args, **kwargs)
1005
except (KeyboardInterrupt, Exception) as e:
854
except (KeyboardInterrupt, Exception), e:
1006
855
# used to handle AssertionError and KeyboardInterrupt
1007
856
# specially here, but hopefully they're handled ok by the logger now
1008
857
exc_info = sys.exc_info()
1009
858
exitcode = trace.report_exception(exc_info, sys.stderr)
1010
if os.environ.get('BRZ_PDB'):
1011
print('**** entering debugger')
859
if os.environ.get('BZR_PDB'):
860
print '**** entering debugger'
1013
pdb.post_mortem(exc_info[2])
863
if sys.version_info[:2] < (2, 6):
865
# pdb.post_mortem(tb)
866
# but because pdb.post_mortem gives bad results for tracebacks
867
# from inside generators, we do it manually.
868
# (http://bugs.python.org/issue4150, fixed in Python 2.6)
870
# Setup pdb on the traceback
873
p.setup(tb.tb_frame, tb)
874
# Point the debugger at the deepest frame of the stack
875
p.curindex = len(p.stack) - 1
876
p.curframe = p.stack[p.curindex][0]
877
# Start the pdb prompt.
878
p.print_stack_entry(p.stack[p.curindex])
1017
886
def apply_lsprofiled(filename, the_callable, *args, **kwargs):
1018
from breezy.lsprof import profile
1019
ret, stats = profile(exception_to_return_code, the_callable,
887
from bzrlib.lsprof import profile
888
ret, stats = profile(exception_to_return_code, the_callable, *args, **kwargs)
1022
890
if filename is None:
1025
893
stats.save(filename)
1026
trace.note(gettext('Profile data written to "%s".'), filename)
894
trace.note('Profile data written to "%s".', filename)
898
def shlex_split_unicode(unsplit):
900
return [u.decode('utf-8') for u in shlex.split(unsplit.encode('utf-8'))]
1030
903
def get_alias(cmd, config=None):
1031
904
"""Return an expanded alias, or None if no alias exists.
1038
911
If it is unspecified, the global config will be used.
1040
913
if config is None:
1041
import breezy.config
1042
config = breezy.config.GlobalConfig()
915
config = bzrlib.config.GlobalConfig()
1043
916
alias = config.get_alias(cmd)
1045
return cmdline.split(alias)
918
return shlex_split_unicode(alias)
1049
def run_bzr(argv, load_plugins=load_plugins, disable_plugins=disable_plugins):
1050
923
"""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.
926
The command-line arguments, without the program name from argv[0]
927
These should already be decoded. All library/test code calling
928
run_bzr should be passing valid strings (don't need decoding).
930
Returns a command status or raises an exception.
1065
932
Special master options: these must come before the command because
1066
933
they control how the command is interpreted.
1082
949
Run under the Python lsprof profiler.
1085
Generate code coverage report
952
Generate line coverage report in the specified directory.
1088
955
Specify the number of processes that can be run concurrently (selftest).
1090
trace.mutter("breezy version: " + breezy.__version__)
1091
argv = _specified_or_unicode_argv(argv)
1092
trace.mutter("brz arguments: %r", argv)
957
trace.mutter("bazaar version: " + bzrlib.__version__)
959
trace.mutter("bzr arguments: %r", argv)
1094
opt_lsprof = opt_profile = opt_no_plugins = opt_builtin = \
1095
opt_coverage = opt_no_l10n = opt_no_aliases = False
1096
opt_lsprof_file = None
961
opt_lsprof = opt_profile = opt_no_plugins = opt_builtin = \
962
opt_no_aliases = False
963
opt_lsprof_file = opt_coverage_dir = None
1098
965
# --no-plugins is handled specially at a very early stage. We need
1099
966
# to load plugins before doing other command parsing so that they
1116
982
opt_no_plugins = True
1117
983
elif a == '--no-aliases':
1118
984
opt_no_aliases = True
1119
elif a == '--no-l10n':
1121
985
elif a == '--builtin':
1122
986
opt_builtin = True
1123
987
elif a == '--concurrency':
1124
os.environ['BRZ_CONCURRENCY'] = argv[i + 1]
988
os.environ['BZR_CONCURRENCY'] = argv[i + 1]
1126
990
elif a == '--coverage':
1128
elif a == '--profile-imports':
1129
pass # already handled in startup script Bug #588277
991
opt_coverage_dir = argv[i + 1]
1130
993
elif a.startswith('-D'):
1131
994
debug.debug_flags.add(a[2:])
1132
elif a.startswith('-O'):
1133
override_config.append(a[2:])
1135
996
argv_copy.append(a)
1138
cmdline_overrides = breezy.get_global_state().cmdline_overrides
1139
cmdline_overrides._from_cmdline(override_config)
1141
999
debug.set_debug_flags_from_config()
1003
from bzrlib.builtins import cmd_help
1004
cmd_help().run_argv_aliases([])
1007
if argv[0] == '--version':
1008
from bzrlib.builtins import cmd_version
1009
cmd_version().run_argv_aliases([])
1143
1012
if not opt_no_plugins:
1013
from bzrlib.plugin import load_plugins
1016
from bzrlib.plugin import disable_plugins
1146
1017
disable_plugins()
1150
get_cmd_object('help').run_argv_aliases([])
1153
if argv[0] == '--version':
1154
get_cmd_object('version').run_argv_aliases([])
1157
1019
alias_argv = None
1159
1021
if not opt_no_aliases:
1160
1022
alias_argv = get_alias(argv[0])
1024
user_encoding = osutils.get_user_encoding()
1025
alias_argv = [a.decode(user_encoding) for a in alias_argv]
1162
1026
argv[0] = alias_argv.pop(0)
1164
1028
cmd = argv.pop(0)
1029
# We want only 'ascii' command names, but the user may have typed
1030
# in a Unicode name. In that case, they should just get a
1031
# 'command not found' error later.
1165
1033
cmd_obj = get_cmd_object(cmd, plugins_override=not opt_builtin)
1167
cmd_obj.l10n = False
1168
1034
run = cmd_obj.run_argv_aliases
1169
1035
run_argv = [argv, alias_argv]
1174
1040
saved_verbosity_level = option._verbosity_level
1175
1041
option._verbosity_level = 0
1043
if opt_coverage_dir:
1179
1045
'--coverage ignored, because --lsprof is in use.')
1180
1046
ret = apply_lsprofiled(opt_lsprof_file, run, *run_argv)
1181
1047
elif opt_profile:
1048
if opt_coverage_dir:
1184
1050
'--coverage ignored, because --profile is in use.')
1185
1051
ret = apply_profiled(run, *run_argv)
1187
ret = apply_coveraged(run, *run_argv)
1052
elif opt_coverage_dir:
1053
ret = apply_coveraged(opt_coverage_dir, run, *run_argv)
1189
1055
ret = run(*run_argv)
1190
1056
return ret or 0
1231
1095
"bzr plugin commands")
1232
1096
Command.hooks.install_named_hook("get_command", _get_external_command,
1233
1097
"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()
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.")
1098
Command.hooks.install_named_hook("get_missing_command", _try_plugin_provider,
1099
"bzr plugin-provider-db check")
1260
1102
def main(argv=None):
1261
1103
"""Main entry point of command-line interface.
1263
Typically `breezy.initialize` should be called first.
1265
1105
:param argv: list of unicode command-line arguments similar to sys.argv.
1266
1106
argv[0] is script name usually, it will be ignored.
1267
1107
Don't pass here sys.argv because this list contains plain strings
1268
1108
and not unicode; pass None instead.
1270
:return: exit code of brz command.
1110
:return: exit code of bzr command.
1272
if argv is not None:
1274
_register_builtin_commands()
1113
bzrlib.ui.ui_factory = bzrlib.ui.make_ui_for_terminal(
1114
sys.stdin, sys.stdout, sys.stderr)
1116
# Is this a final release version? If so, we should suppress warnings
1117
if bzrlib.version_info[3] == 'final':
1118
suppress_deprecation_warnings(override=True)
1120
argv = osutils.get_unicode_argv()
1124
# ensure all arguments are unicode strings
1126
if isinstance(a, unicode):
1129
new_argv.append(a.decode('ascii'))
1130
except UnicodeDecodeError:
1131
raise errors.BzrError("argv should be list of unicode strings.")
1275
1133
ret = run_bzr_catch_errors(argv)
1134
bzrlib.ui.ui_factory.log_transport_activity(
1135
display=('bytes' in debug.debug_flags))
1276
1136
trace.mutter("return code %d", ret)
1137
osutils.report_extension_load_failures()
1283
1144
This function assumed that that UI layer is setup, that symbol deprecations
1284
1145
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
1147
install_bzr_command_hooks()
1288
1148
return exception_to_return_code(run_bzr, argv)
1291
1151
def run_bzr_catch_user_errors(argv):
1292
"""Run brz and report user errors, but let internal errors propagate.
1152
"""Run bzr and report user errors, but let internal errors propagate.
1294
1154
This is used for the test suite, and might be useful for other programs
1295
1155
that want to wrap the commandline interface.
1297
# done here so that they're covered for every test run
1298
1157
install_bzr_command_hooks()
1300
1159
return run_bzr(argv)
1301
except Exception as e:
1160
except Exception, e:
1302
1161
if (isinstance(e, (OSError, IOError))
1303
1162
or not getattr(e, 'internal_error', True)):
1304
1163
trace.report_exception(sys.exc_info(), sys.stderr)
1333
1192
class Provider(object):
1334
"""Generic class to be overriden by plugins"""
1193
'''Generic class to be overriden by plugins'''
1336
1195
def plugin_for_command(self, cmd_name):
1337
"""Takes a command and returns the information for that plugin
1196
'''Takes a command and returns the information for that plugin
1339
1198
:return: A dictionary with all the available information
1340
for the requested plugin
1199
for the requested plugin
1342
1201
raise NotImplementedError
1345
1204
class ProvidersRegistry(registry.Registry):
1346
"""This registry exists to allow other providers to exist"""
1205
'''This registry exists to allow other providers to exist'''
1348
1207
def __iter__(self):
1349
for key, provider in self.items():
1208
for key, provider in self.iteritems():
1352
1211
command_providers_registry = ProvidersRegistry()
1214
if __name__ == '__main__':
1215
sys.exit(main(sys.argv))
added
removed
bzrlib/commands.py
