dataclass

Enhanced dataclass functionality for parameter handling.

This module extends Python’s standard dataclasses with additional capabilities for handling required and optional parameters in a more controlled way.

Key features:

• Use sentinel values (REQ, OPT) to mark required and optional fields

• Validation of required parameters during initialization

• Methods to convert dataclass instances to dictionaries with proper handling of sentinels

• Freedom from dataclass limitations on field ordering (required fields first)

class func_args.dataclass.BaseModelMixin

Base class for all parameter dataclasses with validation capabilities.

This class provides enhanced functionality for parameter validation and conversion that all parameter classes can inherit. It handles required parameter validation during initialization and provides utility methods to convert parameters to dictionaries suitable for function calls.

to_dict() → dict[str, Any]

Convert the dataclass to a complete dictionary with all fields.

to_kwargs() → dict[str, Any]

Convert the dataclass to a dictionary suitable for function calls.

class func_args.dataclass.BaseModel

class func_args.dataclass.BaseFrozenModel