29
35
lazy_import(globals(), """
33
38
from warnings import warn
36
41
from bzrlib import (
49
from bzrlib.hooks import HookPoint, Hooks
50
# Compatibility - Option used to be in commands.
51
from bzrlib.option import Option
52
from bzrlib.plugin import disable_plugins, load_plugins
53
from bzrlib import registry
54
51
from bzrlib.symbol_versioning import (
55
52
deprecated_function,
61
class CommandInfo(object):
62
"""Information about a command."""
64
def __init__(self, aliases):
65
"""The list of aliases for the command."""
66
self.aliases = aliases
69
def from_command(klass, command):
70
"""Factory to construct a CommandInfo from a command."""
71
return klass(command.aliases)
74
class CommandRegistry(registry.Registry):
75
"""Special registry mapping command names to command classes.
77
:ivar overridden_registry: Look in this registry for commands being
78
overridden by this registry. This can be used to tell plugin commands
79
about the builtin they're decorating.
83
registry.Registry.__init__(self)
84
self.overridden_registry = None
85
# map from aliases to the real command that implements the name
88
def get(self, command_name):
89
real_name = self._alias_dict.get(command_name, command_name)
90
return registry.Registry.get(self, real_name)
93
def _get_name(command_name):
94
if command_name.startswith("cmd_"):
95
return _unsquish_command_name(command_name)
99
def register(self, cmd, decorate=False):
100
"""Utility function to help register a command
102
:param cmd: Command subclass to register
103
:param decorate: If true, allow overriding an existing command
104
of the same name; the old command is returned by this function.
105
Otherwise it is an error to try to override an existing command.
108
k_unsquished = self._get_name(k)
110
previous = self.get(k_unsquished)
113
if self.overridden_registry:
115
previous = self.overridden_registry.get(k_unsquished)
118
info = CommandInfo.from_command(cmd)
120
registry.Registry.register(self, k_unsquished, cmd,
121
override_existing=decorate, info=info)
123
trace.warning('Two plugins defined the same command: %r' % k)
124
trace.warning('Not loading the one in %r' %
125
sys.modules[cmd.__module__])
126
trace.warning('Previously this command was registered from %r' %
127
sys.modules[previous.__module__])
128
for a in cmd.aliases:
129
self._alias_dict[a] = k_unsquished
132
def register_lazy(self, command_name, aliases, module_name):
133
"""Register a command without loading its module.
135
:param command_name: The primary name of the command.
136
:param aliases: A list of aliases for the command.
137
:module_name: The module that the command lives in.
139
key = self._get_name(command_name)
140
registry.Registry.register_lazy(self, key, module_name, command_name,
141
info=CommandInfo(aliases))
143
self._alias_dict[a] = key
146
plugin_cmds = CommandRegistry()
147
builtin_command_registry = CommandRegistry()
148
plugin_cmds.overridden_registry = builtin_command_registry
58
from bzrlib.option import Option
151
64
def register_command(cmd, decorate=False):
152
"""Register a plugin command.
65
"""Utility function to help register a command
154
Should generally be avoided in favor of lazy registration.
67
:param cmd: Command subclass to register
68
:param decorate: If true, allow overriding an existing command
69
of the same name; the old command is returned by this function.
70
Otherwise it is an error to try to override an existing command.
156
72
global plugin_cmds
157
return plugin_cmds.register(cmd, decorate)
74
if k.startswith("cmd_"):
75
k_unsquished = _unsquish_command_name(k)
78
if k_unsquished not in plugin_cmds:
79
plugin_cmds[k_unsquished] = cmd
80
## trace.mutter('registered plugin command %s', k_unsquished)
81
if decorate and k_unsquished in builtin_command_names():
82
return _builtin_commands()[k_unsquished]
84
result = plugin_cmds[k_unsquished]
85
plugin_cmds[k_unsquished] = cmd
88
trace.log_error('Two plugins defined the same command: %r' % k)
89
trace.log_error('Not loading the one in %r' % sys.modules[cmd.__module__])
160
92
def _squish_command_name(cmd):
164
96
def _unsquish_command_name(cmd):
97
assert cmd.startswith("cmd_")
165
98
return cmd[4:].replace('_','-')
168
@deprecated_function(deprecated_in((2, 2, 0)))
169
101
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())
178
def _register_builtin_commands():
179
if builtin_command_registry.keys():
182
102
import bzrlib.builtins
183
for cmd_class in _scan_module_for_commands(bzrlib.builtins).values():
184
builtin_command_registry.register(cmd_class)
185
bzrlib.builtins._register_lazy_builtins()
188
def _scan_module_for_commands(module):
190
for name, obj in module.__dict__.iteritems():
104
builtins = bzrlib.builtins.__dict__
105
for name in builtins:
191
106
if name.startswith("cmd_"):
192
107
real_name = _unsquish_command_name(name)
108
r[real_name] = builtins[name]
197
def _list_bzr_commands(names):
198
"""Find commands from bzr's core and plugins.
200
This is not the public interface, just the default hook called by all_command_names.
202
# to eliminate duplicates
203
names.update(builtin_command_names())
204
names.update(plugin_command_names())
208
def all_command_names():
209
"""Return a set of all command names."""
211
for hook in Command.hooks['list_commands']:
214
raise AssertionError(
215
'hook %s returned None' % Command.hooks.get_hook_name(hook))
219
112
def builtin_command_names():
220
"""Return list of builtin command names.
113
"""Return list of builtin command names."""
114
return _builtin_commands().keys()
222
Use of all_command_names() is encouraged rather than builtin_command_names
223
and/or plugin_command_names.
225
return builtin_command_registry.keys()
228
117
def plugin_command_names():
229
"""Returns command names from commands registered by plugins."""
230
118
return plugin_cmds.keys()
121
def _get_cmd_dict(plugins_override=True):
122
"""Return name->class mapping for all commands."""
123
d = _builtin_commands()
125
d.update(plugin_cmds)
129
def get_all_cmds(plugins_override=True):
130
"""Return canonical name and class for all registered commands."""
131
for k, v in _get_cmd_dict(plugins_override=plugins_override).iteritems():
233
135
def get_cmd_object(cmd_name, plugins_override=True):
234
"""Return the command object for a command.
136
"""Return the canonical name and command class for a command.
237
139
If true, plugin commands can override builtins.
242
144
raise errors.BzrCommandError('unknown command "%s"' % cmd_name)
245
def _get_cmd_object(cmd_name, plugins_override=True, check_missing=True):
246
"""Get a command object.
147
def _get_cmd_object(cmd_name, plugins_override=True):
148
"""Worker for get_cmd_object which raises KeyError rather than BzrCommandError."""
149
from bzrlib.externalcommand import ExternalCommand
248
:param cmd_name: The name of the command.
249
:param plugins_override: Allow plugins to override builtins.
250
:param check_missing: Look up commands not found in the regular index via
251
the get_missing_command hook.
252
:return: A Command object instance
253
:raises KeyError: If no command is found.
255
151
# We want only 'ascii' command names, but the user may have typed
256
152
# in a Unicode name. In that case, they should just get a
257
153
# 'command not found' error later.
258
154
# In the future, we may actually support Unicode command names.
261
for hook in Command.hooks['get_command']:
262
cmd = hook(cmd, cmd_name)
263
if cmd is not None and not plugins_override and not cmd.plugin_name():
264
# We've found a non-plugin command, don't permit it to be
267
if cmd is None and check_missing:
268
for hook in Command.hooks['get_missing_command']:
275
# Allow plugins to extend commands
276
for hook in Command.hooks['extend_command']:
281
def _try_plugin_provider(cmd_name):
282
"""Probe for a plugin provider having cmd_name."""
284
plugin_metadata, provider = probe_for_provider(cmd_name)
285
raise errors.CommandAvailableInPlugin(cmd_name,
286
plugin_metadata, provider)
287
except errors.NoPluginAvailable:
291
def probe_for_provider(cmd_name):
292
"""Look for a provider for cmd_name.
294
:param cmd_name: The command name.
295
:return: plugin_metadata, provider for getting cmd_name.
296
:raises NoPluginAvailable: When no provider can supply the plugin.
298
# look for providers that provide this command but aren't installed
299
for provider in command_providers_registry:
301
return provider.plugin_for_command(cmd_name), provider
302
except errors.NoPluginAvailable:
304
raise errors.NoPluginAvailable(cmd_name)
307
def _get_bzr_command(cmd_or_None, cmd_name):
308
"""Get a command from bzr's core."""
310
cmd_class = builtin_command_registry.get(cmd_name)
156
# first look up this command under the specified name
157
cmds = _get_cmd_dict(plugins_override=plugins_override)
159
return cmds[cmd_name]()
318
def _get_external_command(cmd_or_None, cmd_name):
319
"""Lookup a command that is a shell script."""
320
# Only do external command lookups when no command is found so far.
321
if cmd_or_None is not None:
323
from bzrlib.externalcommand import ExternalCommand
163
# look for any command which claims this as an alias
164
for real_cmd_name, cmd_class in cmds.iteritems():
165
if cmd_name in cmd_class.aliases:
324
168
cmd_obj = ExternalCommand.find_command(cmd_name)
329
def _get_plugin_command(cmd_or_None, cmd_name):
330
"""Get a command from bzr's plugins."""
332
return plugin_cmds.get(cmd_name)()
335
for key in plugin_cmds.keys():
336
info = plugin_cmds.get_info(key)
337
if cmd_name in info.aliases:
338
return plugin_cmds.get(key)()
342
174
class Command(object):
404
235
encoding_type = 'strict'
408
239
def __init__(self):
409
240
"""Construct an instance of this command."""
410
241
if self.__doc__ == Command.__doc__:
411
242
warn("No help message set for %r" % self)
412
# List of standard options directly supported
413
self.supported_std_options = []
416
def add_cleanup(self, cleanup_func, *args, **kwargs):
417
"""Register a function to call after self.run returns or raises.
419
Functions will be called in LIFO order.
421
self._operation.add_cleanup(cleanup_func, *args, **kwargs)
423
def cleanup_now(self):
424
"""Execute and empty pending cleanup functions immediately.
426
After cleanup_now all registered cleanups are forgotten. add_cleanup
427
may be called again after cleanup_now; these cleanups will be called
428
after self.run returns or raises (or when cleanup_now is next called).
430
This is useful for releasing expensive or contentious resources (such
431
as write locks) before doing further work that does not require those
432
resources (such as writing results to self.outf). Note though, that
433
as it releases all resources, this may release locks that the command
434
wants to hold, so use should be done with care.
436
self._operation.cleanup_now()
438
@deprecated_method(deprecated_in((2, 1, 0)))
439
244
def _maybe_expand_globs(self, file_list):
440
245
"""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
247
:return: A possibly empty list of unicode paths.
447
249
Introduced in bzrlib 0.18.
253
if sys.platform == 'win32':
254
file_list = win32utils.glob_expand(file_list)
255
return list(file_list)
451
257
def _usage(self):
452
258
"""Return single-line grammar for this command.
463
269
elif aname[-1] == '*':
464
270
aname = '[' + aname[:-1] + '...]'
466
s = s[:-1] # remove last space
469
def get_help_text(self, additional_see_also=None, plain=True,
470
see_also_as_links=False, verbose=True):
277
def get_help_text(self, additional_see_also=None, plain=True):
471
278
"""Return a text string with help for this command.
473
280
:param additional_see_also: Additional help topics to be
474
281
cross-referenced.
475
282
:param plain: if False, raw help (reStructuredText) is
476
283
returned instead of plain text.
477
:param see_also_as_links: if True, convert items in 'See also'
478
list to internal links (used by bzr_man rstx generator)
479
:param verbose: if True, display the full help, otherwise
480
leave out the descriptive sections and just display
481
usage help (e.g. Purpose, Usage, Options) with a
482
message explaining how to obtain full help.
484
285
doc = self.help()
486
287
raise NotImplementedError("sorry, no detailed help yet for %r" % self.name())
488
289
# Extract the summary (purpose) and sections out from the text
489
purpose,sections,order = self._get_help_parts(doc)
290
purpose,sections = self._get_help_parts(doc)
491
292
# If a custom usage section was provided, use it
492
293
if sections.has_key('Usage'):
506
307
# Add the options
508
# XXX: optparse implicitly rewraps the help, and not always perfectly,
509
# so we get <https://bugs.launchpad.net/bzr/+bug/249908>. -- mbp
511
308
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:
518
options = options.replace(' format:\n', ' format::\n\n', 1)
519
309
if options.startswith('Options:'):
520
310
result += ':' + options
521
elif options.startswith('options:'):
522
# Python 2.4 version of optparse
523
result += ':Options:' + options[len('options:'):]
525
312
result += options
529
# Add the description, indenting it 2 spaces
530
# to match the indentation of the options
531
if sections.has_key(None):
532
text = sections.pop(None)
533
text = '\n '.join(text.splitlines())
534
result += ':%s:\n %s\n\n' % ('Description',text)
315
# Add the description, indenting it 2 spaces
316
# to match the indentation of the options
317
if sections.has_key(None):
318
text = sections.pop(None)
319
text = '\n '.join(text.splitlines())
320
result += ':%s:\n %s\n\n' % ('Description',text)
536
# Add the custom sections (e.g. Examples). Note that there's no need
537
# to indent these as they must be indented already in the source.
540
if sections.has_key(label):
541
result += ':%s:\n%s\n' % (label,sections[label])
544
result += ("See bzr help %s for more details and examples.\n\n"
322
# Add the custom sections (e.g. Examples). Note that there's no need
323
# to indent these as they must be indented already in the source.
325
labels = sorted(sections.keys())
327
result += ':%s:\n%s\n\n' % (label,sections[label])
547
329
# Add the aliases, source (plug-in) and see also links, if any
553
335
result += ':From: plugin "%s"\n' % plugin_name
554
336
see_also = self.get_see_also(additional_see_also)
556
if not plain and see_also_as_links:
558
for item in see_also:
560
# topics doesn't have an independent section
561
# so don't create a real link
562
see_also_links.append(item)
564
# Use a Sphinx link for this entry
565
link_text = ":doc:`%s <%s-help>`" % (item, item)
566
see_also_links.append(link_text)
567
see_also = see_also_links
568
338
result += ':See also: '
569
339
result += ', '.join(see_also) + '\n'
571
# If this will be rendered as plain text, convert it
341
# If this will be rendered as plan text, convert it
573
343
import bzrlib.help_topics
574
344
result = bzrlib.help_topics.help_as_plain_text(result)
578
348
def _get_help_parts(text):
579
349
"""Split help text into a summary and named sections.
581
:return: (summary,sections,order) where summary is the top line and
351
:return: (summary,sections) where summary is the top line and
582
352
sections is a dictionary of the rest indexed by section name.
583
order is the order the section appear in the text.
584
353
A section starts with a heading line of the form ":xxx:".
585
354
Indented text on following lines is the section value.
586
355
All text found outside a named section is assigned to the
587
356
default section which is given the key of None.
589
def save_section(sections, order, label, section):
358
def save_section(sections, label, section):
590
359
if len(section) > 0:
591
360
if sections.has_key(label):
592
361
sections[label] += '\n' + section
595
363
sections[label] = section
597
365
lines = text.rstrip().splitlines()
598
366
summary = lines.pop(0)
601
368
label,section = None,''
602
369
for line in lines:
603
370
if line.startswith(':') and line.endswith(':') and len(line) > 2:
604
save_section(sections, order, label, section)
371
save_section(sections, label, section)
605
372
label,section = line[1:-1],''
606
elif (label is not None) and len(line) > 1 and not line[0].isspace():
607
save_section(sections, order, label, section)
373
elif label != None and len(line) > 1 and not line[0].isspace():
374
save_section(sections, label, section)
608
375
label,section = None,line
610
377
if len(section) > 0:
611
378
section += '\n' + line
614
save_section(sections, order, label, section)
615
return summary, sections, order
381
save_section(sections, label, section)
382
return summary, sections
617
384
def get_help_topic(self):
618
385
"""Return the commands help topic - its name."""
619
386
return self.name()
621
388
def get_see_also(self, additional_terms=None):
622
"""Return a list of help topics that are related to this command.
389
"""Return a list of help topics that are related to this ommand.
624
391
The list is derived from the content of the _see_also attribute. Any
625
392
duplicates are removed and the result is in lexical order.
626
393
:param additional_terms: Additional help topics to cross-reference.
635
402
"""Return dict of valid options for this command.
637
404
Maps from long option name to option object."""
638
r = Option.STD_OPTIONS.copy()
406
r['help'] = option._help_option
640
407
for o in self.takes_options:
641
408
if isinstance(o, basestring):
642
409
o = option.Option.OPTIONS[o]
644
if o.name in std_names:
645
self.supported_std_options.append(o.name)
648
413
def _setup_outf(self):
649
414
"""Return a file linked to stdout, which has proper encoding."""
650
self.outf = ui.ui_factory.make_output_stream(
651
encoding_type=self.encoding_type)
415
assert self.encoding_type in ['strict', 'exact', 'replace']
417
# Originally I was using self.stdout, but that looks
418
# *way* too much like sys.stdout
419
if self.encoding_type == 'exact':
420
# force sys.stdout to be binary stream on win32
421
if sys.platform == 'win32':
422
fileno = getattr(sys.stdout, 'fileno', None)
425
msvcrt.setmode(fileno(), os.O_BINARY)
426
self.outf = sys.stdout
429
output_encoding = osutils.get_terminal_encoding()
431
# use 'replace' so that we don't abort if trying to write out
432
# in e.g. the default C locale.
433
self.outf = codecs.getwriter(output_encoding)(sys.stdout, errors=self.encoding_type)
434
# For whatever reason codecs.getwriter() does not advertise its encoding
435
# it just returns the encoding of the wrapped file, which is completely
436
# bogus. So set the attribute, so we can find the correct encoding later.
437
self.outf.encoding = output_encoding
653
439
def run_argv_aliases(self, argv, alias_argv=None):
654
440
"""Parse the command line and run with extra aliases in alias_argv."""
442
warn("Passing None for [] is deprecated from bzrlib 0.10",
443
DeprecationWarning, stacklevel=2)
655
445
args, opts = parse_args(self, argv, alias_argv)
657
# Process the standard options
658
446
if 'help' in opts: # e.g. bzr add --help
659
447
sys.stdout.write(self.get_help_text())
661
if 'usage' in opts: # e.g. bzr add --usage
662
sys.stdout.write(self.get_help_text(verbose=False))
664
trace.set_verbosity_level(option._verbosity_level)
665
if 'verbose' in self.supported_std_options:
666
opts['verbose'] = trace.is_verbose()
667
elif opts.has_key('verbose'):
669
if 'quiet' in self.supported_std_options:
670
opts['quiet'] = trace.is_quiet()
671
elif opts.has_key('quiet'):
674
449
# mix arguments and options into one dictionary
675
450
cmdargs = _match_argform(self.name(), self.takes_args, args)
683
458
self._setup_outf()
685
460
return self.run(**all_cmd_args)
687
def _setup_run(self):
688
"""Wrap the defined run method on self with a cleanup.
690
This is called by __init__ to make the Command be able to be run
691
by just calling run(), as it could be before cleanups were added.
693
If a different form of cleanups are in use by your Command subclass,
694
you can override this method.
697
def run(*args, **kwargs):
698
self._operation = cleanup.OperationWithCleanups(class_run)
700
return self._operation.run_simple(*args, **kwargs)
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)
711
463
"""Actually run the command.
756
class CommandHooks(Hooks):
757
"""Hooks related to Command object creation/enumeration."""
760
"""Create the default hooks.
762
These are all empty initially, because by default nothing should get
766
self.create_hook(HookPoint('extend_command',
767
"Called after creating a command object to allow modifications "
768
"such as adding or removing options, docs etc. Called with the "
769
"new bzrlib.commands.Command object.", (1, 13), None))
770
self.create_hook(HookPoint('get_command',
771
"Called when creating a single command. Called with "
772
"(cmd_or_None, command_name). get_command should either return "
773
"the cmd_or_None parameter, or a replacement Command object that "
774
"should be used for the command. Note that the Command.hooks "
775
"hooks are core infrastructure. Many users will prefer to use "
776
"bzrlib.commands.register_command or plugin_cmds.register_lazy.",
778
self.create_hook(HookPoint('get_missing_command',
779
"Called when creating a single command if no command could be "
780
"found. Called with (command_name). get_missing_command should "
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',
784
"Called when enumerating commands. Called with a set of "
785
"cmd_name strings for all the commands found so far. This set "
786
" is safe to mutate - e.g. to remove a command. "
787
"list_commands should return the updated set of command names.",
790
Command.hooks = CommandHooks()
497
# Technically, this function hasn't been use in a *really* long time
498
# but we are only deprecating it now.
499
@deprecated_function(zero_eleven)
500
def parse_spec(spec):
506
>>> parse_spec("../@")
508
>>> parse_spec("../f/@35")
510
>>> parse_spec('./@revid:john@arbash-meinel.com-20050711044610-3ca0327c6a222f67')
511
['.', 'revid:john@arbash-meinel.com-20050711044610-3ca0327c6a222f67']
516
parsed = spec.split('/@')
517
assert len(parsed) == 2
522
parsed[1] = int(parsed[1])
524
pass # We can allow stuff like ./@revid:blahblahblah
528
parsed = [spec, None]
793
531
def parse_args(command, argv, alias_argv=None):
794
532
"""Parse command line.
796
534
Arguments and options are parsed at this level before being passed
797
535
down to specific command handlers. This routine knows, from a
798
536
lookup table, something about the available options, what optargs
847
585
% (cmd, argname.upper()))
849
587
argdict[argname] = args.pop(0)
852
590
raise errors.BzrCommandError("extra argument to command %s: %s"
853
591
% (cmd, args[0]))
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)
867
return exception_to_return_code(the_callable, *args, **kwargs)
870
results = tracer.results()
871
results.write_results(show_missing=1, summary=False,
875
597
def apply_profiled(the_callable, *args, **kwargs):
896
617
os.remove(pfname)
899
def exception_to_return_code(the_callable, *args, **kwargs):
900
"""UI level helper for profiling and coverage.
902
This transforms exceptions into a return value of 3. As such its only
903
relevant to the UI layer, and should never be called where catching
904
exceptions may be desirable.
907
return the_callable(*args, **kwargs)
908
except (KeyboardInterrupt, Exception), e:
909
# used to handle AssertionError and KeyboardInterrupt
910
# specially here, but hopefully they're handled ok by the logger now
911
exc_info = sys.exc_info()
912
exitcode = trace.report_exception(exc_info, sys.stderr)
913
if os.environ.get('BZR_PDB'):
914
print '**** entering debugger'
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])
940
620
def apply_lsprofiled(filename, the_callable, *args, **kwargs):
941
621
from bzrlib.lsprof import profile
942
ret, stats = profile(exception_to_return_code, the_callable, *args, **kwargs)
622
ret, stats = profile(the_callable, *args, **kwargs)
944
624
if filename is None:
969
644
config = bzrlib.config.GlobalConfig()
970
645
alias = config.get_alias(cmd)
972
return cmdline.split(alias)
648
return [a.decode('utf-8') for a in shlex.split(alias.encode('utf-8'))]
976
def run_bzr(argv, load_plugins=load_plugins, disable_plugins=disable_plugins):
977
653
"""Execute a command.
979
:param argv: The command-line arguments, without the program name from
980
argv[0] These should already be decoded. All library/test code calling
981
run_bzr should be passing valid strings (don't need decoding).
982
:param load_plugins: What function to call when triggering plugin loading.
983
This function should take no arguments and cause all plugins to be
985
:param disable_plugins: What function to call when disabling plugin
986
loading. This function should take no arguments and cause all plugin
987
loading to be prohibited (so that code paths in your application that
988
know about some plugins possibly being present will fail to import
989
those plugins even if they are installed.)
990
:return: Returns a command exit code or raises an exception.
655
This is similar to main(), but without all the trappings for
656
logging and error handling.
659
The command-line arguments, without the program name from argv[0]
660
These should already be decoded. All library/test code calling
661
run_bzr should be passing valid strings (don't need decoding).
663
Returns a command status or raises an exception.
992
665
Special master options: these must come before the command because
993
666
they control how the command is interpreted.
1044
710
opt_no_aliases = True
1045
711
elif a == '--builtin':
1046
712
opt_builtin = True
1047
elif a == '--concurrency':
1048
os.environ['BZR_CONCURRENCY'] = argv[i + 1]
1050
elif a == '--coverage':
1051
opt_coverage_dir = argv[i + 1]
713
elif a in ('--quiet', '-q'):
1053
715
elif a.startswith('-D'):
1054
716
debug.debug_flags.add(a[2:])
1056
718
argv_copy.append(a)
1059
debug.set_debug_flags_from_config()
723
from bzrlib.builtins import cmd_help
724
cmd_help().run_argv_aliases([])
727
if argv[0] == '--version':
728
from bzrlib.version import show_version
1061
732
if not opt_no_plugins:
733
from bzrlib.plugin import load_plugins
736
from bzrlib.plugin import disable_plugins
1064
737
disable_plugins()
1068
get_cmd_object('help').run_argv_aliases([])
1071
if argv[0] == '--version':
1072
get_cmd_object('version').run_argv_aliases([])
1075
739
alias_argv = None
1077
741
if not opt_no_aliases:
1078
742
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]
744
alias_argv = [a.decode(bzrlib.user_encoding) for a in alias_argv]
1082
745
argv[0] = alias_argv.pop(0)
1084
747
cmd = argv.pop(0)
1091
754
run_argv = [argv, alias_argv]
1094
# We can be called recursively (tests for example), but we don't want
1095
# the verbosity level to propagate.
1096
saved_verbosity_level = option._verbosity_level
1097
option._verbosity_level = 0
1099
if opt_coverage_dir:
1101
'--coverage ignored, because --lsprof is in use.')
1102
758
ret = apply_lsprofiled(opt_lsprof_file, run, *run_argv)
1103
759
elif opt_profile:
1104
if opt_coverage_dir:
1106
'--coverage ignored, because --profile is in use.')
1107
760
ret = apply_profiled(run, *run_argv)
1108
elif opt_coverage_dir:
1109
ret = apply_coveraged(opt_coverage_dir, run, *run_argv)
1111
762
ret = run(*run_argv)
1114
# reset, in case we may do other commands later within the same
1115
# process. Commands that want to execute sub-commands must propagate
1116
# --verbose in their own way.
1117
if 'memory' in debug.debug_flags:
1118
trace.debug_memory('Process status after command:', short=False)
1119
option._verbosity_level = saved_verbosity_level
765
# reset, in case we may do other commands later within the same process
766
trace.be_quiet(False)
1122
768
def display_command(func):
1123
769
"""Decorator that suppresses pipe/interrupt errors."""
1139
785
return ignore_pipe
1142
def install_bzr_command_hooks():
1143
"""Install the hooks to supply bzr's own commands."""
1144
if _list_bzr_commands in Command.hooks["list_commands"]:
1146
Command.hooks.install_named_hook("list_commands", _list_bzr_commands,
1148
Command.hooks.install_named_hook("get_command", _get_bzr_command,
1150
Command.hooks.install_named_hook("get_command", _get_plugin_command,
1151
"bzr plugin commands")
1152
Command.hooks.install_named_hook("get_command", _get_external_command,
1153
"bzr external command lookup")
1154
Command.hooks.install_named_hook("get_missing_command", _try_plugin_provider,
1155
"bzr plugin-provider-db check")
1159
def _specified_or_unicode_argv(argv):
1160
# For internal or testing use, argv can be passed. Otherwise, get it from
1161
# the process arguments in a unicode-safe way.
1163
return osutils.get_unicode_argv()
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.")
1178
def main(argv=None):
1179
"""Main entry point of command-line interface.
1181
Typically `bzrlib.initialize` should be called first.
1183
:param argv: list of unicode command-line arguments similar to sys.argv.
1184
argv[0] is script name usually, it will be ignored.
1185
Don't pass here sys.argv because this list contains plain strings
1186
and not unicode; pass None instead.
1188
:return: exit code of bzr command.
1190
argv = _specified_or_unicode_argv(argv)
1191
_register_builtin_commands()
790
from bzrlib.ui.text import TextUIFactory
791
bzrlib.ui.ui_factory = TextUIFactory()
792
argv = [a.decode(bzrlib.user_encoding) for a in argv[1:]]
1192
793
ret = run_bzr_catch_errors(argv)
1193
bzrlib.ui.ui_factory.log_transport_activity(
1194
display=('bytes' in debug.debug_flags))
1195
794
trace.mutter("return code %d", ret)
1199
798
def run_bzr_catch_errors(argv):
1200
"""Run a bzr command with parameters as described by argv.
1202
This function assumed that that UI layer is setup, that symbol deprecations
1203
are already applied, and that unicode decoding has already been performed on argv.
1205
# done here so that they're covered for every test run
1206
install_bzr_command_hooks()
1207
return exception_to_return_code(run_bzr, argv)
1210
def run_bzr_catch_user_errors(argv):
1211
"""Run bzr and report user errors, but let internal errors propagate.
1213
This is used for the test suite, and might be useful for other programs
1214
that want to wrap the commandline interface.
1216
# done here so that they're covered for every test run
1217
install_bzr_command_hooks()
1219
800
return run_bzr(argv)
1220
except Exception, e:
1221
if (isinstance(e, (OSError, IOError))
1222
or not getattr(e, 'internal_error', True)):
1223
trace.report_exception(sys.exc_info(), sys.stderr)
801
except (KeyboardInterrupt, Exception), e:
802
# used to handle AssertionError and KeyboardInterrupt
803
# specially here, but hopefully they're handled ok by the logger now
804
trace.report_exception(sys.exc_info(), sys.stderr)
805
if os.environ.get('BZR_PDB'):
806
print '**** entering debugger'
808
pdb.post_mortem(sys.exc_traceback)
1229
812
class HelpCommandIndex(object):
1242
825
if topic and topic.startswith(self.prefix):
1243
826
topic = topic[len(self.prefix):]
1245
cmd = _get_cmd_object(topic, check_missing=False)
828
cmd = _get_cmd_object(topic)
1246
829
except KeyError:
1252
class Provider(object):
1253
'''Generic class to be overriden by plugins'''
1255
def plugin_for_command(self, cmd_name):
1256
'''Takes a command and returns the information for that plugin
1258
:return: A dictionary with all the available information
1259
for the requested plugin
1261
raise NotImplementedError
1264
class ProvidersRegistry(registry.Registry):
1265
'''This registry exists to allow other providers to exist'''
1268
for key, provider in self.iteritems():
1271
command_providers_registry = ProvidersRegistry()
835
if __name__ == '__main__':
836
sys.exit(main(sys.argv))
added
removed
bzrlib/commands.py
