Validate Call
Decorator for validating function calls.
validate_call ¶
validate_call(
__func=None, *, config=None, validate_return=False
)
Usage Documentation
Returns a decorated wrapper around the function that validates the arguments and, optionally, the return value.
Usage may be either as a plain decorator @validate_call
or with arguments @validate_call(...)
.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
__func |
AnyCallableT | None
|
The function to be decorated. |
None
|
config |
ConfigDict | None
|
The configuration dictionary. |
None
|
validate_return |
bool
|
Whether to validate the return value. |
False
|
Returns:
Type | Description |
---|---|
AnyCallableT | Callable[[AnyCallableT], AnyCallableT]
|
The decorated function. |
Source code in pydantic/validate_call_decorator.py
29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 |
|