29
from .lazy_import import lazy_import
28
from bzrlib.lazy_import import lazy_import
30
29
lazy_import(globals(), """
33
from warnings import warn
48
from .hooks import Hooks
49
from .i18n import gettext
49
from bzrlib.hooks import HookPoint, Hooks
50
50
# Compatibility - Option used to be in commands.
51
from .option import Option
52
from .plugin import disable_plugins, load_plugins, plugin_name
53
from . import errors, registry
51
from bzrlib.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):
244
230
return plugin_cmds.keys()
247
# Overrides for common mispellings that heuristics get wrong
249
'ic': {'ci': 0}, # heuristic finds nick
253
def guess_command(cmd_name):
254
"""Guess what command a user typoed.
256
:param cmd_name: Command to search for
257
:return: None if no command was found, name of a command otherwise
260
for name in all_command_names():
262
cmd = get_cmd_object(name)
263
names.update(cmd.aliases)
264
# candidate: modified levenshtein distance against cmd_name.
266
from . import patiencediff
267
for name in sorted(names):
268
matcher = patiencediff.PatienceSequenceMatcher(None, cmd_name, name)
270
opcodes = matcher.get_opcodes()
271
for opcode, l1, l2, r1, r2 in opcodes:
272
if opcode == 'delete':
274
elif opcode == 'replace':
275
distance += max(l2-l1, r2-l1)
276
elif opcode == 'insert':
278
elif opcode == 'equal':
279
# Score equal ranges lower, making similar commands of equal
280
# length closer than arbitrary same length commands.
281
distance -= 0.1 * (l2-l1)
282
costs[name] = distance
283
costs.update(_GUESS_OVERRIDES.get(cmd_name, {}))
284
costs = sorted((costs[key], key) for key in costs)
289
candidate = costs[0][1]
293
233
def get_cmd_object(cmd_name, plugins_override=True):
294
234
"""Return the command object for a command.
300
240
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"')
242
raise errors.BzrCommandError('unknown command "%s"' % cmd_name)
312
245
def _get_cmd_object(cmd_name, plugins_override=True, check_missing=True):
342
275
# Allow plugins to extend commands
343
276
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
281
def _try_plugin_provider(cmd_name):
355
282
"""Probe for a plugin provider having cmd_name."""
357
284
plugin_metadata, provider = probe_for_provider(cmd_name)
358
raise CommandAvailableInPlugin(cmd_name, plugin_metadata, provider)
359
except NoPluginAvailable:
285
raise errors.CommandAvailableInPlugin(cmd_name,
286
plugin_metadata, provider)
287
except errors.NoPluginAvailable:
429
357
summary, then a complete description of the command. A grammar
430
358
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
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
448
382
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.)
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
469
399
: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
403
takes_options = []
481
404
encoding_type = 'strict'
487
408
def __init__(self):
488
409
"""Construct an instance of this command."""
410
if self.__doc__ == Command.__doc__:
411
warn("No help message set for %r" % self)
489
412
# List of standard options directly supported
490
413
self.supported_std_options = []
491
414
self._setup_run()
513
436
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.
515
451
def _usage(self):
516
452
"""Return single-line grammar for this command.
518
454
Only describes arguments, not options.
520
s = 'brz ' + self.name() + ' '
456
s = 'bzr ' + self.name() + ' '
521
457
for aname in self.takes_args:
522
458
aname = aname.upper()
523
459
if aname[-1] in ['$', '+']:
545
481
usage help (e.g. Purpose, Usage, Options) with a
546
482
message explaining how to obtain full help.
549
i18n.install() # Install i18n only for get_help_text for now.
550
484
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.")
486
raise NotImplementedError("sorry, no detailed help yet for %r" % self.name())
561
488
# Extract the summary (purpose) and sections out from the text
562
purpose, sections, order = self._get_help_parts(doc)
489
purpose,sections,order = self._get_help_parts(doc)
564
491
# If a custom usage section was provided, use it
565
if 'Usage' in sections:
492
if sections.has_key('Usage'):
566
493
usage = sections.pop('Usage')
568
495
usage = self._usage()
570
497
# The header is the purpose and usage
572
result += gettext(':Purpose: %s\n') % (purpose,)
499
result += ':Purpose: %s\n' % purpose
573
500
if usage.find('\n') >= 0:
574
result += gettext(':Usage:\n%s\n') % (usage,)
501
result += ':Usage:\n%s\n' % usage
576
result += gettext(':Usage: %s\n') % (usage,)
503
result += ':Usage: %s\n' % usage
579
506
# Add the options
581
508
# XXX: optparse implicitly rewraps the help, and not always perfectly,
582
509
# 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:
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:
593
518
options = options.replace(' format:\n', ' format::\n\n', 1)
594
519
if options.startswith('Options:'):
595
result += gettext(':Options:%s') % (options[len('options:'):],)
520
result += ':' + options
521
elif options.startswith('options:'):
522
# Python 2.4 version of optparse
523
result += ':Options:' + options[len('options:'):]
597
525
result += options
601
529
# Add the description, indenting it 2 spaces
602
530
# to match the indentation of the options
531
if sections.has_key(None):
604
532
text = sections.pop(None)
605
533
text = '\n '.join(text.splitlines())
606
result += gettext(':Description:\n %s\n\n') % (text,)
534
result += ':%s:\n %s\n\n' % ('Description',text)
608
536
# Add the custom sections (e.g. Examples). Note that there's no need
609
537
# to indent these as they must be indented already in the source.
611
539
for label in order:
612
if label in sections:
613
result += ':%s:\n%s\n' % (label, sections[label])
540
if sections.has_key(label):
541
result += ':%s:\n%s\n' % (label,sections[label])
616
result += (gettext("See brz help %s for more details and examples.\n\n")
544
result += ("See bzr help %s for more details and examples.\n\n"
619
547
# Add the aliases, source (plug-in) and see also links, if any
621
result += gettext(':Aliases: ')
549
result += ':Aliases: '
622
550
result += ', '.join(self.aliases) + '\n'
623
551
plugin_name = self.plugin_name()
624
552
if plugin_name is not None:
625
result += gettext(':From: plugin "%s"\n') % plugin_name
553
result += ':From: plugin "%s"\n' % plugin_name
626
554
see_also = self.get_see_also(additional_see_also)
628
556
if not plain and see_also_as_links:
634
562
see_also_links.append(item)
636
564
# Use a Sphinx link for this entry
637
link_text = gettext(":doc:`{0} <{1}-help>`").format(
565
link_text = ":doc:`%s <%s-help>`" % (item, item)
639
566
see_also_links.append(link_text)
640
567
see_also = see_also_links
641
result += gettext(':See also: %s') % ', '.join(see_also) + '\n'
568
result += ':See also: '
569
result += ', '.join(see_also) + '\n'
643
571
# 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)
573
import bzrlib.help_topics
574
result = bzrlib.help_topics.help_as_plain_text(result)
670
598
summary = lines.pop(0)
673
label, section = None, ''
601
label,section = None,''
674
602
for line in lines:
675
603
if line.startswith(':') and line.endswith(':') and len(line) > 2:
676
604
save_section(sections, order, label, section)
677
label, section = line[1:-1], ''
605
label,section = line[1:-1],''
678
606
elif (label is not None) and len(line) > 1 and not line[0].isspace():
679
607
save_section(sections, order, label, section)
680
label, section = None, line
608
label,section = None,line
682
610
if len(section) > 0:
683
611
section += '\n' + line
725
653
def run_argv_aliases(self, argv, alias_argv=None):
726
654
"""Parse the command line and run with extra aliases in alias_argv."""
727
655
args, opts = parse_args(self, argv, alias_argv)
730
657
# Process the standard options
731
if 'help' in opts: # e.g. brz add --help
732
self.outf.write(self.get_help_text())
658
if 'help' in opts: # e.g. bzr add --help
659
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))
661
if 'usage' in opts: # e.g. bzr add --usage
662
sys.stdout.write(self.get_help_text(verbose=False))
737
664
trace.set_verbosity_level(option._verbosity_level)
738
665
if 'verbose' in self.supported_std_options:
739
666
opts['verbose'] = trace.is_verbose()
740
elif 'verbose' in opts:
667
elif opts.has_key('verbose'):
741
668
del opts['verbose']
742
669
if 'quiet' in self.supported_std_options:
743
670
opts['quiet'] = trace.is_quiet()
744
elif 'quiet' in opts:
671
elif opts.has_key('quiet'):
745
672
del opts['quiet']
746
674
# mix arguments and options into one dictionary
747
675
cmdargs = _match_argform(self.name(), self.takes_args, args)
752
680
all_cmd_args = cmdargs.copy()
753
681
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)
685
return self.run(**all_cmd_args)
765
687
def _setup_run(self):
766
688
"""Wrap the defined run method on self with a cleanup.
774
696
class_run = self.run
775
697
def run(*args, **kwargs):
776
for hook in Command.hooks['pre_command']:
778
698
self._operation = cleanup.OperationWithCleanups(class_run)
780
700
return self._operation.run_simple(*args, **kwargs)
782
702
del self._operation
783
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)
788
711
"""Actually run the command.
847
762
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',
766
self.create_hook(HookPoint('extend_command',
852
767
"Called after creating a command object to allow modifications "
853
768
"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',
769
"new bzrlib.commands.Command object.", (1, 13), None))
770
self.create_hook(HookPoint('get_command',
856
771
"Called when creating a single command. Called with "
857
772
"(cmd_or_None, command_name). get_command should either return "
858
773
"the cmd_or_None parameter, or a replacement Command object that "
859
774
"should be used for the command. Note that the Command.hooks "
860
775
"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',
776
"bzrlib.commands.register_command or plugin_cmds.register_lazy.",
778
self.create_hook(HookPoint('get_missing_command',
864
779
"Called when creating a single command if no command could be "
865
780
"found. Called with (command_name). get_missing_command should "
866
781
"either return None, or a Command object to be used for the "
868
self.add_hook('list_commands',
782
"command.", (1, 17), None))
783
self.create_hook(HookPoint('list_commands',
869
784
"Called when enumerating commands. Called with a set of "
870
785
"cmd_name strings for all the commands found so far. This set "
871
786
" is safe to mutate - e.g. to remove a command. "
872
787
"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
790
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)
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])
909
811
return args, opts
926
828
argdict[argname + '_list'] = None
927
829
elif ap[-1] == '+':
929
raise errors.BzrCommandError(gettext(
930
"command {0!r} needs one or more {1}").format(
931
cmd, argname.upper()))
831
raise errors.BzrCommandError("command %r needs one or more %s"
832
% (cmd, argname.upper()))
933
834
argdict[argname + '_list'] = args[:]
935
836
elif ap[-1] == '$': # all but one
936
837
if len(args) < 2:
937
raise errors.BzrCommandError(
938
gettext("command {0!r} needs one or more {1}").format(
939
cmd, argname.upper()))
838
raise errors.BzrCommandError("command %r needs one or more %s"
839
% (cmd, argname.upper()))
940
840
argdict[argname + '_list'] = args[:-1]
943
843
# just a plain arg
946
raise errors.BzrCommandError(
947
gettext("command {0!r} requires argument {1}").format(
948
cmd, argname.upper()))
846
raise errors.BzrCommandError("command %r requires argument %s"
847
% (cmd, argname.upper()))
950
849
argdict[argname] = args.pop(0)
953
raise errors.BzrCommandError( gettext(
954
"extra argument to command {0}: {1}").format(
852
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
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)
966
867
return exception_to_return_code(the_callable, *args, **kwargs)
870
results = tracer.results()
871
results.write_results(show_missing=1, summary=False,
972
875
def apply_profiled(the_callable, *args, **kwargs):
1004
907
return the_callable(*args, **kwargs)
1005
except (KeyboardInterrupt, Exception) as e:
908
except (KeyboardInterrupt, Exception), e:
1006
909
# used to handle AssertionError and KeyboardInterrupt
1007
910
# specially here, but hopefully they're handled ok by the logger now
1008
911
exc_info = sys.exc_info()
1009
912
exitcode = trace.report_exception(exc_info, sys.stderr)
1010
if os.environ.get('BRZ_PDB'):
1011
print('**** entering debugger')
913
if os.environ.get('BZR_PDB'):
914
print '**** entering debugger'
1013
pdb.post_mortem(exc_info[2])
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])
1017
940
def apply_lsprofiled(filename, the_callable, *args, **kwargs):
1018
from breezy.lsprof import profile
1019
ret, stats = profile(exception_to_return_code, the_callable,
941
from bzrlib.lsprof import profile
942
ret, stats = profile(exception_to_return_code, the_callable, *args, **kwargs)
1022
944
if filename is None:
1025
947
stats.save(filename)
1026
trace.note(gettext('Profile data written to "%s".'), filename)
948
trace.note('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)
1030
957
def get_alias(cmd, config=None):
1031
958
"""Return an expanded alias, or None if no alias exists.
1082
1009
Run under the Python lsprof profiler.
1085
Generate code coverage report
1012
Generate line coverage report in the specified directory.
1088
1015
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)
1017
trace.mutter("bazaar version: " + bzrlib.__version__)
1019
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
1021
opt_lsprof = opt_profile = opt_no_plugins = opt_builtin = \
1022
opt_no_aliases = False
1023
opt_lsprof_file = opt_coverage_dir = None
1098
1025
# --no-plugins is handled specially at a very early stage. We need
1099
1026
# to load plugins before doing other command parsing so that they
1116
1042
opt_no_plugins = True
1117
1043
elif a == '--no-aliases':
1118
1044
opt_no_aliases = True
1119
elif a == '--no-l10n':
1121
1045
elif a == '--builtin':
1122
1046
opt_builtin = True
1123
1047
elif a == '--concurrency':
1124
os.environ['BRZ_CONCURRENCY'] = argv[i + 1]
1048
os.environ['BZR_CONCURRENCY'] = argv[i + 1]
1126
1050
elif a == '--coverage':
1128
elif a == '--profile-imports':
1129
pass # already handled in startup script Bug #588277
1051
opt_coverage_dir = argv[i + 1]
1130
1053
elif a.startswith('-D'):
1131
1054
debug.debug_flags.add(a[2:])
1132
elif a.startswith('-O'):
1133
override_config.append(a[2:])
1135
1056
argv_copy.append(a)
1138
cmdline_overrides = breezy.get_global_state().cmdline_overrides
1139
cmdline_overrides._from_cmdline(override_config)
1141
1059
debug.set_debug_flags_from_config()
1143
1061
if not opt_no_plugins:
1159
1077
if not opt_no_aliases:
1160
1078
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]
1162
1082
argv[0] = alias_argv.pop(0)
1164
1084
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.
1165
1089
cmd_obj = get_cmd_object(cmd, plugins_override=not opt_builtin)
1167
cmd_obj.l10n = False
1168
1090
run = cmd_obj.run_argv_aliases
1169
1091
run_argv = [argv, alias_argv]
1174
1096
saved_verbosity_level = option._verbosity_level
1175
1097
option._verbosity_level = 0
1099
if opt_coverage_dir:
1179
1101
'--coverage ignored, because --lsprof is in use.')
1180
1102
ret = apply_lsprofiled(opt_lsprof_file, run, *run_argv)
1181
1103
elif opt_profile:
1104
if opt_coverage_dir:
1184
1106
'--coverage ignored, because --profile is in use.')
1185
1107
ret = apply_profiled(run, *run_argv)
1187
ret = apply_coveraged(run, *run_argv)
1108
elif opt_coverage_dir:
1109
ret = apply_coveraged(opt_coverage_dir, run, *run_argv)
1189
1111
ret = run(*run_argv)
1190
1112
return ret or 0
1242
1161
# the process arguments in a unicode-safe way.
1243
1162
if argv is None:
1244
1163
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.")
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.")
1260
1178
def main(argv=None):
1261
1179
"""Main entry point of command-line interface.
1263
Typically `breezy.initialize` should be called first.
1181
Typically `bzrlib.initialize` should be called first.
1265
1183
:param argv: list of unicode command-line arguments similar to sys.argv.
1266
1184
argv[0] is script name usually, it will be ignored.
1267
1185
Don't pass here sys.argv because this list contains plain strings
1268
1186
and not unicode; pass None instead.
1270
:return: exit code of brz command.
1188
:return: exit code of bzr command.
1272
if argv is not None:
1190
argv = _specified_or_unicode_argv(argv)
1274
1191
_register_builtin_commands()
1275
1192
ret = run_bzr_catch_errors(argv)
1193
bzrlib.ui.ui_factory.log_transport_activity(
1194
display=('bytes' in debug.debug_flags))
1276
1195
trace.mutter("return code %d", ret)
1333
1252
class Provider(object):
1334
"""Generic class to be overriden by plugins"""
1253
'''Generic class to be overriden by plugins'''
1336
1255
def plugin_for_command(self, cmd_name):
1337
"""Takes a command and returns the information for that plugin
1256
'''Takes a command and returns the information for that plugin
1339
1258
:return: A dictionary with all the available information
1340
for the requested plugin
1259
for the requested plugin
1342
1261
raise NotImplementedError
1345
1264
class ProvidersRegistry(registry.Registry):
1346
"""This registry exists to allow other providers to exist"""
1265
'''This registry exists to allow other providers to exist'''
1348
1267
def __iter__(self):
1349
for key, provider in self.items():
1268
for key, provider in self.iteritems():
1352
1271
command_providers_registry = ProvidersRegistry()
added
removed
bzrlib/commands.py
