boolean
Parses Boolean Pydantic Fields to Command-Line Arguments.
The boolean
module contains the should_parse
function, which checks whether
this module should be used to parse the field, as well as the parse_field
function, which parses boolean pydantic
model fields to ArgumentParser
command-line arguments.
should_parse(field)
Checks whether the field should be parsed as a boolean
.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
field |
pydantic.fields.ModelField |
Field to check. |
required |
Returns:
Type | Description |
---|---|
bool |
Whether the field should be parsed as a |
Source code in pydantic_argparse/parsers/boolean.py
def should_parse(field: pydantic.fields.ModelField) -> bool:
"""Checks whether the field should be parsed as a `boolean`.
Args:
field (pydantic.fields.ModelField): Field to check.
Returns:
bool: Whether the field should be parsed as a `boolean`.
"""
# Check and Return
return utils.types.is_field_a(field, bool)
parse_field(parser, field)
Adds boolean pydantic field to argument parser.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
parser |
argparse.ArgumentParser |
Argument parser to add to. |
required |
field |
pydantic.fields.ModelField |
Field to be added to parser. |
required |
Returns:
Type | Description |
---|---|
Optional[utils.pydantic.PydanticValidator] |
Possible validator method. |
Source code in pydantic_argparse/parsers/boolean.py
def parse_field(
parser: argparse.ArgumentParser,
field: pydantic.fields.ModelField,
) -> Optional[utils.pydantic.PydanticValidator]:
"""Adds boolean pydantic field to argument parser.
Args:
parser (argparse.ArgumentParser): Argument parser to add to.
field (pydantic.fields.ModelField): Field to be added to parser.
Returns:
Optional[utils.pydantic.PydanticValidator]: Possible validator method.
"""
# Compute Argument Intrinsics
is_inverted = not field.required and bool(field.get_default())
# Determine Argument Properties
action = (
actions.BooleanOptionalAction
if field.required
else argparse._StoreFalseAction
if is_inverted
else argparse._StoreTrueAction
)
# Add Boolean Field
parser.add_argument(
utils.arguments.name(field, is_inverted),
action=action,
help=utils.arguments.description(field),
dest=field.alias,
required=bool(field.required),
)
# Construct and Return Validator
return utils.pydantic.as_validator(field, lambda v: v)