24
26
# TODO: Specific "examples" property on commands for consistent formatting.
28
# TODO: "--profile=cum", to change sort order. Is there any value in leaving
29
# the profile output behind so it can be interactively examined?
29
34
from bzrlib.lazy_import import lazy_import
30
35
lazy_import(globals(), """
39
from warnings import warn
35
42
from bzrlib import (
49
from bzrlib.hooks import Hooks
50
from bzrlib.i18n import gettext
54
from bzrlib.hooks import HookPoint, Hooks
51
55
# Compatibility - Option used to be in commands.
52
56
from bzrlib.option import Option
53
from bzrlib.plugin import disable_plugins, load_plugins
54
57
from bzrlib import registry
58
from bzrlib.symbol_versioning import (
57
65
class CommandInfo(object):
70
78
class CommandRegistry(registry.Registry):
71
"""Special registry mapping command names to command classes.
73
:ivar overridden_registry: Look in this registry for commands being
74
overridden by this registry. This can be used to tell plugin commands
75
about the builtin they're decorating.
79
registry.Registry.__init__(self)
80
self.overridden_registry = None
81
# map from aliases to the real command that implements the name
84
def get(self, command_name):
85
real_name = self._alias_dict.get(command_name, command_name)
86
return registry.Registry.get(self, real_name)
89
81
def _get_name(command_name):
135
120
key = self._get_name(command_name)
136
121
registry.Registry.register_lazy(self, key, module_name, command_name,
137
122
info=CommandInfo(aliases))
139
self._alias_dict[a] = key
142
125
plugin_cmds = CommandRegistry()
143
builtin_command_registry = CommandRegistry()
144
plugin_cmds.overridden_registry = builtin_command_registry
147
128
def register_command(cmd, decorate=False):
148
"""Register a plugin command.
150
Should generally be avoided in favor of lazy registration.
152
129
global plugin_cmds
153
130
return plugin_cmds.register(cmd, decorate)
227
195
return _get_cmd_object(cmd_name, plugins_override)
229
raise errors.BzrCommandError(gettext('unknown command "%s"') % cmd_name)
232
def _get_cmd_object(cmd_name, plugins_override=True, check_missing=True):
197
raise errors.BzrCommandError('unknown command "%s"' % cmd_name)
200
def _get_cmd_object(cmd_name, plugins_override=True):
233
201
"""Get a command object.
235
203
:param cmd_name: The name of the command.
236
204
:param plugins_override: Allow plugins to override builtins.
237
:param check_missing: Look up commands not found in the regular index via
238
the get_missing_command hook.
239
205
:return: A Command object instance
240
206
:raises KeyError: If no command is found.
346
313
summary, then a complete description of the command. A grammar
347
314
description will be inserted.
349
:cvar aliases: Other accepted names for this command.
351
:cvar takes_args: List of argument forms, marked with whether they are
352
optional, repeated, etc. Examples::
354
['to_location', 'from_branch?', 'file*']
356
* 'to_location' is required
357
* 'from_branch' is optional
358
* 'file' can be specified 0 or more times
360
:cvar takes_options: List of options that may be given for this command.
361
These can be either strings, referring to globally-defined options, or
362
option objects. Retrieve through options().
364
:cvar hidden: If true, this command isn't advertised. This is typically
317
Other accepted names for this command.
320
List of argument forms, marked with whether they are optional,
325
['to_location', 'from_branch?', 'file*']
327
'to_location' is required
328
'from_branch' is optional
329
'file' can be specified 0 or more times
332
List of options that may be given for this command. These can
333
be either strings, referring to globally-defined options,
334
or option objects. Retrieve through options().
337
If true, this command isn't advertised. This is typically
365
338
for commands intended for expert users.
367
:cvar encoding_type: Command objects will get a 'outf' attribute, which has
368
been setup to properly handle encoding of unicode strings.
369
encoding_type determines what will happen when characters cannot be
372
* strict - abort if we cannot decode
373
* replace - put in a bogus character (typically '?')
374
* exact - do not encode sys.stdout
376
NOTE: by default on Windows, sys.stdout is opened as a text stream,
377
therefore LF line-endings are converted to CRLF. When a command uses
378
encoding_type = 'exact', then sys.stdout is forced to be a binary
379
stream, and line-endings will not mangled.
382
A string indicating the real name under which this command was
383
invoked, before expansion of aliases.
384
(This may be None if the command was constructed and run in-process.)
341
Command objects will get a 'outf' attribute, which has been
342
setup to properly handle encoding of unicode strings.
343
encoding_type determines what will happen when characters cannot
345
strict - abort if we cannot decode
346
replace - put in a bogus character (typically '?')
347
exact - do not encode sys.stdout
349
NOTE: by default on Windows, sys.stdout is opened as a text
350
stream, therefore LF line-endings are converted to CRLF.
351
When a command uses encoding_type = 'exact', then
352
sys.stdout is forced to be a binary stream, and line-endings
386
355
:cvar hooks: An instance of CommandHooks.
388
:cvar __doc__: The help shown by 'bzr help command' for this command.
389
This is set by assigning explicitly to __doc__ so that -OO can
393
__doc__ = "My help goes here"
397
359
takes_options = []
398
360
encoding_type = 'strict'
404
364
def __init__(self):
405
365
"""Construct an instance of this command."""
366
if self.__doc__ == Command.__doc__:
367
warn("No help message set for %r" % self)
406
368
# List of standard options directly supported
407
369
self.supported_std_options = []
370
self._operation = cleanup.OperationWithCleanups(self.run)
410
372
def add_cleanup(self, cleanup_func, *args, **kwargs):
411
373
"""Register a function to call after self.run returns or raises.
424
386
This is useful for releasing expensive or contentious resources (such
425
387
as write locks) before doing further work that does not require those
426
resources (such as writing results to self.outf). Note though, that
427
as it releases all resources, this may release locks that the command
428
wants to hold, so use should be done with care.
388
resources (such as writing results to self.outf).
430
390
self._operation.cleanup_now()
392
@deprecated_method(deprecated_in((2, 1, 0)))
393
def _maybe_expand_globs(self, file_list):
394
"""Glob expand file_list if the platform does not do that itself.
396
Not used anymore, now that the bzr command-line parser globs on
399
:return: A possibly empty list of unicode paths.
401
Introduced in bzrlib 0.18.
432
405
def _usage(self):
433
406
"""Return single-line grammar for this command.
462
435
usage help (e.g. Purpose, Usage, Options) with a
463
436
message explaining how to obtain full help.
466
i18n.install() # Install i18n only for get_help_text for now.
467
438
doc = self.help()
469
# Note: If self.gettext() translates ':Usage:\n', the section will
470
# be shown after "Description" section and we don't want to
471
# translate the usage string.
472
# Though, bzr export-pot don't exports :Usage: section and it must
474
doc = self.gettext(doc)
476
doc = gettext("No help for this command.")
440
raise NotImplementedError("sorry, no detailed help yet for %r" % self.name())
478
442
# Extract the summary (purpose) and sections out from the text
479
443
purpose,sections,order = self._get_help_parts(doc)
498
462
# XXX: optparse implicitly rewraps the help, and not always perfectly,
499
463
# so we get <https://bugs.launchpad.net/bzr/+bug/249908>. -- mbp
501
parser = option.get_optparser(self.options())
502
options = parser.format_option_help()
503
# FIXME: According to the spec, ReST option lists actually don't
504
# support options like --1.14 so that causes syntax errors (in Sphinx
505
# at least). As that pattern always appears in the commands that
506
# break, we trap on that and then format that block of 'format' options
507
# as a literal block. We use the most recent format still listed so we
508
# don't have to do that too often -- vila 20110514
509
if not plain and options.find(' --1.14 ') != -1:
465
options = option.get_optparser(self.options()).format_option_help()
466
# XXX: According to the spec, ReST option lists actually don't support
467
# options like --1.9 so that causes syntax errors (in Sphinx at least).
468
# As that pattern always appears in the commands that break, we trap
469
# on that and then format that block of 'format' options as a literal
471
if not plain and options.find(' --1.9 ') != -1:
510
472
options = options.replace(' format:\n', ' format::\n\n', 1)
511
473
if options.startswith('Options:'):
512
result += gettext(':Options:%s') % (options[len('options:'):],)
474
result += ':' + options
475
elif options.startswith('options:'):
476
# Python 2.4 version of optparse
477
result += ':Options:' + options[len('options:'):]
514
479
result += options
520
485
if sections.has_key(None):
521
486
text = sections.pop(None)
522
487
text = '\n '.join(text.splitlines())
523
result += gettext(':Description:\n %s\n\n') % (text,)
488
result += ':%s:\n %s\n\n' % ('Description',text)
525
490
# Add the custom sections (e.g. Examples). Note that there's no need
526
491
# to indent these as they must be indented already in the source.
528
493
for label in order:
529
if label in sections:
530
result += ':%s:\n%s\n' % (label, sections[label])
494
if sections.has_key(label):
495
result += ':%s:\n%s\n' % (label,sections[label])
533
result += (gettext("See bzr help %s for more details and examples.\n\n")
498
result += ("See bzr help %s for more details and examples.\n\n"
536
501
# Add the aliases, source (plug-in) and see also links, if any
538
result += gettext(':Aliases: ')
503
result += ':Aliases: '
539
504
result += ', '.join(self.aliases) + '\n'
540
505
plugin_name = self.plugin_name()
541
506
if plugin_name is not None:
542
result += gettext(':From: plugin "%s"\n') % plugin_name
507
result += ':From: plugin "%s"\n' % plugin_name
543
508
see_also = self.get_see_also(additional_see_also)
545
510
if not plain and see_also_as_links:
642
607
def run_argv_aliases(self, argv, alias_argv=None):
643
608
"""Parse the command line and run with extra aliases in alias_argv."""
644
609
args, opts = parse_args(self, argv, alias_argv)
647
611
# Process the standard options
648
612
if 'help' in opts: # e.g. bzr add --help
649
self.outf.write(self.get_help_text())
613
sys.stdout.write(self.get_help_text())
651
615
if 'usage' in opts: # e.g. bzr add --usage
652
self.outf.write(self.get_help_text(verbose=False))
616
sys.stdout.write(self.get_help_text(verbose=False))
654
618
trace.set_verbosity_level(option._verbosity_level)
655
619
if 'verbose' in self.supported_std_options:
669
634
all_cmd_args = cmdargs.copy()
670
635
all_cmd_args.update(cmdopts)
673
return self.run(**all_cmd_args)
675
# reset it, so that other commands run in the same process won't
676
# inherit state. Before we reset it, log any activity, so that it
677
# gets properly tracked.
678
ui.ui_factory.log_transport_activity(
679
display=('bytes' in debug.debug_flags))
680
trace.set_verbosity_level(0)
682
def _setup_run(self):
683
"""Wrap the defined run method on self with a cleanup.
685
This is called by __init__ to make the Command be able to be run
686
by just calling run(), as it could be before cleanups were added.
688
If a different form of cleanups are in use by your Command subclass,
689
you can override this method.
692
def run(*args, **kwargs):
693
for hook in Command.hooks['pre_command']:
695
self._operation = cleanup.OperationWithCleanups(class_run)
697
return self._operation.run_simple(*args, **kwargs)
700
for hook in Command.hooks['post_command']:
639
return self.run_direct(**all_cmd_args)
641
def run_direct(self, *args, **kwargs):
642
"""Call run directly with objects (without parsing an argv list)."""
643
return self._operation.run_simple(*args, **kwargs)
705
646
"""Actually run the command.
710
651
Return 0 or None if the command was successful, or a non-zero
711
652
shell error code if not. It's OK for this method to allow
712
653
an exception to raise up.
714
This method is automatically wrapped by Command.__init__ with a
715
cleanup operation, stored as self._operation. This can be used
716
via self.add_cleanup to perform automatic cleanups at the end of
719
The argument for run are assembled by introspection. So for instance,
720
if your command takes an argument files, you would declare::
722
def run(self, files=None):
725
655
raise NotImplementedError('no implementation of command %r'
768
686
These are all empty initially, because by default nothing should get
771
Hooks.__init__(self, "bzrlib.commands", "Command.hooks")
772
self.add_hook('extend_command',
690
self.create_hook(HookPoint('extend_command',
773
691
"Called after creating a command object to allow modifications "
774
692
"such as adding or removing options, docs etc. Called with the "
775
"new bzrlib.commands.Command object.", (1, 13))
776
self.add_hook('get_command',
693
"new bzrlib.commands.Command object.", (1, 13), None))
694
self.create_hook(HookPoint('get_command',
777
695
"Called when creating a single command. Called with "
778
696
"(cmd_or_None, command_name). get_command should either return "
779
697
"the cmd_or_None parameter, or a replacement Command object that "
780
698
"should be used for the command. Note that the Command.hooks "
781
699
"hooks are core infrastructure. Many users will prefer to use "
782
700
"bzrlib.commands.register_command or plugin_cmds.register_lazy.",
784
self.add_hook('get_missing_command',
702
self.create_hook(HookPoint('get_missing_command',
785
703
"Called when creating a single command if no command could be "
786
704
"found. Called with (command_name). get_missing_command should "
787
705
"either return None, or a Command object to be used for the "
789
self.add_hook('list_commands',
706
"command.", (1, 17), None))
707
self.create_hook(HookPoint('list_commands',
790
708
"Called when enumerating commands. Called with a set of "
791
709
"cmd_name strings for all the commands found so far. This set "
792
710
" is safe to mutate - e.g. to remove a command. "
793
711
"list_commands should return the updated set of command names.",
795
self.add_hook('pre_command',
796
"Called prior to executing a command. Called with the command "
798
self.add_hook('post_command',
799
"Called after executing a command. Called with the command "
802
714
Command.hooks = CommandHooks()
820
# for python 2.5 and later, optparse raises this exception if a non-ascii
821
# option name is given. See http://bugs.python.org/issue2931
823
options, args = parser.parse_args(args)
824
except UnicodeEncodeError,e:
825
raise errors.BzrCommandError(
826
gettext('Only ASCII permitted in option names'))
732
options, args = parser.parse_args(args)
828
733
opts = dict([(k, v) for k, v in options.__dict__.iteritems() if
829
734
v is not option.OptionParser.DEFAULT_VALUE])
830
735
return args, opts
847
752
argdict[argname + '_list'] = None
848
753
elif ap[-1] == '+':
850
raise errors.BzrCommandError(gettext(
851
"command {0!r} needs one or more {1}").format(
852
cmd, argname.upper()))
755
raise errors.BzrCommandError("command %r needs one or more %s"
756
% (cmd, argname.upper()))
854
758
argdict[argname + '_list'] = args[:]
856
760
elif ap[-1] == '$': # all but one
857
761
if len(args) < 2:
858
raise errors.BzrCommandError(
859
gettext("command {0!r} needs one or more {1}").format(
860
cmd, argname.upper()))
762
raise errors.BzrCommandError("command %r needs one or more %s"
763
% (cmd, argname.upper()))
861
764
argdict[argname + '_list'] = args[:-1]
864
767
# just a plain arg
867
raise errors.BzrCommandError(
868
gettext("command {0!r} requires argument {1}").format(
869
cmd, argname.upper()))
770
raise errors.BzrCommandError("command %r requires argument %s"
771
% (cmd, argname.upper()))
871
773
argdict[argname] = args.pop(0)
874
raise errors.BzrCommandError( gettext(
875
"extra argument to command {0}: {1}").format(
776
raise errors.BzrCommandError("extra argument to command %s: %s"
935
836
exitcode = trace.report_exception(exc_info, sys.stderr)
936
837
if os.environ.get('BZR_PDB'):
937
838
print '**** entering debugger'
939
pdb.post_mortem(exc_info[2])
841
if sys.version_info[:2] < (2, 6):
843
# pdb.post_mortem(tb)
844
# but because pdb.post_mortem gives bad results for tracebacks
845
# from inside generators, we do it manually.
846
# (http://bugs.python.org/issue4150, fixed in Python 2.6)
848
# Setup pdb on the traceback
851
p.setup(tb.tb_frame, tb)
852
# Point the debugger at the deepest frame of the stack
853
p.curindex = len(p.stack) - 1
854
p.curframe = p.stack[p.curindex][0]
855
# Start the pdb prompt.
856
p.print_stack_entry(p.stack[p.curindex])
943
864
def apply_lsprofiled(filename, the_callable, *args, **kwargs):
944
865
from bzrlib.lsprof import profile
945
ret, stats = profile(exception_to_return_code, the_callable,
866
ret, stats = profile(exception_to_return_code, the_callable, *args, **kwargs)
948
868
if filename is None:
951
871
stats.save(filename)
952
trace.note(gettext('Profile data written to "%s".'), filename)
872
trace.note('Profile data written to "%s".', filename)
876
def shlex_split_unicode(unsplit):
878
return [u.decode('utf-8') for u in shlex.split(unsplit.encode('utf-8'))]
956
881
def get_alias(cmd, config=None):
957
882
"""Return an expanded alias, or None if no alias exists.
968
893
config = bzrlib.config.GlobalConfig()
969
894
alias = config.get_alias(cmd)
971
return cmdline.split(alias)
896
return shlex_split_unicode(alias)
975
def run_bzr(argv, load_plugins=load_plugins, disable_plugins=disable_plugins):
976
901
"""Execute a command.
978
:param argv: The command-line arguments, without the program name from
979
argv[0] These should already be decoded. All library/test code calling
980
run_bzr should be passing valid strings (don't need decoding).
981
:param load_plugins: What function to call when triggering plugin loading.
982
This function should take no arguments and cause all plugins to be
984
:param disable_plugins: What function to call when disabling plugin
985
loading. This function should take no arguments and cause all plugin
986
loading to be prohibited (so that code paths in your application that
987
know about some plugins possibly being present will fail to import
988
those plugins even if they are installed.)
989
:return: Returns a command exit code or raises an exception.
904
The command-line arguments, without the program name from argv[0]
905
These should already be decoded. All library/test code calling
906
run_bzr should be passing valid strings (don't need decoding).
908
Returns a command status or raises an exception.
991
910
Special master options: these must come before the command because
992
911
they control how the command is interpreted.
1052
968
elif a == '--coverage':
1053
969
opt_coverage_dir = argv[i + 1]
1055
elif a == '--profile-imports':
1056
pass # already handled in startup script Bug #588277
1057
971
elif a.startswith('-D'):
1058
972
debug.debug_flags.add(a[2:])
1059
elif a.startswith('-O'):
1060
override_config.append(a[2:])
1062
974
argv_copy.append(a)
1065
if bzrlib.global_state is None:
1066
# FIXME: Workaround for users that imported bzrlib but didn't call
1067
# bzrlib.initialize -- vila 2012-01-19
1068
cmdline_overrides = config.CommandLineStore()
1070
cmdline_overrides = bzrlib.global_state.cmdline_overrides
1071
cmdline_overrides._from_cmdline(override_config)
1073
977
debug.set_debug_flags_from_config()
981
from bzrlib.builtins import cmd_help
982
cmd_help().run_argv_aliases([])
985
if argv[0] == '--version':
986
from bzrlib.builtins import cmd_version
987
cmd_version().run_argv_aliases([])
1075
990
if not opt_no_plugins:
991
from bzrlib.plugin import load_plugins
994
from bzrlib.plugin import disable_plugins
1078
995
disable_plugins()
1082
get_cmd_object('help').run_argv_aliases([])
1085
if argv[0] == '--version':
1086
get_cmd_object('version').run_argv_aliases([])
1089
997
alias_argv = None
1091
999
if not opt_no_aliases:
1092
1000
alias_argv = get_alias(argv[0])
1002
user_encoding = osutils.get_user_encoding()
1003
alias_argv = [a.decode(user_encoding) for a in alias_argv]
1094
1004
argv[0] = alias_argv.pop(0)
1096
1006
cmd = argv.pop(0)
1007
# We want only 'ascii' command names, but the user may have typed
1008
# in a Unicode name. In that case, they should just get a
1009
# 'command not found' error later.
1097
1011
cmd_obj = get_cmd_object(cmd, plugins_override=not opt_builtin)
1100
1012
run = cmd_obj.run_argv_aliases
1101
1013
run_argv = [argv, alias_argv]
1264
1173
class Provider(object):
1265
"""Generic class to be overriden by plugins"""
1174
'''Generic class to be overriden by plugins'''
1267
1176
def plugin_for_command(self, cmd_name):
1268
"""Takes a command and returns the information for that plugin
1177
'''Takes a command and returns the information for that plugin
1270
1179
:return: A dictionary with all the available information
1271
for the requested plugin
1180
for the requested plugin
1273
1182
raise NotImplementedError
1276
1185
class ProvidersRegistry(registry.Registry):
1277
"""This registry exists to allow other providers to exist"""
1186
'''This registry exists to allow other providers to exist'''
1279
1188
def __iter__(self):
1280
1189
for key, provider in self.iteritems():
added
removed
bzrlib/commands.py
