28
from bzrlib.lazy_import import lazy_import
35
from .lazy_import import lazy_import
29
36
lazy_import(globals(), """
33
from warnings import warn
49
from bzrlib.hooks import HookPoint, Hooks
51
from .hooks import Hooks
52
from .i18n import gettext
50
53
# Compatibility - Option used to be in commands.
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 (
54
from .option import Option
55
from .plugin import disable_plugins, load_plugins, plugin_name
56
from . import errors, registry
64
class BzrOptionError(errors.BzrCommandError):
66
_fmt = "Error in command line options"
69
class CommandAvailableInPlugin(Exception):
71
internal_error = False
73
def __init__(self, cmd_name, plugin_metadata, provider):
75
self.plugin_metadata = plugin_metadata
76
self.cmd_name = cmd_name
77
self.provider = provider
81
_fmt = ('"%s" is not a standard brz command. \n'
82
'However, the following official plugin provides this command: %s\n'
83
'You can install it by going to: %s'
84
% (self.cmd_name, self.plugin_metadata['name'],
85
self.plugin_metadata['url']))
61
90
class CommandInfo(object):
62
91
"""Information about a command."""
164
193
def _unsquish_command_name(cmd):
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())
194
return cmd[4:].replace('_', '-')
178
197
def _register_builtin_commands():
179
198
if builtin_command_registry.keys():
182
import bzrlib.builtins
183
for cmd_class in _scan_module_for_commands(bzrlib.builtins).values():
201
import breezy.builtins
202
for cmd_class in _scan_module_for_commands(breezy.builtins):
184
203
builtin_command_registry.register(cmd_class)
185
bzrlib.builtins._register_lazy_builtins()
204
breezy.builtins._register_lazy_builtins()
188
207
def _scan_module_for_commands(module):
190
for name, obj in module.__dict__.iteritems():
208
module_dict = module.__dict__
209
for name in module_dict:
191
210
if name.startswith("cmd_"):
192
real_name = _unsquish_command_name(name)
211
yield module_dict[name]
197
214
def _list_bzr_commands(names):
230
248
return plugin_cmds.keys()
251
# Overrides for common mispellings that heuristics get wrong
253
'ic': {'ci': 0}, # heuristic finds nick
257
def guess_command(cmd_name):
258
"""Guess what command a user typoed.
260
:param cmd_name: Command to search for
261
:return: None if no command was found, name of a command otherwise
264
for name in all_command_names():
266
cmd = get_cmd_object(name)
267
names.update(cmd.aliases)
268
# candidate: modified levenshtein distance against cmd_name.
270
from . import patiencediff
271
for name in sorted(names):
272
matcher = patiencediff.PatienceSequenceMatcher(None, cmd_name, name)
274
opcodes = matcher.get_opcodes()
275
for opcode, l1, l2, r1, r2 in opcodes:
276
if opcode == 'delete':
278
elif opcode == 'replace':
279
distance += max(l2-l1, r2-l1)
280
elif opcode == 'insert':
282
elif opcode == 'equal':
283
# Score equal ranges lower, making similar commands of equal
284
# length closer than arbitrary same length commands.
285
distance -= 0.1 * (l2-l1)
286
costs[name] = distance
287
costs.update(_GUESS_OVERRIDES.get(cmd_name, {}))
288
costs = sorted((costs[key], key) for key in costs)
293
candidate = costs[0][1]
233
297
def get_cmd_object(cmd_name, plugins_override=True):
234
298
"""Return the command object for a command.
240
304
return _get_cmd_object(cmd_name, plugins_override)
242
raise errors.BzrCommandError('unknown command "%s"' % cmd_name)
306
# No command found, see if this was a typo
307
candidate = guess_command(cmd_name)
308
if candidate is not None:
309
raise errors.BzrCommandError(
310
gettext('unknown command "%s". Perhaps you meant "%s"')
311
% (cmd_name, candidate))
312
raise errors.BzrCommandError(gettext('unknown command "%s"')
245
316
def _get_cmd_object(cmd_name, plugins_override=True, check_missing=True):
275
346
# Allow plugins to extend commands
276
347
for hook in Command.hooks['extend_command']:
349
if getattr(cmd, 'invoked_as', None) is None:
350
cmd.invoked_as = cmd_name
354
class NoPluginAvailable(errors.BzrError):
281
358
def _try_plugin_provider(cmd_name):
282
359
"""Probe for a plugin provider having cmd_name."""
284
361
plugin_metadata, provider = probe_for_provider(cmd_name)
285
raise errors.CommandAvailableInPlugin(cmd_name,
286
plugin_metadata, provider)
287
except errors.NoPluginAvailable:
362
raise CommandAvailableInPlugin(cmd_name, plugin_metadata, provider)
363
except NoPluginAvailable:
357
433
summary, then a complete description of the command. A grammar
358
434
description will be inserted.
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
436
:cvar aliases: Other accepted names for this command.
438
:cvar takes_args: List of argument forms, marked with whether they are
439
optional, repeated, etc. Examples::
441
['to_location', 'from_branch?', 'file*']
443
* 'to_location' is required
444
* 'from_branch' is optional
445
* 'file' can be specified 0 or more times
447
:cvar takes_options: List of options that may be given for this command.
448
These can be either strings, referring to globally-defined options, or
449
option objects. Retrieve through options().
451
:cvar hidden: If true, this command isn't advertised. This is typically
382
452
for commands intended for expert users.
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
454
:cvar encoding_type: Command objects will get a 'outf' attribute, which has
455
been setup to properly handle encoding of unicode strings.
456
encoding_type determines what will happen when characters cannot be
459
* strict - abort if we cannot decode
460
* replace - put in a bogus character (typically '?')
461
* exact - do not encode sys.stdout
463
NOTE: by default on Windows, sys.stdout is opened as a text stream,
464
therefore LF line-endings are converted to CRLF. When a command uses
465
encoding_type = 'exact', then sys.stdout is forced to be a binary
466
stream, and line-endings will not mangled.
469
A string indicating the real name under which this command was
470
invoked, before expansion of aliases.
471
(This may be None if the command was constructed and run in-process.)
399
473
:cvar hooks: An instance of CommandHooks.
475
:cvar __doc__: The help shown by 'brz help command' for this command.
476
This is set by assigning explicitly to __doc__ so that -OO can
480
__doc__ = "My help goes here"
403
484
takes_options = []
404
485
encoding_type = 'strict'
408
491
def __init__(self):
409
492
"""Construct an instance of this command."""
410
if self.__doc__ == Command.__doc__:
411
warn("No help message set for %r" % self)
412
493
# List of standard options directly supported
413
494
self.supported_std_options = []
414
495
self._setup_run()
436
517
self._operation.cleanup_now()
438
@deprecated_method(deprecated_in((2, 1, 0)))
439
def _maybe_expand_globs(self, file_list):
440
"""Glob expand file_list if the platform does not do that itself.
442
Not used anymore, now that the bzr command-line parser globs on
445
:return: A possibly empty list of unicode paths.
447
Introduced in bzrlib 0.18.
451
519
def _usage(self):
452
520
"""Return single-line grammar for this command.
454
522
Only describes arguments, not options.
456
s = 'bzr ' + self.name() + ' '
524
s = 'brz ' + self.name() + ' '
457
525
for aname in self.takes_args:
458
526
aname = aname.upper()
459
527
if aname[-1] in ['$', '+']:
481
549
usage help (e.g. Purpose, Usage, Options) with a
482
550
message explaining how to obtain full help.
553
i18n.install() # Install i18n only for get_help_text for now.
484
554
doc = self.help()
486
raise NotImplementedError("sorry, no detailed help yet for %r" % self.name())
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.")
488
565
# Extract the summary (purpose) and sections out from the text
489
purpose,sections,order = self._get_help_parts(doc)
566
purpose, sections, order = self._get_help_parts(doc)
491
568
# If a custom usage section was provided, use it
492
if sections.has_key('Usage'):
569
if 'Usage' in sections:
493
570
usage = sections.pop('Usage')
495
572
usage = self._usage()
497
574
# The header is the purpose and usage
499
result += ':Purpose: %s\n' % purpose
576
result += gettext(':Purpose: %s\n') % (purpose,)
500
577
if usage.find('\n') >= 0:
501
result += ':Usage:\n%s\n' % usage
578
result += gettext(':Usage:\n%s\n') % (usage,)
503
result += ':Usage: %s\n' % usage
580
result += gettext(':Usage: %s\n') % (usage,)
506
583
# Add the options
508
585
# XXX: optparse implicitly rewraps the help, and not always perfectly,
509
586
# so we get <https://bugs.launchpad.net/bzr/+bug/249908>. -- mbp
511
options = option.get_optparser(self.options()).format_option_help()
512
# XXX: According to the spec, ReST option lists actually don't support
513
# options like --1.9 so that causes syntax errors (in Sphinx at least).
514
# As that pattern always appears in the commands that break, we trap
515
# on that and then format that block of 'format' options as a literal
517
if not plain and options.find(' --1.9 ') != -1:
588
parser = option.get_optparser([v for k, v in sorted(self.options().items())])
589
options = parser.format_option_help()
590
# FIXME: According to the spec, ReST option lists actually don't
591
# support options like --1.14 so that causes syntax errors (in Sphinx
592
# at least). As that pattern always appears in the commands that
593
# break, we trap on that and then format that block of 'format' options
594
# as a literal block. We use the most recent format still listed so we
595
# don't have to do that too often -- vila 20110514
596
if not plain and options.find(' --1.14 ') != -1:
518
597
options = options.replace(' format:\n', ' format::\n\n', 1)
519
598
if options.startswith('Options:'):
520
result += ':' + options
521
elif options.startswith('options:'):
522
# Python 2.4 version of optparse
523
result += ':Options:' + options[len('options:'):]
599
result += gettext(':Options:%s') % (options[len('options:'):],)
525
601
result += options
529
605
# Add the description, indenting it 2 spaces
530
606
# to match the indentation of the options
531
if sections.has_key(None):
532
608
text = sections.pop(None)
533
609
text = '\n '.join(text.splitlines())
534
result += ':%s:\n %s\n\n' % ('Description',text)
610
result += gettext(':Description:\n %s\n\n') % (text,)
536
612
# Add the custom sections (e.g. Examples). Note that there's no need
537
613
# to indent these as they must be indented already in the source.
539
615
for label in order:
540
if sections.has_key(label):
541
result += ':%s:\n%s\n' % (label,sections[label])
616
if label in sections:
617
result += ':%s:\n%s\n' % (label, sections[label])
544
result += ("See bzr help %s for more details and examples.\n\n"
620
result += (gettext("See brz help %s for more details and examples.\n\n")
547
623
# Add the aliases, source (plug-in) and see also links, if any
549
result += ':Aliases: '
625
result += gettext(':Aliases: ')
550
626
result += ', '.join(self.aliases) + '\n'
551
627
plugin_name = self.plugin_name()
552
628
if plugin_name is not None:
553
result += ':From: plugin "%s"\n' % plugin_name
629
result += gettext(':From: plugin "%s"\n') % plugin_name
554
630
see_also = self.get_see_also(additional_see_also)
556
632
if not plain and see_also_as_links:
562
638
see_also_links.append(item)
564
640
# Use a Sphinx link for this entry
565
link_text = ":doc:`%s <%s-help>`" % (item, item)
641
link_text = gettext(":doc:`{0} <{1}-help>`").format(
566
643
see_also_links.append(link_text)
567
644
see_also = see_also_links
568
result += ':See also: '
569
result += ', '.join(see_also) + '\n'
645
result += gettext(':See also: %s') % ', '.join(see_also) + '\n'
571
647
# If this will be rendered as plain text, convert it
573
import bzrlib.help_topics
574
result = bzrlib.help_topics.help_as_plain_text(result)
649
import breezy.help_topics
650
result = breezy.help_topics.help_as_plain_text(result)
598
674
summary = lines.pop(0)
601
label,section = None,''
677
label, section = None, ''
602
678
for line in lines:
603
679
if line.startswith(':') and line.endswith(':') and len(line) > 2:
604
680
save_section(sections, order, label, section)
605
label,section = line[1:-1],''
681
label, section = line[1:-1], ''
606
682
elif (label is not None) and len(line) > 1 and not line[0].isspace():
607
683
save_section(sections, order, label, section)
608
label,section = None,line
684
label, section = None, line
610
686
if len(section) > 0:
611
687
section += '\n' + line
653
729
def run_argv_aliases(self, argv, alias_argv=None):
654
730
"""Parse the command line and run with extra aliases in alias_argv."""
655
731
args, opts = parse_args(self, argv, alias_argv)
657
734
# Process the standard options
658
if 'help' in opts: # e.g. bzr add --help
659
sys.stdout.write(self.get_help_text())
735
if 'help' in opts: # e.g. brz add --help
736
self.outf.write(self.get_help_text())
661
if 'usage' in opts: # e.g. bzr add --usage
662
sys.stdout.write(self.get_help_text(verbose=False))
738
if 'usage' in opts: # e.g. brz add --usage
739
self.outf.write(self.get_help_text(verbose=False))
664
741
trace.set_verbosity_level(option._verbosity_level)
665
742
if 'verbose' in self.supported_std_options:
666
743
opts['verbose'] = trace.is_verbose()
667
elif opts.has_key('verbose'):
744
elif 'verbose' in opts:
668
745
del opts['verbose']
669
746
if 'quiet' in self.supported_std_options:
670
747
opts['quiet'] = trace.is_quiet()
671
elif opts.has_key('quiet'):
748
elif 'quiet' in opts:
672
749
del opts['quiet']
674
750
# mix arguments and options into one dictionary
675
751
cmdargs = _match_argform(self.name(), self.takes_args, args)
680
756
all_cmd_args = cmdargs.copy()
681
757
all_cmd_args.update(cmdopts)
685
return self.run(**all_cmd_args)
760
return self.run(**all_cmd_args)
762
# reset it, so that other commands run in the same process won't
763
# inherit state. Before we reset it, log any activity, so that it
764
# gets properly tracked.
765
ui.ui_factory.log_transport_activity(
766
display=('bytes' in debug.debug_flags))
767
trace.set_verbosity_level(0)
687
769
def _setup_run(self):
688
770
"""Wrap the defined run method on self with a cleanup.
696
778
class_run = self.run
697
779
def run(*args, **kwargs):
780
for hook in Command.hooks['pre_command']:
698
782
self._operation = cleanup.OperationWithCleanups(class_run)
700
784
return self._operation.run_simple(*args, **kwargs)
702
786
del self._operation
787
for hook in Command.hooks['post_command']:
705
@deprecated_method(deprecated_in((2, 2, 0)))
706
def run_direct(self, *args, **kwargs):
707
"""Deprecated thunk from bzrlib 2.1."""
708
return self.run(*args, **kwargs)
711
792
"""Actually run the command.
762
851
These are all empty initially, because by default nothing should get
766
self.create_hook(HookPoint('extend_command',
854
Hooks.__init__(self, "breezy.commands", "Command.hooks")
855
self.add_hook('extend_command',
767
856
"Called after creating a command object to allow modifications "
768
857
"such as adding or removing options, docs etc. Called with the "
769
"new bzrlib.commands.Command object.", (1, 13), None))
770
self.create_hook(HookPoint('get_command',
858
"new breezy.commands.Command object.", (1, 13))
859
self.add_hook('get_command',
771
860
"Called when creating a single command. Called with "
772
861
"(cmd_or_None, command_name). get_command should either return "
773
862
"the cmd_or_None parameter, or a replacement Command object that "
774
863
"should be used for the command. Note that the Command.hooks "
775
864
"hooks are core infrastructure. Many users will prefer to use "
776
"bzrlib.commands.register_command or plugin_cmds.register_lazy.",
778
self.create_hook(HookPoint('get_missing_command',
865
"breezy.commands.register_command or plugin_cmds.register_lazy.",
867
self.add_hook('get_missing_command',
779
868
"Called when creating a single command if no command could be "
780
869
"found. Called with (command_name). get_missing_command should "
781
870
"either return None, or a Command object to be used for the "
782
"command.", (1, 17), None))
783
self.create_hook(HookPoint('list_commands',
872
self.add_hook('list_commands',
784
873
"Called when enumerating commands. Called with a set of "
785
874
"cmd_name strings for all the commands found so far. This set "
786
875
" is safe to mutate - e.g. to remove a command. "
787
876
"list_commands should return the updated set of command names.",
878
self.add_hook('pre_command',
879
"Called prior to executing a command. Called with the command "
881
self.add_hook('post_command',
882
"Called after executing a command. Called with the command "
790
885
Command.hooks = CommandHooks()
799
894
they take, and which commands will accept them.
801
896
# TODO: make it a method of the Command?
802
parser = option.get_optparser(command.options())
897
parser = option.get_optparser(
898
[v for k, v in sorted(command.options().items())])
803
899
if alias_argv is not None:
804
900
args = alias_argv + argv
808
options, args = parser.parse_args(args)
809
opts = dict([(k, v) for k, v in options.__dict__.iteritems() if
810
v is not option.OptionParser.DEFAULT_VALUE])
904
# python 2's optparse raises this exception if a non-ascii
905
# option name is given. See http://bugs.python.org/issue2931
907
options, args = parser.parse_args(args)
908
except UnicodeEncodeError as e:
909
raise errors.BzrCommandError(
910
gettext('Only ASCII permitted in option names'))
912
opts = dict((k, v) for k, v in options.__dict__.items() if
913
v is not option.OptionParser.DEFAULT_VALUE)
811
914
return args, opts
828
931
argdict[argname + '_list'] = None
829
932
elif ap[-1] == '+':
831
raise errors.BzrCommandError("command %r needs one or more %s"
832
% (cmd, argname.upper()))
934
raise errors.BzrCommandError(gettext(
935
"command {0!r} needs one or more {1}").format(
936
cmd, argname.upper()))
834
938
argdict[argname + '_list'] = args[:]
836
940
elif ap[-1] == '$': # all but one
837
941
if len(args) < 2:
838
raise errors.BzrCommandError("command %r needs one or more %s"
839
% (cmd, argname.upper()))
942
raise errors.BzrCommandError(
943
gettext("command {0!r} needs one or more {1}").format(
944
cmd, argname.upper()))
840
945
argdict[argname + '_list'] = args[:-1]
843
948
# just a plain arg
846
raise errors.BzrCommandError("command %r requires argument %s"
847
% (cmd, argname.upper()))
951
raise errors.BzrCommandError(
952
gettext("command {0!r} requires argument {1}").format(
953
cmd, argname.upper()))
849
955
argdict[argname] = args.pop(0)
852
raise errors.BzrCommandError("extra argument to command %s: %s"
958
raise errors.BzrCommandError( gettext(
959
"extra argument to command {0}: {1}").format(
857
def apply_coveraged(dirname, the_callable, *args, **kwargs):
858
# Cannot use "import trace", as that would import bzrlib.trace instead of
859
# the standard library's trace.
860
trace = __import__('trace')
862
tracer = trace.Trace(count=1, trace=0)
863
sys.settrace(tracer.globaltrace)
864
threading.settrace(tracer.globaltrace)
965
def apply_coveraged(the_callable, *args, **kwargs):
967
cov = coverage.Coverage()
968
os.environ['COVERAGE_PROCESS_START'] = cov.config_file
867
971
return exception_to_return_code(the_callable, *args, **kwargs)
870
results = tracer.results()
871
results.write_results(show_missing=1, summary=False,
875
977
def apply_profiled(the_callable, *args, **kwargs):
907
1009
return the_callable(*args, **kwargs)
908
except (KeyboardInterrupt, Exception), e:
1010
except (KeyboardInterrupt, Exception) as e:
909
1011
# used to handle AssertionError and KeyboardInterrupt
910
1012
# specially here, but hopefully they're handled ok by the logger now
911
1013
exc_info = sys.exc_info()
912
1014
exitcode = trace.report_exception(exc_info, sys.stderr)
913
if os.environ.get('BZR_PDB'):
914
print '**** entering debugger'
1015
if os.environ.get('BRZ_PDB'):
1016
print('**** entering debugger')
917
if sys.version_info[:2] < (2, 6):
919
# pdb.post_mortem(tb)
920
# but because pdb.post_mortem gives bad results for tracebacks
921
# from inside generators, we do it manually.
922
# (http://bugs.python.org/issue4150, fixed in Python 2.6)
924
# Setup pdb on the traceback
927
p.setup(tb.tb_frame, tb)
928
# Point the debugger at the deepest frame of the stack
929
p.curindex = len(p.stack) - 1
930
p.curframe = p.stack[p.curindex][0]
931
# Start the pdb prompt.
932
p.print_stack_entry(p.stack[p.curindex])
1018
pdb.post_mortem(exc_info[2])
940
1022
def apply_lsprofiled(filename, the_callable, *args, **kwargs):
941
from bzrlib.lsprof import profile
942
ret, stats = profile(exception_to_return_code, the_callable, *args, **kwargs)
1023
from breezy.lsprof import profile
1024
ret, stats = profile(exception_to_return_code, the_callable,
944
1027
if filename is None:
947
1030
stats.save(filename)
948
trace.note('Profile data written to "%s".', filename)
1031
trace.note(gettext('Profile data written to "%s".'), filename)
952
@deprecated_function(deprecated_in((2, 2, 0)))
953
def shlex_split_unicode(unsplit):
954
return cmdline.split(unsplit)
957
1035
def get_alias(cmd, config=None):
958
1036
"""Return an expanded alias, or None if no alias exists.
1009
1087
Run under the Python lsprof profiler.
1012
Generate line coverage report in the specified directory.
1090
Generate code coverage report
1015
1093
Specify the number of processes that can be run concurrently (selftest).
1017
trace.mutter("bazaar version: " + bzrlib.__version__)
1019
trace.mutter("bzr arguments: %r", argv)
1095
trace.mutter("breezy version: " + breezy.__version__)
1096
argv = _specified_or_unicode_argv(argv)
1097
trace.mutter("brz arguments: %r", argv)
1021
opt_lsprof = opt_profile = opt_no_plugins = opt_builtin = \
1022
opt_no_aliases = False
1023
opt_lsprof_file = opt_coverage_dir = None
1099
opt_lsprof = opt_profile = opt_no_plugins = opt_builtin = \
1100
opt_coverage = opt_no_l10n = opt_no_aliases = False
1101
opt_lsprof_file = None
1025
1103
# --no-plugins is handled specially at a very early stage. We need
1026
1104
# to load plugins before doing other command parsing so that they
1042
1121
opt_no_plugins = True
1043
1122
elif a == '--no-aliases':
1044
1123
opt_no_aliases = True
1124
elif a == '--no-l10n':
1045
1126
elif a == '--builtin':
1046
1127
opt_builtin = True
1047
1128
elif a == '--concurrency':
1048
os.environ['BZR_CONCURRENCY'] = argv[i + 1]
1129
os.environ['BRZ_CONCURRENCY'] = argv[i + 1]
1050
1131
elif a == '--coverage':
1051
opt_coverage_dir = argv[i + 1]
1133
elif a == '--profile-imports':
1134
pass # already handled in startup script Bug #588277
1053
1135
elif a.startswith('-D'):
1054
1136
debug.debug_flags.add(a[2:])
1137
elif a.startswith('-O'):
1138
override_config.append(a[2:])
1056
1140
argv_copy.append(a)
1143
cmdline_overrides = breezy.get_global_state().cmdline_overrides
1144
cmdline_overrides._from_cmdline(override_config)
1059
1146
debug.set_debug_flags_from_config()
1061
1148
if not opt_no_plugins:
1077
1164
if not opt_no_aliases:
1078
1165
alias_argv = get_alias(argv[0])
1080
user_encoding = osutils.get_user_encoding()
1081
alias_argv = [a.decode(user_encoding) for a in alias_argv]
1082
1167
argv[0] = alias_argv.pop(0)
1084
1169
cmd = argv.pop(0)
1085
# We want only 'ascii' command names, but the user may have typed
1086
# in a Unicode name. In that case, they should just get a
1087
# 'command not found' error later.
1089
1170
cmd_obj = get_cmd_object(cmd, plugins_override=not opt_builtin)
1172
cmd_obj.l10n = False
1090
1173
run = cmd_obj.run_argv_aliases
1091
1174
run_argv = [argv, alias_argv]
1096
1179
saved_verbosity_level = option._verbosity_level
1097
1180
option._verbosity_level = 0
1099
if opt_coverage_dir:
1101
1184
'--coverage ignored, because --lsprof is in use.')
1102
1185
ret = apply_lsprofiled(opt_lsprof_file, run, *run_argv)
1103
1186
elif opt_profile:
1104
if opt_coverage_dir:
1106
1189
'--coverage ignored, because --profile is in use.')
1107
1190
ret = apply_profiled(run, *run_argv)
1108
elif opt_coverage_dir:
1109
ret = apply_coveraged(opt_coverage_dir, run, *run_argv)
1192
ret = apply_coveraged(run, *run_argv)
1111
1194
ret = run(*run_argv)
1112
1195
return ret or 0
1161
1247
# the process arguments in a unicode-safe way.
1162
1248
if argv is None:
1163
1249
return osutils.get_unicode_argv()
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.")
1252
# ensure all arguments are unicode strings
1254
if not isinstance(a, string_types):
1255
raise ValueError('not native str or unicode: %r' % (a,))
1256
if isinstance(a, bytes):
1257
# For Python 2 only allow ascii native strings
1258
a = a.decode('ascii')
1260
except (ValueError, UnicodeDecodeError):
1261
raise errors.BzrError("argv should be list of unicode strings.")
1178
1265
def main(argv=None):
1179
1266
"""Main entry point of command-line interface.
1181
Typically `bzrlib.initialize` should be called first.
1268
Typically `breezy.initialize` should be called first.
1183
1270
:param argv: list of unicode command-line arguments similar to sys.argv.
1184
1271
argv[0] is script name usually, it will be ignored.
1185
1272
Don't pass here sys.argv because this list contains plain strings
1186
1273
and not unicode; pass None instead.
1188
:return: exit code of bzr command.
1275
:return: exit code of brz command.
1190
argv = _specified_or_unicode_argv(argv)
1277
if argv is not None:
1191
1279
_register_builtin_commands()
1192
1280
ret = run_bzr_catch_errors(argv)
1193
bzrlib.ui.ui_factory.log_transport_activity(
1194
display=('bytes' in debug.debug_flags))
1195
1281
trace.mutter("return code %d", ret)
1252
1338
class Provider(object):
1253
'''Generic class to be overriden by plugins'''
1339
"""Generic class to be overriden by plugins"""
1255
1341
def plugin_for_command(self, cmd_name):
1256
'''Takes a command and returns the information for that plugin
1342
"""Takes a command and returns the information for that plugin
1258
1344
:return: A dictionary with all the available information
1259
for the requested plugin
1345
for the requested plugin
1261
1347
raise NotImplementedError
1264
1350
class ProvidersRegistry(registry.Registry):
1265
'''This registry exists to allow other providers to exist'''
1351
"""This registry exists to allow other providers to exist"""
1267
1353
def __iter__(self):
1268
for key, provider in self.iteritems():
1354
for key, provider in self.items():
1271
1357
command_providers_registry = ProvidersRegistry()