Skip to main content

​
resolve

Function
This function is defined in the param_resolver module.
Resolve a consolidated parameter following precedence rules: Instance > Config > Array > Dict > String > Bool > Default

​
Signature

def resolve(value: Any, param_name: str, config_class: Optional[Type], presets: Optional[Dict[str, Any]], default: Any, instance_check: Optional[Callable[[Any], bool]], url_schemes: Optional[Dict[str, str]], array_mode: Optional[str], string_mode: Optional[str]) -> Any

​
Parameters

​
value
Any
required
The parameter value
​
param_name
str
required
Name of the parameter (for error messages)
​
config_class
Optional
Expected config dataclass type
​
presets
Optional
Dict mapping preset strings to config dicts or instances
​
default
Any
Default value if None/unset
​
instance_check
Optional
Function to check if value is an instance
​
url_schemes
Optional
Dict mapping URL schemes to backend names
​
array_mode
Optional
How to handle array values (see ArrayMode)
​
string_mode
Optional
How to handle string values (“path_as_source”, etc.)

​
Returns

​
Returns
Any
Resolved config object or value

​
Exceptions

If value is invalid with helpful error message