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):
410
235
encoding_type = 'strict'
414
239
def __init__(self):
415
240
"""Construct an instance of this command."""
416
# List of standard options directly supported
417
self.supported_std_options = []
420
def add_cleanup(self, cleanup_func, *args, **kwargs):
421
"""Register a function to call after self.run returns or raises.
423
Functions will be called in LIFO order.
425
self._operation.add_cleanup(cleanup_func, *args, **kwargs)
427
def cleanup_now(self):
428
"""Execute and empty pending cleanup functions immediately.
430
After cleanup_now all registered cleanups are forgotten. add_cleanup
431
may be called again after cleanup_now; these cleanups will be called
432
after self.run returns or raises (or when cleanup_now is next called).
434
This is useful for releasing expensive or contentious resources (such
435
as write locks) before doing further work that does not require those
436
resources (such as writing results to self.outf). Note though, that
437
as it releases all resources, this may release locks that the command
438
wants to hold, so use should be done with care.
440
self._operation.cleanup_now()
442
@deprecated_method(deprecated_in((2, 1, 0)))
241
if self.__doc__ == Command.__doc__:
242
warn("No help message set for %r" % self)
443
244
def _maybe_expand_globs(self, file_list):
444
245
"""Glob expand file_list if the platform does not do that itself.
446
Not used anymore, now that the bzr command-line parser globs on
449
247
:return: A possibly empty list of unicode paths.
451
249
Introduced in bzrlib 0.18.
253
if sys.platform == 'win32':
254
file_list = win32utils.glob_expand(file_list)
255
return list(file_list)
455
257
def _usage(self):
456
258
"""Return single-line grammar for this command.
467
269
elif aname[-1] == '*':
468
270
aname = '[' + aname[:-1] + '...]'
470
s = s[:-1] # remove last space
473
277
def get_help_text(self, additional_see_also=None, plain=True,
474
see_also_as_links=False, verbose=True):
278
see_also_as_links=False):
475
279
"""Return a text string with help for this command.
477
281
:param additional_see_also: Additional help topics to be
478
282
cross-referenced.
479
283
:param plain: if False, raw help (reStructuredText) is
480
284
returned instead of plain text.
481
285
:param see_also_as_links: if True, convert items in 'See also'
482
286
list to internal links (used by bzr_man rstx generator)
483
:param verbose: if True, display the full help, otherwise
484
leave out the descriptive sections and just display
485
usage help (e.g. Purpose, Usage, Options) with a
486
message explaining how to obtain full help.
488
288
doc = self.help()
490
doc = "No help for this command."
290
raise NotImplementedError("sorry, no detailed help yet for %r" % self.name())
492
292
# Extract the summary (purpose) and sections out from the text
493
purpose,sections,order = self._get_help_parts(doc)
293
purpose,sections = self._get_help_parts(doc)
495
295
# If a custom usage section was provided, use it
496
296
if sections.has_key('Usage'):
529
318
result += options
533
# Add the description, indenting it 2 spaces
534
# to match the indentation of the options
535
if sections.has_key(None):
536
text = sections.pop(None)
537
text = '\n '.join(text.splitlines())
538
result += ':%s:\n %s\n\n' % ('Description',text)
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)
540
# Add the custom sections (e.g. Examples). Note that there's no need
541
# to indent these as they must be indented already in the source.
544
if sections.has_key(label):
545
result += ':%s:\n%s\n' % (label,sections[label])
548
result += ("See bzr help %s for more details and examples.\n\n"
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])
551
335
# Add the aliases, source (plug-in) and see also links, if any
582
365
def _get_help_parts(text):
583
366
"""Split help text into a summary and named sections.
585
:return: (summary,sections,order) where summary is the top line and
368
:return: (summary,sections) where summary is the top line and
586
369
sections is a dictionary of the rest indexed by section name.
587
order is the order the section appear in the text.
588
370
A section starts with a heading line of the form ":xxx:".
589
371
Indented text on following lines is the section value.
590
372
All text found outside a named section is assigned to the
591
373
default section which is given the key of None.
593
def save_section(sections, order, label, section):
375
def save_section(sections, label, section):
594
376
if len(section) > 0:
595
377
if sections.has_key(label):
596
378
sections[label] += '\n' + section
599
380
sections[label] = section
601
382
lines = text.rstrip().splitlines()
602
383
summary = lines.pop(0)
605
385
label,section = None,''
606
386
for line in lines:
607
387
if line.startswith(':') and line.endswith(':') and len(line) > 2:
608
save_section(sections, order, label, section)
388
save_section(sections, label, section)
609
389
label,section = line[1:-1],''
610
elif (label is not None) and len(line) > 1 and not line[0].isspace():
611
save_section(sections, order, label, section)
390
elif label != None and len(line) > 1 and not line[0].isspace():
391
save_section(sections, label, section)
612
392
label,section = None,line
614
394
if len(section) > 0:
615
395
section += '\n' + line
618
save_section(sections, order, label, section)
619
return summary, sections, order
398
save_section(sections, label, section)
399
return summary, sections
621
401
def get_help_topic(self):
622
402
"""Return the commands help topic - its name."""
639
419
"""Return dict of valid options for this command.
641
421
Maps from long option name to option object."""
642
r = Option.STD_OPTIONS.copy()
423
r['help'] = option._help_option
644
424
for o in self.takes_options:
645
425
if isinstance(o, basestring):
646
426
o = option.Option.OPTIONS[o]
648
if o.name in std_names:
649
self.supported_std_options.append(o.name)
652
430
def _setup_outf(self):
653
431
"""Return a file linked to stdout, which has proper encoding."""
654
self.outf = ui.ui_factory.make_output_stream(
655
encoding_type=self.encoding_type)
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
657
456
def run_argv_aliases(self, argv, alias_argv=None):
658
457
"""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)
659
462
args, opts = parse_args(self, argv, alias_argv)
661
# Process the standard options
662
463
if 'help' in opts: # e.g. bzr add --help
663
464
sys.stdout.write(self.get_help_text())
665
if 'usage' in opts: # e.g. bzr add --usage
666
sys.stdout.write(self.get_help_text(verbose=False))
668
trace.set_verbosity_level(option._verbosity_level)
669
if 'verbose' in self.supported_std_options:
670
opts['verbose'] = trace.is_verbose()
671
elif opts.has_key('verbose'):
673
if 'quiet' in self.supported_std_options:
674
opts['quiet'] = trace.is_quiet()
675
elif opts.has_key('quiet'):
678
466
# mix arguments and options into one dictionary
679
467
cmdargs = _match_argform(self.name(), self.takes_args, args)
687
475
self._setup_outf()
689
477
return self.run(**all_cmd_args)
691
def _setup_run(self):
692
"""Wrap the defined run method on self with a cleanup.
694
This is called by __init__ to make the Command be able to be run
695
by just calling run(), as it could be before cleanups were added.
697
If a different form of cleanups are in use by your Command subclass,
698
you can override this method.
701
def run(*args, **kwargs):
702
self._operation = cleanup.OperationWithCleanups(class_run)
704
return self._operation.run_simple(*args, **kwargs)
709
@deprecated_method(deprecated_in((2, 2, 0)))
710
def run_direct(self, *args, **kwargs):
711
"""Deprecated thunk from bzrlib 2.1."""
712
return self.run(*args, **kwargs)
715
480
"""Actually run the command.
760
class CommandHooks(Hooks):
761
"""Hooks related to Command object creation/enumeration."""
764
"""Create the default hooks.
766
These are all empty initially, because by default nothing should get
770
self.create_hook(HookPoint('extend_command',
771
"Called after creating a command object to allow modifications "
772
"such as adding or removing options, docs etc. Called with the "
773
"new bzrlib.commands.Command object.", (1, 13), None))
774
self.create_hook(HookPoint('get_command',
775
"Called when creating a single command. Called with "
776
"(cmd_or_None, command_name). get_command should either return "
777
"the cmd_or_None parameter, or a replacement Command object that "
778
"should be used for the command. Note that the Command.hooks "
779
"hooks are core infrastructure. Many users will prefer to use "
780
"bzrlib.commands.register_command or plugin_cmds.register_lazy.",
782
self.create_hook(HookPoint('get_missing_command',
783
"Called when creating a single command if no command could be "
784
"found. Called with (command_name). get_missing_command should "
785
"either return None, or a Command object to be used for the "
786
"command.", (1, 17), None))
787
self.create_hook(HookPoint('list_commands',
788
"Called when enumerating commands. Called with a set of "
789
"cmd_name strings for all the commands found so far. This set "
790
" is safe to mutate - e.g. to remove a command. "
791
"list_commands should return the updated set of command names.",
794
Command.hooks = CommandHooks()
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]
797
548
def parse_args(command, argv, alias_argv=None):
798
549
"""Parse command line.
800
551
Arguments and options are parsed at this level before being passed
801
552
down to specific command handlers. This routine knows, from a
802
553
lookup table, something about the available options, what optargs
851
602
% (cmd, argname.upper()))
853
604
argdict[argname] = args.pop(0)
856
607
raise errors.BzrCommandError("extra argument to command %s: %s"
857
608
% (cmd, args[0]))
861
def apply_coveraged(dirname, the_callable, *args, **kwargs):
862
# Cannot use "import trace", as that would import bzrlib.trace instead of
863
# the standard library's trace.
864
trace = __import__('trace')
866
tracer = trace.Trace(count=1, trace=0)
867
sys.settrace(tracer.globaltrace)
868
threading.settrace(tracer.globaltrace)
871
return exception_to_return_code(the_callable, *args, **kwargs)
874
results = tracer.results()
875
results.write_results(show_missing=1, summary=False,
879
614
def apply_profiled(the_callable, *args, **kwargs):
900
634
os.remove(pfname)
903
def exception_to_return_code(the_callable, *args, **kwargs):
904
"""UI level helper for profiling and coverage.
906
This transforms exceptions into a return value of 3. As such its only
907
relevant to the UI layer, and should never be called where catching
908
exceptions may be desirable.
911
return the_callable(*args, **kwargs)
912
except (KeyboardInterrupt, Exception), e:
913
# used to handle AssertionError and KeyboardInterrupt
914
# specially here, but hopefully they're handled ok by the logger now
915
exc_info = sys.exc_info()
916
exitcode = trace.report_exception(exc_info, sys.stderr)
917
if os.environ.get('BZR_PDB'):
918
print '**** entering debugger'
921
if sys.version_info[:2] < (2, 6):
923
# pdb.post_mortem(tb)
924
# but because pdb.post_mortem gives bad results for tracebacks
925
# from inside generators, we do it manually.
926
# (http://bugs.python.org/issue4150, fixed in Python 2.6)
928
# Setup pdb on the traceback
931
p.setup(tb.tb_frame, tb)
932
# Point the debugger at the deepest frame of the stack
933
p.curindex = len(p.stack) - 1
934
p.curframe = p.stack[p.curindex][0]
935
# Start the pdb prompt.
936
p.print_stack_entry(p.stack[p.curindex])
944
637
def apply_lsprofiled(filename, the_callable, *args, **kwargs):
945
638
from bzrlib.lsprof import profile
946
ret, stats = profile(exception_to_return_code, the_callable, *args, **kwargs)
639
ret, stats = profile(the_callable, *args, **kwargs)
948
641
if filename is None:
973
661
config = bzrlib.config.GlobalConfig()
974
662
alias = config.get_alias(cmd)
976
return cmdline.split(alias)
665
return [a.decode('utf-8') for a in shlex.split(alias.encode('utf-8'))]
980
def run_bzr(argv, load_plugins=load_plugins, disable_plugins=disable_plugins):
981
670
"""Execute a command.
983
:param argv: The command-line arguments, without the program name from
984
argv[0] These should already be decoded. All library/test code calling
985
run_bzr should be passing valid strings (don't need decoding).
986
:param load_plugins: What function to call when triggering plugin loading.
987
This function should take no arguments and cause all plugins to be
989
:param disable_plugins: What function to call when disabling plugin
990
loading. This function should take no arguments and cause all plugin
991
loading to be prohibited (so that code paths in your application that
992
know about some plugins possibly being present will fail to import
993
those plugins even if they are installed.)
994
:return: Returns a command exit code or raises an exception.
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.
996
682
Special master options: these must come before the command because
997
683
they control how the command is interpreted.
1048
727
opt_no_aliases = True
1049
728
elif a == '--builtin':
1050
729
opt_builtin = True
1051
elif a == '--concurrency':
1052
os.environ['BZR_CONCURRENCY'] = argv[i + 1]
1054
elif a == '--coverage':
1055
opt_coverage_dir = argv[i + 1]
730
elif a in ('--quiet', '-q'):
1057
732
elif a.startswith('-D'):
1058
733
debug.debug_flags.add(a[2:])
1060
735
argv_copy.append(a)
1063
debug.set_debug_flags_from_config()
740
from bzrlib.builtins import cmd_help
741
cmd_help().run_argv_aliases([])
744
if argv[0] == '--version':
745
from bzrlib.version import show_version
1065
749
if not opt_no_plugins:
750
from bzrlib.plugin import load_plugins
753
from bzrlib.plugin import disable_plugins
1068
754
disable_plugins()
1072
get_cmd_object('help').run_argv_aliases([])
1075
if argv[0] == '--version':
1076
get_cmd_object('version').run_argv_aliases([])
1079
756
alias_argv = None
1081
758
if not opt_no_aliases:
1082
759
alias_argv = get_alias(argv[0])
761
alias_argv = [a.decode(bzrlib.user_encoding) for a in alias_argv]
1084
762
argv[0] = alias_argv.pop(0)
1086
764
cmd = argv.pop(0)
765
# We want only 'ascii' command names, but the user may have typed
766
# in a Unicode name. In that case, they should just get a
767
# 'command not found' error later.
1087
769
cmd_obj = get_cmd_object(cmd, plugins_override=not opt_builtin)
1088
770
run = cmd_obj.run_argv_aliases
1089
771
run_argv = [argv, alias_argv]
1092
# We can be called recursively (tests for example), but we don't want
1093
# the verbosity level to propagate.
1094
saved_verbosity_level = option._verbosity_level
1095
option._verbosity_level = 0
1097
if opt_coverage_dir:
1099
'--coverage ignored, because --lsprof is in use.')
1100
775
ret = apply_lsprofiled(opt_lsprof_file, run, *run_argv)
1101
776
elif opt_profile:
1102
if opt_coverage_dir:
1104
'--coverage ignored, because --profile is in use.')
1105
777
ret = apply_profiled(run, *run_argv)
1106
elif opt_coverage_dir:
1107
ret = apply_coveraged(opt_coverage_dir, run, *run_argv)
1109
779
ret = run(*run_argv)
1112
# reset, in case we may do other commands later within the same
1113
# process. Commands that want to execute sub-commands must propagate
1114
# --verbose in their own way.
1115
if 'memory' in debug.debug_flags:
1116
trace.debug_memory('Process status after command:', short=False)
1117
option._verbosity_level = saved_verbosity_level
782
# reset, in case we may do other commands later within the same process
783
trace.be_quiet(False)
1120
785
def display_command(func):
1121
786
"""Decorator that suppresses pipe/interrupt errors."""
1137
802
return ignore_pipe
1140
def install_bzr_command_hooks():
1141
"""Install the hooks to supply bzr's own commands."""
1142
if _list_bzr_commands in Command.hooks["list_commands"]:
1144
Command.hooks.install_named_hook("list_commands", _list_bzr_commands,
1146
Command.hooks.install_named_hook("get_command", _get_bzr_command,
1148
Command.hooks.install_named_hook("get_command", _get_plugin_command,
1149
"bzr plugin commands")
1150
Command.hooks.install_named_hook("get_command", _get_external_command,
1151
"bzr external command lookup")
1152
Command.hooks.install_named_hook("get_missing_command", _try_plugin_provider,
1153
"bzr plugin-provider-db check")
1157
def _specified_or_unicode_argv(argv):
1158
# For internal or testing use, argv can be passed. Otherwise, get it from
1159
# the process arguments in a unicode-safe way.
1161
return osutils.get_unicode_argv()
1165
# ensure all arguments are unicode strings
1167
if isinstance(a, unicode):
1170
new_argv.append(a.decode('ascii'))
1171
except UnicodeDecodeError:
1172
raise errors.BzrError("argv should be list of unicode strings.")
1176
def main(argv=None):
1177
"""Main entry point of command-line interface.
1179
Typically `bzrlib.initialize` should be called first.
1181
:param argv: list of unicode command-line arguments similar to sys.argv.
1182
argv[0] is script name usually, it will be ignored.
1183
Don't pass here sys.argv because this list contains plain strings
1184
and not unicode; pass None instead.
1186
:return: exit code of bzr command.
1188
argv = _specified_or_unicode_argv(argv)
1189
_register_builtin_commands()
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:]]
1190
810
ret = run_bzr_catch_errors(argv)
1191
bzrlib.ui.ui_factory.log_transport_activity(
1192
display=('bytes' in debug.debug_flags))
1193
811
trace.mutter("return code %d", ret)
1197
815
def run_bzr_catch_errors(argv):
1198
"""Run a bzr command with parameters as described by argv.
1200
This function assumed that that UI layer is setup, that symbol deprecations
1201
are already applied, and that unicode decoding has already been performed on argv.
1203
# done here so that they're covered for every test run
1204
install_bzr_command_hooks()
1205
return exception_to_return_code(run_bzr, argv)
1208
def run_bzr_catch_user_errors(argv):
1209
"""Run bzr and report user errors, but let internal errors propagate.
1211
This is used for the test suite, and might be useful for other programs
1212
that want to wrap the commandline interface.
1214
# done here so that they're covered for every test run
1215
install_bzr_command_hooks()
1217
817
return run_bzr(argv)
1218
except Exception, e:
1219
if (isinstance(e, (OSError, IOError))
1220
or not getattr(e, 'internal_error', True)):
1221
trace.report_exception(sys.exc_info(), sys.stderr)
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)
1227
829
class HelpCommandIndex(object):
1240
842
if topic and topic.startswith(self.prefix):
1241
843
topic = topic[len(self.prefix):]
1243
cmd = _get_cmd_object(topic, check_missing=False)
845
cmd = _get_cmd_object(topic)
1244
846
except KeyError:
1250
class Provider(object):
1251
'''Generic class to be overriden by plugins'''
1253
def plugin_for_command(self, cmd_name):
1254
'''Takes a command and returns the information for that plugin
1256
:return: A dictionary with all the available information
1257
for the requested plugin
1259
raise NotImplementedError
1262
class ProvidersRegistry(registry.Registry):
1263
'''This registry exists to allow other providers to exist'''
1266
for key, provider in self.iteritems():
1269
command_providers_registry = ProvidersRegistry()
852
if __name__ == '__main__':
853
sys.exit(main(sys.argv))
added
removed
bzrlib/commands.py
