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.
267
from . import patiencediff
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.
473
This is set by assigning explicitly to __doc__ so that -OO can
477
__doc__ = "My help goes here"
481
403
takes_options = []
482
404
encoding_type = 'strict'
488
408
def __init__(self):
489
409
"""Construct an instance of this command."""
410
if self.__doc__ == Command.__doc__:
411
warn("No help message set for %r" % self)
490
412
# List of standard options directly supported
491
413
self.supported_std_options = []
492
414
self._setup_run()
514
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.
516
451
def _usage(self):
517
452
"""Return single-line grammar for this command.
519
454
Only describes arguments, not options.
521
s = 'brz ' + self.name() + ' '
456
s = 'bzr ' + self.name() + ' '
522
457
for aname in self.takes_args:
523
458
aname = aname.upper()
524
459
if aname[-1] in ['$', '+']:
546
481
usage help (e.g. Purpose, Usage, Options) with a
547
482
message explaining how to obtain full help.
550
i18n.install() # Install i18n only for get_help_text for now.
551
484
doc = self.help()
553
# Note: If self.gettext() translates ':Usage:\n', the section will
554
# be shown after "Description" section and we don't want to
555
# translate the usage string.
556
# Though, brz export-pot don't exports :Usage: section and it must
558
doc = self.gettext(doc)
560
doc = gettext("No help for this command.")
486
raise NotImplementedError("sorry, no detailed help yet for %r" % self.name())
562
488
# Extract the summary (purpose) and sections out from the text
563
purpose, sections, order = self._get_help_parts(doc)
489
purpose,sections,order = self._get_help_parts(doc)
565
491
# If a custom usage section was provided, use it
566
if 'Usage' in sections:
492
if sections.has_key('Usage'):
567
493
usage = sections.pop('Usage')
569
495
usage = self._usage()
571
497
# The header is the purpose and usage
573
result += gettext(':Purpose: %s\n') % (purpose,)
499
result += ':Purpose: %s\n' % purpose
574
500
if usage.find('\n') >= 0:
575
result += gettext(':Usage:\n%s\n') % (usage,)
501
result += ':Usage:\n%s\n' % usage
577
result += gettext(':Usage: %s\n') % (usage,)
503
result += ':Usage: %s\n' % usage
580
506
# Add the options
582
508
# XXX: optparse implicitly rewraps the help, and not always perfectly,
583
509
# so we get <https://bugs.launchpad.net/bzr/+bug/249908>. -- mbp
585
parser = option.get_optparser(
586
[v for k, v in sorted(self.options().items())])
587
options = parser.format_option_help()
588
# FIXME: According to the spec, ReST option lists actually don't
589
# support options like --1.14 so that causes syntax errors (in Sphinx
590
# at least). As that pattern always appears in the commands that
591
# break, we trap on that and then format that block of 'format' options
592
# as a literal block. We use the most recent format still listed so we
593
# don't have to do that too often -- vila 20110514
594
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:
595
518
options = options.replace(' format:\n', ' format::\n\n', 1)
596
519
if options.startswith('Options:'):
597
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:'):]
599
525
result += options
603
529
# Add the description, indenting it 2 spaces
604
530
# to match the indentation of the options
531
if sections.has_key(None):
606
532
text = sections.pop(None)
607
533
text = '\n '.join(text.splitlines())
608
result += gettext(':Description:\n %s\n\n') % (text,)
534
result += ':%s:\n %s\n\n' % ('Description',text)
610
536
# Add the custom sections (e.g. Examples). Note that there's no need
611
537
# to indent these as they must be indented already in the source.
613
539
for label in order:
614
if label in sections:
615
result += ':%s:\n%s\n' % (label, sections[label])
540
if sections.has_key(label):
541
result += ':%s:\n%s\n' % (label,sections[label])
618
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"
621
547
# Add the aliases, source (plug-in) and see also links, if any
623
result += gettext(':Aliases: ')
549
result += ':Aliases: '
624
550
result += ', '.join(self.aliases) + '\n'
625
551
plugin_name = self.plugin_name()
626
552
if plugin_name is not None:
627
result += gettext(':From: plugin "%s"\n') % plugin_name
553
result += ':From: plugin "%s"\n' % plugin_name
628
554
see_also = self.get_see_also(additional_see_also)
630
556
if not plain and see_also_as_links:
636
562
see_also_links.append(item)
638
564
# Use a Sphinx link for this entry
639
link_text = gettext(":doc:`{0} <{1}-help>`").format(
565
link_text = ":doc:`%s <%s-help>`" % (item, item)
641
566
see_also_links.append(link_text)
642
567
see_also = see_also_links
643
result += gettext(':See also: %s') % ', '.join(see_also) + '\n'
568
result += ':See also: '
569
result += ', '.join(see_also) + '\n'
645
571
# If this will be rendered as plain text, convert it
647
import breezy.help_topics
648
result = breezy.help_topics.help_as_plain_text(result)
573
import bzrlib.help_topics
574
result = bzrlib.help_topics.help_as_plain_text(result)
672
598
summary = lines.pop(0)
675
label, section = None, ''
601
label,section = None,''
676
602
for line in lines:
677
603
if line.startswith(':') and line.endswith(':') and len(line) > 2:
678
604
save_section(sections, order, label, section)
679
label, section = line[1:-1], ''
680
elif (label is not None and len(line) > 1 and
681
not line[0].isspace()):
605
label,section = line[1:-1],''
606
elif (label is not None) and len(line) > 1 and not line[0].isspace():
682
607
save_section(sections, order, label, section)
683
label, section = None, line
608
label,section = None,line
685
610
if len(section) > 0:
686
611
section += '\n' + line
728
653
def run_argv_aliases(self, argv, alias_argv=None):
729
654
"""Parse the command line and run with extra aliases in alias_argv."""
730
655
args, opts = parse_args(self, argv, alias_argv)
733
657
# Process the standard options
734
if 'help' in opts: # e.g. brz add --help
735
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())
737
if 'usage' in opts: # e.g. brz add --usage
738
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))
740
664
trace.set_verbosity_level(option._verbosity_level)
741
665
if 'verbose' in self.supported_std_options:
742
666
opts['verbose'] = trace.is_verbose()
743
elif 'verbose' in opts:
667
elif opts.has_key('verbose'):
744
668
del opts['verbose']
745
669
if 'quiet' in self.supported_std_options:
746
670
opts['quiet'] = trace.is_quiet()
747
elif 'quiet' in opts:
671
elif opts.has_key('quiet'):
748
672
del opts['quiet']
749
674
# mix arguments and options into one dictionary
750
675
cmdargs = _match_argform(self.name(), self.takes_args, args)
755
680
all_cmd_args = cmdargs.copy()
756
681
all_cmd_args.update(cmdopts)
759
return self.run(**all_cmd_args)
761
# reset it, so that other commands run in the same process won't
762
# inherit state. Before we reset it, log any activity, so that it
763
# gets properly tracked.
764
ui.ui_factory.log_transport_activity(
765
display=('bytes' in debug.debug_flags))
766
trace.set_verbosity_level(0)
685
return self.run(**all_cmd_args)
768
687
def _setup_run(self):
769
688
"""Wrap the defined run method on self with a cleanup.
775
694
you can override this method.
777
696
class_run = self.run
779
697
def run(*args, **kwargs):
780
for hook in Command.hooks['pre_command']:
782
698
self._operation = cleanup.OperationWithCleanups(class_run)
784
700
return self._operation.run_simple(*args, **kwargs)
786
702
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)
792
711
"""Actually run the command.
851
762
These are all empty initially, because by default nothing should get
854
Hooks.__init__(self, "breezy.commands", "Command.hooks")
766
self.create_hook(HookPoint('extend_command',
857
767
"Called after creating a command object to allow modifications "
858
768
"such as adding or removing options, docs etc. Called with the "
859
"new breezy.commands.Command object.", (1, 13))
769
"new bzrlib.commands.Command object.", (1, 13), None))
770
self.create_hook(HookPoint('get_command',
862
771
"Called when creating a single command. Called with "
863
772
"(cmd_or_None, command_name). get_command should either return "
864
773
"the cmd_or_None parameter, or a replacement Command object that "
865
774
"should be used for the command. Note that the Command.hooks "
866
775
"hooks are core infrastructure. Many users will prefer to use "
867
"breezy.commands.register_command or plugin_cmds.register_lazy.",
870
'get_missing_command',
776
"bzrlib.commands.register_command or plugin_cmds.register_lazy.",
778
self.create_hook(HookPoint('get_missing_command',
871
779
"Called when creating a single command if no command could be "
872
780
"found. Called with (command_name). get_missing_command should "
873
781
"either return None, or a Command object to be used for the "
782
"command.", (1, 17), None))
783
self.create_hook(HookPoint('list_commands',
877
784
"Called when enumerating commands. Called with a set of "
878
785
"cmd_name strings for all the commands found so far. This set "
879
786
" is safe to mutate - e.g. to remove a command. "
880
787
"list_commands should return the updated set of command names.",
884
"Called prior to executing a command. Called with the command "
888
"Called after executing a command. Called with the command "
892
790
Command.hooks = CommandHooks()
901
799
they take, and which commands will accept them.
903
801
# TODO: make it a method of the Command?
904
parser = option.get_optparser(
905
[v for k, v in sorted(command.options().items())])
802
parser = option.get_optparser(command.options())
906
803
if alias_argv is not None:
907
804
args = alias_argv + argv
911
# python 2's optparse raises this exception if a non-ascii
912
# option name is given. See http://bugs.python.org/issue2931
914
options, args = parser.parse_args(args)
915
except UnicodeEncodeError:
916
raise errors.BzrCommandError(
917
gettext('Only ASCII permitted in option names'))
919
opts = dict((k, v) for k, v in options.__dict__.items() if
920
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])
921
811
return args, opts
938
828
argdict[argname + '_list'] = None
939
829
elif ap[-1] == '+':
941
raise errors.BzrCommandError(gettext(
942
"command {0!r} needs one or more {1}").format(
943
cmd, argname.upper()))
831
raise errors.BzrCommandError("command %r needs one or more %s"
832
% (cmd, argname.upper()))
945
834
argdict[argname + '_list'] = args[:]
947
elif ap[-1] == '$': # all but one
836
elif ap[-1] == '$': # all but one
948
837
if len(args) < 2:
949
raise errors.BzrCommandError(
950
gettext("command {0!r} needs one or more {1}").format(
951
cmd, argname.upper()))
838
raise errors.BzrCommandError("command %r needs one or more %s"
839
% (cmd, argname.upper()))
952
840
argdict[argname + '_list'] = args[:-1]
955
843
# just a plain arg
958
raise errors.BzrCommandError(
959
gettext("command {0!r} requires argument {1}").format(
960
cmd, argname.upper()))
846
raise errors.BzrCommandError("command %r requires argument %s"
847
% (cmd, argname.upper()))
962
849
argdict[argname] = args.pop(0)
965
raise errors.BzrCommandError(gettext(
966
"extra argument to command {0}: {1}").format(
852
raise errors.BzrCommandError("extra argument to command %s: %s"
972
def apply_coveraged(the_callable, *args, **kwargs):
974
cov = coverage.Coverage()
975
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)
978
867
return exception_to_return_code(the_callable, *args, **kwargs)
870
results = tracer.results()
871
results.write_results(show_missing=1, summary=False,
984
875
def apply_profiled(the_callable, *args, **kwargs):
1016
907
return the_callable(*args, **kwargs)
1017
except (KeyboardInterrupt, Exception):
908
except (KeyboardInterrupt, Exception), e:
1018
909
# used to handle AssertionError and KeyboardInterrupt
1019
910
# specially here, but hopefully they're handled ok by the logger now
1020
911
exc_info = sys.exc_info()
1021
912
exitcode = trace.report_exception(exc_info, sys.stderr)
1022
if os.environ.get('BRZ_PDB'):
1023
print('**** entering debugger')
913
if os.environ.get('BZR_PDB'):
914
print '**** entering debugger'
1025
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])
1029
940
def apply_lsprofiled(filename, the_callable, *args, **kwargs):
1030
from breezy.lsprof import profile
1031
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)
1034
944
if filename is None:
1037
947
stats.save(filename)
1038
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)
1042
957
def get_alias(cmd, config=None):
1043
958
"""Return an expanded alias, or None if no alias exists.
1094
1009
Run under the Python lsprof profiler.
1097
Generate code coverage report
1012
Generate line coverage report in the specified directory.
1100
Specify the number of processes that can be run concurrently
1015
Specify the number of processes that can be run concurrently (selftest).
1103
trace.mutter("breezy version: " + breezy.__version__)
1104
argv = _specified_or_unicode_argv(argv)
1105
trace.mutter("brz arguments: %r", argv)
1017
trace.mutter("bazaar version: " + bzrlib.__version__)
1019
trace.mutter("bzr arguments: %r", argv)
1107
opt_lsprof = opt_profile = opt_no_plugins = opt_builtin = \
1108
opt_coverage = opt_no_l10n = opt_no_aliases = False
1109
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
1111
1025
# --no-plugins is handled specially at a very early stage. We need
1112
1026
# to load plugins before doing other command parsing so that they
1129
1042
opt_no_plugins = True
1130
1043
elif a == '--no-aliases':
1131
1044
opt_no_aliases = True
1132
elif a == '--no-l10n':
1134
1045
elif a == '--builtin':
1135
1046
opt_builtin = True
1136
1047
elif a == '--concurrency':
1137
os.environ['BRZ_CONCURRENCY'] = argv[i + 1]
1048
os.environ['BZR_CONCURRENCY'] = argv[i + 1]
1139
1050
elif a == '--coverage':
1141
elif a == '--profile-imports':
1142
pass # already handled in startup script Bug #588277
1051
opt_coverage_dir = argv[i + 1]
1143
1053
elif a.startswith('-D'):
1144
1054
debug.debug_flags.add(a[2:])
1145
elif a.startswith('-O'):
1146
override_config.append(a[2:])
1148
1056
argv_copy.append(a)
1151
cmdline_overrides = breezy.get_global_state().cmdline_overrides
1152
cmdline_overrides._from_cmdline(override_config)
1154
1059
debug.set_debug_flags_from_config()
1156
1061
if not opt_no_plugins:
1172
1077
if not opt_no_aliases:
1173
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]
1175
1082
argv[0] = alias_argv.pop(0)
1177
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.
1178
1089
cmd_obj = get_cmd_object(cmd, plugins_override=not opt_builtin)
1180
cmd_obj.l10n = False
1181
1090
run = cmd_obj.run_argv_aliases
1182
1091
run_argv = [argv, alias_argv]
1187
1096
saved_verbosity_level = option._verbosity_level
1188
1097
option._verbosity_level = 0
1099
if opt_coverage_dir:
1192
1101
'--coverage ignored, because --lsprof is in use.')
1193
1102
ret = apply_lsprofiled(opt_lsprof_file, run, *run_argv)
1194
1103
elif opt_profile:
1104
if opt_coverage_dir:
1197
1106
'--coverage ignored, because --profile is in use.')
1198
1107
ret = apply_profiled(run, *run_argv)
1200
ret = apply_coveraged(run, *run_argv)
1108
elif opt_coverage_dir:
1109
ret = apply_coveraged(opt_coverage_dir, run, *run_argv)
1202
1111
ret = run(*run_argv)
1203
1112
return ret or 0
1237
1144
if _list_bzr_commands in Command.hooks["list_commands"]:
1239
1146
Command.hooks.install_named_hook("list_commands", _list_bzr_commands,
1241
1148
Command.hooks.install_named_hook("get_command", _get_bzr_command,
1243
1150
Command.hooks.install_named_hook("get_command", _get_plugin_command,
1244
"bzr plugin commands")
1151
"bzr plugin commands")
1245
1152
Command.hooks.install_named_hook("get_command", _get_external_command,
1246
"bzr external command lookup")
1247
Command.hooks.install_named_hook("get_missing_command",
1248
_try_plugin_provider,
1249
"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")
1252
1159
def _specified_or_unicode_argv(argv):
1254
1161
# the process arguments in a unicode-safe way.
1255
1162
if argv is None:
1256
1163
return osutils.get_unicode_argv()
1259
# ensure all arguments are unicode strings
1261
if not isinstance(a, string_types):
1262
raise ValueError('not native str or unicode: %r' % (a,))
1263
if isinstance(a, bytes):
1264
# For Python 2 only allow ascii native strings
1265
a = a.decode('ascii')
1267
except (ValueError, UnicodeDecodeError):
1268
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.")
1272
1178
def main(argv=None):
1273
1179
"""Main entry point of command-line interface.
1275
Typically `breezy.initialize` should be called first.
1181
Typically `bzrlib.initialize` should be called first.
1277
1183
:param argv: list of unicode command-line arguments similar to sys.argv.
1278
1184
argv[0] is script name usually, it will be ignored.
1279
1185
Don't pass here sys.argv because this list contains plain strings
1280
1186
and not unicode; pass None instead.
1282
:return: exit code of brz command.
1188
:return: exit code of bzr command.
1284
if argv is not None:
1190
argv = _specified_or_unicode_argv(argv)
1286
1191
_register_builtin_commands()
1287
1192
ret = run_bzr_catch_errors(argv)
1193
bzrlib.ui.ui_factory.log_transport_activity(
1194
display=('bytes' in debug.debug_flags))
1288
1195
trace.mutter("return code %d", ret)
1346
1252
class Provider(object):
1347
"""Generic class to be overriden by plugins"""
1253
'''Generic class to be overriden by plugins'''
1349
1255
def plugin_for_command(self, cmd_name):
1350
"""Takes a command and returns the information for that plugin
1256
'''Takes a command and returns the information for that plugin
1352
1258
:return: A dictionary with all the available information
1353
for the requested plugin
1259
for the requested plugin
1355
1261
raise NotImplementedError
1358
1264
class ProvidersRegistry(registry.Registry):
1359
"""This registry exists to allow other providers to exist"""
1265
'''This registry exists to allow other providers to exist'''
1361
1267
def __iter__(self):
1362
for key, provider in self.items():
1268
for key, provider in self.iteritems():
1366
1271
command_providers_registry = ProvidersRegistry()
added
removed
bzrlib/commands.py
