5609.16.1
by John Arbash Meinel
Fix bug #713258. Restore logging of bytes transferred. |
1 |
# Copyright (C) 2005-2011 Canonical Ltd
|
1610.1.4
by Martin Pool
Doc |
2 |
#
|
1
by mbp at sourcefrog
import from baz patch-364 |
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.
|
|
1610.1.4
by Martin Pool
Doc |
7 |
#
|
1
by mbp at sourcefrog
import from baz patch-364 |
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.
|
|
1610.1.4
by Martin Pool
Doc |
12 |
#
|
1
by mbp at sourcefrog
import from baz patch-364 |
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
|
|
4183.7.1
by Sabin Iacob
update FSF mailing address |
15 |
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
|
1
by mbp at sourcefrog
import from baz patch-364 |
16 |
|
6379.6.1
by Jelmer Vernooij
Import absolute_import in a few places. |
17 |
from __future__ import absolute_import |
1
by mbp at sourcefrog
import from baz patch-364 |
18 |
|
1095
by Martin Pool
todo |
19 |
# TODO: Define arguments by objects, rather than just using names.
|
20 |
# Those objects can specify the expected type of the argument, which
|
|
1610.1.4
by Martin Pool
Doc |
21 |
# would help with validation and shell completion. They could also provide
|
22 |
# help/explanation for that argument in a structured way.
|
|
23 |
||
24 |
# TODO: Specific "examples" property on commands for consistent formatting.
|
|
1095
by Martin Pool
todo |
25 |
|
1996.3.1
by John Arbash Meinel
Demandloading builtins.py drops our load time from 350ms to 291ms |
26 |
import os |
27 |
import sys |
|
28 |
||
29 |
from bzrlib.lazy_import import lazy_import |
|
30 |
lazy_import(globals(), """ |
|
1857.1.1
by Aaron Bentley
Use optparse for parsing options |
31 |
import errno
|
4325.1.1
by Vincent Ladeuil
Make --coverage works for threads too. |
32 |
import threading
|
1
by mbp at sourcefrog
import from baz patch-364 |
33 |
|
34 |
import bzrlib
|
|
1996.3.1
by John Arbash Meinel
Demandloading builtins.py drops our load time from 350ms to 291ms |
35 |
from bzrlib import (
|
6437.6.3
by Vincent Ladeuil
Add the missing config import. |
36 |
config,
|
4900.1.1
by Andrew Bennetts
Add add_cleanup to Command. |
37 |
cleanup,
|
4913.5.24
by Gordon Tyler
Added cmdline.split function, which replaces commands.shlex_split_unicode. |
38 |
cmdline,
|
2095.5.2
by Martin Pool
save commit message if commit fails (#32054) |
39 |
debug,
|
1996.3.1
by John Arbash Meinel
Demandloading builtins.py drops our load time from 350ms to 291ms |
40 |
errors,
|
5875.3.25
by Vincent Ladeuil
Fix test failures and make sure we don't rely on a default translation. |
41 |
i18n,
|
1996.3.1
by John Arbash Meinel
Demandloading builtins.py drops our load time from 350ms to 291ms |
42 |
option,
|
43 |
osutils,
|
|
44 |
trace,
|
|
4792.8.9
by Martin Pool
Send Command.outf through UIFactory |
45 |
ui,
|
1996.3.1
by John Arbash Meinel
Demandloading builtins.py drops our load time from 350ms to 291ms |
46 |
)
|
47 |
""") |
|
48 |
||
5622.3.2
by Jelmer Vernooij
Add more lazily usable hook points. |
49 |
from bzrlib.hooks import Hooks |
5875.3.25
by Vincent Ladeuil
Fix test failures and make sure we don't rely on a default translation. |
50 |
from bzrlib.i18n import gettext |
4119.3.8
by Robert Collins
Get missing command support sorted out. |
51 |
# Compatibility - Option used to be in commands.
|
1581.1.1
by Robert Collins
Bugfix aliases to be backwards compatible with plugins providing command.run_argv. |
52 |
from bzrlib.option import Option |
5051.1.1
by Robert Collins
* ``bzrlib.comands.run_bzr`` is more extensible: callers can supply the |
53 |
from bzrlib.plugin import disable_plugins, load_plugins |
4119.3.8
by Robert Collins
Get missing command support sorted out. |
54 |
from bzrlib import registry |
1996.3.1
by John Arbash Meinel
Demandloading builtins.py drops our load time from 350ms to 291ms |
55 |
|
1
by mbp at sourcefrog
import from baz patch-364 |
56 |
|
3785.1.2
by Aaron Bentley
Avoid getting plugins unnecessarily |
57 |
class CommandInfo(object): |
58 |
"""Information about a command."""
|
|
59 |
||
60 |
def __init__(self, aliases): |
|
61 |
"""The list of aliases for the command."""
|
|
62 |
self.aliases = aliases |
|
63 |
||
64 |
@classmethod
|
|
65 |
def from_command(klass, command): |
|
66 |
"""Factory to construct a CommandInfo from a command."""
|
|
67 |
return klass(command.aliases) |
|
68 |
||
69 |
||
3785.1.1
by Aaron Bentley
Switch from dict to Registry for plugin_cmds |
70 |
class CommandRegistry(registry.Registry): |
5018.1.9
by Martin Pool
Handle aliases directly in CommandRegistry |
71 |
"""Special registry mapping command names to command classes.
|
72 |
|
|
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.
|
|
5018.1.6
by Martin Pool
Avoid more cases of using a dict of all builtins |
76 |
"""
|
77 |
||
5018.1.9
by Martin Pool
Handle aliases directly in CommandRegistry |
78 |
def __init__(self): |
79 |
registry.Registry.__init__(self) |
|
80 |
self.overridden_registry = None |
|
81 |
# map from aliases to the real command that implements the name
|
|
82 |
self._alias_dict = {} |
|
83 |
||
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) |
|
87 |
||
3785.1.4
by Aaron Bentley
Enable lazy-loading of commands |
88 |
@staticmethod
|
89 |
def _get_name(command_name): |
|
90 |
if command_name.startswith("cmd_"): |
|
91 |
return _unsquish_command_name(command_name) |
|
92 |
else: |
|
93 |
return command_name |
|
94 |
||
3785.1.1
by Aaron Bentley
Switch from dict to Registry for plugin_cmds |
95 |
def register(self, cmd, decorate=False): |
96 |
"""Utility function to help register a command
|
|
97 |
||
98 |
:param cmd: Command subclass to register
|
|
99 |
:param decorate: If true, allow overriding an existing command
|
|
100 |
of the same name; the old command is returned by this function.
|
|
101 |
Otherwise it is an error to try to override an existing command.
|
|
102 |
"""
|
|
103 |
k = cmd.__name__ |
|
3785.1.4
by Aaron Bentley
Enable lazy-loading of commands |
104 |
k_unsquished = self._get_name(k) |
3785.1.1
by Aaron Bentley
Switch from dict to Registry for plugin_cmds |
105 |
try: |
106 |
previous = self.get(k_unsquished) |
|
107 |
except KeyError: |
|
5018.1.6
by Martin Pool
Avoid more cases of using a dict of all builtins |
108 |
previous = None |
109 |
if self.overridden_registry: |
|
110 |
try: |
|
111 |
previous = self.overridden_registry.get(k_unsquished) |
|
112 |
except KeyError: |
|
113 |
pass
|
|
3785.1.2
by Aaron Bentley
Avoid getting plugins unnecessarily |
114 |
info = CommandInfo.from_command(cmd) |
3785.1.1
by Aaron Bentley
Switch from dict to Registry for plugin_cmds |
115 |
try: |
116 |
registry.Registry.register(self, k_unsquished, cmd, |
|
3785.1.2
by Aaron Bentley
Avoid getting plugins unnecessarily |
117 |
override_existing=decorate, info=info) |
3785.1.1
by Aaron Bentley
Switch from dict to Registry for plugin_cmds |
118 |
except KeyError: |
4695.5.2
by Martin Pool
Remove trace.log_error |
119 |
trace.warning('Two plugins defined the same command: %r' % k) |
120 |
trace.warning('Not loading the one in %r' % |
|
121 |
sys.modules[cmd.__module__]) |
|
122 |
trace.warning('Previously this command was registered from %r' % |
|
123 |
sys.modules[previous.__module__]) |
|
5018.1.9
by Martin Pool
Handle aliases directly in CommandRegistry |
124 |
for a in cmd.aliases: |
125 |
self._alias_dict[a] = k_unsquished |
|
3785.1.1
by Aaron Bentley
Switch from dict to Registry for plugin_cmds |
126 |
return previous |
127 |
||
3785.1.4
by Aaron Bentley
Enable lazy-loading of commands |
128 |
def register_lazy(self, command_name, aliases, module_name): |
129 |
"""Register a command without loading its module.
|
|
130 |
||
131 |
:param command_name: The primary name of the command.
|
|
132 |
:param aliases: A list of aliases for the command.
|
|
133 |
:module_name: The module that the command lives in.
|
|
134 |
"""
|
|
135 |
key = self._get_name(command_name) |
|
136 |
registry.Registry.register_lazy(self, key, module_name, command_name, |
|
137 |
info=CommandInfo(aliases)) |
|
5018.1.9
by Martin Pool
Handle aliases directly in CommandRegistry |
138 |
for a in aliases: |
139 |
self._alias_dict[a] = key |
|
3785.1.4
by Aaron Bentley
Enable lazy-loading of commands |
140 |
|
3785.1.1
by Aaron Bentley
Switch from dict to Registry for plugin_cmds |
141 |
|
142 |
plugin_cmds = CommandRegistry() |
|
5018.1.5
by Martin Pool
Rename registry to builtin_command_registry |
143 |
builtin_command_registry = CommandRegistry() |
5018.1.6
by Martin Pool
Avoid more cases of using a dict of all builtins |
144 |
plugin_cmds.overridden_registry = builtin_command_registry |
731
by Martin Pool
- merge plugin patch from john |
145 |
|
146 |
||
1492
by Robert Collins
Support decoration of commands. |
147 |
def register_command(cmd, decorate=False): |
5018.1.7
by Martin Pool
doc |
148 |
"""Register a plugin command.
|
149 |
||
150 |
Should generally be avoided in favor of lazy registration.
|
|
151 |
"""
|
|
731
by Martin Pool
- merge plugin patch from john |
152 |
global plugin_cmds |
3785.1.1
by Aaron Bentley
Switch from dict to Registry for plugin_cmds |
153 |
return plugin_cmds.register(cmd, decorate) |
731
by Martin Pool
- merge plugin patch from john |
154 |
|
155 |
||
350
by Martin Pool
- refactor command aliases into command classes |
156 |
def _squish_command_name(cmd): |
157 |
return 'cmd_' + cmd.replace('-', '_') |
|
158 |
||
159 |
||
160 |
def _unsquish_command_name(cmd): |
|
161 |
return cmd[4:].replace('_','-') |
|
162 |
||
914
by Martin Pool
- fix up breakage of 'bzr log -v' by root_id patch |
163 |
|
5018.1.3
by Martin Pool
Put builtin commands into a real registry |
164 |
def _register_builtin_commands(): |
5018.1.5
by Martin Pool
Rename registry to builtin_command_registry |
165 |
if builtin_command_registry.keys(): |
5018.1.3
by Martin Pool
Put builtin commands into a real registry |
166 |
# only load once
|
167 |
return
|
|
1147
by Martin Pool
- split builtin commands into separate module bzrlib.builtins; |
168 |
import bzrlib.builtins |
5018.1.3
by Martin Pool
Put builtin commands into a real registry |
169 |
for cmd_class in _scan_module_for_commands(bzrlib.builtins).values(): |
5018.1.5
by Martin Pool
Rename registry to builtin_command_registry |
170 |
builtin_command_registry.register(cmd_class) |
5127.1.1
by Martin Pool
version-info is lazily loaded |
171 |
bzrlib.builtins._register_lazy_builtins() |
4119.3.6
by Robert Collins
Refactor commands.__get_cmd_object to be default-installed hooks. |
172 |
|
173 |
||
174 |
def _scan_module_for_commands(module): |
|
1162
by Martin Pool
- change Command infrastructure to use (mostly stateless) objects to |
175 |
r = {} |
4119.3.6
by Robert Collins
Refactor commands.__get_cmd_object to be default-installed hooks. |
176 |
for name, obj in module.__dict__.iteritems(): |
1147
by Martin Pool
- split builtin commands into separate module bzrlib.builtins; |
177 |
if name.startswith("cmd_"): |
1616.1.6
by Martin Pool
doc |
178 |
real_name = _unsquish_command_name(name) |
4119.3.6
by Robert Collins
Refactor commands.__get_cmd_object to be default-installed hooks. |
179 |
r[real_name] = obj |
1162
by Martin Pool
- change Command infrastructure to use (mostly stateless) objects to |
180 |
return r |
3943.8.1
by Marius Kruger
remove all trailing whitespace from bzr source |
181 |
|
1162
by Martin Pool
- change Command infrastructure to use (mostly stateless) objects to |
182 |
|
4119.3.6
by Robert Collins
Refactor commands.__get_cmd_object to be default-installed hooks. |
183 |
def _list_bzr_commands(names): |
5018.1.7
by Martin Pool
doc |
184 |
"""Find commands from bzr's core and plugins.
|
185 |
|
|
186 |
This is not the public interface, just the default hook called by all_command_names.
|
|
187 |
"""
|
|
4119.3.6
by Robert Collins
Refactor commands.__get_cmd_object to be default-installed hooks. |
188 |
# to eliminate duplicates
|
189 |
names.update(builtin_command_names()) |
|
190 |
names.update(plugin_command_names()) |
|
191 |
return names |
|
192 |
||
193 |
||
4119.3.4
by Robert Collins
Add Command lookup hooks: list_commands and get_command. |
194 |
def all_command_names(): |
4119.3.10
by Robert Collins
More review feedback. |
195 |
"""Return a set of all command names."""
|
4119.3.6
by Robert Collins
Refactor commands.__get_cmd_object to be default-installed hooks. |
196 |
names = set() |
4119.3.4
by Robert Collins
Add Command lookup hooks: list_commands and get_command. |
197 |
for hook in Command.hooks['list_commands']: |
4119.3.10
by Robert Collins
More review feedback. |
198 |
names = hook(names) |
199 |
if names is None: |
|
4119.3.4
by Robert Collins
Add Command lookup hooks: list_commands and get_command. |
200 |
raise AssertionError( |
201 |
'hook %s returned None' % Command.hooks.get_hook_name(hook)) |
|
202 |
return names |
|
203 |
||
204 |
||
1162
by Martin Pool
- change Command infrastructure to use (mostly stateless) objects to |
205 |
def builtin_command_names(): |
4119.3.4
by Robert Collins
Add Command lookup hooks: list_commands and get_command. |
206 |
"""Return list of builtin command names.
|
207 |
|
|
208 |
Use of all_command_names() is encouraged rather than builtin_command_names
|
|
209 |
and/or plugin_command_names.
|
|
210 |
"""
|
|
5255.5.1
by Ian Clatworthy
Ensure builtin_command_names() is initialized correctly |
211 |
_register_builtin_commands() |
5018.1.5
by Martin Pool
Rename registry to builtin_command_registry |
212 |
return builtin_command_registry.keys() |
3943.8.1
by Marius Kruger
remove all trailing whitespace from bzr source |
213 |
|
1162
by Martin Pool
- change Command infrastructure to use (mostly stateless) objects to |
214 |
|
215 |
def plugin_command_names(): |
|
4119.3.4
by Robert Collins
Add Command lookup hooks: list_commands and get_command. |
216 |
"""Returns command names from commands registered by plugins."""
|
1162
by Martin Pool
- change Command infrastructure to use (mostly stateless) objects to |
217 |
return plugin_cmds.keys() |
218 |
||
219 |
||
220 |
def get_cmd_object(cmd_name, plugins_override=True): |
|
4119.3.4
by Robert Collins
Add Command lookup hooks: list_commands and get_command. |
221 |
"""Return the command object for a command.
|
1162
by Martin Pool
- change Command infrastructure to use (mostly stateless) objects to |
222 |
|
223 |
plugins_override
|
|
224 |
If true, plugin commands can override builtins.
|
|
350
by Martin Pool
- refactor command aliases into command classes |
225 |
"""
|
2432.1.13
by Robert Collins
HelpCommandContext now implementes get_topics. |
226 |
try: |
4119.3.4
by Robert Collins
Add Command lookup hooks: list_commands and get_command. |
227 |
return _get_cmd_object(cmd_name, plugins_override) |
2432.1.13
by Robert Collins
HelpCommandContext now implementes get_topics. |
228 |
except KeyError: |
6138.3.7
by Jonathan Riddell
add gettext() to BzrCommandError uses |
229 |
raise errors.BzrCommandError(gettext('unknown command "%s"') % cmd_name) |
2432.1.13
by Robert Collins
HelpCommandContext now implementes get_topics. |
230 |
|
231 |
||
5058.2.1
by Robert Collins
* ``bzr help`` will no longer trigger the get_missing_command hook when |
232 |
def _get_cmd_object(cmd_name, plugins_override=True, check_missing=True): |
4119.3.4
by Robert Collins
Add Command lookup hooks: list_commands and get_command. |
233 |
"""Get a command object.
|
234 |
||
235 |
:param cmd_name: The name of the command.
|
|
236 |
:param plugins_override: Allow plugins to override builtins.
|
|
5058.2.1
by Robert Collins
* ``bzr help`` will no longer trigger the get_missing_command hook when |
237 |
:param check_missing: Look up commands not found in the regular index via
|
238 |
the get_missing_command hook.
|
|
4119.3.4
by Robert Collins
Add Command lookup hooks: list_commands and get_command. |
239 |
:return: A Command object instance
|
4119.3.10
by Robert Collins
More review feedback. |
240 |
:raises KeyError: If no command is found.
|
4119.3.4
by Robert Collins
Add Command lookup hooks: list_commands and get_command. |
241 |
"""
|
4119.3.6
by Robert Collins
Refactor commands.__get_cmd_object to be default-installed hooks. |
242 |
# We want only 'ascii' command names, but the user may have typed
|
243 |
# in a Unicode name. In that case, they should just get a
|
|
244 |
# 'command not found' error later.
|
|
245 |
# In the future, we may actually support Unicode command names.
|
|
246 |
cmd = None |
|
247 |
# Get a command
|
|
4119.3.4
by Robert Collins
Add Command lookup hooks: list_commands and get_command. |
248 |
for hook in Command.hooks['get_command']: |
249 |
cmd = hook(cmd, cmd_name) |
|
4119.3.10
by Robert Collins
More review feedback. |
250 |
if cmd is not None and not plugins_override and not cmd.plugin_name(): |
4119.3.6
by Robert Collins
Refactor commands.__get_cmd_object to be default-installed hooks. |
251 |
# We've found a non-plugin command, don't permit it to be
|
252 |
# overridden.
|
|
4119.3.10
by Robert Collins
More review feedback. |
253 |
break
|
5058.2.1
by Robert Collins
* ``bzr help`` will no longer trigger the get_missing_command hook when |
254 |
if cmd is None and check_missing: |
4119.3.8
by Robert Collins
Get missing command support sorted out. |
255 |
for hook in Command.hooks['get_missing_command']: |
256 |
cmd = hook(cmd_name) |
|
257 |
if cmd is not None: |
|
258 |
break
|
|
259 |
if cmd is None: |
|
4119.3.4
by Robert Collins
Add Command lookup hooks: list_commands and get_command. |
260 |
# No command found.
|
261 |
raise KeyError |
|
262 |
# Allow plugins to extend commands
|
|
6240.5.7
by Jelmer Vernooij
Drop exception suppression support. |
263 |
for hook in Command.hooks['extend_command']: |
264 |
hook(cmd) |
|
5741.3.1
by Martin Pool
Add Command.invoked_as |
265 |
if getattr(cmd, 'invoked_as', None) is None: |
266 |
cmd.invoked_as = cmd_name |
|
4119.3.4
by Robert Collins
Add Command lookup hooks: list_commands and get_command. |
267 |
return cmd |
268 |
||
269 |
||
4119.3.8
by Robert Collins
Get missing command support sorted out. |
270 |
def _try_plugin_provider(cmd_name): |
271 |
"""Probe for a plugin provider having cmd_name."""
|
|
272 |
try: |
|
273 |
plugin_metadata, provider = probe_for_provider(cmd_name) |
|
274 |
raise errors.CommandAvailableInPlugin(cmd_name, |
|
275 |
plugin_metadata, provider) |
|
276 |
except errors.NoPluginAvailable: |
|
277 |
pass
|
|
278 |
||
279 |
||
4119.3.4
by Robert Collins
Add Command lookup hooks: list_commands and get_command. |
280 |
def probe_for_provider(cmd_name): |
281 |
"""Look for a provider for cmd_name.
|
|
282 |
||
283 |
:param cmd_name: The command name.
|
|
284 |
:return: plugin_metadata, provider for getting cmd_name.
|
|
285 |
:raises NoPluginAvailable: When no provider can supply the plugin.
|
|
286 |
"""
|
|
287 |
# look for providers that provide this command but aren't installed
|
|
288 |
for provider in command_providers_registry: |
|
289 |
try: |
|
290 |
return provider.plugin_for_command(cmd_name), provider |
|
291 |
except errors.NoPluginAvailable: |
|
292 |
pass
|
|
293 |
raise errors.NoPluginAvailable(cmd_name) |
|
294 |
||
295 |
||
4119.3.6
by Robert Collins
Refactor commands.__get_cmd_object to be default-installed hooks. |
296 |
def _get_bzr_command(cmd_or_None, cmd_name): |
297 |
"""Get a command from bzr's core."""
|
|
272
by Martin Pool
- Add command aliases |
298 |
try: |
5018.1.6
by Martin Pool
Avoid more cases of using a dict of all builtins |
299 |
cmd_class = builtin_command_registry.get(cmd_name) |
272
by Martin Pool
- Add command aliases |
300 |
except KeyError: |
350
by Martin Pool
- refactor command aliases into command classes |
301 |
pass
|
5018.1.6
by Martin Pool
Avoid more cases of using a dict of all builtins |
302 |
else: |
303 |
return cmd_class() |
|
4119.3.6
by Robert Collins
Refactor commands.__get_cmd_object to be default-installed hooks. |
304 |
return cmd_or_None |
305 |
||
306 |
||
307 |
def _get_external_command(cmd_or_None, cmd_name): |
|
308 |
"""Lookup a command that is a shell script."""
|
|
309 |
# Only do external command lookups when no command is found so far.
|
|
310 |
if cmd_or_None is not None: |
|
311 |
return cmd_or_None |
|
312 |
from bzrlib.externalcommand import ExternalCommand |
|
1162
by Martin Pool
- change Command infrastructure to use (mostly stateless) objects to |
313 |
cmd_obj = ExternalCommand.find_command(cmd_name) |
314 |
if cmd_obj: |
|
315 |
return cmd_obj |
|
4119.3.6
by Robert Collins
Refactor commands.__get_cmd_object to be default-installed hooks. |
316 |
|
317 |
||
318 |
def _get_plugin_command(cmd_or_None, cmd_name): |
|
319 |
"""Get a command from bzr's plugins."""
|
|
320 |
try: |
|
321 |
return plugin_cmds.get(cmd_name)() |
|
322 |
except KeyError: |
|
323 |
pass
|
|
324 |
for key in plugin_cmds.keys(): |
|
325 |
info = plugin_cmds.get_info(key) |
|
326 |
if cmd_name in info.aliases: |
|
327 |
return plugin_cmds.get(key)() |
|
328 |
return cmd_or_None |
|
272
by Martin Pool
- Add command aliases |
329 |
|
329
by Martin Pool
- refactor command functions into command classes |
330 |
|
558
by Martin Pool
- All top-level classes inherit from object |
331 |
class Command(object): |
329
by Martin Pool
- refactor command functions into command classes |
332 |
"""Base class for commands.
|
333 |
||
1162
by Martin Pool
- change Command infrastructure to use (mostly stateless) objects to |
334 |
Commands are the heart of the command-line bzr interface.
|
335 |
||
336 |
The command object mostly handles the mapping of command-line
|
|
337 |
parameters into one or more bzrlib operations, and of the results
|
|
338 |
into textual output.
|
|
339 |
||
340 |
Commands normally don't have any state. All their arguments are
|
|
341 |
passed in to the run method. (Subclasses may take a different
|
|
342 |
policy if the behaviour of the instance needs to depend on e.g. a
|
|
343 |
shell plugin and not just its Python class.)
|
|
344 |
||
329
by Martin Pool
- refactor command functions into command classes |
345 |
The docstring for an actual command should give a single-line
|
346 |
summary, then a complete description of the command. A grammar
|
|
347 |
description will be inserted.
|
|
348 |
||
5891.1.3
by Andrew Bennetts
Move docstring formatting fixes. |
349 |
:cvar aliases: Other accepted names for this command.
|
350 |
||
351 |
:cvar takes_args: List of argument forms, marked with whether they are
|
|
352 |
optional, repeated, etc. Examples::
|
|
353 |
||
354 |
['to_location', 'from_branch?', 'file*']
|
|
355 |
||
356 |
* 'to_location' is required
|
|
357 |
* 'from_branch' is optional
|
|
358 |
* 'file' can be specified 0 or more times
|
|
359 |
||
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().
|
|
363 |
||
364 |
:cvar hidden: If true, this command isn't advertised. This is typically
|
|
1162
by Martin Pool
- change Command infrastructure to use (mostly stateless) objects to |
365 |
for commands intended for expert users.
|
1185.85.22
by John Arbash Meinel
Updated cmd_inventory. Changing from having each Command request an encoded stdout to providing one before calling run() |
366 |
|
5891.1.3
by Andrew Bennetts
Move docstring formatting fixes. |
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
|
|
370 |
encoded:
|
|
371 |
||
372 |
* strict - abort if we cannot decode
|
|
373 |
* replace - put in a bogus character (typically '?')
|
|
374 |
* exact - do not encode sys.stdout
|
|
375 |
||
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.
|
|
380 |
||
381 |
:cvar invoked_as:
|
|
5741.3.1
by Martin Pool
Add Command.invoked_as |
382 |
A string indicating the real name under which this command was
|
5891.1.3
by Andrew Bennetts
Move docstring formatting fixes. |
383 |
invoked, before expansion of aliases.
|
5741.3.1
by Martin Pool
Add Command.invoked_as |
384 |
(This may be None if the command was constructed and run in-process.)
|
385 |
||
4000.1.1
by Robert Collins
Add a new hook Commands['extend_command'] for plugins that want to alter commands without overriding the entire command. |
386 |
:cvar hooks: An instance of CommandHooks.
|
5741.3.1
by Martin Pool
Add Command.invoked_as |
387 |
|
5891.1.3
by Andrew Bennetts
Move docstring formatting fixes. |
388 |
:cvar __doc__: The help shown by 'bzr help command' for this command.
|
5264.1.2
by Robert Collins
Final fix for 'no help for command' issue. We now show a clean message |
389 |
This is set by assigning explicitly to __doc__ so that -OO can
|
390 |
be used::
|
|
391 |
||
5891.1.3
by Andrew Bennetts
Move docstring formatting fixes. |
392 |
class Foo(Command):
|
393 |
__doc__ = "My help goes here"
|
|
329
by Martin Pool
- refactor command functions into command classes |
394 |
"""
|
395 |
aliases = [] |
|
396 |
takes_args = [] |
|
397 |
takes_options = [] |
|
1185.85.22
by John Arbash Meinel
Updated cmd_inventory. Changing from having each Command request an encoded stdout to providing one before calling run() |
398 |
encoding_type = 'strict' |
5741.3.1
by Martin Pool
Add Command.invoked_as |
399 |
invoked_as = None |
5875.4.6
by INADA Naoki
Call i18n.install in get_help_text. |
400 |
l10n = True |
329
by Martin Pool
- refactor command functions into command classes |
401 |
|
402 |
hidden = False |
|
3943.8.1
by Marius Kruger
remove all trailing whitespace from bzr source |
403 |
|
1162
by Martin Pool
- change Command infrastructure to use (mostly stateless) objects to |
404 |
def __init__(self): |
405 |
"""Construct an instance of this command."""
|
|
2768.1.4
by Ian Clatworthy
Process --verbose and --quiet standard options |
406 |
# List of standard options directly supported
|
407 |
self.supported_std_options = [] |
|
5141.2.1
by Robert Collins
``bzrlib.commands.Command.run_direct`` is no longer needed - the pre |
408 |
self._setup_run() |
5050.1.3
by Vincent Ladeuil
Delete spurious spaces. |
409 |
|
4900.1.1
by Andrew Bennetts
Add add_cleanup to Command. |
410 |
def add_cleanup(self, cleanup_func, *args, **kwargs): |
4900.1.3
by Andrew Bennetts
Replace lots of try/finally blocks in builtins.py with add_cleanup. Reduces line count by 80, and removes lots of indentation levels too. |
411 |
"""Register a function to call after self.run returns or raises.
|
412 |
||
413 |
Functions will be called in LIFO order.
|
|
414 |
"""
|
|
4900.1.1
by Andrew Bennetts
Add add_cleanup to Command. |
415 |
self._operation.add_cleanup(cleanup_func, *args, **kwargs) |
4900.1.3
by Andrew Bennetts
Replace lots of try/finally blocks in builtins.py with add_cleanup. Reduces line count by 80, and removes lots of indentation levels too. |
416 |
|
417 |
def cleanup_now(self): |
|
418 |
"""Execute and empty pending cleanup functions immediately.
|
|
419 |
||
420 |
After cleanup_now all registered cleanups are forgotten. add_cleanup
|
|
421 |
may be called again after cleanup_now; these cleanups will be called
|
|
422 |
after self.run returns or raises (or when cleanup_now is next called).
|
|
423 |
||
424 |
This is useful for releasing expensive or contentious resources (such
|
|
425 |
as write locks) before doing further work that does not require those
|
|
5141.2.1
by Robert Collins
``bzrlib.commands.Command.run_direct`` is no longer needed - the pre |
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.
|
|
4900.1.3
by Andrew Bennetts
Replace lots of try/finally blocks in builtins.py with add_cleanup. Reduces line count by 80, and removes lots of indentation levels too. |
429 |
"""
|
430 |
self._operation.cleanup_now() |
|
5050.1.3
by Vincent Ladeuil
Delete spurious spaces. |
431 |
|
2432.1.12
by Robert Collins
Relocate command help onto Command. |
432 |
def _usage(self): |
433 |
"""Return single-line grammar for this command.
|
|
434 |
||
435 |
Only describes arguments, not options.
|
|
436 |
"""
|
|
437 |
s = 'bzr ' + self.name() + ' ' |
|
438 |
for aname in self.takes_args: |
|
439 |
aname = aname.upper() |
|
440 |
if aname[-1] in ['$', '+']: |
|
441 |
aname = aname[:-1] + '...' |
|
442 |
elif aname[-1] == '?': |
|
443 |
aname = '[' + aname[:-1] + ']' |
|
444 |
elif aname[-1] == '*': |
|
445 |
aname = '[' + aname[:-1] + '...]' |
|
446 |
s += aname + ' ' |
|
3376.2.4
by Martin Pool
Remove every assert statement from bzrlib! |
447 |
s = s[:-1] # remove last space |
2432.1.12
by Robert Collins
Relocate command help onto Command. |
448 |
return s |
449 |
||
2677.1.2
by Alexander Belchenko
bzr_man: see also topics as cross-reference links |
450 |
def get_help_text(self, additional_see_also=None, plain=True, |
3984.4.1
by Ian Clatworthy
get_help_text() verbose parameter & keep custom sections ordered |
451 |
see_also_as_links=False, verbose=True): |
2432.1.21
by Robert Collins
Teach Command.get_help_text to show additional help cross references when supplied. |
452 |
"""Return a text string with help for this command.
|
3943.8.1
by Marius Kruger
remove all trailing whitespace from bzr source |
453 |
|
2432.1.21
by Robert Collins
Teach Command.get_help_text to show additional help cross references when supplied. |
454 |
:param additional_see_also: Additional help topics to be
|
455 |
cross-referenced.
|
|
2666.1.1
by Ian Clatworthy
Bazaar User Reference generated from online help |
456 |
:param plain: if False, raw help (reStructuredText) is
|
457 |
returned instead of plain text.
|
|
2677.1.2
by Alexander Belchenko
bzr_man: see also topics as cross-reference links |
458 |
:param see_also_as_links: if True, convert items in 'See also'
|
2677.1.4
by Alexander Belchenko
fixes after John's review |
459 |
list to internal links (used by bzr_man rstx generator)
|
3984.4.1
by Ian Clatworthy
get_help_text() verbose parameter & keep custom sections ordered |
460 |
:param verbose: if True, display the full help, otherwise
|
461 |
leave out the descriptive sections and just display
|
|
3984.4.8
by Ian Clatworthy
tweak docstring |
462 |
usage help (e.g. Purpose, Usage, Options) with a
|
463 |
message explaining how to obtain full help.
|
|
2432.1.21
by Robert Collins
Teach Command.get_help_text to show additional help cross references when supplied. |
464 |
"""
|
6112.1.1
by Jonathan Riddell
check for installed i18n before doing install |
465 |
if self.l10n: |
5875.3.25
by Vincent Ladeuil
Fix test failures and make sure we don't rely on a default translation. |
466 |
i18n.install() # Install i18n only for get_help_text for now. |
2432.1.12
by Robert Collins
Relocate command help onto Command. |
467 |
doc = self.help() |
5875.3.1
by INADA Naoki
Implement command help l10n. |
468 |
if doc: |
5875.4.1
by INADA Naoki
Add comment about describing ":Usage:" section is not translated. |
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
|
|
473 |
# not be translated.
|
|
5875.3.25
by Vincent Ladeuil
Fix test failures and make sure we don't rely on a default translation. |
474 |
doc = self.gettext(doc) |
5875.3.1
by INADA Naoki
Implement command help l10n. |
475 |
else: |
476 |
doc = gettext("No help for this command.") |
|
2432.1.12
by Robert Collins
Relocate command help onto Command. |
477 |
|
2666.1.1
by Ian Clatworthy
Bazaar User Reference generated from online help |
478 |
# Extract the summary (purpose) and sections out from the text
|
3974.1.1
by Ian Clatworthy
keep section ordering in help |
479 |
purpose,sections,order = self._get_help_parts(doc) |
2666.1.1
by Ian Clatworthy
Bazaar User Reference generated from online help |
480 |
|
481 |
# If a custom usage section was provided, use it
|
|
482 |
if sections.has_key('Usage'): |
|
483 |
usage = sections.pop('Usage') |
|
484 |
else: |
|
485 |
usage = self._usage() |
|
486 |
||
487 |
# The header is the purpose and usage
|
|
2432.1.12
by Robert Collins
Relocate command help onto Command. |
488 |
result = "" |
5875.3.26
by Vincent Ladeuil
Tweak test_help some more. |
489 |
result += gettext(':Purpose: %s\n') % (purpose,) |
2666.1.1
by Ian Clatworthy
Bazaar User Reference generated from online help |
490 |
if usage.find('\n') >= 0: |
5875.3.23
by Vincent Ladeuil
Put the '\n' back into the formats and fix tests accordingly (reducing code duplication). |
491 |
result += gettext(':Usage:\n%s\n') % (usage,) |
2666.1.1
by Ian Clatworthy
Bazaar User Reference generated from online help |
492 |
else: |
5875.3.23
by Vincent Ladeuil
Put the '\n' back into the formats and fix tests accordingly (reducing code duplication). |
493 |
result += gettext(':Usage: %s\n') % (usage,) |
2666.1.1
by Ian Clatworthy
Bazaar User Reference generated from online help |
494 |
result += '\n' |
495 |
||
496 |
# Add the options
|
|
4070.11.3
by Martin Pool
doc |
497 |
#
|
498 |
# XXX: optparse implicitly rewraps the help, and not always perfectly,
|
|
499 |
# so we get <https://bugs.launchpad.net/bzr/+bug/249908>. -- mbp
|
|
500 |
# 20090319
|
|
5875.4.4
by INADA Naoki
Remove l10n of options. |
501 |
parser = option.get_optparser(self.options()) |
5875.3.15
by INADA Naoki
Use better variable name. |
502 |
options = parser.format_option_help() |
5860.1.1
by Vincent Ladeuil
Fix some ReST typos in the configuration help and restore the workaround for dotted format names breaking sphinx. |
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: |
|
4634.39.39
by Ian Clatworthy
Fix ReST syntax errors in User Reference caused by options like --1.9 that ReST option lists don't permit |
510 |
options = options.replace(' format:\n', ' format::\n\n', 1) |
5875.3.14
by INADA Naoki
Change how to use gettext for section titles. |
511 |
if options.startswith('Options:'): |
512 |
result += gettext(':Options:%s') % (options[len('options:'):],) |
|
2666.1.1
by Ian Clatworthy
Bazaar User Reference generated from online help |
513 |
else: |
514 |
result += options |
|
515 |
result += '\n' |
|
516 |
||
3984.4.1
by Ian Clatworthy
get_help_text() verbose parameter & keep custom sections ordered |
517 |
if verbose: |
518 |
# Add the description, indenting it 2 spaces
|
|
519 |
# to match the indentation of the options
|
|
520 |
if sections.has_key(None): |
|
521 |
text = sections.pop(None) |
|
522 |
text = '\n '.join(text.splitlines()) |
|
5875.3.23
by Vincent Ladeuil
Put the '\n' back into the formats and fix tests accordingly (reducing code duplication). |
523 |
result += gettext(':Description:\n %s\n\n') % (text,) |
2666.1.1
by Ian Clatworthy
Bazaar User Reference generated from online help |
524 |
|
3984.4.1
by Ian Clatworthy
get_help_text() verbose parameter & keep custom sections ordered |
525 |
# Add the custom sections (e.g. Examples). Note that there's no need
|
526 |
# to indent these as they must be indented already in the source.
|
|
527 |
if sections: |
|
528 |
for label in order: |
|
5875.3.1
by INADA Naoki
Implement command help l10n. |
529 |
if label in sections: |
530 |
result += ':%s:\n%s\n' % (label, sections[label]) |
|
3984.4.1
by Ian Clatworthy
get_help_text() verbose parameter & keep custom sections ordered |
531 |
result += '\n' |
532 |
else: |
|
5875.3.1
by INADA Naoki
Implement command help l10n. |
533 |
result += (gettext("See bzr help %s for more details and examples.\n\n") |
3984.4.2
by Ian Clatworthy
make help on commands concise by default |
534 |
% self.name()) |
2666.1.1
by Ian Clatworthy
Bazaar User Reference generated from online help |
535 |
|
536 |
# Add the aliases, source (plug-in) and see also links, if any
|
|
2432.1.12
by Robert Collins
Relocate command help onto Command. |
537 |
if self.aliases: |
5875.3.14
by INADA Naoki
Change how to use gettext for section titles. |
538 |
result += gettext(':Aliases: ') |
2432.1.12
by Robert Collins
Relocate command help onto Command. |
539 |
result += ', '.join(self.aliases) + '\n' |
540 |
plugin_name = self.plugin_name() |
|
541 |
if plugin_name is not None: |
|
5875.3.14
by INADA Naoki
Change how to use gettext for section titles. |
542 |
result += gettext(':From: plugin "%s"\n') % plugin_name |
2432.1.21
by Robert Collins
Teach Command.get_help_text to show additional help cross references when supplied. |
543 |
see_also = self.get_see_also(additional_see_also) |
2432.1.12
by Robert Collins
Relocate command help onto Command. |
544 |
if see_also: |
2677.1.4
by Alexander Belchenko
fixes after John's review |
545 |
if not plain and see_also_as_links: |
546 |
see_also_links = [] |
|
547 |
for item in see_also: |
|
548 |
if item == 'topics': |
|
549 |
# topics doesn't have an independent section
|
|
550 |
# so don't create a real link
|
|
551 |
see_also_links.append(item) |
|
552 |
else: |
|
4927.2.2
by Ian Clatworthy
User Reference as topics |
553 |
# Use a Sphinx link for this entry
|
6147.1.1
by Jonathan Riddell
use .format() instead of % for string formatting where there are multiple formats in one string to allow for translations |
554 |
link_text = gettext(":doc:`{0} <{1}-help>`").format( |
555 |
item, item) |
|
4927.2.2
by Ian Clatworthy
User Reference as topics |
556 |
see_also_links.append(link_text) |
2677.1.4
by Alexander Belchenko
fixes after John's review |
557 |
see_also = see_also_links |
5875.3.14
by INADA Naoki
Change how to use gettext for section titles. |
558 |
result += gettext(':See also: %s') % ', '.join(see_also) + '\n' |
2666.1.1
by Ian Clatworthy
Bazaar User Reference generated from online help |
559 |
|
3668.2.1
by Vincent Ladeuil
Fix bug #263249 by setting valid default _param_name. |
560 |
# If this will be rendered as plain text, convert it
|
2666.1.1
by Ian Clatworthy
Bazaar User Reference generated from online help |
561 |
if plain: |
562 |
import bzrlib.help_topics |
|
563 |
result = bzrlib.help_topics.help_as_plain_text(result) |
|
2432.1.12
by Robert Collins
Relocate command help onto Command. |
564 |
return result |
565 |
||
2666.1.1
by Ian Clatworthy
Bazaar User Reference generated from online help |
566 |
@staticmethod
|
567 |
def _get_help_parts(text): |
|
568 |
"""Split help text into a summary and named sections.
|
|
569 |
||
3974.1.1
by Ian Clatworthy
keep section ordering in help |
570 |
:return: (summary,sections,order) where summary is the top line and
|
2666.1.1
by Ian Clatworthy
Bazaar User Reference generated from online help |
571 |
sections is a dictionary of the rest indexed by section name.
|
3974.1.1
by Ian Clatworthy
keep section ordering in help |
572 |
order is the order the section appear in the text.
|
2666.1.1
by Ian Clatworthy
Bazaar User Reference generated from online help |
573 |
A section starts with a heading line of the form ":xxx:".
|
574 |
Indented text on following lines is the section value.
|
|
575 |
All text found outside a named section is assigned to the
|
|
576 |
default section which is given the key of None.
|
|
577 |
"""
|
|
3974.1.1
by Ian Clatworthy
keep section ordering in help |
578 |
def save_section(sections, order, label, section): |
2666.1.1
by Ian Clatworthy
Bazaar User Reference generated from online help |
579 |
if len(section) > 0: |
580 |
if sections.has_key(label): |
|
581 |
sections[label] += '\n' + section |
|
582 |
else: |
|
3974.1.1
by Ian Clatworthy
keep section ordering in help |
583 |
order.append(label) |
2666.1.1
by Ian Clatworthy
Bazaar User Reference generated from online help |
584 |
sections[label] = section |
3668.2.1
by Vincent Ladeuil
Fix bug #263249 by setting valid default _param_name. |
585 |
|
2666.1.1
by Ian Clatworthy
Bazaar User Reference generated from online help |
586 |
lines = text.rstrip().splitlines() |
587 |
summary = lines.pop(0) |
|
588 |
sections = {} |
|
3974.1.1
by Ian Clatworthy
keep section ordering in help |
589 |
order = [] |
2666.1.1
by Ian Clatworthy
Bazaar User Reference generated from online help |
590 |
label,section = None,'' |
591 |
for line in lines: |
|
592 |
if line.startswith(':') and line.endswith(':') and len(line) > 2: |
|
3974.1.1
by Ian Clatworthy
keep section ordering in help |
593 |
save_section(sections, order, label, section) |
2666.1.1
by Ian Clatworthy
Bazaar User Reference generated from online help |
594 |
label,section = line[1:-1],'' |
3376.2.11
by Martin Pool
Compare to None using is/is not not == |
595 |
elif (label is not None) and len(line) > 1 and not line[0].isspace(): |
3974.1.1
by Ian Clatworthy
keep section ordering in help |
596 |
save_section(sections, order, label, section) |
2666.1.1
by Ian Clatworthy
Bazaar User Reference generated from online help |
597 |
label,section = None,line |
598 |
else: |
|
599 |
if len(section) > 0: |
|
600 |
section += '\n' + line |
|
601 |
else: |
|
602 |
section = line |
|
3974.1.1
by Ian Clatworthy
keep section ordering in help |
603 |
save_section(sections, order, label, section) |
604 |
return summary, sections, order |
|
2666.1.1
by Ian Clatworthy
Bazaar User Reference generated from online help |
605 |
|
2432.1.28
by Robert Collins
Add a get_help_topic method to commands.Command. |
606 |
def get_help_topic(self): |
607 |
"""Return the commands help topic - its name."""
|
|
608 |
return self.name() |
|
609 |
||
2432.1.21
by Robert Collins
Teach Command.get_help_text to show additional help cross references when supplied. |
610 |
def get_see_also(self, additional_terms=None): |
2677.1.2
by Alexander Belchenko
bzr_man: see also topics as cross-reference links |
611 |
"""Return a list of help topics that are related to this command.
|
3943.8.1
by Marius Kruger
remove all trailing whitespace from bzr source |
612 |
|
2425.2.1
by Robert Collins
Command objects can now declare related help topics by having _see_also |
613 |
The list is derived from the content of the _see_also attribute. Any
|
614 |
duplicates are removed and the result is in lexical order.
|
|
2432.1.21
by Robert Collins
Teach Command.get_help_text to show additional help cross references when supplied. |
615 |
:param additional_terms: Additional help topics to cross-reference.
|
2425.2.1
by Robert Collins
Command objects can now declare related help topics by having _see_also |
616 |
:return: A list of help topics.
|
617 |
"""
|
|
2432.1.21
by Robert Collins
Teach Command.get_help_text to show additional help cross references when supplied. |
618 |
see_also = set(getattr(self, '_see_also', [])) |
619 |
if additional_terms: |
|
620 |
see_also.update(additional_terms) |
|
621 |
return sorted(see_also) |
|
2425.2.1
by Robert Collins
Command objects can now declare related help topics by having _see_also |
622 |
|
1185.16.43
by Martin Pool
- clean up handling of option objects |
623 |
def options(self): |
624 |
"""Return dict of valid options for this command.
|
|
625 |
||
626 |
Maps from long option name to option object."""
|
|
2768.1.4
by Ian Clatworthy
Process --verbose and --quiet standard options |
627 |
r = Option.STD_OPTIONS.copy() |
628 |
std_names = r.keys() |
|
1185.16.43
by Martin Pool
- clean up handling of option objects |
629 |
for o in self.takes_options: |
1857.1.8
by Aaron Bentley
Group enum options and add enum options to init and init-repo |
630 |
if isinstance(o, basestring): |
1996.3.1
by John Arbash Meinel
Demandloading builtins.py drops our load time from 350ms to 291ms |
631 |
o = option.Option.OPTIONS[o] |
1185.16.43
by Martin Pool
- clean up handling of option objects |
632 |
r[o.name] = o |
2768.1.4
by Ian Clatworthy
Process --verbose and --quiet standard options |
633 |
if o.name in std_names: |
634 |
self.supported_std_options.append(o.name) |
|
1185.16.43
by Martin Pool
- clean up handling of option objects |
635 |
return r |
1165
by Martin Pool
- move parsing of argv into arguments and options into Command.run_argv |
636 |
|
1685.1.80
by Wouter van Heyst
more code cleanup |
637 |
def _setup_outf(self): |
1185.85.22
by John Arbash Meinel
Updated cmd_inventory. Changing from having each Command request an encoded stdout to providing one before calling run() |
638 |
"""Return a file linked to stdout, which has proper encoding."""
|
4792.8.9
by Martin Pool
Send Command.outf through UIFactory |
639 |
self.outf = ui.ui_factory.make_output_stream( |
640 |
encoding_type=self.encoding_type) |
|
1185.85.22
by John Arbash Meinel
Updated cmd_inventory. Changing from having each Command request an encoded stdout to providing one before calling run() |
641 |
|
1581.1.1
by Robert Collins
Bugfix aliases to be backwards compatible with plugins providing command.run_argv. |
642 |
def run_argv_aliases(self, argv, alias_argv=None): |
643 |
"""Parse the command line and run with extra aliases in alias_argv."""
|
|
1553.6.8
by Erik BÃ¥gfors
support for overrides |
644 |
args, opts = parse_args(self, argv, alias_argv) |
5875.4.2
by INADA Naoki
Command.run_argv_aliases() always calls self._setup_outf. |
645 |
self._setup_outf() |
2768.1.4
by Ian Clatworthy
Process --verbose and --quiet standard options |
646 |
|
647 |
# Process the standard options
|
|
3984.4.5
by Ian Clatworthy
help xxx is full help; xxx -h is concise help |
648 |
if 'help' in opts: # e.g. bzr add --help |
5875.3.1
by INADA Naoki
Implement command help l10n. |
649 |
self.outf.write(self.get_help_text()) |
3984.4.6
by Ian Clatworthy
Show usage on --usage, not -h |
650 |
return 0 |
651 |
if 'usage' in opts: # e.g. bzr add --usage |
|
5875.3.16
by INADA Naoki
Use _outf for '--using' too. |
652 |
self.outf.write(self.get_help_text(verbose=False)) |
3984.4.5
by Ian Clatworthy
help xxx is full help; xxx -h is concise help |
653 |
return 0 |
2768.1.4
by Ian Clatworthy
Process --verbose and --quiet standard options |
654 |
trace.set_verbosity_level(option._verbosity_level) |
655 |
if 'verbose' in self.supported_std_options: |
|
656 |
opts['verbose'] = trace.is_verbose() |
|
657 |
elif opts.has_key('verbose'): |
|
658 |
del opts['verbose'] |
|
659 |
if 'quiet' in self.supported_std_options: |
|
660 |
opts['quiet'] = trace.is_quiet() |
|
661 |
elif opts.has_key('quiet'): |
|
662 |
del opts['quiet'] |
|
1165
by Martin Pool
- move parsing of argv into arguments and options into Command.run_argv |
663 |
# mix arguments and options into one dictionary
|
664 |
cmdargs = _match_argform(self.name(), self.takes_args, args) |
|
665 |
cmdopts = {} |
|
666 |
for k, v in opts.items(): |
|
667 |
cmdopts[k.replace('-', '_')] = v |
|
668 |
||
669 |
all_cmd_args = cmdargs.copy() |
|
670 |
all_cmd_args.update(cmdopts) |
|
671 |
||
5463.1.2
by Martin Pool
Make run_argv_aliases reset the global verbosity after running |
672 |
try: |
673 |
return self.run(**all_cmd_args) |
|
674 |
finally: |
|
675 |
# reset it, so that other commands run in the same process won't
|
|
5609.16.1
by John Arbash Meinel
Fix bug #713258. Restore logging of bytes transferred. |
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)) |
|
5463.1.2
by Martin Pool
Make run_argv_aliases reset the global verbosity after running |
680 |
trace.set_verbosity_level(0) |
5141.2.1
by Robert Collins
``bzrlib.commands.Command.run_direct`` is no longer needed - the pre |
681 |
|
682 |
def _setup_run(self): |
|
683 |
"""Wrap the defined run method on self with a cleanup.
|
|
684 |
||
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.
|
|
687 |
||
688 |
If a different form of cleanups are in use by your Command subclass,
|
|
689 |
you can override this method.
|
|
690 |
"""
|
|
691 |
class_run = self.run |
|
692 |
def run(*args, **kwargs): |
|
6240.5.7
by Jelmer Vernooij
Drop exception suppression support. |
693 |
for hook in Command.hooks['pre_command']: |
694 |
hook(self) |
|
5141.2.1
by Robert Collins
``bzrlib.commands.Command.run_direct`` is no longer needed - the pre |
695 |
self._operation = cleanup.OperationWithCleanups(class_run) |
696 |
try: |
|
697 |
return self._operation.run_simple(*args, **kwargs) |
|
698 |
finally: |
|
699 |
del self._operation |
|
6240.5.7
by Jelmer Vernooij
Drop exception suppression support. |
700 |
for hook in Command.hooks['post_command']: |
701 |
hook(self) |
|
5141.2.1
by Robert Collins
``bzrlib.commands.Command.run_direct`` is no longer needed - the pre |
702 |
self.run = run |
703 |
||
1162
by Martin Pool
- change Command infrastructure to use (mostly stateless) objects to |
704 |
def run(self): |
705 |
"""Actually run the command.
|
|
329
by Martin Pool
- refactor command functions into command classes |
706 |
|
707 |
This is invoked with the options and arguments bound to
|
|
708 |
keyword parameters.
|
|
709 |
||
1162
by Martin Pool
- change Command infrastructure to use (mostly stateless) objects to |
710 |
Return 0 or None if the command was successful, or a non-zero
|
711 |
shell error code if not. It's OK for this method to allow
|
|
712 |
an exception to raise up.
|
|
5141.2.1
by Robert Collins
``bzrlib.commands.Command.run_direct`` is no longer needed - the pre |
713 |
|
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
|
|
717 |
run().
|
|
718 |
||
719 |
The argument for run are assembled by introspection. So for instance,
|
|
720 |
if your command takes an argument files, you would declare::
|
|
721 |
||
722 |
def run(self, files=None):
|
|
723 |
pass
|
|
329
by Martin Pool
- refactor command functions into command classes |
724 |
"""
|
2155.2.1
by Marius Kruger
* Get command aliases to respect quoted arguments. |
725 |
raise NotImplementedError('no implementation of command %r' |
1610.1.3
by Martin Pool
Better error message for Command.run() not implemented |
726 |
% self.name()) |
329
by Martin Pool
- refactor command functions into command classes |
727 |
|
1162
by Martin Pool
- change Command infrastructure to use (mostly stateless) objects to |
728 |
def help(self): |
729 |
"""Return help message for this class."""
|
|
1610.1.2
by Martin Pool
Move rarely-used import into Command.help() |
730 |
from inspect import getdoc |
1162
by Martin Pool
- change Command infrastructure to use (mostly stateless) objects to |
731 |
if self.__doc__ is Command.__doc__: |
732 |
return None |
|
733 |
return getdoc(self) |
|
734 |
||
5875.4.3
by INADA Naoki
Don't use property |
735 |
def gettext(self, message): |
5875.3.1
by INADA Naoki
Implement command help l10n. |
736 |
"""Returns the gettext function used to translate this command's help.
|
737 |
||
5875.3.18
by INADA Naoki
Fix docstring of Command.get_gettext |
738 |
Commands provided by plugins should override this to use their
|
739 |
own i18n system.
|
|
5875.3.1
by INADA Naoki
Implement command help l10n. |
740 |
"""
|
5875.3.25
by Vincent Ladeuil
Fix test failures and make sure we don't rely on a default translation. |
741 |
return i18n.gettext_per_paragraph(message) |
5875.3.1
by INADA Naoki
Implement command help l10n. |
742 |
|
1162
by Martin Pool
- change Command infrastructure to use (mostly stateless) objects to |
743 |
def name(self): |
5741.3.1
by Martin Pool
Add Command.invoked_as |
744 |
"""Return the canonical name for this command.
|
745 |
||
746 |
The name under which it was actually invoked is available in invoked_as.
|
|
747 |
"""
|
|
1162
by Martin Pool
- change Command infrastructure to use (mostly stateless) objects to |
748 |
return _unsquish_command_name(self.__class__.__name__) |
749 |
||
1733.2.5
by Michael Ellerman
Show which plugin (if any) provides a command. |
750 |
def plugin_name(self): |
751 |
"""Get the name of the plugin that provides this command.
|
|
752 |
||
753 |
:return: The name of the plugin or None if the command is builtin.
|
|
754 |
"""
|
|
755 |
mod_parts = self.__module__.split('.') |
|
756 |
if len(mod_parts) >= 3 and mod_parts[1] == 'plugins': |
|
757 |
return mod_parts[2] |
|
758 |
else: |
|
759 |
return None |
|
760 |
||
1162
by Martin Pool
- change Command infrastructure to use (mostly stateless) objects to |
761 |
|
4000.1.1
by Robert Collins
Add a new hook Commands['extend_command'] for plugins that want to alter commands without overriding the entire command. |
762 |
class CommandHooks(Hooks): |
763 |
"""Hooks related to Command object creation/enumeration."""
|
|
764 |
||
5622.3.10
by Jelmer Vernooij
Don't require arguments to hooks. |
765 |
def __init__(self): |
4000.1.1
by Robert Collins
Add a new hook Commands['extend_command'] for plugins that want to alter commands without overriding the entire command. |
766 |
"""Create the default hooks.
|
767 |
||
768 |
These are all empty initially, because by default nothing should get
|
|
769 |
notified.
|
|
770 |
"""
|
|
5622.3.10
by Jelmer Vernooij
Don't require arguments to hooks. |
771 |
Hooks.__init__(self, "bzrlib.commands", "Command.hooks") |
5622.3.2
by Jelmer Vernooij
Add more lazily usable hook points. |
772 |
self.add_hook('extend_command', |
4119.3.2
by Robert Collins
Migrate existing hooks over to the new HookPoint infrastructure. |
773 |
"Called after creating a command object to allow modifications "
|
774 |
"such as adding or removing options, docs etc. Called with the "
|
|
5622.3.2
by Jelmer Vernooij
Add more lazily usable hook points. |
775 |
"new bzrlib.commands.Command object.", (1, 13)) |
776 |
self.add_hook('get_command', |
|
4119.3.4
by Robert Collins
Add Command lookup hooks: list_commands and get_command. |
777 |
"Called when creating a single command. Called with "
|
778 |
"(cmd_or_None, command_name). get_command should either return "
|
|
779 |
"the cmd_or_None parameter, or a replacement Command object that "
|
|
4119.3.10
by Robert Collins
More review feedback. |
780 |
"should be used for the command. Note that the Command.hooks "
|
781 |
"hooks are core infrastructure. Many users will prefer to use "
|
|
782 |
"bzrlib.commands.register_command or plugin_cmds.register_lazy.", |
|
5622.3.2
by Jelmer Vernooij
Add more lazily usable hook points. |
783 |
(1, 17)) |
784 |
self.add_hook('get_missing_command', |
|
4119.3.8
by Robert Collins
Get missing command support sorted out. |
785 |
"Called when creating a single command if no command could be "
|
786 |
"found. Called with (command_name). get_missing_command should "
|
|
787 |
"either return None, or a Command object to be used for the "
|
|
5622.3.2
by Jelmer Vernooij
Add more lazily usable hook points. |
788 |
"command.", (1, 17)) |
789 |
self.add_hook('list_commands', |
|
4119.3.10
by Robert Collins
More review feedback. |
790 |
"Called when enumerating commands. Called with a set of "
|
791 |
"cmd_name strings for all the commands found so far. This set "
|
|
792 |
" is safe to mutate - e.g. to remove a command. "
|
|
793 |
"list_commands should return the updated set of command names.", |
|
5622.3.2
by Jelmer Vernooij
Add more lazily usable hook points. |
794 |
(1, 17)) |
6240.5.1
by Brian de Alwis
Introduce two new command hooks, 'pre_command' and 'post_command', |
795 |
self.add_hook('pre_command', |
796 |
"Called prior to executing a command. Called with the command "
|
|
6475.1.1
by Brian de Alwis
Doc fix: command hooks available in 2.6 |
797 |
"object.", (2, 6)) |
6240.5.1
by Brian de Alwis
Introduce two new command hooks, 'pre_command' and 'post_command', |
798 |
self.add_hook('post_command', |
799 |
"Called after executing a command. Called with the command "
|
|
6475.1.1
by Brian de Alwis
Doc fix: command hooks available in 2.6 |
800 |
"object.", (2, 6)) |
4000.1.1
by Robert Collins
Add a new hook Commands['extend_command'] for plugins that want to alter commands without overriding the entire command. |
801 |
|
5622.3.10
by Jelmer Vernooij
Don't require arguments to hooks. |
802 |
Command.hooks = CommandHooks() |
4000.1.1
by Robert Collins
Add a new hook Commands['extend_command'] for plugins that want to alter commands without overriding the entire command. |
803 |
|
804 |
||
1553.6.11
by Erik BÃ¥gfors
small bugfixes, all tests pass now |
805 |
def parse_args(command, argv, alias_argv=None): |
1
by mbp at sourcefrog
import from baz patch-364 |
806 |
"""Parse command line.
|
3943.8.1
by Marius Kruger
remove all trailing whitespace from bzr source |
807 |
|
1
by mbp at sourcefrog
import from baz patch-364 |
808 |
Arguments and options are parsed at this level before being passed
|
809 |
down to specific command handlers. This routine knows, from a
|
|
810 |
lookup table, something about the available options, what optargs
|
|
811 |
they take, and which commands will accept them.
|
|
812 |
"""
|
|
1857.1.1
by Aaron Bentley
Use optparse for parsing options |
813 |
# TODO: make it a method of the Command?
|
1857.1.3
by Aaron Bentley
Make option adding depend on Option type |
814 |
parser = option.get_optparser(command.options()) |
1857.1.1
by Aaron Bentley
Use optparse for parsing options |
815 |
if alias_argv is not None: |
816 |
args = alias_argv + argv |
|
817 |
else: |
|
818 |
args = argv |
|
683
by Martin Pool
- short option stacking patch from John A Meinel |
819 |
|
5514.3.2
by Rory Yorke
Added comment on try-except around pargse_args(), w/ pointer to Python bug. |
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
|
|
5514.3.1
by Rory Yorke
Report an error if a non-ASCII option name is given (bug 140563). |
822 |
try: |
823 |
options, args = parser.parse_args(args) |
|
824 |
except UnicodeEncodeError,e: |
|
6171.2.1
by Vincent Ladeuil
Global options respect their hidden attribute |
825 |
raise errors.BzrCommandError( |
826 |
gettext('Only ASCII permitted in option names')) |
|
5514.3.1
by Rory Yorke
Report an error if a non-ASCII option name is given (bug 140563). |
827 |
|
2155.2.1
by Marius Kruger
* Get command aliases to respect quoted arguments. |
828 |
opts = dict([(k, v) for k, v in options.__dict__.iteritems() if |
1857.1.3
by Aaron Bentley
Make option adding depend on Option type |
829 |
v is not option.OptionParser.DEFAULT_VALUE]) |
1
by mbp at sourcefrog
import from baz patch-364 |
830 |
return args, opts |
831 |
||
832 |
||
329
by Martin Pool
- refactor command functions into command classes |
833 |
def _match_argform(cmd, takes_args, args): |
1
by mbp at sourcefrog
import from baz patch-364 |
834 |
argdict = {} |
26
by mbp at sourcefrog
fix StopIteration error on python2.3(?) |
835 |
|
329
by Martin Pool
- refactor command functions into command classes |
836 |
# step through args and takes_args, allowing appropriate 0-many matches
|
837 |
for ap in takes_args: |
|
1
by mbp at sourcefrog
import from baz patch-364 |
838 |
argname = ap[:-1] |
839 |
if ap[-1] == '?': |
|
62
by mbp at sourcefrog
- new find_branch_root function; based on suggestion from aaron |
840 |
if args: |
841 |
argdict[argname] = args.pop(0) |
|
196
by mbp at sourcefrog
selected-file diff |
842 |
elif ap[-1] == '*': # all remaining arguments |
843 |
if args: |
|
844 |
argdict[argname + '_list'] = args[:] |
|
845 |
args = [] |
|
846 |
else: |
|
847 |
argdict[argname + '_list'] = None |
|
1
by mbp at sourcefrog
import from baz patch-364 |
848 |
elif ap[-1] == '+': |
849 |
if not args: |
|
6138.3.7
by Jonathan Riddell
add gettext() to BzrCommandError uses |
850 |
raise errors.BzrCommandError(gettext( |
851 |
"command {0!r} needs one or more {1}").format( |
|
852 |
cmd, argname.upper())) |
|
1
by mbp at sourcefrog
import from baz patch-364 |
853 |
else: |
854 |
argdict[argname + '_list'] = args[:] |
|
855 |
args = [] |
|
160
by mbp at sourcefrog
- basic support for moving files to different directories - have not done support for renaming them yet, but should be straightforward - some tests, but many cases are not handled yet i think |
856 |
elif ap[-1] == '$': # all but one |
857 |
if len(args) < 2: |
|
6138.3.7
by Jonathan Riddell
add gettext() to BzrCommandError uses |
858 |
raise errors.BzrCommandError( |
859 |
gettext("command {0!r} needs one or more {1}").format( |
|
860 |
cmd, argname.upper())) |
|
160
by mbp at sourcefrog
- basic support for moving files to different directories - have not done support for renaming them yet, but should be straightforward - some tests, but many cases are not handled yet i think |
861 |
argdict[argname + '_list'] = args[:-1] |
1740.5.6
by Martin Pool
Clean up many exception classes. |
862 |
args[:-1] = [] |
1
by mbp at sourcefrog
import from baz patch-364 |
863 |
else: |
864 |
# just a plain arg
|
|
865 |
argname = ap |
|
866 |
if not args: |
|
6138.3.7
by Jonathan Riddell
add gettext() to BzrCommandError uses |
867 |
raise errors.BzrCommandError( |
868 |
gettext("command {0!r} requires argument {1}").format( |
|
869 |
cmd, argname.upper())) |
|
1
by mbp at sourcefrog
import from baz patch-364 |
870 |
else: |
871 |
argdict[argname] = args.pop(0) |
|
3943.8.1
by Marius Kruger
remove all trailing whitespace from bzr source |
872 |
|
1
by mbp at sourcefrog
import from baz patch-364 |
873 |
if args: |
6138.3.14
by Jonathan Riddell
fix syntax |
874 |
raise errors.BzrCommandError( gettext( |
875 |
"extra argument to command {0}: {1}").format( |
|
876 |
cmd, args[0]) ) |
|
1
by mbp at sourcefrog
import from baz patch-364 |
877 |
|
878 |
return argdict |
|
879 |
||
3169.3.1
by Andrew Bennetts
Make --coverage a global option. |
880 |
def apply_coveraged(dirname, the_callable, *args, **kwargs): |
881 |
# Cannot use "import trace", as that would import bzrlib.trace instead of
|
|
882 |
# the standard library's trace.
|
|
883 |
trace = __import__('trace') |
|
884 |
||
885 |
tracer = trace.Trace(count=1, trace=0) |
|
886 |
sys.settrace(tracer.globaltrace) |
|
4325.1.1
by Vincent Ladeuil
Make --coverage works for threads too. |
887 |
threading.settrace(tracer.globaltrace) |
3169.3.1
by Andrew Bennetts
Make --coverage a global option. |
888 |
|
4084.6.1
by Robert Collins
Refactor profiling exception handling to restore clear layers - command handling in commands.py, profiling in lsprof.py. |
889 |
try: |
890 |
return exception_to_return_code(the_callable, *args, **kwargs) |
|
891 |
finally: |
|
892 |
sys.settrace(None) |
|
893 |
results = tracer.results() |
|
894 |
results.write_results(show_missing=1, summary=False, |
|
895 |
coverdir=dirname) |
|
1
by mbp at sourcefrog
import from baz patch-364 |
896 |
|
897 |
||
1162
by Martin Pool
- change Command infrastructure to use (mostly stateless) objects to |
898 |
def apply_profiled(the_callable, *args, **kwargs): |
899 |
import hotshot |
|
900 |
import tempfile |
|
1393.1.27
by Martin Pool
- clean up profile code and change default sort order |
901 |
import hotshot.stats |
1162
by Martin Pool
- change Command infrastructure to use (mostly stateless) objects to |
902 |
pffileno, pfname = tempfile.mkstemp() |
903 |
try: |
|
904 |
prof = hotshot.Profile(pfname) |
|
905 |
try: |
|
4084.6.1
by Robert Collins
Refactor profiling exception handling to restore clear layers - command handling in commands.py, profiling in lsprof.py. |
906 |
ret = prof.runcall(exception_to_return_code, the_callable, *args, |
907 |
**kwargs) or 0 |
|
1162
by Martin Pool
- change Command infrastructure to use (mostly stateless) objects to |
908 |
finally: |
909 |
prof.close() |
|
910 |
stats = hotshot.stats.load(pfname) |
|
1393.1.27
by Martin Pool
- clean up profile code and change default sort order |
911 |
stats.strip_dirs() |
912 |
stats.sort_stats('cum') # 'time' |
|
1162
by Martin Pool
- change Command infrastructure to use (mostly stateless) objects to |
913 |
## XXX: Might like to write to stderr or the trace file instead but
|
914 |
## print_stats seems hardcoded to stdout
|
|
915 |
stats.print_stats(20) |
|
916 |
return ret |
|
917 |
finally: |
|
918 |
os.close(pffileno) |
|
919 |
os.remove(pfname) |
|
920 |
||
921 |
||
4084.6.1
by Robert Collins
Refactor profiling exception handling to restore clear layers - command handling in commands.py, profiling in lsprof.py. |
922 |
def exception_to_return_code(the_callable, *args, **kwargs): |
923 |
"""UI level helper for profiling and coverage.
|
|
924 |
||
4084.6.3
by Robert Collins
Disagreement on trailing whitespace with the test suite. |
925 |
This transforms exceptions into a return value of 3. As such its only
|
4084.6.1
by Robert Collins
Refactor profiling exception handling to restore clear layers - command handling in commands.py, profiling in lsprof.py. |
926 |
relevant to the UI layer, and should never be called where catching
|
927 |
exceptions may be desirable.
|
|
928 |
"""
|
|
929 |
try: |
|
930 |
return the_callable(*args, **kwargs) |
|
931 |
except (KeyboardInterrupt, Exception), e: |
|
932 |
# used to handle AssertionError and KeyboardInterrupt
|
|
933 |
# specially here, but hopefully they're handled ok by the logger now
|
|
934 |
exc_info = sys.exc_info() |
|
935 |
exitcode = trace.report_exception(exc_info, sys.stderr) |
|
936 |
if os.environ.get('BZR_PDB'): |
|
937 |
print '**** entering debugger' |
|
938 |
import pdb |
|
6555.1.2
by Jelmer Vernooij
Inline traceback specification. |
939 |
pdb.post_mortem(exc_info[2]) |
4084.6.1
by Robert Collins
Refactor profiling exception handling to restore clear layers - command handling in commands.py, profiling in lsprof.py. |
940 |
return exitcode |
941 |
||
942 |
||
1553.7.1
by Robey Pointer
add --lsprof-file option to specify a file for writing lsprof data to (instead of dumping a pretty-print to the terminal) |
943 |
def apply_lsprofiled(filename, the_callable, *args, **kwargs): |
1185.33.85
by Martin Pool
New --lsprof option from Denys Duchier |
944 |
from bzrlib.lsprof import profile |
6027.1.3
by Vincent Ladeuil
Remove bzrlib.commands deprecated stuff. |
945 |
ret, stats = profile(exception_to_return_code, the_callable, |
946 |
*args, **kwargs) |
|
1185.33.85
by Martin Pool
New --lsprof option from Denys Duchier |
947 |
stats.sort() |
1553.7.1
by Robey Pointer
add --lsprof-file option to specify a file for writing lsprof data to (instead of dumping a pretty-print to the terminal) |
948 |
if filename is None: |
949 |
stats.pprint() |
|
950 |
else: |
|
2654.2.2
by Ian Clatworthy
Put all format detection stuff in one spot as requested by John Arbash Meinel |
951 |
stats.save(filename) |
6138.3.2
by Jonathan Riddell
gettext-ify bzrlib/commit.py |
952 |
trace.note(gettext('Profile data written to "%s".'), filename) |
1185.33.85
by Martin Pool
New --lsprof option from Denys Duchier |
953 |
return ret |
954 |
||
1553.6.9
by Erik BÃ¥gfors
PEP8-ify |
955 |
|
2155.2.1
by Marius Kruger
* Get command aliases to respect quoted arguments. |
956 |
def get_alias(cmd, config=None): |
957 |
"""Return an expanded alias, or None if no alias exists.
|
|
958 |
||
959 |
cmd
|
|
960 |
Command to be checked for an alias.
|
|
961 |
config
|
|
962 |
Used to specify an alternative config to use,
|
|
2155.2.3
by Marius Kruger
* commands.py |
963 |
which is especially useful for testing.
|
2155.2.1
by Marius Kruger
* Get command aliases to respect quoted arguments. |
964 |
If it is unspecified, the global config will be used.
|
965 |
"""
|
|
966 |
if config is None: |
|
967 |
import bzrlib.config |
|
968 |
config = bzrlib.config.GlobalConfig() |
|
969 |
alias = config.get_alias(cmd) |
|
1553.6.1
by Erik BÃ¥gfors
support for aliases in bazaar.conf |
970 |
if (alias): |
4913.5.24
by Gordon Tyler
Added cmdline.split function, which replaces commands.shlex_split_unicode. |
971 |
return cmdline.split(alias) |
1553.6.8
by Erik BÃ¥gfors
support for overrides |
972 |
return None |
1553.6.1
by Erik BÃ¥gfors
support for aliases in bazaar.conf |
973 |
|
1553.6.9
by Erik BÃ¥gfors
PEP8-ify |
974 |
|
5051.1.1
by Robert Collins
* ``bzrlib.comands.run_bzr`` is more extensible: callers can supply the |
975 |
def run_bzr(argv, load_plugins=load_plugins, disable_plugins=disable_plugins): |
1
by mbp at sourcefrog
import from baz patch-364 |
976 |
"""Execute a command.
|
977 |
||
5051.1.1
by Robert Collins
* ``bzrlib.comands.run_bzr`` is more extensible: callers can supply the |
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
|
|
983 |
loaded.
|
|
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.
|
|
974.1.26
by aaron.bentley at utoronto
merged mbp@sourcefrog.net-20050817233101-0939da1cf91f2472 |
990 |
|
991 |
Special master options: these must come before the command because
|
|
992 |
they control how the command is interpreted.
|
|
993 |
||
994 |
--no-plugins
|
|
995 |
Do not load plugin modules at all
|
|
996 |
||
1553.6.1
by Erik BÃ¥gfors
support for aliases in bazaar.conf |
997 |
--no-aliases
|
998 |
Do not allow aliases
|
|
999 |
||
974.1.26
by aaron.bentley at utoronto
merged mbp@sourcefrog.net-20050817233101-0939da1cf91f2472 |
1000 |
--builtin
|
1001 |
Only use builtin commands. (Plugins are still allowed to change
|
|
1002 |
other behaviour.)
|
|
1003 |
||
1004 |
--profile
|
|
1185.33.85
by Martin Pool
New --lsprof option from Denys Duchier |
1005 |
Run under the Python hotshot profiler.
|
1006 |
||
1007 |
--lsprof
|
|
1008 |
Run under the Python lsprof profiler.
|
|
3169.3.1
by Andrew Bennetts
Make --coverage a global option. |
1009 |
|
1010 |
--coverage
|
|
1011 |
Generate line coverage report in the specified directory.
|
|
4766.3.7
by Vincent Ladeuil
Mix BZR_CONCURRENCY and --concurrency so both are available. |
1012 |
|
1013 |
--concurrency
|
|
4766.3.9
by Vincent Ladeuil
Make it clear that --concurrency is for selftest only (so far). |
1014 |
Specify the number of processes that can be run concurrently (selftest).
|
1
by mbp at sourcefrog
import from baz patch-364 |
1015 |
"""
|
4926.2.2
by Toon Nolten
Solution to https://bugs.launchpad.net/bzr/+bug/257170; log now records the bazaar version |
1016 |
trace.mutter("bazaar version: " + bzrlib.__version__) |
5785.1.2
by Martin
Move _specified_or_unicode_argv call inside run_bzr as it may raise an error that should be reported |
1017 |
argv = _specified_or_unicode_argv(argv) |
2127.5.1
by mbp at sourcefrog
record command-line arguments in .bzr.log, drop some mutter statements |
1018 |
trace.mutter("bzr arguments: %r", argv) |
907.1.21
by John Arbash Meinel
Adding http transport as a valid transport protocol. |
1019 |
|
5875.3.1
by INADA Naoki
Implement command help l10n. |
1020 |
opt_lsprof = opt_profile = opt_no_plugins = opt_builtin = \ |
5875.3.22
by INADA Naoki
s/i18n/l10n/ |
1021 |
opt_no_l10n = opt_no_aliases = False |
4766.3.7
by Vincent Ladeuil
Mix BZR_CONCURRENCY and --concurrency so both are available. |
1022 |
opt_lsprof_file = opt_coverage_dir = None |
974.1.26
by aaron.bentley at utoronto
merged mbp@sourcefrog.net-20050817233101-0939da1cf91f2472 |
1023 |
|
1024 |
# --no-plugins is handled specially at a very early stage. We need
|
|
1025 |
# to load plugins before doing other command parsing so that they
|
|
1026 |
# can override commands, but this needs to happen first.
|
|
1027 |
||
1553.7.1
by Robey Pointer
add --lsprof-file option to specify a file for writing lsprof data to (instead of dumping a pretty-print to the terminal) |
1028 |
argv_copy = [] |
1029 |
i = 0 |
|
6161.1.4
by Vincent Ladeuil
Follow the lead of other 'global' options which are not declared in option.py but handled in bzrlib.commands.run_bzr instead. |
1030 |
override_config = [] |
1553.7.1
by Robey Pointer
add --lsprof-file option to specify a file for writing lsprof data to (instead of dumping a pretty-print to the terminal) |
1031 |
while i < len(argv): |
1032 |
a = argv[i] |
|
974.1.26
by aaron.bentley at utoronto
merged mbp@sourcefrog.net-20050817233101-0939da1cf91f2472 |
1033 |
if a == '--profile': |
1034 |
opt_profile = True |
|
1185.33.85
by Martin Pool
New --lsprof option from Denys Duchier |
1035 |
elif a == '--lsprof': |
1036 |
opt_lsprof = True |
|
1553.7.1
by Robey Pointer
add --lsprof-file option to specify a file for writing lsprof data to (instead of dumping a pretty-print to the terminal) |
1037 |
elif a == '--lsprof-file': |
1706.2.6
by Robey Pointer
when giving --lsprof-file, assume --lsprof |
1038 |
opt_lsprof = True |
1553.7.1
by Robey Pointer
add --lsprof-file option to specify a file for writing lsprof data to (instead of dumping a pretty-print to the terminal) |
1039 |
opt_lsprof_file = argv[i + 1] |
1040 |
i += 1 |
|
974.1.26
by aaron.bentley at utoronto
merged mbp@sourcefrog.net-20050817233101-0939da1cf91f2472 |
1041 |
elif a == '--no-plugins': |
1042 |
opt_no_plugins = True |
|
1553.6.1
by Erik BÃ¥gfors
support for aliases in bazaar.conf |
1043 |
elif a == '--no-aliases': |
1044 |
opt_no_aliases = True |
|
5875.3.22
by INADA Naoki
s/i18n/l10n/ |
1045 |
elif a == '--no-l10n': |
1046 |
opt_no_l10n = True |
|
974.1.26
by aaron.bentley at utoronto
merged mbp@sourcefrog.net-20050817233101-0939da1cf91f2472 |
1047 |
elif a == '--builtin': |
1048 |
opt_builtin = True |
|
4766.3.4
by Matt Nordhoff
Change the environment variable to a global option. |
1049 |
elif a == '--concurrency': |
4766.3.7
by Vincent Ladeuil
Mix BZR_CONCURRENCY and --concurrency so both are available. |
1050 |
os.environ['BZR_CONCURRENCY'] = argv[i + 1] |
4766.3.4
by Matt Nordhoff
Change the environment variable to a global option. |
1051 |
i += 1 |
3169.3.1
by Andrew Bennetts
Make --coverage a global option. |
1052 |
elif a == '--coverage': |
1053 |
opt_coverage_dir = argv[i + 1] |
|
1054 |
i += 1 |
|
5274.4.10
by Jason Spashett
Take away removal of --profile-imports from bzr script. Instead ignore this in global options bzrlib/commands.py run_bzr |
1055 |
elif a == '--profile-imports': |
1056 |
pass # already handled in startup script Bug #588277 |
|
2095.5.1
by Martin Pool
Add new -Derror global option to always display tracebacks |
1057 |
elif a.startswith('-D'): |
2095.5.2
by Martin Pool
save commit message if commit fails (#32054) |
1058 |
debug.debug_flags.add(a[2:]) |
6161.1.4
by Vincent Ladeuil
Follow the lead of other 'global' options which are not declared in option.py but handled in bzrlib.commands.run_bzr instead. |
1059 |
elif a.startswith('-O'): |
1060 |
override_config.append(a[2:]) |
|
974.1.26
by aaron.bentley at utoronto
merged mbp@sourcefrog.net-20050817233101-0939da1cf91f2472 |
1061 |
else: |
1553.7.1
by Robey Pointer
add --lsprof-file option to specify a file for writing lsprof data to (instead of dumping a pretty-print to the terminal) |
1062 |
argv_copy.append(a) |
1063 |
i += 1 |
|
974.1.26
by aaron.bentley at utoronto
merged mbp@sourcefrog.net-20050817233101-0939da1cf91f2472 |
1064 |
|
6437.6.1
by Vincent Ladeuil
Support scripts that don't call bzrlib.initialize() but still call run_bzr(). |
1065 |
if bzrlib.global_state is None: |
6437.6.2
by Vincent Ladeuil
Clarifying why we need to workaround bzrlib.initialize() not being called. |
1066 |
# FIXME: Workaround for users that imported bzrlib but didn't call
|
1067 |
# bzrlib.initialize -- vila 2012-01-19
|
|
6437.6.1
by Vincent Ladeuil
Support scripts that don't call bzrlib.initialize() but still call run_bzr(). |
1068 |
cmdline_overrides = config.CommandLineStore() |
1069 |
else: |
|
1070 |
cmdline_overrides = bzrlib.global_state.cmdline_overrides |
|
1071 |
cmdline_overrides._from_cmdline(override_config) |
|
6161.1.4
by Vincent Ladeuil
Follow the lead of other 'global' options which are not declared in option.py but handled in bzrlib.commands.run_bzr instead. |
1072 |
|
4070.8.2
by Martin Pool
Initial support for debug_flags config option |
1073 |
debug.set_debug_flags_from_config() |
1074 |
||
5051.1.1
by Robert Collins
* ``bzrlib.comands.run_bzr`` is more extensible: callers can supply the |
1075 |
if not opt_no_plugins: |
1076 |
load_plugins() |
|
1077 |
else: |
|
1078 |
disable_plugins() |
|
1079 |
||
1553.7.1
by Robey Pointer
add --lsprof-file option to specify a file for writing lsprof data to (instead of dumping a pretty-print to the terminal) |
1080 |
argv = argv_copy |
1616.1.15
by Martin Pool
Handle 'bzr ?', etc. |
1081 |
if (not argv): |
5051.1.1
by Robert Collins
* ``bzrlib.comands.run_bzr`` is more extensible: callers can supply the |
1082 |
get_cmd_object('help').run_argv_aliases([]) |
1165
by Martin Pool
- move parsing of argv into arguments and options into Command.run_argv |
1083 |
return 0 |
1084 |
||
1085 |
if argv[0] == '--version': |
|
5051.1.1
by Robert Collins
* ``bzrlib.comands.run_bzr`` is more extensible: callers can supply the |
1086 |
get_cmd_object('version').run_argv_aliases([]) |
1165
by Martin Pool
- move parsing of argv into arguments and options into Command.run_argv |
1087 |
return 0 |
3755.1.1
by Vincent Ladeuil
Fix --verbose leaking into blackbox tests. |
1088 |
|
1553.6.17
by Erik BÃ¥gfors
fix for broken --no-aliases |
1089 |
alias_argv = None |
1090 |
||
1553.6.1
by Erik BÃ¥gfors
support for aliases in bazaar.conf |
1091 |
if not opt_no_aliases: |
1553.6.8
by Erik BÃ¥gfors
support for overrides |
1092 |
alias_argv = get_alias(argv[0]) |
1093 |
if alias_argv: |
|
1094 |
argv[0] = alias_argv.pop(0) |
|
1553.6.1
by Erik BÃ¥gfors
support for aliases in bazaar.conf |
1095 |
|
1948.1.1
by John Arbash Meinel
Raise a reasonable error when a command is non-ascii |
1096 |
cmd = argv.pop(0) |
1162
by Martin Pool
- change Command infrastructure to use (mostly stateless) objects to |
1097 |
cmd_obj = get_cmd_object(cmd, plugins_override=not opt_builtin) |
5875.4.6
by INADA Naoki
Call i18n.install in get_help_text. |
1098 |
if opt_no_l10n: |
1099 |
cmd.l10n = False |
|
2367.2.1
by Robert Collins
Remove bzrlib 0.8 compatability where it was making the code unclear or messy. (Robert Collins) |
1100 |
run = cmd_obj.run_argv_aliases |
1101 |
run_argv = [argv, alias_argv] |
|
1534.7.154
by Aaron Bentley
Removed changes from bzr.ab 1529..1536 |
1102 |
|
1185.33.42
by Martin Pool
[patch] make --quiet a global option (robey) |
1103 |
try: |
3755.1.1
by Vincent Ladeuil
Fix --verbose leaking into blackbox tests. |
1104 |
# We can be called recursively (tests for example), but we don't want
|
1105 |
# the verbosity level to propagate.
|
|
1106 |
saved_verbosity_level = option._verbosity_level |
|
1107 |
option._verbosity_level = 0 |
|
1185.33.85
by Martin Pool
New --lsprof option from Denys Duchier |
1108 |
if opt_lsprof: |
3169.3.4
by Andrew Bennetts
Warn if --coverage is used with a conflicting global option. |
1109 |
if opt_coverage_dir: |
1110 |
trace.warning( |
|
1111 |
'--coverage ignored, because --lsprof is in use.') |
|
1581.1.1
by Robert Collins
Bugfix aliases to be backwards compatible with plugins providing command.run_argv. |
1112 |
ret = apply_lsprofiled(opt_lsprof_file, run, *run_argv) |
1185.33.85
by Martin Pool
New --lsprof option from Denys Duchier |
1113 |
elif opt_profile: |
3169.3.4
by Andrew Bennetts
Warn if --coverage is used with a conflicting global option. |
1114 |
if opt_coverage_dir: |
1115 |
trace.warning( |
|
1116 |
'--coverage ignored, because --profile is in use.') |
|
1581.1.1
by Robert Collins
Bugfix aliases to be backwards compatible with plugins providing command.run_argv. |
1117 |
ret = apply_profiled(run, *run_argv) |
3169.3.1
by Andrew Bennetts
Make --coverage a global option. |
1118 |
elif opt_coverage_dir: |
1119 |
ret = apply_coveraged(opt_coverage_dir, run, *run_argv) |
|
1185.33.42
by Martin Pool
[patch] make --quiet a global option (robey) |
1120 |
else: |
1581.1.1
by Robert Collins
Bugfix aliases to be backwards compatible with plugins providing command.run_argv. |
1121 |
ret = run(*run_argv) |
1185.33.42
by Martin Pool
[patch] make --quiet a global option (robey) |
1122 |
return ret or 0 |
1123 |
finally: |
|
3755.1.1
by Vincent Ladeuil
Fix --verbose leaking into blackbox tests. |
1124 |
# reset, in case we may do other commands later within the same
|
1125 |
# process. Commands that want to execute sub-commands must propagate
|
|
1126 |
# --verbose in their own way.
|
|
4682.1.1
by John Arbash Meinel
Put the 'debug_memory' check into the finally clause. |
1127 |
if 'memory' in debug.debug_flags: |
1128 |
trace.debug_memory('Process status after command:', short=False) |
|
3755.1.1
by Vincent Ladeuil
Fix --verbose leaking into blackbox tests. |
1129 |
option._verbosity_level = saved_verbosity_level |
6161.1.5
by Vincent Ladeuil
Get rid of the --override-config long name, ensures the overrides are resest when the command has run. |
1130 |
# Reset the overrides
|
6437.6.1
by Vincent Ladeuil
Support scripts that don't call bzrlib.initialize() but still call run_bzr(). |
1131 |
cmdline_overrides._reset() |
267
by Martin Pool
- better reporting of errors |
1132 |
|
4000.1.1
by Robert Collins
Add a new hook Commands['extend_command'] for plugins that want to alter commands without overriding the entire command. |
1133 |
|
1185.12.56
by Aaron Bentley
Prevented display commands from printing broken pipe errors |
1134 |
def display_command(func): |
1185.33.18
by Martin Pool
[patch] handle bad IOError subclass raised by urlopen |
1135 |
"""Decorator that suppresses pipe/interrupt errors."""
|
1185.12.56
by Aaron Bentley
Prevented display commands from printing broken pipe errors |
1136 |
def ignore_pipe(*args, **kwargs): |
1137 |
try: |
|
1185.35.22
by Aaron Bentley
Handled more pipe errors for display commands. |
1138 |
result = func(*args, **kwargs) |
1139 |
sys.stdout.flush() |
|
1140 |
return result |
|
1185.12.56
by Aaron Bentley
Prevented display commands from printing broken pipe errors |
1141 |
except IOError, e: |
1963.2.6
by Robey Pointer
pychecker is on crack; go back to using 'is None'. |
1142 |
if getattr(e, 'errno', None) is None: |
1185.33.18
by Martin Pool
[patch] handle bad IOError subclass raised by urlopen |
1143 |
raise
|
1185.12.56
by Aaron Bentley
Prevented display commands from printing broken pipe errors |
1144 |
if e.errno != errno.EPIPE: |
1711.4.31
by John Arbash Meinel
Catch proper error instead of EPIPE on win32, also don't double flush |
1145 |
# Win32 raises IOError with errno=0 on a broken pipe
|
2304.2.1
by Alexander Belchenko
Suppress IOError with errno=22 (Invalid argument) on win32 when pipe is broken |
1146 |
if sys.platform != 'win32' or (e.errno not in (0, errno.EINVAL)): |
1711.4.31
by John Arbash Meinel
Catch proper error instead of EPIPE on win32, also don't double flush |
1147 |
raise
|
1185.33.18
by Martin Pool
[patch] handle bad IOError subclass raised by urlopen |
1148 |
pass
|
1185.12.69
by Aaron Bentley
Ignored ^C in display commands |
1149 |
except KeyboardInterrupt: |
1490
by Robert Collins
Implement a 'bzr push' command, with saved locations; update diff to return 1. |
1150 |
pass
|
1185.12.56
by Aaron Bentley
Prevented display commands from printing broken pipe errors |
1151 |
return ignore_pipe |
267
by Martin Pool
- better reporting of errors |
1152 |
|
1185.43.6
by Martin Pool
Enable logging early enough to save argv |
1153 |
|
4119.3.8
by Robert Collins
Get missing command support sorted out. |
1154 |
def install_bzr_command_hooks(): |
1155 |
"""Install the hooks to supply bzr's own commands."""
|
|
4119.3.13
by Robert Collins
Unbreak blackbox tests. |
1156 |
if _list_bzr_commands in Command.hooks["list_commands"]: |
1157 |
return
|
|
4119.3.8
by Robert Collins
Get missing command support sorted out. |
1158 |
Command.hooks.install_named_hook("list_commands", _list_bzr_commands, |
1159 |
"bzr commands") |
|
1160 |
Command.hooks.install_named_hook("get_command", _get_bzr_command, |
|
1161 |
"bzr commands") |
|
1162 |
Command.hooks.install_named_hook("get_command", _get_plugin_command, |
|
1163 |
"bzr plugin commands") |
|
1164 |
Command.hooks.install_named_hook("get_command", _get_external_command, |
|
1165 |
"bzr external command lookup") |
|
6161.1.1
by Vincent Ladeuil
Allow config options to be overridden from the command line |
1166 |
Command.hooks.install_named_hook("get_missing_command", |
1167 |
_try_plugin_provider, |
|
1168 |
"bzr plugin-provider-db check") |
|
4119.3.8
by Robert Collins
Get missing command support sorted out. |
1169 |
|
1170 |
||
5017.1.1
by Martin Pool
Add bzrlib.initialize |
1171 |
|
1172 |
def _specified_or_unicode_argv(argv): |
|
1173 |
# For internal or testing use, argv can be passed. Otherwise, get it from
|
|
1174 |
# the process arguments in a unicode-safe way.
|
|
4355.2.1
by Alexander Belchenko
Using unicode Windows API to obtain command-line arguments. |
1175 |
if argv is None: |
5274.4.8
by Jason Spashett
Reverse merge -r 5280..5279 |
1176 |
return osutils.get_unicode_argv() |
4355.2.1
by Alexander Belchenko
Using unicode Windows API to obtain command-line arguments. |
1177 |
else: |
4355.2.3
by Alexander Belchenko
commands.py: main() function expect to get argv argument as list of unicode or pure ascii strings. |
1178 |
new_argv = [] |
4355.2.1
by Alexander Belchenko
Using unicode Windows API to obtain command-line arguments. |
1179 |
try: |
4355.2.3
by Alexander Belchenko
commands.py: main() function expect to get argv argument as list of unicode or pure ascii strings. |
1180 |
# ensure all arguments are unicode strings
|
5785.1.2
by Martin
Move _specified_or_unicode_argv call inside run_bzr as it may raise an error that should be reported |
1181 |
for a in argv: |
4355.2.3
by Alexander Belchenko
commands.py: main() function expect to get argv argument as list of unicode or pure ascii strings. |
1182 |
if isinstance(a, unicode): |
1183 |
new_argv.append(a) |
|
1184 |
else: |
|
1185 |
new_argv.append(a.decode('ascii')) |
|
4355.2.1
by Alexander Belchenko
Using unicode Windows API to obtain command-line arguments. |
1186 |
except UnicodeDecodeError: |
1187 |
raise errors.BzrError("argv should be list of unicode strings.") |
|
5017.1.1
by Martin Pool
Add bzrlib.initialize |
1188 |
return new_argv |
1189 |
||
1190 |
||
1191 |
def main(argv=None): |
|
1192 |
"""Main entry point of command-line interface.
|
|
1193 |
||
1194 |
Typically `bzrlib.initialize` should be called first.
|
|
1195 |
||
1196 |
:param argv: list of unicode command-line arguments similar to sys.argv.
|
|
1197 |
argv[0] is script name usually, it will be ignored.
|
|
1198 |
Don't pass here sys.argv because this list contains plain strings
|
|
1199 |
and not unicode; pass None instead.
|
|
1200 |
||
1201 |
:return: exit code of bzr command.
|
|
1202 |
"""
|
|
5785.1.2
by Martin
Move _specified_or_unicode_argv call inside run_bzr as it may raise an error that should be reported |
1203 |
if argv is not None: |
1204 |
argv = argv[1:] |
|
5018.1.3
by Martin Pool
Put builtin commands into a real registry |
1205 |
_register_builtin_commands() |
1185.85.4
by John Arbash Meinel
currently broken, trying to fix things up. |
1206 |
ret = run_bzr_catch_errors(argv) |
1996.3.1
by John Arbash Meinel
Demandloading builtins.py drops our load time from 350ms to 291ms |
1207 |
trace.mutter("return code %d", ret) |
1185.43.6
by Martin Pool
Enable logging early enough to save argv |
1208 |
return ret |
1185.3.19
by Martin Pool
- split out commandline error reporting for ease of testing |
1209 |
|
1210 |
||
1211 |
def run_bzr_catch_errors(argv): |
|
4084.6.1
by Robert Collins
Refactor profiling exception handling to restore clear layers - command handling in commands.py, profiling in lsprof.py. |
1212 |
"""Run a bzr command with parameters as described by argv.
|
4084.6.3
by Robert Collins
Disagreement on trailing whitespace with the test suite. |
1213 |
|
4084.6.1
by Robert Collins
Refactor profiling exception handling to restore clear layers - command handling in commands.py, profiling in lsprof.py. |
1214 |
This function assumed that that UI layer is setup, that symbol deprecations
|
1215 |
are already applied, and that unicode decoding has already been performed on argv.
|
|
1216 |
"""
|
|
5017.1.1
by Martin Pool
Add bzrlib.initialize |
1217 |
# done here so that they're covered for every test run
|
4119.3.13
by Robert Collins
Unbreak blackbox tests. |
1218 |
install_bzr_command_hooks() |
4084.6.1
by Robert Collins
Refactor profiling exception handling to restore clear layers - command handling in commands.py, profiling in lsprof.py. |
1219 |
return exception_to_return_code(run_bzr, argv) |
1
by mbp at sourcefrog
import from baz patch-364 |
1220 |
|
2432.1.2
by Robert Collins
Add a HelpCommandContext class for help from commands. |
1221 |
|
2830.2.1
by Martin Pool
If TestCase.run_bzr hits an internal exception, don't catch it but rather propagate up into the test suite |
1222 |
def run_bzr_catch_user_errors(argv): |
1223 |
"""Run bzr and report user errors, but let internal errors propagate.
|
|
1224 |
||
1225 |
This is used for the test suite, and might be useful for other programs
|
|
1226 |
that want to wrap the commandline interface.
|
|
1227 |
"""
|
|
5017.1.1
by Martin Pool
Add bzrlib.initialize |
1228 |
# done here so that they're covered for every test run
|
4119.3.13
by Robert Collins
Unbreak blackbox tests. |
1229 |
install_bzr_command_hooks() |
2830.2.1
by Martin Pool
If TestCase.run_bzr hits an internal exception, don't catch it but rather propagate up into the test suite |
1230 |
try: |
1231 |
return run_bzr(argv) |
|
1232 |
except Exception, e: |
|
1233 |
if (isinstance(e, (OSError, IOError)) |
|
1234 |
or not getattr(e, 'internal_error', True)): |
|
1235 |
trace.report_exception(sys.exc_info(), sys.stderr) |
|
1236 |
return 3 |
|
1237 |
else: |
|
1238 |
raise
|
|
1239 |
||
1240 |
||
2432.1.15
by Robert Collins
Rename Context (in bzrlib.help) to Index, for a clearer name. |
1241 |
class HelpCommandIndex(object): |
1242 |
"""A index for bzr help that returns commands."""
|
|
2432.1.2
by Robert Collins
Add a HelpCommandContext class for help from commands. |
1243 |
|
2432.1.17
by Robert Collins
Add prefixes to HelpIndexes. |
1244 |
def __init__(self): |
1245 |
self.prefix = 'commands/' |
|
1246 |
||
2432.1.13
by Robert Collins
HelpCommandContext now implementes get_topics. |
1247 |
def get_topics(self, topic): |
1248 |
"""Search for topic amongst commands.
|
|
1249 |
||
1250 |
:param topic: A topic to search for.
|
|
1251 |
:return: A list which is either empty or contains a single
|
|
1252 |
Command entry.
|
|
1253 |
"""
|
|
2432.1.18
by Robert Collins
Add support for doing bzr help commands/COMMANDNAME. |
1254 |
if topic and topic.startswith(self.prefix): |
1255 |
topic = topic[len(self.prefix):] |
|
2432.1.13
by Robert Collins
HelpCommandContext now implementes get_topics. |
1256 |
try: |
5058.2.1
by Robert Collins
* ``bzr help`` will no longer trigger the get_missing_command hook when |
1257 |
cmd = _get_cmd_object(topic, check_missing=False) |
2432.1.13
by Robert Collins
HelpCommandContext now implementes get_topics. |
1258 |
except KeyError: |
1259 |
return [] |
|
1260 |
else: |
|
1261 |
return [cmd] |
|
1262 |
||
2432.1.2
by Robert Collins
Add a HelpCommandContext class for help from commands. |
1263 |
|
3246.7.1
by Martin Albisetti
Core code for automatic plugin suggestion |
1264 |
class Provider(object): |
5891.1.3
by Andrew Bennetts
Move docstring formatting fixes. |
1265 |
"""Generic class to be overriden by plugins"""
|
3246.7.1
by Martin Albisetti
Core code for automatic plugin suggestion |
1266 |
|
1267 |
def plugin_for_command(self, cmd_name): |
|
5891.1.3
by Andrew Bennetts
Move docstring formatting fixes. |
1268 |
"""Takes a command and returns the information for that plugin
|
3943.8.1
by Marius Kruger
remove all trailing whitespace from bzr source |
1269 |
|
1270 |
:return: A dictionary with all the available information
|
|
5891.1.3
by Andrew Bennetts
Move docstring formatting fixes. |
1271 |
for the requested plugin
|
1272 |
"""
|
|
3246.7.1
by Martin Albisetti
Core code for automatic plugin suggestion |
1273 |
raise NotImplementedError |
1274 |
||
1275 |
||
1276 |
class ProvidersRegistry(registry.Registry): |
|
5891.1.3
by Andrew Bennetts
Move docstring formatting fixes. |
1277 |
"""This registry exists to allow other providers to exist"""
|
3246.7.3
by Martin Albisetti
Code cleanup and documentation |
1278 |
|
3246.7.1
by Martin Albisetti
Core code for automatic plugin suggestion |
1279 |
def __iter__(self): |
1280 |
for key, provider in self.iteritems(): |
|
1281 |
yield provider |
|
1282 |
||
1283 |
command_providers_registry = ProvidersRegistry() |