Skip to content

errors

Errors Utility Functions for Declarative Typed Argument Parsing.

The errors module contains a utility function used for formatting pydantic Validation Errors to human readable messages.

format(error)

Formats a pydantic error into a human readable format.

Parameters:

Name Type Description Default
error PydanticError

pydantic error to be formatted.

 required

Returns:

Type Description
str

pydantic error in a human readable format.
Source code in pydantic_argparse/utils/errors.py 
def format(error: PydanticError) -> str:  # noqa: A001
    """Formats a `pydantic` error into a human readable format.

    Args:
        error (PydanticError): `pydantic` error to be formatted.

    Returns:
        str: `pydantic` error in a human readable format.
    """
    # Format and Return
    return str(error)