one_of

hone(msg, context=None, description=None, include_traceback=True)

Create a function to repackage the issue with a new message and context.

Parameters:

Name	Type	Description	Default
msg	str	The new message.	required
context	object | None	The new context.	None
description	str | None	The new description.	None
include_traceback	bool	Whether to include the traceback.	True

Returns:

Type	Description
Callable[[Issue], OneOf[Issue, Any]]	A function that takes an issue and returns a new issue.

Source code in m/core/one_of.py

def hone(
    msg: str,
    context: object | None = None,
    description: str | None = None,
    include_traceback: bool = True,
) -> Callable[[Issue], OneOf[Issue, Any]]:
    """Create a function to repackage the issue with a new message and context.

    Args:
        msg: The new message.
        context: The new context.
        description: The new description.
        include_traceback: Whether to include the traceback.

    Returns:
        A function that takes an issue and returns a new issue.
    """
    return partial(_hone, msg, context, description, include_traceback)

issue(message, description=None, cause=None, context=None, include_traceback=True)

Shortcut to create a Bad OneOf containing an Issue.

Parameters:

Name	Type	Description	Default
message	str	The issue message.	required
description	str | None	Optional description.	None
cause	Exception | None	Optional exception that caused the issue.	None
context	object | None	Optional dictionary to provide extra information.	None
include_traceback	bool	Defaults to true to provide the stack trace.	True

Returns:

Type	Description
OneOf[Issue, Any]	An instance of an Issue.

Source code in m/core/one_of.py

def issue(  # noqa: WPS211
    message: str,
    description: str | None = None,
    cause: Exception | None = None,
    context: object | None = None,
    include_traceback: bool = True,
) -> OneOf[Issue, Any]:
    """Shortcut to create a Bad OneOf containing an Issue.

    Args:
        message: The issue message.
        description: Optional description.
        cause: Optional exception that caused the issue.
        context: Optional dictionary to provide extra information.
        include_traceback: Defaults to true to provide the stack trace.

    Returns:
        An instance of an `Issue`.
    """
    inst = Issue(message, description, cause, context, include_traceback)
    return Bad(inst)

non_issue(inst)

Obtain the value of the OneOf as if it was a Good value.

Warning: This should only be used provided that we know for sure that we are not dealing with a Bad value.

Parameters:

Name	Type	Description	Default
inst	OneOf[Issue, G]	A OneOf.	required

Returns:

Type	Description
G	The value stored in the OneOf.

Source code in m/core/one_of.py

def non_issue(inst: OneOf[Issue, G]) -> G:
    """Obtain the value of the `OneOf` as if it was a Good value.

    Warning: This should only be used provided that we know for sure
    that we are not dealing with a `Bad` value.

    Args:
        inst: A OneOf.

    Returns:
        The value stored in the OneOf.
    """
    # The assert statement can go away with the -O flag.
    assert not inst.is_bad  # noqa: S101
    return cast(G, inst.value)

one_of(comp)

Handle the "Good" value of a OneOf.

To be used so that we may iterate over OneOf objects that may raise the StopBadIteration exception.

Parameters:

Name	Type	Description	Default
comp	Callable[[], list[G]]	A lambda function returning an array with a single value.	required

Returns:

Type	Description
OneOf[Any, G]	A OneOf with the value returned from comp.

Source code in m/core/one_of.py

def one_of(comp: Callable[[], list[G]]) -> OneOf[Any, G]:
    """Handle the "Good" value of a `OneOf`.

    To be used so that we may iterate over OneOf objects that may raise
    the `StopBadIteration` exception.

    Args:
        comp: A lambda function returning an array with a single value.

    Returns:
        A `OneOf` with the value returned from `comp`.
    """
    res = None
    try:
        res = comp()
    except StopBadIteration as ex:
        return cast(Bad, ex.bad)
    except ValidationError as ex:
        return issue('pydantic validation error', cause=ex)
    except Exception as ex:
        return issue('one_of caught exception', cause=ex)
    if res:
        return Good(res[0])
    # LOOK AT ME - you may be here because a mock is not returning a OneOf.
    return issue('one_of empty response - iteration missing a OneOf')

to_one_of(callback, message, context=None)

Wrap a python call in a OneOf.

Parameters:

Name	Type	Description	Default
callback	Callable[[], Any]	A lambda function with a simple python statement.	required
message	str	An error message in case the statement raises an exception.	required
context	object | None	Additional error context.	None

Returns:

Type	Description
OneOf[Issue, int]	A OneOf containing an Issue if the callback raises an error.

Source code in m/core/one_of.py

def to_one_of(
    callback: Callable[[], Any],
    message: str,
    context: object | None = None,
) -> OneOf[Issue, int]:
    """Wrap a python call in a `OneOf`.

    Args:
        callback: A lambda function with a simple python statement.
        message: An error message in case the statement raises an exception.
        context: Additional error context.

    Returns:
        A `OneOf` containing an `Issue` if the callback raises an error.
    """
    try:
        callback()
    except Exception as ex:
        return issue(message, cause=ex, context=context)
    return Good(0)