35
from .lazy_import import lazy_import
28
from bzrlib.lazy_import import lazy_import
36
29
lazy_import(globals(), """
33
from warnings import warn
49
from .hooks import Hooks
50
from .i18n import gettext
49
from bzrlib.hooks import HookPoint, Hooks
51
50
# Compatibility - Option used to be in commands.
52
from .option import Option
53
from .plugin import disable_plugins, load_plugins, plugin_name
54
from . import errors, registry
51
from bzrlib.option import Option
52
from bzrlib.plugin import disable_plugins, load_plugins
53
from bzrlib import registry
54
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
61
class CommandInfo(object):
87
62
"""Information about a command."""
189
164
def _unsquish_command_name(cmd):
190
return cmd[4:].replace('_', '-')
165
return cmd[4:].replace('_','-')
168
@deprecated_function(deprecated_in((2, 2, 0)))
169
def _builtin_commands():
170
"""Return a dict of {name: cmd_class} for builtin commands.
172
:deprecated: Use the builtin_command_registry registry instead
174
# return dict(name: cmd_class)
175
return dict(builtin_command_registry.items())
193
178
def _register_builtin_commands():
194
179
if builtin_command_registry.keys():
197
import breezy.builtins
198
for cmd_class in _scan_module_for_commands(breezy.builtins):
182
import bzrlib.builtins
183
for cmd_class in _scan_module_for_commands(bzrlib.builtins).values():
199
184
builtin_command_registry.register(cmd_class)
200
breezy.builtins._register_lazy_builtins()
185
bzrlib.builtins._register_lazy_builtins()
203
188
def _scan_module_for_commands(module):
204
module_dict = module.__dict__
205
for name in module_dict:
190
for name, obj in module.__dict__.iteritems():
206
191
if name.startswith("cmd_"):
207
yield module_dict[name]
192
real_name = _unsquish_command_name(name)
210
197
def _list_bzr_commands(names):
211
198
"""Find commands from bzr's core and plugins.
213
This is not the public interface, just the default hook called by
200
This is not the public interface, just the default hook called by all_command_names.
216
202
# to eliminate duplicates
217
203
names.update(builtin_command_names())
245
230
return plugin_cmds.keys()
248
# Overrides for common mispellings that heuristics get wrong
250
'ic': {'ci': 0}, # heuristic finds nick
254
def guess_command(cmd_name):
255
"""Guess what command a user typoed.
257
:param cmd_name: Command to search for
258
:return: None if no command was found, name of a command otherwise
261
for name in all_command_names():
263
cmd = get_cmd_object(name)
264
names.update(cmd.aliases)
265
# candidate: modified levenshtein distance against cmd_name.
268
for name in sorted(names):
269
matcher = patiencediff.PatienceSequenceMatcher(None, cmd_name, name)
271
opcodes = matcher.get_opcodes()
272
for opcode, l1, l2, r1, r2 in opcodes:
273
if opcode == 'delete':
275
elif opcode == 'replace':
276
distance += max(l2 - l1, r2 - l1)
277
elif opcode == 'insert':
279
elif opcode == 'equal':
280
# Score equal ranges lower, making similar commands of equal
281
# length closer than arbitrary same length commands.
282
distance -= 0.1 * (l2 - l1)
283
costs[name] = distance
284
costs.update(_GUESS_OVERRIDES.get(cmd_name, {}))
285
costs = sorted((costs[key], key) for key in costs)
290
candidate = costs[0][1]
294
233
def get_cmd_object(cmd_name, plugins_override=True):
295
234
"""Return the command object for a command.
301
240
return _get_cmd_object(cmd_name, plugins_override)
303
# No command found, see if this was a typo
304
candidate = guess_command(cmd_name)
305
if candidate is not None:
306
raise errors.BzrCommandError(
307
gettext('unknown command "%s". Perhaps you meant "%s"')
308
% (cmd_name, candidate))
309
raise errors.BzrCommandError(gettext('unknown command "%s"')
242
raise errors.BzrCommandError('unknown command "%s"' % cmd_name)
313
245
def _get_cmd_object(cmd_name, plugins_override=True, check_missing=True):
343
275
# Allow plugins to extend commands
344
276
for hook in Command.hooks['extend_command']:
346
if getattr(cmd, 'invoked_as', None) is None:
347
cmd.invoked_as = cmd_name
351
class NoPluginAvailable(errors.BzrError):
355
281
def _try_plugin_provider(cmd_name):
356
282
"""Probe for a plugin provider having cmd_name."""
358
284
plugin_metadata, provider = probe_for_provider(cmd_name)
359
raise CommandAvailableInPlugin(cmd_name, plugin_metadata, provider)
360
except NoPluginAvailable:
285
raise errors.CommandAvailableInPlugin(cmd_name,
286
plugin_metadata, provider)
287
except errors.NoPluginAvailable:
430
357
summary, then a complete description of the command. A grammar
431
358
description will be inserted.
433
:cvar aliases: Other accepted names for this command.
435
:cvar takes_args: List of argument forms, marked with whether they are
436
optional, repeated, etc. Examples::
438
['to_location', 'from_branch?', 'file*']
440
* 'to_location' is required
441
* 'from_branch' is optional
442
* 'file' can be specified 0 or more times
444
:cvar takes_options: List of options that may be given for this command.
445
These can be either strings, referring to globally-defined options, or
446
option objects. Retrieve through options().
448
:cvar hidden: If true, this command isn't advertised. This is typically
361
Other accepted names for this command.
364
List of argument forms, marked with whether they are optional,
369
['to_location', 'from_branch?', 'file*']
371
'to_location' is required
372
'from_branch' is optional
373
'file' can be specified 0 or more times
376
List of options that may be given for this command. These can
377
be either strings, referring to globally-defined options,
378
or option objects. Retrieve through options().
381
If true, this command isn't advertised. This is typically
449
382
for commands intended for expert users.
451
:cvar encoding_type: Command objects will get a 'outf' attribute, which has
452
been setup to properly handle encoding of unicode strings.
453
encoding_type determines what will happen when characters cannot be
456
* strict - abort if we cannot decode
457
* replace - put in a bogus character (typically '?')
458
* exact - do not encode sys.stdout
460
NOTE: by default on Windows, sys.stdout is opened as a text stream,
461
therefore LF line-endings are converted to CRLF. When a command uses
462
encoding_type = 'exact', then sys.stdout is forced to be a binary
463
stream, and line-endings will not mangled.
466
A string indicating the real name under which this command was
467
invoked, before expansion of aliases.
468
(This may be None if the command was constructed and run in-process.)
385
Command objects will get a 'outf' attribute, which has been
386
setup to properly handle encoding of unicode strings.
387
encoding_type determines what will happen when characters cannot
389
strict - abort if we cannot decode
390
replace - put in a bogus character (typically '?')
391
exact - do not encode sys.stdout
393
NOTE: by default on Windows, sys.stdout is opened as a text
394
stream, therefore LF line-endings are converted to CRLF.
395
When a command uses encoding_type = 'exact', then
396
sys.stdout is forced to be a binary stream, and line-endings
470
399
:cvar hooks: An instance of CommandHooks.
472
:cvar __doc__: The help shown by 'brz help command' for this command.
400
:ivar __doc__: The help shown by 'bzr help command' for this command.
473
401
This is set by assigning explicitly to __doc__ so that -OO can
477
__doc__ = "My help goes here"
405
__doc__ = "My help goes here"
481
409
takes_options = []
482
410
encoding_type = 'strict'
511
437
as it releases all resources, this may release locks that the command
512
438
wants to hold, so use should be done with care.
514
self._exit_stack.close()
516
def enter_context(self, cm):
517
return self._exit_stack.enter_context(cm)
440
self._operation.cleanup_now()
442
@deprecated_method(deprecated_in((2, 1, 0)))
443
def _maybe_expand_globs(self, file_list):
444
"""Glob expand file_list if the platform does not do that itself.
446
Not used anymore, now that the bzr command-line parser globs on
449
:return: A possibly empty list of unicode paths.
451
Introduced in bzrlib 0.18.
519
455
def _usage(self):
520
456
"""Return single-line grammar for this command.
522
458
Only describes arguments, not options.
524
s = 'brz ' + self.name() + ' '
460
s = 'bzr ' + self.name() + ' '
525
461
for aname in self.takes_args:
526
462
aname = aname.upper()
527
463
if aname[-1] in ['$', '+']:
549
485
usage help (e.g. Purpose, Usage, Options) with a
550
486
message explaining how to obtain full help.
553
i18n.install() # Install i18n only for get_help_text for now.
554
488
doc = self.help()
556
# Note: If self.gettext() translates ':Usage:\n', the section will
557
# be shown after "Description" section and we don't want to
558
# translate the usage string.
559
# Though, brz export-pot don't exports :Usage: section and it must
561
doc = self.gettext(doc)
563
doc = gettext("No help for this command.")
490
doc = "No help for this command."
565
492
# Extract the summary (purpose) and sections out from the text
566
purpose, sections, order = self._get_help_parts(doc)
493
purpose,sections,order = self._get_help_parts(doc)
568
495
# If a custom usage section was provided, use it
569
if 'Usage' in sections:
496
if sections.has_key('Usage'):
570
497
usage = sections.pop('Usage')
572
499
usage = self._usage()
574
501
# The header is the purpose and usage
576
result += gettext(':Purpose: %s\n') % (purpose,)
503
result += ':Purpose: %s\n' % purpose
577
504
if usage.find('\n') >= 0:
578
result += gettext(':Usage:\n%s\n') % (usage,)
505
result += ':Usage:\n%s\n' % usage
580
result += gettext(':Usage: %s\n') % (usage,)
507
result += ':Usage: %s\n' % usage
583
510
# Add the options
585
512
# XXX: optparse implicitly rewraps the help, and not always perfectly,
586
513
# so we get <https://bugs.launchpad.net/bzr/+bug/249908>. -- mbp
588
parser = option.get_optparser(
589
[v for k, v in sorted(self.options().items())])
590
options = parser.format_option_help()
591
# FIXME: According to the spec, ReST option lists actually don't
592
# support options like --1.14 so that causes syntax errors (in Sphinx
593
# at least). As that pattern always appears in the commands that
594
# break, we trap on that and then format that block of 'format' options
595
# as a literal block. We use the most recent format still listed so we
596
# don't have to do that too often -- vila 20110514
597
if not plain and options.find(' --1.14 ') != -1:
515
options = option.get_optparser(self.options()).format_option_help()
516
# XXX: According to the spec, ReST option lists actually don't support
517
# options like --1.9 so that causes syntax errors (in Sphinx at least).
518
# As that pattern always appears in the commands that break, we trap
519
# on that and then format that block of 'format' options as a literal
521
if not plain and options.find(' --1.9 ') != -1:
598
522
options = options.replace(' format:\n', ' format::\n\n', 1)
599
523
if options.startswith('Options:'):
600
result += gettext(':Options:%s') % (options[len('options:'):],)
524
result += ':' + options
525
elif options.startswith('options:'):
526
# Python 2.4 version of optparse
527
result += ':Options:' + options[len('options:'):]
602
529
result += options
606
533
# Add the description, indenting it 2 spaces
607
534
# to match the indentation of the options
535
if sections.has_key(None):
609
536
text = sections.pop(None)
610
537
text = '\n '.join(text.splitlines())
611
result += gettext(':Description:\n %s\n\n') % (text,)
538
result += ':%s:\n %s\n\n' % ('Description',text)
613
540
# Add the custom sections (e.g. Examples). Note that there's no need
614
541
# to indent these as they must be indented already in the source.
616
543
for label in order:
617
if label in sections:
618
result += ':%s:\n%s\n' % (label, sections[label])
544
if sections.has_key(label):
545
result += ':%s:\n%s\n' % (label,sections[label])
621
result += (gettext("See brz help %s for more details and examples.\n\n")
548
result += ("See bzr help %s for more details and examples.\n\n"
624
551
# Add the aliases, source (plug-in) and see also links, if any
626
result += gettext(':Aliases: ')
553
result += ':Aliases: '
627
554
result += ', '.join(self.aliases) + '\n'
628
555
plugin_name = self.plugin_name()
629
556
if plugin_name is not None:
630
result += gettext(':From: plugin "%s"\n') % plugin_name
557
result += ':From: plugin "%s"\n' % plugin_name
631
558
see_also = self.get_see_also(additional_see_also)
633
560
if not plain and see_also_as_links:
639
566
see_also_links.append(item)
641
568
# Use a Sphinx link for this entry
642
link_text = gettext(":doc:`{0} <{1}-help>`").format(
569
link_text = ":doc:`%s <%s-help>`" % (item, item)
644
570
see_also_links.append(link_text)
645
571
see_also = see_also_links
646
result += gettext(':See also: %s') % ', '.join(see_also) + '\n'
572
result += ':See also: '
573
result += ', '.join(see_also) + '\n'
648
575
# If this will be rendered as plain text, convert it
650
import breezy.help_topics
651
result = breezy.help_topics.help_as_plain_text(result)
577
import bzrlib.help_topics
578
result = bzrlib.help_topics.help_as_plain_text(result)
675
602
summary = lines.pop(0)
678
label, section = None, ''
605
label,section = None,''
679
606
for line in lines:
680
607
if line.startswith(':') and line.endswith(':') and len(line) > 2:
681
608
save_section(sections, order, label, section)
682
label, section = line[1:-1], ''
683
elif (label is not None and len(line) > 1 and
684
not line[0].isspace()):
609
label,section = line[1:-1],''
610
elif (label is not None) and len(line) > 1 and not line[0].isspace():
685
611
save_section(sections, order, label, section)
686
label, section = None, line
612
label,section = None,line
688
614
if len(section) > 0:
689
615
section += '\n' + line
731
657
def run_argv_aliases(self, argv, alias_argv=None):
732
658
"""Parse the command line and run with extra aliases in alias_argv."""
733
659
args, opts = parse_args(self, argv, alias_argv)
736
661
# Process the standard options
737
if 'help' in opts: # e.g. brz add --help
738
self.outf.write(self.get_help_text())
662
if 'help' in opts: # e.g. bzr add --help
663
sys.stdout.write(self.get_help_text())
740
if 'usage' in opts: # e.g. brz add --usage
741
self.outf.write(self.get_help_text(verbose=False))
665
if 'usage' in opts: # e.g. bzr add --usage
666
sys.stdout.write(self.get_help_text(verbose=False))
743
668
trace.set_verbosity_level(option._verbosity_level)
744
669
if 'verbose' in self.supported_std_options:
745
670
opts['verbose'] = trace.is_verbose()
746
elif 'verbose' in opts:
671
elif opts.has_key('verbose'):
747
672
del opts['verbose']
748
673
if 'quiet' in self.supported_std_options:
749
674
opts['quiet'] = trace.is_quiet()
750
elif 'quiet' in opts:
675
elif opts.has_key('quiet'):
751
676
del opts['quiet']
752
678
# mix arguments and options into one dictionary
753
679
cmdargs = _match_argform(self.name(), self.takes_args, args)
758
684
all_cmd_args = cmdargs.copy()
759
685
all_cmd_args.update(cmdopts)
762
return self.run(**all_cmd_args)
764
# reset it, so that other commands run in the same process won't
765
# inherit state. Before we reset it, log any activity, so that it
766
# gets properly tracked.
767
ui.ui_factory.log_transport_activity(
768
display=('bytes' in debug.debug_flags))
769
trace.set_verbosity_level(0)
689
return self.run(**all_cmd_args)
771
691
def _setup_run(self):
772
692
"""Wrap the defined run method on self with a cleanup.
778
698
you can override this method.
780
700
class_run = self.run
782
701
def run(*args, **kwargs):
783
for hook in Command.hooks['pre_command']:
702
self._operation = cleanup.OperationWithCleanups(class_run)
786
with cleanup.ExitStack() as self._exit_stack:
787
return class_run(*args, **kwargs)
704
return self._operation.run_simple(*args, **kwargs)
789
for hook in Command.hooks['post_command']:
709
@deprecated_method(deprecated_in((2, 2, 0)))
710
def run_direct(self, *args, **kwargs):
711
"""Deprecated thunk from bzrlib 2.1."""
712
return self.run(*args, **kwargs)
794
715
"""Actually run the command.
853
766
These are all empty initially, because by default nothing should get
856
Hooks.__init__(self, "breezy.commands", "Command.hooks")
770
self.create_hook(HookPoint('extend_command',
859
771
"Called after creating a command object to allow modifications "
860
772
"such as adding or removing options, docs etc. Called with the "
861
"new breezy.commands.Command object.", (1, 13))
773
"new bzrlib.commands.Command object.", (1, 13), None))
774
self.create_hook(HookPoint('get_command',
864
775
"Called when creating a single command. Called with "
865
776
"(cmd_or_None, command_name). get_command should either return "
866
777
"the cmd_or_None parameter, or a replacement Command object that "
867
778
"should be used for the command. Note that the Command.hooks "
868
779
"hooks are core infrastructure. Many users will prefer to use "
869
"breezy.commands.register_command or plugin_cmds.register_lazy.",
872
'get_missing_command',
780
"bzrlib.commands.register_command or plugin_cmds.register_lazy.",
782
self.create_hook(HookPoint('get_missing_command',
873
783
"Called when creating a single command if no command could be "
874
784
"found. Called with (command_name). get_missing_command should "
875
785
"either return None, or a Command object to be used for the "
786
"command.", (1, 17), None))
787
self.create_hook(HookPoint('list_commands',
879
788
"Called when enumerating commands. Called with a set of "
880
789
"cmd_name strings for all the commands found so far. This set "
881
790
" is safe to mutate - e.g. to remove a command. "
882
791
"list_commands should return the updated set of command names.",
886
"Called prior to executing a command. Called with the command "
890
"Called after executing a command. Called with the command "
894
794
Command.hooks = CommandHooks()
903
803
they take, and which commands will accept them.
905
805
# TODO: make it a method of the Command?
906
parser = option.get_optparser(
907
[v for k, v in sorted(command.options().items())])
806
parser = option.get_optparser(command.options())
908
807
if alias_argv is not None:
909
808
args = alias_argv + argv
913
# python 2's optparse raises this exception if a non-ascii
914
# option name is given. See http://bugs.python.org/issue2931
916
options, args = parser.parse_args(args)
917
except UnicodeEncodeError:
918
raise errors.BzrCommandError(
919
gettext('Only ASCII permitted in option names'))
921
opts = dict((k, v) for k, v in options.__dict__.items() if
922
v is not option.OptionParser.DEFAULT_VALUE)
812
options, args = parser.parse_args(args)
813
opts = dict([(k, v) for k, v in options.__dict__.iteritems() if
814
v is not option.OptionParser.DEFAULT_VALUE])
923
815
return args, opts
940
832
argdict[argname + '_list'] = None
941
833
elif ap[-1] == '+':
943
raise errors.BzrCommandError(gettext(
944
"command {0!r} needs one or more {1}").format(
945
cmd, argname.upper()))
835
raise errors.BzrCommandError("command %r needs one or more %s"
836
% (cmd, argname.upper()))
947
838
argdict[argname + '_list'] = args[:]
949
elif ap[-1] == '$': # all but one
840
elif ap[-1] == '$': # all but one
950
841
if len(args) < 2:
951
raise errors.BzrCommandError(
952
gettext("command {0!r} needs one or more {1}").format(
953
cmd, argname.upper()))
842
raise errors.BzrCommandError("command %r needs one or more %s"
843
% (cmd, argname.upper()))
954
844
argdict[argname + '_list'] = args[:-1]
957
847
# just a plain arg
960
raise errors.BzrCommandError(
961
gettext("command {0!r} requires argument {1}").format(
962
cmd, argname.upper()))
850
raise errors.BzrCommandError("command %r requires argument %s"
851
% (cmd, argname.upper()))
964
853
argdict[argname] = args.pop(0)
967
raise errors.BzrCommandError(gettext(
968
"extra argument to command {0}: {1}").format(
856
raise errors.BzrCommandError("extra argument to command %s: %s"
974
def apply_coveraged(the_callable, *args, **kwargs):
976
cov = coverage.Coverage()
978
config_file = cov.config.config_file
979
except AttributeError: # older versions of coverage
980
config_file = cov.config_file
981
os.environ['COVERAGE_PROCESS_START'] = config_file
861
def apply_coveraged(dirname, the_callable, *args, **kwargs):
862
# Cannot use "import trace", as that would import bzrlib.trace instead of
863
# the standard library's trace.
864
trace = __import__('trace')
866
tracer = trace.Trace(count=1, trace=0)
867
sys.settrace(tracer.globaltrace)
868
threading.settrace(tracer.globaltrace)
984
871
return exception_to_return_code(the_callable, *args, **kwargs)
874
results = tracer.results()
875
results.write_results(show_missing=1, summary=False,
990
879
def apply_profiled(the_callable, *args, **kwargs):
1022
911
return the_callable(*args, **kwargs)
1023
except (KeyboardInterrupt, Exception):
912
except (KeyboardInterrupt, Exception), e:
1024
913
# used to handle AssertionError and KeyboardInterrupt
1025
914
# specially here, but hopefully they're handled ok by the logger now
1026
915
exc_info = sys.exc_info()
1027
916
exitcode = trace.report_exception(exc_info, sys.stderr)
1028
if os.environ.get('BRZ_PDB'):
1029
print('**** entering debugger')
917
if os.environ.get('BZR_PDB'):
918
print '**** entering debugger'
1031
pdb.post_mortem(exc_info[2])
921
if sys.version_info[:2] < (2, 6):
923
# pdb.post_mortem(tb)
924
# but because pdb.post_mortem gives bad results for tracebacks
925
# from inside generators, we do it manually.
926
# (http://bugs.python.org/issue4150, fixed in Python 2.6)
928
# Setup pdb on the traceback
931
p.setup(tb.tb_frame, tb)
932
# Point the debugger at the deepest frame of the stack
933
p.curindex = len(p.stack) - 1
934
p.curframe = p.stack[p.curindex][0]
935
# Start the pdb prompt.
936
p.print_stack_entry(p.stack[p.curindex])
1035
944
def apply_lsprofiled(filename, the_callable, *args, **kwargs):
1036
from breezy.lsprof import profile
1037
ret, stats = profile(exception_to_return_code, the_callable,
945
from bzrlib.lsprof import profile
946
ret, stats = profile(exception_to_return_code, the_callable, *args, **kwargs)
1040
948
if filename is None:
1043
951
stats.save(filename)
1044
trace.note(gettext('Profile data written to "%s".'), filename)
952
trace.note('Profile data written to "%s".', filename)
956
@deprecated_function(deprecated_in((2, 2, 0)))
957
def shlex_split_unicode(unsplit):
958
return cmdline.split(unsplit)
1048
961
def get_alias(cmd, config=None):
1049
962
"""Return an expanded alias, or None if no alias exists.
1100
1013
Run under the Python lsprof profiler.
1103
Generate code coverage report
1016
Generate line coverage report in the specified directory.
1106
Specify the number of processes that can be run concurrently
1019
Specify the number of processes that can be run concurrently (selftest).
1109
trace.mutter("breezy version: " + breezy.__version__)
1110
argv = _specified_or_unicode_argv(argv)
1111
trace.mutter("brz arguments: %r", argv)
1021
trace.mutter("bazaar version: " + bzrlib.__version__)
1023
trace.mutter("bzr arguments: %r", argv)
1113
opt_lsprof = opt_profile = opt_no_plugins = opt_builtin = \
1114
opt_coverage = opt_no_l10n = opt_no_aliases = False
1115
opt_lsprof_file = None
1025
opt_lsprof = opt_profile = opt_no_plugins = opt_builtin = \
1026
opt_no_aliases = False
1027
opt_lsprof_file = opt_coverage_dir = None
1117
1029
# --no-plugins is handled specially at a very early stage. We need
1118
1030
# to load plugins before doing other command parsing so that they
1135
1046
opt_no_plugins = True
1136
1047
elif a == '--no-aliases':
1137
1048
opt_no_aliases = True
1138
elif a == '--no-l10n':
1140
1049
elif a == '--builtin':
1141
1050
opt_builtin = True
1142
1051
elif a == '--concurrency':
1143
os.environ['BRZ_CONCURRENCY'] = argv[i + 1]
1052
os.environ['BZR_CONCURRENCY'] = argv[i + 1]
1145
1054
elif a == '--coverage':
1055
opt_coverage_dir = argv[i + 1]
1147
1057
elif a == '--profile-imports':
1148
pass # already handled in startup script Bug #588277
1058
pass # already handled in startup script Bug #588277
1149
1059
elif a.startswith('-D'):
1150
1060
debug.debug_flags.add(a[2:])
1151
elif a.startswith('-O'):
1152
override_config.append(a[2:])
1154
1062
argv_copy.append(a)
1157
cmdline_overrides = breezy.get_global_state().cmdline_overrides
1158
cmdline_overrides._from_cmdline(override_config)
1160
1065
debug.set_debug_flags_from_config()
1162
1067
if not opt_no_plugins:
1193
1096
saved_verbosity_level = option._verbosity_level
1194
1097
option._verbosity_level = 0
1099
if opt_coverage_dir:
1198
1101
'--coverage ignored, because --lsprof is in use.')
1199
1102
ret = apply_lsprofiled(opt_lsprof_file, run, *run_argv)
1200
1103
elif opt_profile:
1104
if opt_coverage_dir:
1203
1106
'--coverage ignored, because --profile is in use.')
1204
1107
ret = apply_profiled(run, *run_argv)
1206
ret = apply_coveraged(run, *run_argv)
1108
elif opt_coverage_dir:
1109
ret = apply_coveraged(opt_coverage_dir, run, *run_argv)
1208
1111
ret = run(*run_argv)
1209
1112
return ret or 0
1243
1144
if _list_bzr_commands in Command.hooks["list_commands"]:
1245
1146
Command.hooks.install_named_hook("list_commands", _list_bzr_commands,
1247
1148
Command.hooks.install_named_hook("get_command", _get_bzr_command,
1249
1150
Command.hooks.install_named_hook("get_command", _get_plugin_command,
1250
"bzr plugin commands")
1151
"bzr plugin commands")
1251
1152
Command.hooks.install_named_hook("get_command", _get_external_command,
1252
"bzr external command lookup")
1253
Command.hooks.install_named_hook("get_missing_command",
1254
_try_plugin_provider,
1255
"bzr plugin-provider-db check")
1153
"bzr external command lookup")
1154
Command.hooks.install_named_hook("get_missing_command", _try_plugin_provider,
1155
"bzr plugin-provider-db check")
1258
1159
def _specified_or_unicode_argv(argv):
1260
1161
# the process arguments in a unicode-safe way.
1261
1162
if argv is None:
1262
1163
return osutils.get_unicode_argv()
1265
# ensure all arguments are unicode strings
1267
if not isinstance(a, string_types):
1268
raise ValueError('not native str or unicode: %r' % (a,))
1269
if isinstance(a, bytes):
1270
# For Python 2 only allow ascii native strings
1271
a = a.decode('ascii')
1273
except (ValueError, UnicodeDecodeError):
1274
raise errors.BzrError("argv should be list of unicode strings.")
1167
# ensure all arguments are unicode strings
1169
if isinstance(a, unicode):
1172
new_argv.append(a.decode('ascii'))
1173
except UnicodeDecodeError:
1174
raise errors.BzrError("argv should be list of unicode strings.")
1278
1178
def main(argv=None):
1279
1179
"""Main entry point of command-line interface.
1281
Typically `breezy.initialize` should be called first.
1181
Typically `bzrlib.initialize` should be called first.
1283
1183
:param argv: list of unicode command-line arguments similar to sys.argv.
1284
1184
argv[0] is script name usually, it will be ignored.
1285
1185
Don't pass here sys.argv because this list contains plain strings
1286
1186
and not unicode; pass None instead.
1288
:return: exit code of brz command.
1188
:return: exit code of bzr command.
1290
if argv is not None:
1190
argv = _specified_or_unicode_argv(argv)
1292
1191
_register_builtin_commands()
1293
1192
ret = run_bzr_catch_errors(argv)
1193
bzrlib.ui.ui_factory.log_transport_activity(
1194
display=('bytes' in debug.debug_flags))
1294
1195
trace.mutter("return code %d", ret)
1352
1252
class Provider(object):
1353
"""Generic class to be overriden by plugins"""
1253
'''Generic class to be overriden by plugins'''
1355
1255
def plugin_for_command(self, cmd_name):
1356
"""Takes a command and returns the information for that plugin
1256
'''Takes a command and returns the information for that plugin
1358
1258
:return: A dictionary with all the available information
1359
for the requested plugin
1259
for the requested plugin
1361
1261
raise NotImplementedError
1364
1264
class ProvidersRegistry(registry.Registry):
1365
"""This registry exists to allow other providers to exist"""
1265
'''This registry exists to allow other providers to exist'''
1367
1267
def __iter__(self):
1368
for key, provider in self.items():
1268
for key, provider in self.iteritems():
1372
1271
command_providers_registry = ProvidersRegistry()
added
removed
bzrlib/commands.py
