func-args 1.0.1

Basic Sentinels

In this example, we create a wrapper around an AWS S3 put_object API:

def put_object(
    Bucket: str,
    Key: str,
    Body: bytes,
    Metadata: T.Optional[dict[str, str]] = ...,
    Tags: T.Optional[dict[str, str]] = ...,
):
    ...

from func_args.api import REQ, OPT, prepare_kwargs

# Our enhanced wrapper with REQ and OPT
def better_put_object(
    Bucket: str = REQ,
    Key: str = REQ,
    Body: bytes = REQ,
    Metadata: T.Optional[dict[str, str]] = OPT,
    Tags: T.Optional[dict[str, str]] = OPT,
):
    # custom parameter handling
    if Metadata is NA:
        Metadata = {"creator": "admin"}
    if Tags is NA:
        Tags = {"creator": "admin"}

    # Prepare kwargs with validation
    kwargs = dict(
        Bucket=Bucket,
        Key=Key,
        Body=Body,
        Metadata=Metadata,
        Tags=Tags,
    )

    # This will:
    # 1. Raise ParamError if any REQ values remain
    # 2. Remove any OPT values
    # 3. Return a clean dict with only provided values
    cleaned_kwargs = prepare_kwargs(kwargs)

    # Call the original API with only the necessary parameters
    return put_object(**cleaned_kwargs)

Required Parameter Validation

from func_args.arg import REQ, check_required

# Function with required parameters
def create_user(username=REQ, email=REQ, role="user"):
    # Validate required parameters
    check_required(username=username, email=email)

    # If we got here, all required parameters were provided
    return {"username": username, "email": email, "role": role}

# This works
user = create_user(username="alice", email="alice@example.com")

# This raises ParamError: "Missing required argument: 'email'"
try:
    user = create_user(username="bob")
except ParamError as e:
    print(e)

Optional Parameter Removal

from func_args.arg import OPT, remove_optional

# Function with many optional parameters
def search_items(query, limit=10, offset=0, sort_by=OPT, filter_by=OPT, include_deleted=False):
    # Build base query parameters
    params = {
        "query": query,
        "limit": limit,
        "offset": offset,
        "sort_by": sort_by,
        "filter_by": filter_by,
        "include_deleted": include_deleted,
    }

    # Remove optional parameters that weren't provided
    clean_params = remove_optional(**params)

    # Now we can safely pass to the API without sending None values or defaults
    return api_search(**clean_params)

Enhanced Dataclasses

import dataclasses
from func_args.dataclass import BaseModel, REQ, OPT

@dataclasses.dataclass
class UserParameters(BaseModel):
    """Parameter class for user operations with validation."""

    # Required fields
    username: str = dataclasses.field(default=REQ)
    email: str = dataclasses.field(default=REQ)

    # Optional fields
    display_name: str = dataclasses.field(default=OPT)
    role: str = dataclasses.field(default="user")
    tags: list = dataclasses.field(default_factory=list)

    def validate_email(self):
        """Additional validation logic."""
        if not "@" in self.email:
            raise ValueError("Invalid email format")

    def __post_init__(self):
        # Call the base class validation
        super().__post_init__()
        # Perform additional validation
        self.validate_email()

# Usage
params = UserParameters(username="alice", email="alice@example.com")

# Convert to dict with all fields (including OPT sentinel values)
full_dict = params.to_dict()
# {"username": "alice", "email": "alice@example.com", "display_name": OPT, "role": "user", "tags": []}

# Convert to dict with only provided values (excluding OPT sentinels)
kwargs = params.to_kwargs()
# {"username": "alice", "email": "alice@example.com", "role": "user", "tags": []}