cachai.utilities.validate_kwargs

cachai.utilities.validate_kwargs(keys, allowed_keys, aliases={})[source]

Validates that given keyword arguments are within the allowed set of parameters.

Parameters

keyslist or array-like: A list with the name of the key arguments you want to validate.
allowed_keyslist or array-like: A list with the name of the valid arguments.
aliasesdict, optional: A python dictionary with alternative aliases for the key arguments ().

Examples

import cachai.utilities as chu

user_given_kwargs = {'name': 'Agustina', 'favorite_artist': 'Chappell Roan'}

allowed_params  = ['name', 'age', 'favorite_color']
aliases         = {'favorite_color': 'favc'}

chu.validate_kwargs(user_given_kwargs.keys(),allowed_params,aliases)

---------------------------------------------------------------------------
Traceback (most recent call last):
    line 8
KeyError: 'Invalid argument "favorite_artist". Allowed arguments are: name, age, favorite_color / favc.'