brails.utils.inventory_validator module

This module provides a utility class for validating AssetInventory objects.

InventoryValidator()

A utility class for validating AssetInventory objects.

class brails.utils.inventory_validator.InventoryValidator

Bases: object

A utility class for validating AssetInventory objects.

This class provides static methods for checking whether a given object is a valid instance of AssetInventory, and for enforcing that validation with clear error reporting.

Methods: is_inventory(inventory: AssetInventory) -> bool:

Returns True if the input is an instance of AssetInventory, otherwise False.

validate_inventory(inventory: AssetInventory) -> None:

Raises a TypeError if the input is not an instance of AssetInventory.

Examples: >>> from brails.utils.input_validator import InventoryValidator >>> inventory = AssetInventory(…) # assume valid initialization >>> InventoryValidator.is_inventory(inventory) True >>> InventoryValidator.validate_inventory(inventory) # passes silently

>>> InventoryValidator.validate_inventory("not an inventory")
Traceback (most recent call last):
    ...
TypeError: Expected an instance of AssetInventory for inventory input.

static is_inventory(inventory: Any) → bool

Check if the given object is an instance of AssetInventory.

Args:

inventory (Any):

The object to check.

Returns:

bool:

True if the object is an instance of AssetInventory, False otherwise.

static validate_inventory(inventory: Any) → None

Validate that the input is an instance of AssetInventory.

Args:

inventory (Any):

The object to validate.

Raises:

TypeError:

If the input is not an instance of AssetInventory.