qfinbox.core.validators

Input validation utilities for qfinbox.

Functions

validate_positive(value[, name])	Validate that a value is positive.
validate_returns(returns)	Validate return data.
validate_weights(weights)	Validate portfolio weights.

Exceptions

ValidationError

Raised when input validation fails.

qfinbox.core.validators.validate_weights(weights: ndarray | Series | list) → ndarray

Validate portfolio weights.

Parameters:

weights (array-like) – Portfolio weights to validate.

Returns:

Validated weights as numpy array.

Return type:

np.ndarray

Raises:

ValidationError – If weights are invalid.

qfinbox.core.validators.validate_returns(returns: ndarray | Series | DataFrame) → ndarray

Validate return data.

Parameters:

returns (array-like) – Return data to validate.

Returns:

Validated returns as numpy array.

Return type:

np.ndarray

Raises:

ValidationError – If returns are invalid.

qfinbox.core.validators.validate_positive(value: float, name: str = 'value') → float

Validate that a value is positive.

Parameters:

• value (float) – Value to validate.

• name (str, default "value") – Name of the parameter for error messages.

Returns:

The validated value.

Return type:

float

Raises:

ValidationError – If value is not positive.