1
# Copyright (C) 2006, 2008 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
18
# TODO: probably should say which arguments are candidates for glob
19
# expansion on windows and do that at the command level.
21
# TODO: Define arguments by objects, rather than just using names.
22
# Those objects can specify the expected type of the argument, which
23
# would help with validation and shell completion. They could also provide
24
# help/explanation for that argument in a structured way.
26
# TODO: Specific "examples" property on commands for consistent formatting.
28
# TODO: "--profile=cum", to change sort order. Is there any value in leaving
29
# the profile output behind so it can be interactively examined?
34
from bzrlib.lazy_import import lazy_import
35
lazy_import(globals(), """
39
from warnings import warn
52
from bzrlib import registry
54
from bzrlib.hooks import HookPoint, Hooks
55
from bzrlib.option import Option
58
class CommandInfo(object):
59
"""Information about a command."""
61
def __init__(self, aliases):
62
"""The list of aliases for the command."""
63
self.aliases = aliases
66
def from_command(klass, command):
67
"""Factory to construct a CommandInfo from a command."""
68
return klass(command.aliases)
71
class CommandRegistry(registry.Registry):
74
def _get_name(command_name):
75
if command_name.startswith("cmd_"):
76
return _unsquish_command_name(command_name)
80
def register(self, cmd, decorate=False):
81
"""Utility function to help register a command
83
:param cmd: Command subclass to register
84
:param decorate: If true, allow overriding an existing command
85
of the same name; the old command is returned by this function.
86
Otherwise it is an error to try to override an existing command.
89
k_unsquished = self._get_name(k)
91
previous = self.get(k_unsquished)
93
previous = _builtin_commands().get(k_unsquished)
94
info = CommandInfo.from_command(cmd)
96
registry.Registry.register(self, k_unsquished, cmd,
97
override_existing=decorate, info=info)
99
trace.log_error('Two plugins defined the same command: %r' % k)
100
trace.log_error('Not loading the one in %r' %
101
sys.modules[cmd.__module__])
102
trace.log_error('Previously this command was registered from %r' %
103
sys.modules[previous.__module__])
106
def register_lazy(self, command_name, aliases, module_name):
107
"""Register a command without loading its module.
109
:param command_name: The primary name of the command.
110
:param aliases: A list of aliases for the command.
111
:module_name: The module that the command lives in.
113
key = self._get_name(command_name)
114
registry.Registry.register_lazy(self, key, module_name, command_name,
115
info=CommandInfo(aliases))
118
plugin_cmds = CommandRegistry()
121
def register_command(cmd, decorate=False):
123
return plugin_cmds.register(cmd, decorate)
126
def _squish_command_name(cmd):
127
return 'cmd_' + cmd.replace('-', '_')
130
def _unsquish_command_name(cmd):
131
return cmd[4:].replace('_','-')
134
def _builtin_commands():
135
import bzrlib.builtins
136
return _scan_module_for_commands(bzrlib.builtins)
139
def _scan_module_for_commands(module):
141
for name, obj in module.__dict__.iteritems():
142
if name.startswith("cmd_"):
143
real_name = _unsquish_command_name(name)
148
def _list_bzr_commands(names):
149
"""Return a list of all the registered commands.
151
This searches plugins and the core.
153
# to eliminate duplicates
154
names.update(builtin_command_names())
155
names.update(plugin_command_names())
159
def all_command_names():
160
"""Return a list of all command names."""
162
for hook in Command.hooks['list_commands']:
163
new_names = hook(names)
164
if new_names is None:
165
raise AssertionError(
166
'hook %s returned None' % Command.hooks.get_hook_name(hook))
171
def builtin_command_names():
172
"""Return list of builtin command names.
174
Use of all_command_names() is encouraged rather than builtin_command_names
175
and/or plugin_command_names.
177
return _builtin_commands().keys()
180
def plugin_command_names():
181
"""Returns command names from commands registered by plugins."""
182
return plugin_cmds.keys()
185
def _get_cmd_dict(plugins_override=True):
186
"""Return name->class mapping for all commands."""
187
d = _builtin_commands()
189
d.update(plugin_cmds.iteritems())
193
def get_all_cmds(plugins_override=True):
194
"""Return canonical name and class for all registered commands."""
195
for k, v in _get_cmd_dict(plugins_override=plugins_override).iteritems():
199
def get_cmd_object(cmd_name, plugins_override=True):
200
"""Return the command object for a command.
203
If true, plugin commands can override builtins.
206
return _get_cmd_object(cmd_name, plugins_override)
208
raise errors.BzrCommandError('unknown command "%s"' % cmd_name)
211
def _get_cmd_object(cmd_name, plugins_override=True):
212
"""Get a command object.
214
:param cmd_name: The name of the command.
215
:param plugins_override: Allow plugins to override builtins.
216
:return: A Command object instance
217
:raises: KeyError if no command is found.
219
# We want only 'ascii' command names, but the user may have typed
220
# in a Unicode name. In that case, they should just get a
221
# 'command not found' error later.
222
# In the future, we may actually support Unicode command names.
226
for hook in Command.hooks['get_command']:
227
cmd = hook(cmd, cmd_name)
228
if cmd is not None and not plugins_override:
229
# We've found a non-plugin command, don't permit it to be
231
if not cmd.plugin_name():
235
plugin_metadata, provider = probe_for_provider(cmd_name)
236
raise errors.CommandAvailableInPlugin(cmd_name,
237
plugin_metadata, provider)
238
except errors.NoPluginAvailable:
242
# Allow plugins to extend commands
243
for hook in Command.hooks['extend_command']:
248
def probe_for_provider(cmd_name):
249
"""Look for a provider for cmd_name.
251
:param cmd_name: The command name.
252
:return: plugin_metadata, provider for getting cmd_name.
253
:raises NoPluginAvailable: When no provider can supply the plugin.
255
# look for providers that provide this command but aren't installed
256
for provider in command_providers_registry:
258
return provider.plugin_for_command(cmd_name), provider
259
except errors.NoPluginAvailable:
261
raise errors.NoPluginAvailable(cmd_name)
264
def _get_bzr_command(cmd_or_None, cmd_name):
265
"""Get a command from bzr's core."""
266
cmds = _get_cmd_dict(plugins_override=False)
268
return cmds[cmd_name]()
271
# look for any command which claims this as an alias
272
for real_cmd_name, cmd_class in cmds.iteritems():
273
if cmd_name in cmd_class.aliases:
278
def _get_external_command(cmd_or_None, cmd_name):
279
"""Lookup a command that is a shell script."""
280
# Only do external command lookups when no command is found so far.
281
if cmd_or_None is not None:
283
from bzrlib.externalcommand import ExternalCommand
284
cmd_obj = ExternalCommand.find_command(cmd_name)
289
def _get_plugin_command(cmd_or_None, cmd_name):
290
"""Get a command from bzr's plugins."""
292
return plugin_cmds.get(cmd_name)()
295
for key in plugin_cmds.keys():
296
info = plugin_cmds.get_info(key)
297
if cmd_name in info.aliases:
298
return plugin_cmds.get(key)()
302
class Command(object):
303
"""Base class for commands.
305
Commands are the heart of the command-line bzr interface.
307
The command object mostly handles the mapping of command-line
308
parameters into one or more bzrlib operations, and of the results
311
Commands normally don't have any state. All their arguments are
312
passed in to the run method. (Subclasses may take a different
313
policy if the behaviour of the instance needs to depend on e.g. a
314
shell plugin and not just its Python class.)
316
The docstring for an actual command should give a single-line
317
summary, then a complete description of the command. A grammar
318
description will be inserted.
321
Other accepted names for this command.
324
List of argument forms, marked with whether they are optional,
329
['to_location', 'from_branch?', 'file*']
331
'to_location' is required
332
'from_branch' is optional
333
'file' can be specified 0 or more times
336
List of options that may be given for this command. These can
337
be either strings, referring to globally-defined options,
338
or option objects. Retrieve through options().
341
If true, this command isn't advertised. This is typically
342
for commands intended for expert users.
345
Command objects will get a 'outf' attribute, which has been
346
setup to properly handle encoding of unicode strings.
347
encoding_type determines what will happen when characters cannot
349
strict - abort if we cannot decode
350
replace - put in a bogus character (typically '?')
351
exact - do not encode sys.stdout
353
NOTE: by default on Windows, sys.stdout is opened as a text
354
stream, therefore LF line-endings are converted to CRLF.
355
When a command uses encoding_type = 'exact', then
356
sys.stdout is forced to be a binary stream, and line-endings
359
:cvar hooks: An instance of CommandHooks.
364
encoding_type = 'strict'
369
"""Construct an instance of this command."""
370
if self.__doc__ == Command.__doc__:
371
warn("No help message set for %r" % self)
372
# List of standard options directly supported
373
self.supported_std_options = []
375
def _maybe_expand_globs(self, file_list):
376
"""Glob expand file_list if the platform does not do that itself.
378
:return: A possibly empty list of unicode paths.
380
Introduced in bzrlib 0.18.
384
if sys.platform == 'win32':
385
file_list = win32utils.glob_expand(file_list)
386
return list(file_list)
389
"""Return single-line grammar for this command.
391
Only describes arguments, not options.
393
s = 'bzr ' + self.name() + ' '
394
for aname in self.takes_args:
395
aname = aname.upper()
396
if aname[-1] in ['$', '+']:
397
aname = aname[:-1] + '...'
398
elif aname[-1] == '?':
399
aname = '[' + aname[:-1] + ']'
400
elif aname[-1] == '*':
401
aname = '[' + aname[:-1] + '...]'
403
s = s[:-1] # remove last space
406
def get_help_text(self, additional_see_also=None, plain=True,
407
see_also_as_links=False, verbose=True):
408
"""Return a text string with help for this command.
410
:param additional_see_also: Additional help topics to be
412
:param plain: if False, raw help (reStructuredText) is
413
returned instead of plain text.
414
:param see_also_as_links: if True, convert items in 'See also'
415
list to internal links (used by bzr_man rstx generator)
416
:param verbose: if True, display the full help, otherwise
417
leave out the descriptive sections and just display
418
usage help (e.g. Purpose, Usage, Options) with a
419
message explaining how to obtain full help.
423
raise NotImplementedError("sorry, no detailed help yet for %r" % self.name())
425
# Extract the summary (purpose) and sections out from the text
426
purpose,sections,order = self._get_help_parts(doc)
428
# If a custom usage section was provided, use it
429
if sections.has_key('Usage'):
430
usage = sections.pop('Usage')
432
usage = self._usage()
434
# The header is the purpose and usage
436
result += ':Purpose: %s\n' % purpose
437
if usage.find('\n') >= 0:
438
result += ':Usage:\n%s\n' % usage
440
result += ':Usage: %s\n' % usage
444
options = option.get_optparser(self.options()).format_option_help()
445
if options.startswith('Options:'):
446
result += ':' + options
447
elif options.startswith('options:'):
448
# Python 2.4 version of optparse
449
result += ':Options:' + options[len('options:'):]
455
# Add the description, indenting it 2 spaces
456
# to match the indentation of the options
457
if sections.has_key(None):
458
text = sections.pop(None)
459
text = '\n '.join(text.splitlines())
460
result += ':%s:\n %s\n\n' % ('Description',text)
462
# Add the custom sections (e.g. Examples). Note that there's no need
463
# to indent these as they must be indented already in the source.
466
if sections.has_key(label):
467
result += ':%s:\n%s\n' % (label,sections[label])
470
result += ("See bzr help %s for more details and examples.\n\n"
473
# Add the aliases, source (plug-in) and see also links, if any
475
result += ':Aliases: '
476
result += ', '.join(self.aliases) + '\n'
477
plugin_name = self.plugin_name()
478
if plugin_name is not None:
479
result += ':From: plugin "%s"\n' % plugin_name
480
see_also = self.get_see_also(additional_see_also)
482
if not plain and see_also_as_links:
484
for item in see_also:
486
# topics doesn't have an independent section
487
# so don't create a real link
488
see_also_links.append(item)
490
# Use a reST link for this entry
491
see_also_links.append("`%s`_" % (item,))
492
see_also = see_also_links
493
result += ':See also: '
494
result += ', '.join(see_also) + '\n'
496
# If this will be rendered as plain text, convert it
498
import bzrlib.help_topics
499
result = bzrlib.help_topics.help_as_plain_text(result)
503
def _get_help_parts(text):
504
"""Split help text into a summary and named sections.
506
:return: (summary,sections,order) where summary is the top line and
507
sections is a dictionary of the rest indexed by section name.
508
order is the order the section appear in the text.
509
A section starts with a heading line of the form ":xxx:".
510
Indented text on following lines is the section value.
511
All text found outside a named section is assigned to the
512
default section which is given the key of None.
514
def save_section(sections, order, label, section):
516
if sections.has_key(label):
517
sections[label] += '\n' + section
520
sections[label] = section
522
lines = text.rstrip().splitlines()
523
summary = lines.pop(0)
526
label,section = None,''
528
if line.startswith(':') and line.endswith(':') and len(line) > 2:
529
save_section(sections, order, label, section)
530
label,section = line[1:-1],''
531
elif (label is not None) and len(line) > 1 and not line[0].isspace():
532
save_section(sections, order, label, section)
533
label,section = None,line
536
section += '\n' + line
539
save_section(sections, order, label, section)
540
return summary, sections, order
542
def get_help_topic(self):
543
"""Return the commands help topic - its name."""
546
def get_see_also(self, additional_terms=None):
547
"""Return a list of help topics that are related to this command.
549
The list is derived from the content of the _see_also attribute. Any
550
duplicates are removed and the result is in lexical order.
551
:param additional_terms: Additional help topics to cross-reference.
552
:return: A list of help topics.
554
see_also = set(getattr(self, '_see_also', []))
556
see_also.update(additional_terms)
557
return sorted(see_also)
560
"""Return dict of valid options for this command.
562
Maps from long option name to option object."""
563
r = Option.STD_OPTIONS.copy()
565
for o in self.takes_options:
566
if isinstance(o, basestring):
567
o = option.Option.OPTIONS[o]
569
if o.name in std_names:
570
self.supported_std_options.append(o.name)
573
def _setup_outf(self):
574
"""Return a file linked to stdout, which has proper encoding."""
575
# Originally I was using self.stdout, but that looks
576
# *way* too much like sys.stdout
577
if self.encoding_type == 'exact':
578
# force sys.stdout to be binary stream on win32
579
if sys.platform == 'win32':
580
fileno = getattr(sys.stdout, 'fileno', None)
583
msvcrt.setmode(fileno(), os.O_BINARY)
584
self.outf = sys.stdout
587
output_encoding = osutils.get_terminal_encoding()
589
self.outf = codecs.getwriter(output_encoding)(sys.stdout,
590
errors=self.encoding_type)
591
# For whatever reason codecs.getwriter() does not advertise its encoding
592
# it just returns the encoding of the wrapped file, which is completely
593
# bogus. So set the attribute, so we can find the correct encoding later.
594
self.outf.encoding = output_encoding
596
def run_argv_aliases(self, argv, alias_argv=None):
597
"""Parse the command line and run with extra aliases in alias_argv."""
599
warn("Passing None for [] is deprecated from bzrlib 0.10",
600
DeprecationWarning, stacklevel=2)
602
args, opts = parse_args(self, argv, alias_argv)
604
# Process the standard options
605
if 'help' in opts: # e.g. bzr add --help
606
sys.stdout.write(self.get_help_text())
608
if 'usage' in opts: # e.g. bzr add --usage
609
sys.stdout.write(self.get_help_text(verbose=False))
611
trace.set_verbosity_level(option._verbosity_level)
612
if 'verbose' in self.supported_std_options:
613
opts['verbose'] = trace.is_verbose()
614
elif opts.has_key('verbose'):
616
if 'quiet' in self.supported_std_options:
617
opts['quiet'] = trace.is_quiet()
618
elif opts.has_key('quiet'):
621
# mix arguments and options into one dictionary
622
cmdargs = _match_argform(self.name(), self.takes_args, args)
624
for k, v in opts.items():
625
cmdopts[k.replace('-', '_')] = v
627
all_cmd_args = cmdargs.copy()
628
all_cmd_args.update(cmdopts)
632
return self.run(**all_cmd_args)
635
"""Actually run the command.
637
This is invoked with the options and arguments bound to
640
Return 0 or None if the command was successful, or a non-zero
641
shell error code if not. It's OK for this method to allow
642
an exception to raise up.
644
raise NotImplementedError('no implementation of command %r'
648
"""Return help message for this class."""
649
from inspect import getdoc
650
if self.__doc__ is Command.__doc__:
655
return _unsquish_command_name(self.__class__.__name__)
657
def plugin_name(self):
658
"""Get the name of the plugin that provides this command.
660
:return: The name of the plugin or None if the command is builtin.
662
mod_parts = self.__module__.split('.')
663
if len(mod_parts) >= 3 and mod_parts[1] == 'plugins':
669
class CommandHooks(Hooks):
670
"""Hooks related to Command object creation/enumeration."""
673
"""Create the default hooks.
675
These are all empty initially, because by default nothing should get
679
self.create_hook(HookPoint('extend_command',
680
"Called after creating a command object to allow modifications "
681
"such as adding or removing options, docs etc. Called with the "
682
"new bzrlib.commands.Command object.", (1, 13), None))
683
self.create_hook(HookPoint('get_command',
684
"Called when creating a single command. Called with "
685
"(cmd_or_None, command_name). get_command should either return "
686
"the cmd_or_None parameter, or a replacement Command object that "
687
"should be used for the command.", (1, 14), None))
688
self.create_hook(HookPoint('list_commands',
689
"Called when enumerating commands. Called with a dict of "
690
"cmd_name: cmd_class tuples for all the commands found "
691
"so far. This dict is safe to mutate - to remove a command or "
692
"to replace it with another (eg plugin supplied) version. "
693
"list_commands should return the updated dict of commands.",
695
# We currently ship default hooks to get builtin and plugin supplied
697
self.install_named_hook("list_commands", _list_bzr_commands,
699
self.install_named_hook("get_command", _get_bzr_command,
701
self.install_named_hook("get_command", _get_plugin_command,
702
"bzr plugin commands")
703
self.install_named_hook("get_command", _get_external_command,
704
"bzr external command lookup")
706
Command.hooks = CommandHooks()
709
def parse_args(command, argv, alias_argv=None):
710
"""Parse command line.
712
Arguments and options are parsed at this level before being passed
713
down to specific command handlers. This routine knows, from a
714
lookup table, something about the available options, what optargs
715
they take, and which commands will accept them.
717
# TODO: make it a method of the Command?
718
parser = option.get_optparser(command.options())
719
if alias_argv is not None:
720
args = alias_argv + argv
724
options, args = parser.parse_args(args)
725
opts = dict([(k, v) for k, v in options.__dict__.iteritems() if
726
v is not option.OptionParser.DEFAULT_VALUE])
730
def _match_argform(cmd, takes_args, args):
733
# step through args and takes_args, allowing appropriate 0-many matches
734
for ap in takes_args:
738
argdict[argname] = args.pop(0)
739
elif ap[-1] == '*': # all remaining arguments
741
argdict[argname + '_list'] = args[:]
744
argdict[argname + '_list'] = None
747
raise errors.BzrCommandError("command %r needs one or more %s"
748
% (cmd, argname.upper()))
750
argdict[argname + '_list'] = args[:]
752
elif ap[-1] == '$': # all but one
754
raise errors.BzrCommandError("command %r needs one or more %s"
755
% (cmd, argname.upper()))
756
argdict[argname + '_list'] = args[:-1]
762
raise errors.BzrCommandError("command %r requires argument %s"
763
% (cmd, argname.upper()))
765
argdict[argname] = args.pop(0)
768
raise errors.BzrCommandError("extra argument to command %s: %s"
773
def apply_coveraged(dirname, the_callable, *args, **kwargs):
774
# Cannot use "import trace", as that would import bzrlib.trace instead of
775
# the standard library's trace.
776
trace = __import__('trace')
778
tracer = trace.Trace(count=1, trace=0)
779
sys.settrace(tracer.globaltrace)
780
threading.settrace(tracer.globaltrace)
783
return exception_to_return_code(the_callable, *args, **kwargs)
786
results = tracer.results()
787
results.write_results(show_missing=1, summary=False,
791
def apply_profiled(the_callable, *args, **kwargs):
795
pffileno, pfname = tempfile.mkstemp()
797
prof = hotshot.Profile(pfname)
799
ret = prof.runcall(exception_to_return_code, the_callable, *args,
803
stats = hotshot.stats.load(pfname)
805
stats.sort_stats('cum') # 'time'
806
## XXX: Might like to write to stderr or the trace file instead but
807
## print_stats seems hardcoded to stdout
808
stats.print_stats(20)
815
def exception_to_return_code(the_callable, *args, **kwargs):
816
"""UI level helper for profiling and coverage.
818
This transforms exceptions into a return value of 3. As such its only
819
relevant to the UI layer, and should never be called where catching
820
exceptions may be desirable.
823
return the_callable(*args, **kwargs)
824
except (KeyboardInterrupt, Exception), e:
825
# used to handle AssertionError and KeyboardInterrupt
826
# specially here, but hopefully they're handled ok by the logger now
827
exc_info = sys.exc_info()
828
exitcode = trace.report_exception(exc_info, sys.stderr)
829
if os.environ.get('BZR_PDB'):
830
print '**** entering debugger'
833
if sys.version_info[:2] < (2, 6):
835
# pdb.post_mortem(tb)
836
# but because pdb.post_mortem gives bad results for tracebacks
837
# from inside generators, we do it manually.
838
# (http://bugs.python.org/issue4150, fixed in Python 2.6)
840
# Setup pdb on the traceback
843
p.setup(tb.tb_frame, tb)
844
# Point the debugger at the deepest frame of the stack
845
p.curindex = len(p.stack) - 1
846
p.curframe = p.stack[p.curindex][0]
847
# Start the pdb prompt.
848
p.print_stack_entry(p.stack[p.curindex])
856
def apply_lsprofiled(filename, the_callable, *args, **kwargs):
857
from bzrlib.lsprof import profile
858
ret, stats = profile(exception_to_return_code, the_callable, *args, **kwargs)
864
trace.note('Profile data written to "%s".', filename)
868
def shlex_split_unicode(unsplit):
870
return [u.decode('utf-8') for u in shlex.split(unsplit.encode('utf-8'))]
873
def get_alias(cmd, config=None):
874
"""Return an expanded alias, or None if no alias exists.
877
Command to be checked for an alias.
879
Used to specify an alternative config to use,
880
which is especially useful for testing.
881
If it is unspecified, the global config will be used.
885
config = bzrlib.config.GlobalConfig()
886
alias = config.get_alias(cmd)
888
return shlex_split_unicode(alias)
893
"""Execute a command.
896
The command-line arguments, without the program name from argv[0]
897
These should already be decoded. All library/test code calling
898
run_bzr should be passing valid strings (don't need decoding).
900
Returns a command status or raises an exception.
902
Special master options: these must come before the command because
903
they control how the command is interpreted.
906
Do not load plugin modules at all
912
Only use builtin commands. (Plugins are still allowed to change
916
Run under the Python hotshot profiler.
919
Run under the Python lsprof profiler.
922
Generate line coverage report in the specified directory.
925
trace.mutter("bzr arguments: %r", argv)
927
opt_lsprof = opt_profile = opt_no_plugins = opt_builtin = \
928
opt_no_aliases = False
929
opt_lsprof_file = opt_coverage_dir = None
931
# --no-plugins is handled specially at a very early stage. We need
932
# to load plugins before doing other command parsing so that they
933
# can override commands, but this needs to happen first.
941
elif a == '--lsprof':
943
elif a == '--lsprof-file':
945
opt_lsprof_file = argv[i + 1]
947
elif a == '--no-plugins':
948
opt_no_plugins = True
949
elif a == '--no-aliases':
950
opt_no_aliases = True
951
elif a == '--builtin':
953
elif a == '--coverage':
954
opt_coverage_dir = argv[i + 1]
956
elif a.startswith('-D'):
957
debug.debug_flags.add(a[2:])
962
debug.set_debug_flags_from_config()
966
from bzrlib.builtins import cmd_help
967
cmd_help().run_argv_aliases([])
970
if argv[0] == '--version':
971
from bzrlib.builtins import cmd_version
972
cmd_version().run_argv_aliases([])
975
if not opt_no_plugins:
976
from bzrlib.plugin import load_plugins
979
from bzrlib.plugin import disable_plugins
984
if not opt_no_aliases:
985
alias_argv = get_alias(argv[0])
987
user_encoding = osutils.get_user_encoding()
988
alias_argv = [a.decode(user_encoding) for a in alias_argv]
989
argv[0] = alias_argv.pop(0)
992
# We want only 'ascii' command names, but the user may have typed
993
# in a Unicode name. In that case, they should just get a
994
# 'command not found' error later.
996
cmd_obj = get_cmd_object(cmd, plugins_override=not opt_builtin)
997
run = cmd_obj.run_argv_aliases
998
run_argv = [argv, alias_argv]
1001
# We can be called recursively (tests for example), but we don't want
1002
# the verbosity level to propagate.
1003
saved_verbosity_level = option._verbosity_level
1004
option._verbosity_level = 0
1006
if opt_coverage_dir:
1008
'--coverage ignored, because --lsprof is in use.')
1009
ret = apply_lsprofiled(opt_lsprof_file, run, *run_argv)
1011
if opt_coverage_dir:
1013
'--coverage ignored, because --profile is in use.')
1014
ret = apply_profiled(run, *run_argv)
1015
elif opt_coverage_dir:
1016
ret = apply_coveraged(opt_coverage_dir, run, *run_argv)
1018
ret = run(*run_argv)
1019
if 'memory' in debug.debug_flags:
1020
trace.debug_memory('Process status after command:', short=False)
1023
# reset, in case we may do other commands later within the same
1024
# process. Commands that want to execute sub-commands must propagate
1025
# --verbose in their own way.
1026
option._verbosity_level = saved_verbosity_level
1029
def display_command(func):
1030
"""Decorator that suppresses pipe/interrupt errors."""
1031
def ignore_pipe(*args, **kwargs):
1033
result = func(*args, **kwargs)
1037
if getattr(e, 'errno', None) is None:
1039
if e.errno != errno.EPIPE:
1040
# Win32 raises IOError with errno=0 on a broken pipe
1041
if sys.platform != 'win32' or (e.errno not in (0, errno.EINVAL)):
1044
except KeyboardInterrupt:
1049
def main(argv=None):
1050
"""Main entry point of command-line interface.
1052
:param argv: list of unicode command-line arguments similar to sys.argv.
1053
argv[0] is script name usually, it will be ignored.
1054
Don't pass here sys.argv because this list contains plain strings
1055
and not unicode; pass None instead.
1057
:return: exit code of bzr command.
1060
bzrlib.ui.ui_factory = bzrlib.ui.make_ui_for_terminal(
1061
sys.stdin, sys.stdout, sys.stderr)
1063
# Is this a final release version? If so, we should suppress warnings
1064
if bzrlib.version_info[3] == 'final':
1065
from bzrlib import symbol_versioning
1066
symbol_versioning.suppress_deprecation_warnings(override=False)
1068
argv = osutils.get_unicode_argv()
1072
# ensure all arguments are unicode strings
1074
if isinstance(a, unicode):
1077
new_argv.append(a.decode('ascii'))
1078
except UnicodeDecodeError:
1079
raise errors.BzrError("argv should be list of unicode strings.")
1081
ret = run_bzr_catch_errors(argv)
1082
trace.mutter("return code %d", ret)
1086
def run_bzr_catch_errors(argv):
1087
"""Run a bzr command with parameters as described by argv.
1089
This function assumed that that UI layer is setup, that symbol deprecations
1090
are already applied, and that unicode decoding has already been performed on argv.
1092
return exception_to_return_code(run_bzr, argv)
1095
def run_bzr_catch_user_errors(argv):
1096
"""Run bzr and report user errors, but let internal errors propagate.
1098
This is used for the test suite, and might be useful for other programs
1099
that want to wrap the commandline interface.
1102
return run_bzr(argv)
1103
except Exception, e:
1104
if (isinstance(e, (OSError, IOError))
1105
or not getattr(e, 'internal_error', True)):
1106
trace.report_exception(sys.exc_info(), sys.stderr)
1112
class HelpCommandIndex(object):
1113
"""A index for bzr help that returns commands."""
1116
self.prefix = 'commands/'
1118
def get_topics(self, topic):
1119
"""Search for topic amongst commands.
1121
:param topic: A topic to search for.
1122
:return: A list which is either empty or contains a single
1125
if topic and topic.startswith(self.prefix):
1126
topic = topic[len(self.prefix):]
1128
cmd = _get_cmd_object(topic)
1135
class Provider(object):
1136
'''Generic class to be overriden by plugins'''
1138
def plugin_for_command(self, cmd_name):
1139
'''Takes a command and returns the information for that plugin
1141
:return: A dictionary with all the available information
1142
for the requested plugin
1144
raise NotImplementedError
1147
class ProvidersRegistry(registry.Registry):
1148
'''This registry exists to allow other providers to exist'''
1151
for key, provider in self.iteritems():
1154
command_providers_registry = ProvidersRegistry()
1157
if __name__ == '__main__':
1158
sys.exit(main(sys.argv))
added
removed
bzrlib/commands.py
