24
26
# TODO: Specific "examples" property on commands for consistent formatting.
28
# TODO: "--profile=cum", to change sort order. Is there any value in leaving
29
# the profile output behind so it can be interactively examined?
29
from .lazy_import import lazy_import
34
from bzrlib.lazy_import import lazy_import
30
35
lazy_import(globals(), """
39
from warnings import warn
48
from .hooks import Hooks
49
from .i18n import gettext
52
from bzrlib.hooks import HookPoint, Hooks
50
53
# 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
54
from bzrlib.option import Option
55
from bzrlib import registry
56
from bzrlib.symbol_versioning import (
59
suppress_deprecation_warnings,
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
63
class CommandInfo(object):
87
64
"""Information about a command."""
189
135
def _unsquish_command_name(cmd):
190
return cmd[4:].replace('_', '-')
193
def _register_builtin_commands():
194
if builtin_command_registry.keys():
197
import breezy.builtins
198
for cmd_class in _scan_module_for_commands(breezy.builtins):
199
builtin_command_registry.register(cmd_class)
200
breezy.builtins._register_lazy_builtins()
136
return cmd[4:].replace('_','-')
139
def _builtin_commands():
140
import bzrlib.builtins
141
return _scan_module_for_commands(bzrlib.builtins)
203
144
def _scan_module_for_commands(module):
204
module_dict = module.__dict__
205
for name in module_dict:
146
for name, obj in module.__dict__.iteritems():
206
147
if name.startswith("cmd_"):
207
yield module_dict[name]
148
real_name = _unsquish_command_name(name)
210
153
def _list_bzr_commands(names):
211
"""Find commands from bzr's core and plugins.
213
This is not the public interface, just the default hook called by all_command_names.
154
"""Find commands from bzr's core and plugins."""
215
155
# to eliminate duplicates
216
156
names.update(builtin_command_names())
217
157
names.update(plugin_command_names())
244
183
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
186
@deprecated_function(deprecated_in((1, 17, 0)))
187
def get_all_cmds(plugins_override=False):
188
"""Return canonical name and class for most commands.
190
NB: This does not return all commands since the introduction of
191
command hooks, and returning the class is not sufficient to
192
get correctly setup commands, which is why it is deprecated.
194
Use 'all_command_names' + 'get_cmd_object' instead.
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]
196
d = _builtin_commands()
198
d.update(plugin_cmds.iteritems())
199
for k, v in d.iteritems():
293
203
def get_cmd_object(cmd_name, plugins_override=True):
300
210
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"')
312
def _get_cmd_object(cmd_name, plugins_override=True, check_missing=True):
212
raise errors.BzrCommandError('unknown command "%s"' % cmd_name)
215
def _get_cmd_object(cmd_name, plugins_override=True):
313
216
"""Get a command object.
315
218
:param cmd_name: The name of the command.
316
219
:param plugins_override: Allow plugins to override builtins.
317
:param check_missing: Look up commands not found in the regular index via
318
the get_missing_command hook.
319
220
:return: A Command object instance
320
221
:raises KeyError: If no command is found.
429
328
summary, then a complete description of the command. A grammar
430
329
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
332
Other accepted names for this command.
335
List of argument forms, marked with whether they are optional,
340
['to_location', 'from_branch?', 'file*']
342
'to_location' is required
343
'from_branch' is optional
344
'file' can be specified 0 or more times
347
List of options that may be given for this command. These can
348
be either strings, referring to globally-defined options,
349
or option objects. Retrieve through options().
352
If true, this command isn't advertised. This is typically
448
353
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.)
356
Command objects will get a 'outf' attribute, which has been
357
setup to properly handle encoding of unicode strings.
358
encoding_type determines what will happen when characters cannot
360
strict - abort if we cannot decode
361
replace - put in a bogus character (typically '?')
362
exact - do not encode sys.stdout
364
NOTE: by default on Windows, sys.stdout is opened as a text
365
stream, therefore LF line-endings are converted to CRLF.
366
When a command uses encoding_type = 'exact', then
367
sys.stdout is forced to be a binary stream, and line-endings
469
370
: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
374
takes_options = []
481
375
encoding_type = 'strict'
487
379
def __init__(self):
488
380
"""Construct an instance of this command."""
381
if self.__doc__ == Command.__doc__:
382
warn("No help message set for %r" % self)
489
383
# List of standard options directly supported
490
384
self.supported_std_options = []
493
def add_cleanup(self, cleanup_func, *args, **kwargs):
494
"""Register a function to call after self.run returns or raises.
496
Functions will be called in LIFO order.
498
self._operation.add_cleanup(cleanup_func, *args, **kwargs)
500
def cleanup_now(self):
501
"""Execute and empty pending cleanup functions immediately.
503
After cleanup_now all registered cleanups are forgotten. add_cleanup
504
may be called again after cleanup_now; these cleanups will be called
505
after self.run returns or raises (or when cleanup_now is next called).
507
This is useful for releasing expensive or contentious resources (such
508
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.
513
self._operation.cleanup_now()
386
def _maybe_expand_globs(self, file_list):
387
"""Glob expand file_list if the platform does not do that itself.
389
:return: A possibly empty list of unicode paths.
391
Introduced in bzrlib 0.18.
395
if sys.platform == 'win32':
396
file_list = win32utils.glob_expand(file_list)
397
return list(file_list)
515
399
def _usage(self):
516
400
"""Return single-line grammar for this command.
518
402
Only describes arguments, not options.
520
s = 'brz ' + self.name() + ' '
404
s = 'bzr ' + self.name() + ' '
521
405
for aname in self.takes_args:
522
406
aname = aname.upper()
523
407
if aname[-1] in ['$', '+']:
545
429
usage help (e.g. Purpose, Usage, Options) with a
546
430
message explaining how to obtain full help.
549
i18n.install() # Install i18n only for get_help_text for now.
550
432
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.")
434
raise NotImplementedError("sorry, no detailed help yet for %r" % self.name())
561
436
# Extract the summary (purpose) and sections out from the text
562
purpose, sections, order = self._get_help_parts(doc)
437
purpose,sections,order = self._get_help_parts(doc)
564
439
# If a custom usage section was provided, use it
565
if 'Usage' in sections:
440
if sections.has_key('Usage'):
566
441
usage = sections.pop('Usage')
568
443
usage = self._usage()
570
445
# The header is the purpose and usage
572
result += gettext(':Purpose: %s\n') % (purpose,)
447
result += ':Purpose: %s\n' % purpose
573
448
if usage.find('\n') >= 0:
574
result += gettext(':Usage:\n%s\n') % (usage,)
449
result += ':Usage:\n%s\n' % usage
576
result += gettext(':Usage: %s\n') % (usage,)
451
result += ':Usage: %s\n' % usage
579
454
# Add the options
581
456
# XXX: optparse implicitly rewraps the help, and not always perfectly,
582
457
# 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:
459
options = option.get_optparser(self.options()).format_option_help()
460
# XXX: According to the spec, ReST option lists actually don't support
461
# options like --1.9 so that causes syntax errors (in Sphinx at least).
462
# As that pattern always appears in the commands that break, we trap
463
# on that and then format that block of 'format' options as a literal
465
if not plain and options.find(' --1.9 ') != -1:
593
466
options = options.replace(' format:\n', ' format::\n\n', 1)
594
467
if options.startswith('Options:'):
595
result += gettext(':Options:%s') % (options[len('options:'):],)
468
result += ':' + options
469
elif options.startswith('options:'):
470
# Python 2.4 version of optparse
471
result += ':Options:' + options[len('options:'):]
597
473
result += options
601
477
# Add the description, indenting it 2 spaces
602
478
# to match the indentation of the options
479
if sections.has_key(None):
604
480
text = sections.pop(None)
605
481
text = '\n '.join(text.splitlines())
606
result += gettext(':Description:\n %s\n\n') % (text,)
482
result += ':%s:\n %s\n\n' % ('Description',text)
608
484
# Add the custom sections (e.g. Examples). Note that there's no need
609
485
# to indent these as they must be indented already in the source.
611
487
for label in order:
612
if label in sections:
613
result += ':%s:\n%s\n' % (label, sections[label])
488
if sections.has_key(label):
489
result += ':%s:\n%s\n' % (label,sections[label])
616
result += (gettext("See brz help %s for more details and examples.\n\n")
492
result += ("See bzr help %s for more details and examples.\n\n"
619
495
# Add the aliases, source (plug-in) and see also links, if any
621
result += gettext(':Aliases: ')
497
result += ':Aliases: '
622
498
result += ', '.join(self.aliases) + '\n'
623
499
plugin_name = self.plugin_name()
624
500
if plugin_name is not None:
625
result += gettext(':From: plugin "%s"\n') % plugin_name
501
result += ':From: plugin "%s"\n' % plugin_name
626
502
see_also = self.get_see_also(additional_see_also)
628
504
if not plain and see_also_as_links:
720
595
def _setup_outf(self):
721
596
"""Return a file linked to stdout, which has proper encoding."""
722
self.outf = ui.ui_factory.make_output_stream(
723
encoding_type=self.encoding_type)
597
# Originally I was using self.stdout, but that looks
598
# *way* too much like sys.stdout
599
if self.encoding_type == 'exact':
600
# force sys.stdout to be binary stream on win32
601
if sys.platform == 'win32':
602
fileno = getattr(sys.stdout, 'fileno', None)
605
msvcrt.setmode(fileno(), os.O_BINARY)
606
self.outf = sys.stdout
609
output_encoding = osutils.get_terminal_encoding()
611
self.outf = codecs.getwriter(output_encoding)(sys.stdout,
612
errors=self.encoding_type)
613
# For whatever reason codecs.getwriter() does not advertise its encoding
614
# it just returns the encoding of the wrapped file, which is completely
615
# bogus. So set the attribute, so we can find the correct encoding later.
616
self.outf.encoding = output_encoding
725
618
def run_argv_aliases(self, argv, alias_argv=None):
726
619
"""Parse the command line and run with extra aliases in alias_argv."""
621
warn("Passing None for [] is deprecated from bzrlib 0.10",
622
DeprecationWarning, stacklevel=2)
727
624
args, opts = parse_args(self, argv, alias_argv)
730
626
# Process the standard options
731
if 'help' in opts: # e.g. brz add --help
732
self.outf.write(self.get_help_text())
627
if 'help' in opts: # e.g. bzr add --help
628
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))
630
if 'usage' in opts: # e.g. bzr add --usage
631
sys.stdout.write(self.get_help_text(verbose=False))
737
633
trace.set_verbosity_level(option._verbosity_level)
738
634
if 'verbose' in self.supported_std_options:
739
635
opts['verbose'] = trace.is_verbose()
740
elif 'verbose' in opts:
636
elif opts.has_key('verbose'):
741
637
del opts['verbose']
742
638
if 'quiet' in self.supported_std_options:
743
639
opts['quiet'] = trace.is_quiet()
744
elif 'quiet' in opts:
640
elif opts.has_key('quiet'):
745
641
del opts['quiet']
746
643
# mix arguments and options into one dictionary
747
644
cmdargs = _match_argform(self.name(), self.takes_args, args)
752
649
all_cmd_args = cmdargs.copy()
753
650
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']:
654
return self.run(**all_cmd_args)
788
657
"""Actually run the command.
847
697
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',
701
self.create_hook(HookPoint('extend_command',
852
702
"Called after creating a command object to allow modifications "
853
703
"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',
704
"new bzrlib.commands.Command object.", (1, 13), None))
705
self.create_hook(HookPoint('get_command',
856
706
"Called when creating a single command. Called with "
857
707
"(cmd_or_None, command_name). get_command should either return "
858
708
"the cmd_or_None parameter, or a replacement Command object that "
859
709
"should be used for the command. Note that the Command.hooks "
860
710
"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',
711
"bzrlib.commands.register_command or plugin_cmds.register_lazy.",
713
self.create_hook(HookPoint('get_missing_command',
864
714
"Called when creating a single command if no command could be "
865
715
"found. Called with (command_name). get_missing_command should "
866
716
"either return None, or a Command object to be used for the "
868
self.add_hook('list_commands',
717
"command.", (1, 17), None))
718
self.create_hook(HookPoint('list_commands',
869
719
"Called when enumerating commands. Called with a set of "
870
720
"cmd_name strings for all the commands found so far. This set "
871
721
" is safe to mutate - e.g. to remove a command. "
872
722
"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
725
Command.hooks = CommandHooks()
926
763
argdict[argname + '_list'] = None
927
764
elif ap[-1] == '+':
929
raise errors.BzrCommandError(gettext(
930
"command {0!r} needs one or more {1}").format(
931
cmd, argname.upper()))
766
raise errors.BzrCommandError("command %r needs one or more %s"
767
% (cmd, argname.upper()))
933
769
argdict[argname + '_list'] = args[:]
935
771
elif ap[-1] == '$': # all but one
936
772
if len(args) < 2:
937
raise errors.BzrCommandError(
938
gettext("command {0!r} needs one or more {1}").format(
939
cmd, argname.upper()))
773
raise errors.BzrCommandError("command %r needs one or more %s"
774
% (cmd, argname.upper()))
940
775
argdict[argname + '_list'] = args[:-1]
943
778
# just a plain arg
946
raise errors.BzrCommandError(
947
gettext("command {0!r} requires argument {1}").format(
948
cmd, argname.upper()))
781
raise errors.BzrCommandError("command %r requires argument %s"
782
% (cmd, argname.upper()))
950
784
argdict[argname] = args.pop(0)
953
raise errors.BzrCommandError( gettext(
954
"extra argument to command {0}: {1}").format(
787
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
792
def apply_coveraged(dirname, the_callable, *args, **kwargs):
793
# Cannot use "import trace", as that would import bzrlib.trace instead of
794
# the standard library's trace.
795
trace = __import__('trace')
797
tracer = trace.Trace(count=1, trace=0)
798
sys.settrace(tracer.globaltrace)
799
threading.settrace(tracer.globaltrace)
966
802
return exception_to_return_code(the_callable, *args, **kwargs)
805
results = tracer.results()
806
results.write_results(show_missing=1, summary=False,
972
810
def apply_profiled(the_callable, *args, **kwargs):
1004
842
return the_callable(*args, **kwargs)
1005
except (KeyboardInterrupt, Exception) as e:
843
except (KeyboardInterrupt, Exception), e:
1006
844
# used to handle AssertionError and KeyboardInterrupt
1007
845
# specially here, but hopefully they're handled ok by the logger now
1008
846
exc_info = sys.exc_info()
1009
847
exitcode = trace.report_exception(exc_info, sys.stderr)
1010
if os.environ.get('BRZ_PDB'):
1011
print('**** entering debugger')
848
if os.environ.get('BZR_PDB'):
849
print '**** entering debugger'
1013
pdb.post_mortem(exc_info[2])
852
if sys.version_info[:2] < (2, 6):
854
# pdb.post_mortem(tb)
855
# but because pdb.post_mortem gives bad results for tracebacks
856
# from inside generators, we do it manually.
857
# (http://bugs.python.org/issue4150, fixed in Python 2.6)
859
# Setup pdb on the traceback
862
p.setup(tb.tb_frame, tb)
863
# Point the debugger at the deepest frame of the stack
864
p.curindex = len(p.stack) - 1
865
p.curframe = p.stack[p.curindex][0]
866
# Start the pdb prompt.
867
p.print_stack_entry(p.stack[p.curindex])
1017
875
def apply_lsprofiled(filename, the_callable, *args, **kwargs):
1018
from breezy.lsprof import profile
1019
ret, stats = profile(exception_to_return_code, the_callable,
876
from bzrlib.lsprof import profile
877
ret, stats = profile(exception_to_return_code, the_callable, *args, **kwargs)
1022
879
if filename is None:
1025
882
stats.save(filename)
1026
trace.note(gettext('Profile data written to "%s".'), filename)
883
trace.note('Profile data written to "%s".', filename)
887
def shlex_split_unicode(unsplit):
889
return [u.decode('utf-8') for u in shlex.split(unsplit.encode('utf-8'))]
1030
892
def get_alias(cmd, config=None):
1031
893
"""Return an expanded alias, or None if no alias exists.
1038
900
If it is unspecified, the global config will be used.
1040
902
if config is None:
1041
import breezy.config
1042
config = breezy.config.GlobalConfig()
904
config = bzrlib.config.GlobalConfig()
1043
905
alias = config.get_alias(cmd)
1045
return cmdline.split(alias)
907
return shlex_split_unicode(alias)
1049
def run_bzr(argv, load_plugins=load_plugins, disable_plugins=disable_plugins):
1050
912
"""Execute a command.
1052
:param argv: The command-line arguments, without the program name from
1053
argv[0] These should already be decoded. All library/test code calling
1054
run_bzr should be passing valid strings (don't need decoding).
1055
:param load_plugins: What function to call when triggering plugin loading.
1056
This function should take no arguments and cause all plugins to be
1058
:param disable_plugins: What function to call when disabling plugin
1059
loading. This function should take no arguments and cause all plugin
1060
loading to be prohibited (so that code paths in your application that
1061
know about some plugins possibly being present will fail to import
1062
those plugins even if they are installed.)
1063
:return: Returns a command exit code or raises an exception.
915
The command-line arguments, without the program name from argv[0]
916
These should already be decoded. All library/test code calling
917
run_bzr should be passing valid strings (don't need decoding).
919
Returns a command status or raises an exception.
1065
921
Special master options: these must come before the command because
1066
922
they control how the command is interpreted.
1116
967
opt_no_plugins = True
1117
968
elif a == '--no-aliases':
1118
969
opt_no_aliases = True
1119
elif a == '--no-l10n':
1121
970
elif a == '--builtin':
1122
971
opt_builtin = True
1123
elif a == '--concurrency':
1124
os.environ['BRZ_CONCURRENCY'] = argv[i + 1]
1126
972
elif a == '--coverage':
1128
elif a == '--profile-imports':
1129
pass # already handled in startup script Bug #588277
973
opt_coverage_dir = argv[i + 1]
1130
975
elif a.startswith('-D'):
1131
976
debug.debug_flags.add(a[2:])
1132
elif a.startswith('-O'):
1133
override_config.append(a[2:])
1135
978
argv_copy.append(a)
1138
cmdline_overrides = breezy.get_global_state().cmdline_overrides
1139
cmdline_overrides._from_cmdline(override_config)
1141
981
debug.set_debug_flags_from_config()
985
from bzrlib.builtins import cmd_help
986
cmd_help().run_argv_aliases([])
989
if argv[0] == '--version':
990
from bzrlib.builtins import cmd_version
991
cmd_version().run_argv_aliases([])
1143
994
if not opt_no_plugins:
995
from bzrlib.plugin import load_plugins
998
from bzrlib.plugin import disable_plugins
1146
999
disable_plugins()
1150
get_cmd_object('help').run_argv_aliases([])
1153
if argv[0] == '--version':
1154
get_cmd_object('version').run_argv_aliases([])
1157
1001
alias_argv = None
1159
1003
if not opt_no_aliases:
1160
1004
alias_argv = get_alias(argv[0])
1006
user_encoding = osutils.get_user_encoding()
1007
alias_argv = [a.decode(user_encoding) for a in alias_argv]
1162
1008
argv[0] = alias_argv.pop(0)
1164
1010
cmd = argv.pop(0)
1011
# We want only 'ascii' command names, but the user may have typed
1012
# in a Unicode name. In that case, they should just get a
1013
# 'command not found' error later.
1165
1015
cmd_obj = get_cmd_object(cmd, plugins_override=not opt_builtin)
1167
cmd_obj.l10n = False
1168
1016
run = cmd_obj.run_argv_aliases
1169
1017
run_argv = [argv, alias_argv]
1231
1077
"bzr plugin commands")
1232
1078
Command.hooks.install_named_hook("get_command", _get_external_command,
1233
1079
"bzr external command lookup")
1234
Command.hooks.install_named_hook("get_missing_command",
1235
_try_plugin_provider,
1236
"bzr plugin-provider-db check")
1240
def _specified_or_unicode_argv(argv):
1241
# For internal or testing use, argv can be passed. Otherwise, get it from
1242
# the process arguments in a unicode-safe way.
1244
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.")
1080
Command.hooks.install_named_hook("get_missing_command", _try_plugin_provider,
1081
"bzr plugin-provider-db check")
1260
1084
def main(argv=None):
1261
1085
"""Main entry point of command-line interface.
1263
Typically `breezy.initialize` should be called first.
1265
1087
:param argv: list of unicode command-line arguments similar to sys.argv.
1266
1088
argv[0] is script name usually, it will be ignored.
1267
1089
Don't pass here sys.argv because this list contains plain strings
1268
1090
and not unicode; pass None instead.
1270
:return: exit code of brz command.
1092
:return: exit code of bzr command.
1272
if argv is not None:
1274
_register_builtin_commands()
1095
bzrlib.ui.ui_factory = bzrlib.ui.make_ui_for_terminal(
1096
sys.stdin, sys.stdout, sys.stderr)
1098
# Is this a final release version? If so, we should suppress warnings
1099
if bzrlib.version_info[3] == 'final':
1100
suppress_deprecation_warnings(override=True)
1102
argv = osutils.get_unicode_argv()
1106
# ensure all arguments are unicode strings
1108
if isinstance(a, unicode):
1111
new_argv.append(a.decode('ascii'))
1112
except UnicodeDecodeError:
1113
raise errors.BzrError("argv should be list of unicode strings.")
1275
1115
ret = run_bzr_catch_errors(argv)
1276
1116
trace.mutter("return code %d", ret)
1117
osutils.report_extension_load_failures()
1283
1124
This function assumed that that UI layer is setup, that symbol deprecations
1284
1125
are already applied, and that unicode decoding has already been performed on argv.
1286
# done here so that they're covered for every test run
1287
1127
install_bzr_command_hooks()
1288
1128
return exception_to_return_code(run_bzr, argv)
1291
1131
def run_bzr_catch_user_errors(argv):
1292
"""Run brz and report user errors, but let internal errors propagate.
1132
"""Run bzr and report user errors, but let internal errors propagate.
1294
1134
This is used for the test suite, and might be useful for other programs
1295
1135
that want to wrap the commandline interface.
1297
# done here so that they're covered for every test run
1298
1137
install_bzr_command_hooks()
1300
1139
return run_bzr(argv)
1301
except Exception as e:
1140
except Exception, e:
1302
1141
if (isinstance(e, (OSError, IOError))
1303
1142
or not getattr(e, 'internal_error', True)):
1304
1143
trace.report_exception(sys.exc_info(), sys.stderr)
added
removed
bzrlib/commands.py
