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.
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 = []
414
self._operation = cleanup.OperationWithCleanups(self.run)
493
416
def add_cleanup(self, cleanup_func, *args, **kwargs):
494
417
"""Register a function to call after self.run returns or raises.
507
430
This is useful for releasing expensive or contentious resources (such
508
431
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.
432
resources (such as writing results to self.outf).
513
434
self._operation.cleanup_now()
436
@deprecated_method(deprecated_in((2, 1, 0)))
437
def _maybe_expand_globs(self, file_list):
438
"""Glob expand file_list if the platform does not do that itself.
440
Not used anymore, now that the bzr command-line parser globs on
443
:return: A possibly empty list of unicode paths.
445
Introduced in bzrlib 0.18.
515
449
def _usage(self):
516
450
"""Return single-line grammar for this command.
518
452
Only describes arguments, not options.
520
s = 'brz ' + self.name() + ' '
454
s = 'bzr ' + self.name() + ' '
521
455
for aname in self.takes_args:
522
456
aname = aname.upper()
523
457
if aname[-1] in ['$', '+']:
545
479
usage help (e.g. Purpose, Usage, Options) with a
546
480
message explaining how to obtain full help.
549
i18n.install() # Install i18n only for get_help_text for now.
550
482
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.")
484
raise NotImplementedError("sorry, no detailed help yet for %r" % self.name())
561
486
# Extract the summary (purpose) and sections out from the text
562
purpose, sections, order = self._get_help_parts(doc)
487
purpose,sections,order = self._get_help_parts(doc)
564
489
# If a custom usage section was provided, use it
565
if 'Usage' in sections:
490
if sections.has_key('Usage'):
566
491
usage = sections.pop('Usage')
568
493
usage = self._usage()
570
495
# The header is the purpose and usage
572
result += gettext(':Purpose: %s\n') % (purpose,)
497
result += ':Purpose: %s\n' % purpose
573
498
if usage.find('\n') >= 0:
574
result += gettext(':Usage:\n%s\n') % (usage,)
499
result += ':Usage:\n%s\n' % usage
576
result += gettext(':Usage: %s\n') % (usage,)
501
result += ':Usage: %s\n' % usage
579
504
# Add the options
581
506
# XXX: optparse implicitly rewraps the help, and not always perfectly,
582
507
# 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:
509
options = option.get_optparser(self.options()).format_option_help()
510
# XXX: According to the spec, ReST option lists actually don't support
511
# options like --1.9 so that causes syntax errors (in Sphinx at least).
512
# As that pattern always appears in the commands that break, we trap
513
# on that and then format that block of 'format' options as a literal
515
if not plain and options.find(' --1.9 ') != -1:
593
516
options = options.replace(' format:\n', ' format::\n\n', 1)
594
517
if options.startswith('Options:'):
595
result += gettext(':Options:%s') % (options[len('options:'):],)
518
result += ':' + options
519
elif options.startswith('options:'):
520
# Python 2.4 version of optparse
521
result += ':Options:' + options[len('options:'):]
597
523
result += options
601
527
# Add the description, indenting it 2 spaces
602
528
# to match the indentation of the options
529
if sections.has_key(None):
604
530
text = sections.pop(None)
605
531
text = '\n '.join(text.splitlines())
606
result += gettext(':Description:\n %s\n\n') % (text,)
532
result += ':%s:\n %s\n\n' % ('Description',text)
608
534
# Add the custom sections (e.g. Examples). Note that there's no need
609
535
# to indent these as they must be indented already in the source.
611
537
for label in order:
612
if label in sections:
613
result += ':%s:\n%s\n' % (label, sections[label])
538
if sections.has_key(label):
539
result += ':%s:\n%s\n' % (label,sections[label])
616
result += (gettext("See brz help %s for more details and examples.\n\n")
542
result += ("See bzr help %s for more details and examples.\n\n"
619
545
# Add the aliases, source (plug-in) and see also links, if any
621
result += gettext(':Aliases: ')
547
result += ':Aliases: '
622
548
result += ', '.join(self.aliases) + '\n'
623
549
plugin_name = self.plugin_name()
624
550
if plugin_name is not None:
625
result += gettext(':From: plugin "%s"\n') % plugin_name
551
result += ':From: plugin "%s"\n' % plugin_name
626
552
see_also = self.get_see_also(additional_see_also)
628
554
if not plain and see_also_as_links:
634
560
see_also_links.append(item)
636
562
# Use a Sphinx link for this entry
637
link_text = gettext(":doc:`{0} <{1}-help>`").format(
563
link_text = ":doc:`%s <%s-help>`" % (item, item)
639
564
see_also_links.append(link_text)
640
565
see_also = see_also_links
641
result += gettext(':See also: %s') % ', '.join(see_also) + '\n'
566
result += ':See also: '
567
result += ', '.join(see_also) + '\n'
643
569
# 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)
571
import bzrlib.help_topics
572
result = bzrlib.help_topics.help_as_plain_text(result)
670
596
summary = lines.pop(0)
673
label, section = None, ''
599
label,section = None,''
674
600
for line in lines:
675
601
if line.startswith(':') and line.endswith(':') and len(line) > 2:
676
602
save_section(sections, order, label, section)
677
label, section = line[1:-1], ''
603
label,section = line[1:-1],''
678
604
elif (label is not None) and len(line) > 1 and not line[0].isspace():
679
605
save_section(sections, order, label, section)
680
label, section = None, line
606
label,section = None,line
682
608
if len(section) > 0:
683
609
section += '\n' + line
725
651
def run_argv_aliases(self, argv, alias_argv=None):
726
652
"""Parse the command line and run with extra aliases in alias_argv."""
727
653
args, opts = parse_args(self, argv, alias_argv)
730
655
# Process the standard options
731
if 'help' in opts: # e.g. brz add --help
732
self.outf.write(self.get_help_text())
656
if 'help' in opts: # e.g. bzr add --help
657
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))
659
if 'usage' in opts: # e.g. bzr add --usage
660
sys.stdout.write(self.get_help_text(verbose=False))
737
662
trace.set_verbosity_level(option._verbosity_level)
738
663
if 'verbose' in self.supported_std_options:
739
664
opts['verbose'] = trace.is_verbose()
740
elif 'verbose' in opts:
665
elif opts.has_key('verbose'):
741
666
del opts['verbose']
742
667
if 'quiet' in self.supported_std_options:
743
668
opts['quiet'] = trace.is_quiet()
744
elif 'quiet' in opts:
669
elif opts.has_key('quiet'):
745
670
del opts['quiet']
746
672
# mix arguments and options into one dictionary
747
673
cmdargs = _match_argform(self.name(), self.takes_args, args)
752
678
all_cmd_args = cmdargs.copy()
753
679
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']:
683
return self.run_direct(**all_cmd_args)
685
def run_direct(self, *args, **kwargs):
686
"""Call run directly with objects (without parsing an argv list)."""
687
return self._operation.run_simple(*args, **kwargs)
788
690
"""Actually run the command.
793
695
Return 0 or None if the command was successful, or a non-zero
794
696
shell error code if not. It's OK for this method to allow
795
697
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
699
raise NotImplementedError('no implementation of command %r'
847
730
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',
734
self.create_hook(HookPoint('extend_command',
852
735
"Called after creating a command object to allow modifications "
853
736
"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',
737
"new bzrlib.commands.Command object.", (1, 13), None))
738
self.create_hook(HookPoint('get_command',
856
739
"Called when creating a single command. Called with "
857
740
"(cmd_or_None, command_name). get_command should either return "
858
741
"the cmd_or_None parameter, or a replacement Command object that "
859
742
"should be used for the command. Note that the Command.hooks "
860
743
"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',
744
"bzrlib.commands.register_command or plugin_cmds.register_lazy.",
746
self.create_hook(HookPoint('get_missing_command',
864
747
"Called when creating a single command if no command could be "
865
748
"found. Called with (command_name). get_missing_command should "
866
749
"either return None, or a Command object to be used for the "
868
self.add_hook('list_commands',
750
"command.", (1, 17), None))
751
self.create_hook(HookPoint('list_commands',
869
752
"Called when enumerating commands. Called with a set of "
870
753
"cmd_name strings for all the commands found so far. This set "
871
754
" is safe to mutate - e.g. to remove a command. "
872
755
"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
758
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)
776
options, args = parser.parse_args(args)
777
opts = dict([(k, v) for k, v in options.__dict__.iteritems() if
778
v is not option.OptionParser.DEFAULT_VALUE])
909
779
return args, opts
926
796
argdict[argname + '_list'] = None
927
797
elif ap[-1] == '+':
929
raise errors.BzrCommandError(gettext(
930
"command {0!r} needs one or more {1}").format(
931
cmd, argname.upper()))
799
raise errors.BzrCommandError("command %r needs one or more %s"
800
% (cmd, argname.upper()))
933
802
argdict[argname + '_list'] = args[:]
935
804
elif ap[-1] == '$': # all but one
936
805
if len(args) < 2:
937
raise errors.BzrCommandError(
938
gettext("command {0!r} needs one or more {1}").format(
939
cmd, argname.upper()))
806
raise errors.BzrCommandError("command %r needs one or more %s"
807
% (cmd, argname.upper()))
940
808
argdict[argname + '_list'] = args[:-1]
943
811
# just a plain arg
946
raise errors.BzrCommandError(
947
gettext("command {0!r} requires argument {1}").format(
948
cmd, argname.upper()))
814
raise errors.BzrCommandError("command %r requires argument %s"
815
% (cmd, argname.upper()))
950
817
argdict[argname] = args.pop(0)
953
raise errors.BzrCommandError( gettext(
954
"extra argument to command {0}: {1}").format(
820
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
825
def apply_coveraged(dirname, the_callable, *args, **kwargs):
826
# Cannot use "import trace", as that would import bzrlib.trace instead of
827
# the standard library's trace.
828
trace = __import__('trace')
830
tracer = trace.Trace(count=1, trace=0)
831
sys.settrace(tracer.globaltrace)
832
threading.settrace(tracer.globaltrace)
966
835
return exception_to_return_code(the_callable, *args, **kwargs)
838
results = tracer.results()
839
results.write_results(show_missing=1, summary=False,
972
843
def apply_profiled(the_callable, *args, **kwargs):
1004
875
return the_callable(*args, **kwargs)
1005
except (KeyboardInterrupt, Exception) as e:
876
except (KeyboardInterrupt, Exception), e:
1006
877
# used to handle AssertionError and KeyboardInterrupt
1007
878
# specially here, but hopefully they're handled ok by the logger now
1008
879
exc_info = sys.exc_info()
1009
880
exitcode = trace.report_exception(exc_info, sys.stderr)
1010
if os.environ.get('BRZ_PDB'):
1011
print('**** entering debugger')
881
if os.environ.get('BZR_PDB'):
882
print '**** entering debugger'
1013
pdb.post_mortem(exc_info[2])
885
if sys.version_info[:2] < (2, 6):
887
# pdb.post_mortem(tb)
888
# but because pdb.post_mortem gives bad results for tracebacks
889
# from inside generators, we do it manually.
890
# (http://bugs.python.org/issue4150, fixed in Python 2.6)
892
# Setup pdb on the traceback
895
p.setup(tb.tb_frame, tb)
896
# Point the debugger at the deepest frame of the stack
897
p.curindex = len(p.stack) - 1
898
p.curframe = p.stack[p.curindex][0]
899
# Start the pdb prompt.
900
p.print_stack_entry(p.stack[p.curindex])
1017
908
def apply_lsprofiled(filename, the_callable, *args, **kwargs):
1018
from breezy.lsprof import profile
1019
ret, stats = profile(exception_to_return_code, the_callable,
909
from bzrlib.lsprof import profile
910
ret, stats = profile(exception_to_return_code, the_callable, *args, **kwargs)
1022
912
if filename is None:
1025
915
stats.save(filename)
1026
trace.note(gettext('Profile data written to "%s".'), filename)
916
trace.note('Profile data written to "%s".', filename)
920
@deprecated_function(deprecated_in((2, 2, 0)))
921
def shlex_split_unicode(unsplit):
922
return cmdline.split(unsplit)
1030
925
def get_alias(cmd, config=None):
1031
926
"""Return an expanded alias, or None if no alias exists.
1082
977
Run under the Python lsprof profiler.
1085
Generate code coverage report
980
Generate line coverage report in the specified directory.
1088
983
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)
985
trace.mutter("bazaar version: " + bzrlib.__version__)
987
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
989
opt_lsprof = opt_profile = opt_no_plugins = opt_builtin = \
990
opt_no_aliases = False
991
opt_lsprof_file = opt_coverage_dir = None
1098
993
# --no-plugins is handled specially at a very early stage. We need
1099
994
# to load plugins before doing other command parsing so that they
1116
1010
opt_no_plugins = True
1117
1011
elif a == '--no-aliases':
1118
1012
opt_no_aliases = True
1119
elif a == '--no-l10n':
1121
1013
elif a == '--builtin':
1122
1014
opt_builtin = True
1123
1015
elif a == '--concurrency':
1124
os.environ['BRZ_CONCURRENCY'] = argv[i + 1]
1016
os.environ['BZR_CONCURRENCY'] = argv[i + 1]
1126
1018
elif a == '--coverage':
1128
elif a == '--profile-imports':
1129
pass # already handled in startup script Bug #588277
1019
opt_coverage_dir = argv[i + 1]
1130
1021
elif a.startswith('-D'):
1131
1022
debug.debug_flags.add(a[2:])
1132
elif a.startswith('-O'):
1133
override_config.append(a[2:])
1135
1024
argv_copy.append(a)
1138
cmdline_overrides = breezy.get_global_state().cmdline_overrides
1139
cmdline_overrides._from_cmdline(override_config)
1141
1027
debug.set_debug_flags_from_config()
1143
1029
if not opt_no_plugins:
1159
1045
if not opt_no_aliases:
1160
1046
alias_argv = get_alias(argv[0])
1048
user_encoding = osutils.get_user_encoding()
1049
alias_argv = [a.decode(user_encoding) for a in alias_argv]
1162
1050
argv[0] = alias_argv.pop(0)
1164
1052
cmd = argv.pop(0)
1053
# We want only 'ascii' command names, but the user may have typed
1054
# in a Unicode name. In that case, they should just get a
1055
# 'command not found' error later.
1165
1057
cmd_obj = get_cmd_object(cmd, plugins_override=not opt_builtin)
1167
cmd_obj.l10n = False
1168
1058
run = cmd_obj.run_argv_aliases
1169
1059
run_argv = [argv, alias_argv]
1174
1064
saved_verbosity_level = option._verbosity_level
1175
1065
option._verbosity_level = 0
1067
if opt_coverage_dir:
1179
1069
'--coverage ignored, because --lsprof is in use.')
1180
1070
ret = apply_lsprofiled(opt_lsprof_file, run, *run_argv)
1181
1071
elif opt_profile:
1072
if opt_coverage_dir:
1184
1074
'--coverage ignored, because --profile is in use.')
1185
1075
ret = apply_profiled(run, *run_argv)
1187
ret = apply_coveraged(run, *run_argv)
1076
elif opt_coverage_dir:
1077
ret = apply_coveraged(opt_coverage_dir, run, *run_argv)
1189
1079
ret = run(*run_argv)
1190
1080
return ret or 0
1242
1129
# the process arguments in a unicode-safe way.
1243
1130
if argv is None:
1244
1131
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.")
1135
# ensure all arguments are unicode strings
1137
if isinstance(a, unicode):
1140
new_argv.append(a.decode('ascii'))
1141
except UnicodeDecodeError:
1142
raise errors.BzrError("argv should be list of unicode strings.")
1260
1146
def main(argv=None):
1261
1147
"""Main entry point of command-line interface.
1263
Typically `breezy.initialize` should be called first.
1149
Typically `bzrlib.initialize` should be called first.
1265
1151
:param argv: list of unicode command-line arguments similar to sys.argv.
1266
1152
argv[0] is script name usually, it will be ignored.
1267
1153
Don't pass here sys.argv because this list contains plain strings
1268
1154
and not unicode; pass None instead.
1270
:return: exit code of brz command.
1156
:return: exit code of bzr command.
1272
if argv is not None:
1158
argv = _specified_or_unicode_argv(argv)
1274
1159
_register_builtin_commands()
1275
1160
ret = run_bzr_catch_errors(argv)
1161
bzrlib.ui.ui_factory.log_transport_activity(
1162
display=('bytes' in debug.debug_flags))
1276
1163
trace.mutter("return code %d", ret)
1333
1220
class Provider(object):
1334
"""Generic class to be overriden by plugins"""
1221
'''Generic class to be overriden by plugins'''
1336
1223
def plugin_for_command(self, cmd_name):
1337
"""Takes a command and returns the information for that plugin
1224
'''Takes a command and returns the information for that plugin
1339
1226
:return: A dictionary with all the available information
1340
for the requested plugin
1227
for the requested plugin
1342
1229
raise NotImplementedError
1345
1232
class ProvidersRegistry(registry.Registry):
1346
"""This registry exists to allow other providers to exist"""
1233
'''This registry exists to allow other providers to exist'''
1348
1235
def __iter__(self):
1349
for key, provider in self.items():
1236
for key, provider in self.iteritems():
1352
1239
command_providers_registry = ProvidersRegistry()