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
55
from bzrlib.hooks import HookPoint, Hooks
50
56
# 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
57
from bzrlib.option import Option
58
from bzrlib.plugin import disable_plugins, load_plugins
59
from bzrlib import registry
60
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
67
class CommandInfo(object):
87
68
"""Information about a command."""
99
80
class CommandRegistry(registry.Registry):
100
"""Special registry mapping command names to command classes.
102
:ivar overridden_registry: Look in this registry for commands being
103
overridden by this registry. This can be used to tell plugin commands
104
about the builtin they're decorating.
108
registry.Registry.__init__(self)
109
self.overridden_registry = None
110
# map from aliases to the real command that implements the name
111
self._alias_dict = {}
113
def get(self, command_name):
114
real_name = self._alias_dict.get(command_name, command_name)
115
return registry.Registry.get(self, real_name)
118
83
def _get_name(command_name):
164
122
key = self._get_name(command_name)
165
123
registry.Registry.register_lazy(self, key, module_name, command_name,
166
124
info=CommandInfo(aliases))
168
self._alias_dict[a] = key
171
127
plugin_cmds = CommandRegistry()
172
builtin_command_registry = CommandRegistry()
173
plugin_cmds.overridden_registry = builtin_command_registry
176
130
def register_command(cmd, decorate=False):
177
"""Register a plugin command.
179
Should generally be avoided in favor of lazy registration.
181
131
global plugin_cmds
182
132
return plugin_cmds.register(cmd, decorate)
189
139
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()
140
return cmd[4:].replace('_','-')
143
def _builtin_commands():
144
import bzrlib.builtins
145
return _scan_module_for_commands(bzrlib.builtins)
203
148
def _scan_module_for_commands(module):
204
module_dict = module.__dict__
205
for name in module_dict:
150
for name, obj in module.__dict__.iteritems():
206
151
if name.startswith("cmd_"):
207
yield module_dict[name]
152
real_name = _unsquish_command_name(name)
210
157
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.
158
"""Find commands from bzr's core and plugins."""
215
159
# to eliminate duplicates
216
160
names.update(builtin_command_names())
217
161
names.update(plugin_command_names())
244
187
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
190
def get_cmd_object(cmd_name, plugins_override=True):
294
191
"""Return the command object for a command.
342
232
# Allow plugins to extend commands
343
233
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
238
def _try_plugin_provider(cmd_name):
355
239
"""Probe for a plugin provider having cmd_name."""
357
241
plugin_metadata, provider = probe_for_provider(cmd_name)
358
raise CommandAvailableInPlugin(cmd_name, plugin_metadata, provider)
359
except NoPluginAvailable:
242
raise errors.CommandAvailableInPlugin(cmd_name,
243
plugin_metadata, provider)
244
except errors.NoPluginAvailable:
371
256
for provider in command_providers_registry:
373
258
return provider.plugin_for_command(cmd_name), provider
374
except NoPluginAvailable:
259
except errors.NoPluginAvailable:
376
raise NoPluginAvailable(cmd_name)
261
raise errors.NoPluginAvailable(cmd_name)
379
264
def _get_bzr_command(cmd_or_None, cmd_name):
380
265
"""Get a command from bzr's core."""
266
cmds = _builtin_commands()
382
cmd_class = builtin_command_registry.get(cmd_name)
268
return cmds[cmd_name]()
271
# look for any command which claims this as an alias
272
for real_cmd_name, cmd_class in cmds.iteritems():
273
if cmd_name in cmd_class.aliases:
387
275
return cmd_or_None
429
317
summary, then a complete description of the command. A grammar
430
318
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
321
Other accepted names for this command.
324
List of argument forms, marked with whether they are optional,
329
['to_location', 'from_branch?', 'file*']
331
'to_location' is required
332
'from_branch' is optional
333
'file' can be specified 0 or more times
336
List of options that may be given for this command. These can
337
be either strings, referring to globally-defined options,
338
or option objects. Retrieve through options().
341
If true, this command isn't advertised. This is typically
448
342
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.)
345
Command objects will get a 'outf' attribute, which has been
346
setup to properly handle encoding of unicode strings.
347
encoding_type determines what will happen when characters cannot
349
strict - abort if we cannot decode
350
replace - put in a bogus character (typically '?')
351
exact - do not encode sys.stdout
353
NOTE: by default on Windows, sys.stdout is opened as a text
354
stream, therefore LF line-endings are converted to CRLF.
355
When a command uses encoding_type = 'exact', then
356
sys.stdout is forced to be a binary stream, and line-endings
469
359
: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
363
takes_options = []
481
364
encoding_type = 'strict'
487
368
def __init__(self):
488
369
"""Construct an instance of this command."""
370
if self.__doc__ == Command.__doc__:
371
warn("No help message set for %r" % self)
489
372
# List of standard options directly supported
490
373
self.supported_std_options = []
374
self._operation = cleanup.OperationWithCleanups(self.run)
493
376
def add_cleanup(self, cleanup_func, *args, **kwargs):
494
377
"""Register a function to call after self.run returns or raises.
507
390
This is useful for releasing expensive or contentious resources (such
508
391
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.
392
resources (such as writing results to self.outf).
513
394
self._operation.cleanup_now()
396
@deprecated_method(deprecated_in((2, 1, 0)))
397
def _maybe_expand_globs(self, file_list):
398
"""Glob expand file_list if the platform does not do that itself.
400
Not used anymore, now that the bzr command-line parser globs on
403
:return: A possibly empty list of unicode paths.
405
Introduced in bzrlib 0.18.
515
409
def _usage(self):
516
410
"""Return single-line grammar for this command.
518
412
Only describes arguments, not options.
520
s = 'brz ' + self.name() + ' '
414
s = 'bzr ' + self.name() + ' '
521
415
for aname in self.takes_args:
522
416
aname = aname.upper()
523
417
if aname[-1] in ['$', '+']:
545
439
usage help (e.g. Purpose, Usage, Options) with a
546
440
message explaining how to obtain full help.
549
i18n.install() # Install i18n only for get_help_text for now.
550
442
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.")
444
raise NotImplementedError("sorry, no detailed help yet for %r" % self.name())
561
446
# Extract the summary (purpose) and sections out from the text
562
purpose, sections, order = self._get_help_parts(doc)
447
purpose,sections,order = self._get_help_parts(doc)
564
449
# If a custom usage section was provided, use it
565
if 'Usage' in sections:
450
if sections.has_key('Usage'):
566
451
usage = sections.pop('Usage')
568
453
usage = self._usage()
570
455
# The header is the purpose and usage
572
result += gettext(':Purpose: %s\n') % (purpose,)
457
result += ':Purpose: %s\n' % purpose
573
458
if usage.find('\n') >= 0:
574
result += gettext(':Usage:\n%s\n') % (usage,)
459
result += ':Usage:\n%s\n' % usage
576
result += gettext(':Usage: %s\n') % (usage,)
461
result += ':Usage: %s\n' % usage
579
464
# Add the options
581
466
# XXX: optparse implicitly rewraps the help, and not always perfectly,
582
467
# 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:
469
options = option.get_optparser(self.options()).format_option_help()
470
# XXX: According to the spec, ReST option lists actually don't support
471
# options like --1.9 so that causes syntax errors (in Sphinx at least).
472
# As that pattern always appears in the commands that break, we trap
473
# on that and then format that block of 'format' options as a literal
475
if not plain and options.find(' --1.9 ') != -1:
593
476
options = options.replace(' format:\n', ' format::\n\n', 1)
594
477
if options.startswith('Options:'):
595
result += gettext(':Options:%s') % (options[len('options:'):],)
478
result += ':' + options
479
elif options.startswith('options:'):
480
# Python 2.4 version of optparse
481
result += ':Options:' + options[len('options:'):]
597
483
result += options
601
487
# Add the description, indenting it 2 spaces
602
488
# to match the indentation of the options
489
if sections.has_key(None):
604
490
text = sections.pop(None)
605
491
text = '\n '.join(text.splitlines())
606
result += gettext(':Description:\n %s\n\n') % (text,)
492
result += ':%s:\n %s\n\n' % ('Description',text)
608
494
# Add the custom sections (e.g. Examples). Note that there's no need
609
495
# to indent these as they must be indented already in the source.
611
497
for label in order:
612
if label in sections:
613
result += ':%s:\n%s\n' % (label, sections[label])
498
if sections.has_key(label):
499
result += ':%s:\n%s\n' % (label,sections[label])
616
result += (gettext("See brz help %s for more details and examples.\n\n")
502
result += ("See bzr help %s for more details and examples.\n\n"
619
505
# Add the aliases, source (plug-in) and see also links, if any
621
result += gettext(':Aliases: ')
507
result += ':Aliases: '
622
508
result += ', '.join(self.aliases) + '\n'
623
509
plugin_name = self.plugin_name()
624
510
if plugin_name is not None:
625
result += gettext(':From: plugin "%s"\n') % plugin_name
511
result += ':From: plugin "%s"\n' % plugin_name
626
512
see_also = self.get_see_also(additional_see_also)
628
514
if not plain and see_also_as_links:
634
520
see_also_links.append(item)
636
522
# Use a Sphinx link for this entry
637
link_text = gettext(":doc:`{0} <{1}-help>`").format(
523
link_text = ":doc:`%s <%s-help>`" % (item, item)
639
524
see_also_links.append(link_text)
640
525
see_also = see_also_links
641
result += gettext(':See also: %s') % ', '.join(see_also) + '\n'
526
result += ':See also: '
527
result += ', '.join(see_also) + '\n'
643
529
# 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)
531
import bzrlib.help_topics
532
result = bzrlib.help_topics.help_as_plain_text(result)
670
556
summary = lines.pop(0)
673
label, section = None, ''
559
label,section = None,''
674
560
for line in lines:
675
561
if line.startswith(':') and line.endswith(':') and len(line) > 2:
676
562
save_section(sections, order, label, section)
677
label, section = line[1:-1], ''
563
label,section = line[1:-1],''
678
564
elif (label is not None) and len(line) > 1 and not line[0].isspace():
679
565
save_section(sections, order, label, section)
680
label, section = None, line
566
label,section = None,line
682
568
if len(section) > 0:
683
569
section += '\n' + line
725
611
def run_argv_aliases(self, argv, alias_argv=None):
726
612
"""Parse the command line and run with extra aliases in alias_argv."""
727
613
args, opts = parse_args(self, argv, alias_argv)
730
615
# Process the standard options
731
if 'help' in opts: # e.g. brz add --help
732
self.outf.write(self.get_help_text())
616
if 'help' in opts: # e.g. bzr add --help
617
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))
619
if 'usage' in opts: # e.g. bzr add --usage
620
sys.stdout.write(self.get_help_text(verbose=False))
737
622
trace.set_verbosity_level(option._verbosity_level)
738
623
if 'verbose' in self.supported_std_options:
739
624
opts['verbose'] = trace.is_verbose()
740
elif 'verbose' in opts:
625
elif opts.has_key('verbose'):
741
626
del opts['verbose']
742
627
if 'quiet' in self.supported_std_options:
743
628
opts['quiet'] = trace.is_quiet()
744
elif 'quiet' in opts:
629
elif opts.has_key('quiet'):
745
630
del opts['quiet']
746
632
# mix arguments and options into one dictionary
747
633
cmdargs = _match_argform(self.name(), self.takes_args, args)
752
638
all_cmd_args = cmdargs.copy()
753
639
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']:
643
return self.run_direct(**all_cmd_args)
645
def run_direct(self, *args, **kwargs):
646
"""Call run directly with objects (without parsing an argv list)."""
647
return self._operation.run_simple(*args, **kwargs)
788
650
"""Actually run the command.
793
655
Return 0 or None if the command was successful, or a non-zero
794
656
shell error code if not. It's OK for this method to allow
795
657
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
659
raise NotImplementedError('no implementation of command %r'
847
690
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',
694
self.create_hook(HookPoint('extend_command',
852
695
"Called after creating a command object to allow modifications "
853
696
"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',
697
"new bzrlib.commands.Command object.", (1, 13), None))
698
self.create_hook(HookPoint('get_command',
856
699
"Called when creating a single command. Called with "
857
700
"(cmd_or_None, command_name). get_command should either return "
858
701
"the cmd_or_None parameter, or a replacement Command object that "
859
702
"should be used for the command. Note that the Command.hooks "
860
703
"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',
704
"bzrlib.commands.register_command or plugin_cmds.register_lazy.",
706
self.create_hook(HookPoint('get_missing_command',
864
707
"Called when creating a single command if no command could be "
865
708
"found. Called with (command_name). get_missing_command should "
866
709
"either return None, or a Command object to be used for the "
868
self.add_hook('list_commands',
710
"command.", (1, 17), None))
711
self.create_hook(HookPoint('list_commands',
869
712
"Called when enumerating commands. Called with a set of "
870
713
"cmd_name strings for all the commands found so far. This set "
871
714
" is safe to mutate - e.g. to remove a command. "
872
715
"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
718
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)
736
options, args = parser.parse_args(args)
737
opts = dict([(k, v) for k, v in options.__dict__.iteritems() if
738
v is not option.OptionParser.DEFAULT_VALUE])
909
739
return args, opts
926
756
argdict[argname + '_list'] = None
927
757
elif ap[-1] == '+':
929
raise errors.BzrCommandError(gettext(
930
"command {0!r} needs one or more {1}").format(
931
cmd, argname.upper()))
759
raise errors.BzrCommandError("command %r needs one or more %s"
760
% (cmd, argname.upper()))
933
762
argdict[argname + '_list'] = args[:]
935
764
elif ap[-1] == '$': # all but one
936
765
if len(args) < 2:
937
raise errors.BzrCommandError(
938
gettext("command {0!r} needs one or more {1}").format(
939
cmd, argname.upper()))
766
raise errors.BzrCommandError("command %r needs one or more %s"
767
% (cmd, argname.upper()))
940
768
argdict[argname + '_list'] = args[:-1]
943
771
# just a plain arg
946
raise errors.BzrCommandError(
947
gettext("command {0!r} requires argument {1}").format(
948
cmd, argname.upper()))
774
raise errors.BzrCommandError("command %r requires argument %s"
775
% (cmd, argname.upper()))
950
777
argdict[argname] = args.pop(0)
953
raise errors.BzrCommandError( gettext(
954
"extra argument to command {0}: {1}").format(
780
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
785
def apply_coveraged(dirname, the_callable, *args, **kwargs):
786
# Cannot use "import trace", as that would import bzrlib.trace instead of
787
# the standard library's trace.
788
trace = __import__('trace')
790
tracer = trace.Trace(count=1, trace=0)
791
sys.settrace(tracer.globaltrace)
792
threading.settrace(tracer.globaltrace)
966
795
return exception_to_return_code(the_callable, *args, **kwargs)
798
results = tracer.results()
799
results.write_results(show_missing=1, summary=False,
972
803
def apply_profiled(the_callable, *args, **kwargs):
1004
835
return the_callable(*args, **kwargs)
1005
except (KeyboardInterrupt, Exception) as e:
836
except (KeyboardInterrupt, Exception), e:
1006
837
# used to handle AssertionError and KeyboardInterrupt
1007
838
# specially here, but hopefully they're handled ok by the logger now
1008
839
exc_info = sys.exc_info()
1009
840
exitcode = trace.report_exception(exc_info, sys.stderr)
1010
if os.environ.get('BRZ_PDB'):
1011
print('**** entering debugger')
841
if os.environ.get('BZR_PDB'):
842
print '**** entering debugger'
1013
pdb.post_mortem(exc_info[2])
845
if sys.version_info[:2] < (2, 6):
847
# pdb.post_mortem(tb)
848
# but because pdb.post_mortem gives bad results for tracebacks
849
# from inside generators, we do it manually.
850
# (http://bugs.python.org/issue4150, fixed in Python 2.6)
852
# Setup pdb on the traceback
855
p.setup(tb.tb_frame, tb)
856
# Point the debugger at the deepest frame of the stack
857
p.curindex = len(p.stack) - 1
858
p.curframe = p.stack[p.curindex][0]
859
# Start the pdb prompt.
860
p.print_stack_entry(p.stack[p.curindex])
1017
868
def apply_lsprofiled(filename, the_callable, *args, **kwargs):
1018
from breezy.lsprof import profile
1019
ret, stats = profile(exception_to_return_code, the_callable,
869
from bzrlib.lsprof import profile
870
ret, stats = profile(exception_to_return_code, the_callable, *args, **kwargs)
1022
872
if filename is None:
1025
875
stats.save(filename)
1026
trace.note(gettext('Profile data written to "%s".'), filename)
876
trace.note('Profile data written to "%s".', filename)
880
def shlex_split_unicode(unsplit):
881
return cmdline.split(unsplit)
1030
884
def get_alias(cmd, config=None):
1031
885
"""Return an expanded alias, or None if no alias exists.
1082
936
Run under the Python lsprof profiler.
1085
Generate code coverage report
939
Generate line coverage report in the specified directory.
1088
942
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)
944
trace.mutter("bazaar version: " + bzrlib.__version__)
946
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
948
opt_lsprof = opt_profile = opt_no_plugins = opt_builtin = \
949
opt_no_aliases = False
950
opt_lsprof_file = opt_coverage_dir = None
1098
952
# --no-plugins is handled specially at a very early stage. We need
1099
953
# to load plugins before doing other command parsing so that they
1116
969
opt_no_plugins = True
1117
970
elif a == '--no-aliases':
1118
971
opt_no_aliases = True
1119
elif a == '--no-l10n':
1121
972
elif a == '--builtin':
1122
973
opt_builtin = True
1123
974
elif a == '--concurrency':
1124
os.environ['BRZ_CONCURRENCY'] = argv[i + 1]
975
os.environ['BZR_CONCURRENCY'] = argv[i + 1]
1126
977
elif a == '--coverage':
1128
elif a == '--profile-imports':
1129
pass # already handled in startup script Bug #588277
978
opt_coverage_dir = argv[i + 1]
1130
980
elif a.startswith('-D'):
1131
981
debug.debug_flags.add(a[2:])
1132
elif a.startswith('-O'):
1133
override_config.append(a[2:])
1135
983
argv_copy.append(a)
1138
cmdline_overrides = breezy.get_global_state().cmdline_overrides
1139
cmdline_overrides._from_cmdline(override_config)
1141
986
debug.set_debug_flags_from_config()
1143
988
if not opt_no_plugins:
1159
1004
if not opt_no_aliases:
1160
1005
alias_argv = get_alias(argv[0])
1007
user_encoding = osutils.get_user_encoding()
1008
alias_argv = [a.decode(user_encoding) for a in alias_argv]
1162
1009
argv[0] = alias_argv.pop(0)
1164
1011
cmd = argv.pop(0)
1012
# We want only 'ascii' command names, but the user may have typed
1013
# in a Unicode name. In that case, they should just get a
1014
# 'command not found' error later.
1165
1016
cmd_obj = get_cmd_object(cmd, plugins_override=not opt_builtin)
1167
cmd_obj.l10n = False
1168
1017
run = cmd_obj.run_argv_aliases
1169
1018
run_argv = [argv, alias_argv]
1174
1023
saved_verbosity_level = option._verbosity_level
1175
1024
option._verbosity_level = 0
1026
if opt_coverage_dir:
1179
1028
'--coverage ignored, because --lsprof is in use.')
1180
1029
ret = apply_lsprofiled(opt_lsprof_file, run, *run_argv)
1181
1030
elif opt_profile:
1031
if opt_coverage_dir:
1184
1033
'--coverage ignored, because --profile is in use.')
1185
1034
ret = apply_profiled(run, *run_argv)
1187
ret = apply_coveraged(run, *run_argv)
1035
elif opt_coverage_dir:
1036
ret = apply_coveraged(opt_coverage_dir, run, *run_argv)
1189
1038
ret = run(*run_argv)
1190
1039
return ret or 0
1242
1088
# the process arguments in a unicode-safe way.
1243
1089
if argv is None:
1244
1090
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.")
1094
# ensure all arguments are unicode strings
1096
if isinstance(a, unicode):
1099
new_argv.append(a.decode('ascii'))
1100
except UnicodeDecodeError:
1101
raise errors.BzrError("argv should be list of unicode strings.")
1260
1105
def main(argv=None):
1261
1106
"""Main entry point of command-line interface.
1263
Typically `breezy.initialize` should be called first.
1108
Typically `bzrlib.initialize` should be called first.
1265
1110
:param argv: list of unicode command-line arguments similar to sys.argv.
1266
1111
argv[0] is script name usually, it will be ignored.
1267
1112
Don't pass here sys.argv because this list contains plain strings
1268
1113
and not unicode; pass None instead.
1270
:return: exit code of brz command.
1115
:return: exit code of bzr command.
1272
if argv is not None:
1274
_register_builtin_commands()
1117
argv = _specified_or_unicode_argv(argv)
1275
1118
ret = run_bzr_catch_errors(argv)
1119
bzrlib.ui.ui_factory.log_transport_activity(
1120
display=('bytes' in debug.debug_flags))
1276
1121
trace.mutter("return code %d", ret)
1333
1178
class Provider(object):
1334
"""Generic class to be overriden by plugins"""
1179
'''Generic class to be overriden by plugins'''
1336
1181
def plugin_for_command(self, cmd_name):
1337
"""Takes a command and returns the information for that plugin
1182
'''Takes a command and returns the information for that plugin
1339
1184
:return: A dictionary with all the available information
1340
for the requested plugin
1185
for the requested plugin
1342
1187
raise NotImplementedError
1345
1190
class ProvidersRegistry(registry.Registry):
1346
"""This registry exists to allow other providers to exist"""
1191
'''This registry exists to allow other providers to exist'''
1348
1193
def __iter__(self):
1349
for key, provider in self.items():
1194
for key, provider in self.iteritems():
1352
1197
command_providers_registry = ProvidersRegistry()
added
removed
bzrlib/commands.py
