46
from bzrlib.hooks import Hooks
49
from bzrlib.hooks import HookPoint, Hooks
47
50
# Compatibility - Option used to be in commands.
48
51
from bzrlib.option import Option
49
52
from bzrlib.plugin import disable_plugins, load_plugins
412
408
def __init__(self):
413
409
"""Construct an instance of this command."""
410
if self.__doc__ == Command.__doc__:
411
warn("No help message set for %r" % self)
414
412
# List of standard options directly supported
415
413
self.supported_std_options = []
416
414
self._setup_run()
484
482
message explaining how to obtain full help.
486
484
doc = self.help()
488
doc = "No help for this command."
486
raise NotImplementedError("sorry, no detailed help yet for %r" % self.name())
490
488
# Extract the summary (purpose) and sections out from the text
491
489
purpose,sections,order = self._get_help_parts(doc)
685
683
self._setup_outf()
688
return self.run(**all_cmd_args)
690
# reset it, so that other commands run in the same process won't
691
# inherit state. Before we reset it, log any activity, so that it
692
# gets properly tracked.
693
ui.ui_factory.log_transport_activity(
694
display=('bytes' in debug.debug_flags))
695
trace.set_verbosity_level(0)
685
return self.run(**all_cmd_args)
697
687
def _setup_run(self):
698
688
"""Wrap the defined run method on self with a cleanup.
772
762
These are all empty initially, because by default nothing should get
775
Hooks.__init__(self, "bzrlib.commands", "Command.hooks")
776
self.add_hook('extend_command',
766
self.create_hook(HookPoint('extend_command',
777
767
"Called after creating a command object to allow modifications "
778
768
"such as adding or removing options, docs etc. Called with the "
779
"new bzrlib.commands.Command object.", (1, 13))
780
self.add_hook('get_command',
769
"new bzrlib.commands.Command object.", (1, 13), None))
770
self.create_hook(HookPoint('get_command',
781
771
"Called when creating a single command. Called with "
782
772
"(cmd_or_None, command_name). get_command should either return "
783
773
"the cmd_or_None parameter, or a replacement Command object that "
784
774
"should be used for the command. Note that the Command.hooks "
785
775
"hooks are core infrastructure. Many users will prefer to use "
786
776
"bzrlib.commands.register_command or plugin_cmds.register_lazy.",
788
self.add_hook('get_missing_command',
778
self.create_hook(HookPoint('get_missing_command',
789
779
"Called when creating a single command if no command could be "
790
780
"found. Called with (command_name). get_missing_command should "
791
781
"either return None, or a Command object to be used for the "
793
self.add_hook('list_commands',
782
"command.", (1, 17), None))
783
self.create_hook(HookPoint('list_commands',
794
784
"Called when enumerating commands. Called with a set of "
795
785
"cmd_name strings for all the commands found so far. This set "
796
786
" is safe to mutate - e.g. to remove a command. "
797
787
"list_commands should return the updated set of command names.",
800
790
Command.hooks = CommandHooks()
818
# for python 2.5 and later, optparse raises this exception if a non-ascii
819
# option name is given. See http://bugs.python.org/issue2931
821
options, args = parser.parse_args(args)
822
except UnicodeEncodeError,e:
823
raise errors.BzrCommandError('Only ASCII permitted in option names')
808
options, args = parser.parse_args(args)
825
809
opts = dict([(k, v) for k, v in options.__dict__.iteritems() if
826
810
v is not option.OptionParser.DEFAULT_VALUE])
827
811
return args, opts
1095
1077
if not opt_no_aliases:
1096
1078
alias_argv = get_alias(argv[0])
1080
user_encoding = osutils.get_user_encoding()
1081
alias_argv = [a.decode(user_encoding) for a in alias_argv]
1098
1082
argv[0] = alias_argv.pop(0)
1100
1084
cmd = argv.pop(0)
1085
# We want only 'ascii' command names, but the user may have typed
1086
# in a Unicode name. In that case, they should just get a
1087
# 'command not found' error later.
1101
1089
cmd_obj = get_cmd_object(cmd, plugins_override=not opt_builtin)
1102
1090
run = cmd_obj.run_argv_aliases
1103
1091
run_argv = [argv, alias_argv]
1202
1190
argv = _specified_or_unicode_argv(argv)
1203
1191
_register_builtin_commands()
1204
1192
ret = run_bzr_catch_errors(argv)
1193
bzrlib.ui.ui_factory.log_transport_activity(
1194
display=('bytes' in debug.debug_flags))
1205
1195
trace.mutter("return code %d", ret)