57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232 | def apply_callback_arguments( # noqa: C901
*callbacks: Callable[..., Any],
**callback_parameter_names: str,
) -> Callable[..., Callable[..., Any]]:
"""
This decorator maps parameter names to callback arguments.
Each key represents the name of a parameter in the decorated function
which accepts an explicit input, and the corresponding mapped value is
an argument to pass to the provided callback function(s).
Parameters:
*callbacks: One or more callback functions. If both synchronous and
asynchronous functions are provided, they will be used
appropriately based on the decorated function's type, otherwise
synchronous functions will be wrapped for asynchronous use
and vice versa.
**callback_parameter_names:
A mapping of static parameter names to callback parameter names.
Returns:
A decorator function which retrieves argument values by
passing callback function arguments to the callback, and
applying the output to their mapped static parameters.
Examples:
>>> @apply_callback_arguments(
... lambda x: x * 2,
... {"x": "x_lookup_args"},
... )
... def return_value(
... x: int | None = None,
... x_lookup_args: tuple[
... Sequence[int],
... Mapping[str, int],
... ]
... | None = None,
... ) -> int:
... return x**2
>>> return_value(
... x_lookup_args=(
... 3,
... None,
... )
... )
36
"""
callback: Callable[..., Any]
async_callback: Callable[..., Any]
callback, async_callback = _get_sync_async_callbacks(*callbacks)
def decorating_function( # noqa: C901
function: Callable[..., Any],
) -> Callable[..., Any]:
original_function: Callable[..., Any] = unwrap_function(function)
function_signature: Signature = signature(original_function)
def get_args_kwargs( # noqa: C901
*args: Any, **kwargs: Any
) -> tuple[tuple[Any, ...], dict[str, Any]]:
"""
This function performs lookups for any parameters for which an
argument is not passed explicitly.
"""
# Capture errors
errors: dict[str, list[str]] = _get_errors(original_function)
# First we consolidate the keyword arguments with any arguments
# which are passed to parameters which can be either positional
# *or* keyword arguments, and were passed as positional arguments
args = merge_function_signature_args_kwargs(
function_signature, args, kwargs
)
# For any arguments where we have callback arguments and do not
# have an explicitly passed value, execute the callback
key: str
value: Any
used_keys: set[str] = {
key for key, value in kwargs.items() if value is not None
}
unused_callback_parameter_names: set[str] = (
set(callback_parameter_names.values()) & used_keys
)
parameter_name: str
for parameter_name in (
set(callback_parameter_names.keys()) - used_keys
):
callback_parameter_name: str = callback_parameter_names[
parameter_name
]
unused_callback_parameter_names.discard(
callback_parameter_name
)
callback_argument: Any = kwargs.pop(
callback_parameter_name, None
)
parameter: Parameter | None = (
function_signature.parameters.get(parameter_name)
)
callback_: Callable[..., Any] = callback
if (
(parameter is not None)
and (isinstance(parameter.annotation, type))
and issubclass(Coroutine, parameter.annotation)
):
callback_ = async_callback
if callback_argument is not None:
try:
kwargs[parameter_name] = callback_(callback_argument)
# Clear preceding errors for this parameter
errors.pop(parameter_name, None)
except Exception: # noqa: BLE001
errors.setdefault(parameter_name, [])
errors[parameter_name].append(get_exception_text())
elif callback_parameter_name in function_signature.parameters:
default: tuple[Sequence[Any], Mapping[str, Any]] | None = (
function_signature.parameters[
callback_parameter_name
].default
)
if default not in (Signature.empty, None):
try:
kwargs[parameter_name] = callback_(default)
# Clear preceding errors for this parameter
errors.pop(parameter_name, None)
except Exception: # noqa: BLE001
errors.setdefault(parameter_name, [])
errors[parameter_name].append(get_exception_text())
if (function is original_function) and errors:
arguments_error_messages: dict[str, list[str]] = {}
for key, argument_error_messages in errors.items():
# Don't raise an error for parameters which
# have a value or default value
if kwargs.get(key) is None:
parameter = function_signature.parameters.get(key)
if parameter and (
parameter.default is Signature.empty
):
arguments_error_messages[key] = (
argument_error_messages
)
# Clear global errors collection
del _FUNCTIONS_ERRORS[id(function)]
if arguments_error_messages:
raise ArgumentsResolutionError(
arguments_error_messages
)
# Remove unused callback arguments
deque(map(kwargs.pop, unused_callback_parameter_names), maxlen=0)
return (args, kwargs)
if iscoroutinefunction(function):
@wraps(function)
async def wrapper(*args: Any, **kwargs: Any) -> Any:
"""
This function wraps the original and performs lookups for
any parameters for which an argument is not passed
"""
args, kwargs = get_args_kwargs(*args, **kwargs)
# Execute the wrapped function
return await function(*args, **kwargs)
else:
@wraps(function)
def wrapper(*args: Any, **kwargs: Any) -> Any:
"""
This function wraps the original and performs lookups for
any parameters for which an argument is not passed
"""
args, kwargs = get_args_kwargs(*args, **kwargs)
# Execute the wrapped function
return function(*args, **kwargs)
return wrapper
return decorating_function
|