35
29
lazy_import(globals(), """
38
33
from warnings import warn
41
36
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
51
54
from bzrlib.symbol_versioning import (
52
55
deprecated_function,
58
from bzrlib.option import Option
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
64
151
def register_command(cmd, decorate=False):
65
"""Utility function to help register a command
152
"""Register a plugin command.
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.
154
Should generally be avoided in favor of lazy registration.
72
156
global plugin_cmds
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__])
157
return plugin_cmds.register(cmd, decorate)
92
160
def _squish_command_name(cmd):
96
164
def _unsquish_command_name(cmd):
97
assert cmd.startswith("cmd_")
98
165
return cmd[4:].replace('_','-')
168
@deprecated_function(deprecated_in((2, 2, 0)))
101
169
def _builtin_commands():
170
"""Return a dict of {name: cmd_class} for builtin commands.
172
:deprecated: Use the builtin_command_registry registry instead
174
# return dict(name: cmd_class)
175
return dict(builtin_command_registry.items())
178
def _register_builtin_commands():
179
if builtin_command_registry.keys():
102
182
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):
104
builtins = bzrlib.builtins.__dict__
105
for name in builtins:
190
for name, obj in module.__dict__.iteritems():
106
191
if name.startswith("cmd_"):
107
192
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))
112
219
def builtin_command_names():
113
"""Return list of builtin command names."""
114
return _builtin_commands().keys()
220
"""Return list of builtin command names.
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()
117
228
def plugin_command_names():
229
"""Returns command names from commands registered by plugins."""
118
230
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():
135
233
def get_cmd_object(cmd_name, plugins_override=True):
136
"""Return the canonical name and command class for a command.
234
"""Return the command object for a command.
139
237
If true, plugin commands can override builtins.
144
242
raise errors.BzrCommandError('unknown command "%s"' % cmd_name)
147
def _get_cmd_object(cmd_name, plugins_override=True):
148
"""Worker for get_cmd_object which raises KeyError rather than BzrCommandError."""
245
def _get_cmd_object(cmd_name, plugins_override=True, check_missing=True):
246
"""Get a command object.
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
# We want only 'ascii' command names, but the user may have typed
256
# in a Unicode name. In that case, they should just get a
257
# 'command not found' error later.
258
# 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)
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:
149
323
from bzrlib.externalcommand import ExternalCommand
151
# We want only 'ascii' command names, but the user may have typed
152
# in a Unicode name. In that case, they should just get a
153
# 'command not found' error later.
154
# In the future, we may actually support Unicode command names.
156
# first look up this command under the specified name
157
cmds = _get_cmd_dict(plugins_override=plugins_override)
159
return cmds[cmd_name]()
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:
168
324
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)()
174
342
class Command(object):
235
404
encoding_type = 'strict'
239
408
def __init__(self):
240
409
"""Construct an instance of this command."""
241
410
if self.__doc__ == Command.__doc__:
242
411
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)))
244
439
def _maybe_expand_globs(self, file_list):
245
440
"""Glob expand file_list if the platform does not do that itself.
442
Not used anymore, now that the bzr command-line parser globs on
247
445
:return: A possibly empty list of unicode paths.
249
447
Introduced in bzrlib 0.18.
253
if sys.platform == 'win32':
254
file_list = win32utils.glob_expand(file_list)
255
return list(file_list)
257
451
def _usage(self):
258
452
"""Return single-line grammar for this command.
269
463
elif aname[-1] == '*':
270
464
aname = '[' + aname[:-1] + '...]'
466
s = s[:-1] # remove last space
277
469
def get_help_text(self, additional_see_also=None, plain=True,
278
see_also_as_links=False):
470
see_also_as_links=False, verbose=True):
279
471
"""Return a text string with help for this command.
281
473
:param additional_see_also: Additional help topics to be
282
474
cross-referenced.
283
475
:param plain: if False, raw help (reStructuredText) is
284
476
returned instead of plain text.
285
477
:param see_also_as_links: if True, convert items in 'See also'
286
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.
288
484
doc = self.help()
290
486
raise NotImplementedError("sorry, no detailed help yet for %r" % self.name())
292
488
# Extract the summary (purpose) and sections out from the text
293
purpose,sections = self._get_help_parts(doc)
489
purpose,sections,order = self._get_help_parts(doc)
295
491
# If a custom usage section was provided, use it
296
492
if sections.has_key('Usage'):
318
525
result += options
321
# Add the description, indenting it 2 spaces
322
# to match the indentation of the options
323
if sections.has_key(None):
324
text = sections.pop(None)
325
text = '\n '.join(text.splitlines())
326
result += ':%s:\n %s\n\n' % ('Description',text)
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)
328
# Add the custom sections (e.g. Examples). Note that there's no need
329
# to indent these as they must be indented already in the source.
331
labels = sorted(sections.keys())
333
result += ':%s:\n%s\n\n' % (label,sections[label])
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"
335
547
# Add the aliases, source (plug-in) and see also links, if any
365
578
def _get_help_parts(text):
366
579
"""Split help text into a summary and named sections.
368
:return: (summary,sections) where summary is the top line and
581
:return: (summary,sections,order) where summary is the top line and
369
582
sections is a dictionary of the rest indexed by section name.
583
order is the order the section appear in the text.
370
584
A section starts with a heading line of the form ":xxx:".
371
585
Indented text on following lines is the section value.
372
586
All text found outside a named section is assigned to the
373
587
default section which is given the key of None.
375
def save_section(sections, label, section):
589
def save_section(sections, order, label, section):
376
590
if len(section) > 0:
377
591
if sections.has_key(label):
378
592
sections[label] += '\n' + section
380
595
sections[label] = section
382
597
lines = text.rstrip().splitlines()
383
598
summary = lines.pop(0)
385
601
label,section = None,''
386
602
for line in lines:
387
603
if line.startswith(':') and line.endswith(':') and len(line) > 2:
388
save_section(sections, label, section)
604
save_section(sections, order, label, section)
389
605
label,section = line[1:-1],''
390
elif label != None and len(line) > 1 and not line[0].isspace():
391
save_section(sections, label, section)
606
elif (label is not None) and len(line) > 1 and not line[0].isspace():
607
save_section(sections, order, label, section)
392
608
label,section = None,line
394
610
if len(section) > 0:
395
611
section += '\n' + line
398
save_section(sections, label, section)
399
return summary, sections
614
save_section(sections, order, label, section)
615
return summary, sections, order
401
617
def get_help_topic(self):
402
618
"""Return the commands help topic - its name."""
419
635
"""Return dict of valid options for this command.
421
637
Maps from long option name to option object."""
423
r['help'] = option._help_option
638
r = Option.STD_OPTIONS.copy()
424
640
for o in self.takes_options:
425
641
if isinstance(o, basestring):
426
642
o = option.Option.OPTIONS[o]
644
if o.name in std_names:
645
self.supported_std_options.append(o.name)
430
648
def _setup_outf(self):
431
649
"""Return a file linked to stdout, which has proper encoding."""
432
assert self.encoding_type in ['strict', 'exact', 'replace']
434
# Originally I was using self.stdout, but that looks
435
# *way* too much like sys.stdout
436
if self.encoding_type == 'exact':
437
# force sys.stdout to be binary stream on win32
438
if sys.platform == 'win32':
439
fileno = getattr(sys.stdout, 'fileno', None)
442
msvcrt.setmode(fileno(), os.O_BINARY)
443
self.outf = sys.stdout
446
output_encoding = osutils.get_terminal_encoding()
448
# use 'replace' so that we don't abort if trying to write out
449
# in e.g. the default C locale.
450
self.outf = codecs.getwriter(output_encoding)(sys.stdout, errors=self.encoding_type)
451
# For whatever reason codecs.getwriter() does not advertise its encoding
452
# it just returns the encoding of the wrapped file, which is completely
453
# bogus. So set the attribute, so we can find the correct encoding later.
454
self.outf.encoding = output_encoding
650
self.outf = ui.ui_factory.make_output_stream(
651
encoding_type=self.encoding_type)
456
653
def run_argv_aliases(self, argv, alias_argv=None):
457
654
"""Parse the command line and run with extra aliases in alias_argv."""
459
warn("Passing None for [] is deprecated from bzrlib 0.10",
460
DeprecationWarning, stacklevel=2)
462
655
args, opts = parse_args(self, argv, alias_argv)
657
# Process the standard options
463
658
if 'help' in opts: # e.g. bzr add --help
464
659
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'):
466
674
# mix arguments and options into one dictionary
467
675
cmdargs = _match_argform(self.name(), self.takes_args, args)
475
683
self._setup_outf()
477
685
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)
480
711
"""Actually run the command.
514
# Technically, this function hasn't been use in a *really* long time
515
# but we are only deprecating it now.
516
@deprecated_function(zero_eleven)
517
def parse_spec(spec):
523
>>> parse_spec("../@")
525
>>> parse_spec("../f/@35")
527
>>> parse_spec('./@revid:john@arbash-meinel.com-20050711044610-3ca0327c6a222f67')
528
['.', 'revid:john@arbash-meinel.com-20050711044610-3ca0327c6a222f67']
533
parsed = spec.split('/@')
534
assert len(parsed) == 2
539
parsed[1] = int(parsed[1])
541
pass # We can allow stuff like ./@revid:blahblahblah
545
parsed = [spec, None]
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()
548
793
def parse_args(command, argv, alias_argv=None):
549
794
"""Parse command line.
551
796
Arguments and options are parsed at this level before being passed
552
797
down to specific command handlers. This routine knows, from a
553
798
lookup table, something about the available options, what optargs
602
847
% (cmd, argname.upper()))
604
849
argdict[argname] = args.pop(0)
607
852
raise errors.BzrCommandError("extra argument to command %s: %s"
608
853
% (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,
614
875
def apply_profiled(the_callable, *args, **kwargs):
634
896
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])
637
940
def apply_lsprofiled(filename, the_callable, *args, **kwargs):
638
941
from bzrlib.lsprof import profile
639
ret, stats = profile(the_callable, *args, **kwargs)
942
ret, stats = profile(exception_to_return_code, the_callable, *args, **kwargs)
641
944
if filename is None:
661
969
config = bzrlib.config.GlobalConfig()
662
970
alias = config.get_alias(cmd)
665
return [a.decode('utf-8') for a in shlex.split(alias.encode('utf-8'))]
972
return cmdline.split(alias)
976
def run_bzr(argv, load_plugins=load_plugins, disable_plugins=disable_plugins):
670
977
"""Execute a command.
672
This is similar to main(), but without all the trappings for
673
logging and error handling.
676
The command-line arguments, without the program name from argv[0]
677
These should already be decoded. All library/test code calling
678
run_bzr should be passing valid strings (don't need decoding).
680
Returns a command status or raises an exception.
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.
682
992
Special master options: these must come before the command because
683
993
they control how the command is interpreted.
727
1044
opt_no_aliases = True
728
1045
elif a == '--builtin':
729
1046
opt_builtin = True
730
elif a in ('--quiet', '-q'):
1047
elif a == '--concurrency':
1048
os.environ['BZR_CONCURRENCY'] = argv[i + 1]
1050
elif a == '--coverage':
1051
opt_coverage_dir = argv[i + 1]
732
1053
elif a.startswith('-D'):
733
1054
debug.debug_flags.add(a[2:])
735
1056
argv_copy.append(a)
1059
debug.set_debug_flags_from_config()
1061
if not opt_no_plugins:
738
1066
argv = argv_copy
740
from bzrlib.builtins import cmd_help
741
cmd_help().run_argv_aliases([])
1068
get_cmd_object('help').run_argv_aliases([])
744
1071
if argv[0] == '--version':
745
from bzrlib.version import show_version
1072
get_cmd_object('version').run_argv_aliases([])
749
if not opt_no_plugins:
750
from bzrlib.plugin import load_plugins
753
from bzrlib.plugin import disable_plugins
756
1075
alias_argv = None
758
1077
if not opt_no_aliases:
759
1078
alias_argv = get_alias(argv[0])
761
alias_argv = [a.decode(bzrlib.user_encoding) for a in alias_argv]
1080
user_encoding = osutils.get_user_encoding()
1081
alias_argv = [a.decode(user_encoding) for a in alias_argv]
762
1082
argv[0] = alias_argv.pop(0)
764
1084
cmd = argv.pop(0)
771
1091
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.')
775
1102
ret = apply_lsprofiled(opt_lsprof_file, run, *run_argv)
776
1103
elif opt_profile:
1104
if opt_coverage_dir:
1106
'--coverage ignored, because --profile is in use.')
777
1107
ret = apply_profiled(run, *run_argv)
1108
elif opt_coverage_dir:
1109
ret = apply_coveraged(opt_coverage_dir, run, *run_argv)
779
1111
ret = run(*run_argv)
782
# reset, in case we may do other commands later within the same process
783
trace.be_quiet(False)
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
785
1122
def display_command(func):
786
1123
"""Decorator that suppresses pipe/interrupt errors."""
802
1139
return ignore_pipe
807
from bzrlib.ui.text import TextUIFactory
808
bzrlib.ui.ui_factory = TextUIFactory()
809
argv = [a.decode(bzrlib.user_encoding) for a in argv[1:]]
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()
810
1192
ret = run_bzr_catch_errors(argv)
1193
bzrlib.ui.ui_factory.log_transport_activity(
1194
display=('bytes' in debug.debug_flags))
811
1195
trace.mutter("return code %d", ret)
815
1199
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()
817
1219
return run_bzr(argv)
818
except (KeyboardInterrupt, Exception), e:
819
# used to handle AssertionError and KeyboardInterrupt
820
# specially here, but hopefully they're handled ok by the logger now
821
trace.report_exception(sys.exc_info(), sys.stderr)
822
if os.environ.get('BZR_PDB'):
823
print '**** entering debugger'
825
pdb.post_mortem(sys.exc_traceback)
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)
829
1229
class HelpCommandIndex(object):
842
1242
if topic and topic.startswith(self.prefix):
843
1243
topic = topic[len(self.prefix):]
845
cmd = _get_cmd_object(topic)
1245
cmd = _get_cmd_object(topic, check_missing=False)
846
1246
except KeyError:
852
if __name__ == '__main__':
853
sys.exit(main(sys.argv))
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()
added
removed
bzrlib/commands.py
