-
Notifications
You must be signed in to change notification settings - Fork 122
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add a new `pluggy.callers._MultiCall` implementation which removes support the implicit `__multicall__` special argument and drops the recursion required to handle hook wrappers. Rename the original implementation `_LegacyMultiCall` and load it only when the `__multicall__` argument is detected in a hookimpl function signature. Add a deprecation warning whenever the legacy fallback occurs. Resolves #23
- Loading branch information
Tyler Goodlet
committed
Jul 9, 2017
1 parent
fb00c4e
commit 845c502
Showing
2 changed files
with
120 additions
and
12 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,108 @@ | ||
''' | ||
Call loop machinery | ||
''' | ||
import sys | ||
|
||
|
||
_py3 = sys.version_info > (3, 0) | ||
|
||
|
||
if not _py3: | ||
exec(""" | ||
def _reraise(cls, val, tb): | ||
raise cls, val, tb | ||
""") | ||
|
||
|
||
def _raise_wrapfail(wrap_controller, msg): | ||
co = wrap_controller.gi_code | ||
raise RuntimeError("wrap_controller at %r %s:%d %s" % | ||
(co.co_name, co.co_filename, co.co_firstlineno, msg)) | ||
|
||
|
||
class HookCallError(Exception): | ||
""" Hook was called wrongly. """ | ||
|
||
|
||
class Result(object): | ||
def __init__(self, result, excinfo): | ||
self.result = result | ||
self.excinfo = excinfo | ||
|
||
def force_result(self, result): | ||
self.result = result | ||
self.excinfo = None | ||
|
||
def get_result(self): | ||
if self.excinfo is None: | ||
return self.result | ||
else: | ||
ex = self.excinfo | ||
if _py3: | ||
raise ex[1].with_traceback(ex[2]) | ||
_reraise(*ex) # noqa | ||
|
||
|
||
class _MultiCall(object): | ||
"""Execute a call into multiple python functions/methods. | ||
""" | ||
def __init__(self, hook_impls, kwargs, specopts={}, hook=None): | ||
self.hook = hook | ||
self.hook_impls = hook_impls | ||
self.caller_kwargs = kwargs # come from _HookCaller.__call__() | ||
self.specopts = hook.spec_opts if hook else specopts | ||
|
||
def execute(self): | ||
caller_kwargs = self.caller_kwargs | ||
self.results = results = [] | ||
firstresult = self.specopts.get("firstresult") | ||
excinfo = None | ||
try: # run impl and wrapper setup functions in a loop | ||
teardowns = [] | ||
try: | ||
for hook_impl in reversed(self.hook_impls): | ||
try: | ||
args = [caller_kwargs[argname] for argname in hook_impl.argnames] | ||
# args = operator.itemgetter(hookimpl.argnames)(caller_kwargs) | ||
except KeyError: | ||
for argname in hook_impl.argnames: | ||
if argname not in caller_kwargs: | ||
raise HookCallError( | ||
"hook call must provide argument %r" % (argname,)) | ||
|
||
if hook_impl.hookwrapper: | ||
try: | ||
gen = hook_impl.function(*args) | ||
next(gen) # first yield | ||
teardowns.append(gen) | ||
except StopIteration: | ||
_raise_wrapfail(gen, "did not yield") | ||
else: | ||
res = hook_impl.function(*args) | ||
if res is not None: | ||
results.append(res) | ||
if firstresult: # halt further impl calls | ||
break | ||
except BaseException: | ||
excinfo = sys.exc_info() | ||
finally: | ||
outcome = Result(results, excinfo) | ||
|
||
# run all wrapper post-yield blocks | ||
for gen in reversed(teardowns): | ||
try: | ||
gen.send(outcome) | ||
_raise_wrapfail(gen, "has second yield") | ||
except StopIteration: | ||
pass | ||
|
||
if firstresult: | ||
return outcome.get_result()[0] | ||
|
||
return outcome.get_result() | ||
|
||
def __repr__(self): | ||
status = "%d meths" % (len(self.hook_impls),) | ||
if hasattr(self, "results"): | ||
status = ("%d results, " % len(self.results)) + status | ||
return "<_MultiCall %s, kwargs=%r>" % (status, self.caller_kwargs) |