Skip to main content

ArgumentsV3Validator

No overview available.

Attributes

AttributeTypeDescription
parametersVec< Parameter >A collection of parameter definitions used to validate and map input arguments to their respective schema fields.
positional_params_countusizeThe total number of arguments that can be processed positionally during validation.
loc_by_aliasboolDetermines whether error locations should be reported using the parameter's alias instead of its internal name.
extra[ExtraBehavior](../../../build/tools/extrabehavior.md?sid=build_tools_extrabehavior)Defines the validation behavior when encountering arguments that are not defined in the parameters list.
validate_by_aliasOption< bool >An optional flag to force validation using parameter aliases, overriding the default field-level settings.
validate_by_nameOption< bool >An optional flag to force validation using the internal parameter names, overriding the default field-level settings.

Constructor

Signature

def ArgumentsV3Validator(
parameters: Vec< Parameter >,
positional_params_count: usize,
loc_by_alias: bool,
extra: [ExtraBehavior](../../../build/tools/extrabehavior.md?sid=build_tools_extrabehavior),
validate_by_alias: Option< bool >,
validate_by_name: Option< bool >
) - > null

Parameters

NameTypeDescription
parametersVec< Parameter >A list of parameter definitions to validate against.
positional_params_countusizeThe number of parameters that are treated as positional.
loc_by_aliasboolWhether to use aliases for error location reporting.
extra[ExtraBehavior](../../../build/tools/extrabehavior.md?sid=build_tools_extrabehavior)The behavior to apply when extra arguments are encountered.
validate_by_aliasOption< bool >Optional flag to determine if validation should occur by alias.
validate_by_nameOption< bool >Optional flag to determine if validation should occur by name.

Signature

def ArgumentsV3Validator(
parameters: list[[Parameter](parameter.md?sid=validators_arguments_v3_parameter)],
positional_params_count: int,
loc_by_alias: bool,
extra: [ExtraBehavior](../../../build/tools/extrabehavior.md?sid=build_tools_extrabehavior),
validate_by_alias: bool | null,
validate_by_name: bool | null
) - > null

Parameters

NameTypeDescription
parameterslist[[Parameter](parameter.md?sid=validators_arguments_v3_parameter)]A collection of parameter definitions used to validate incoming arguments.
positional_params_countintThe number of parameters that can be passed positionally before keyword-only arguments begin.
loc_by_aliasboolDetermines whether error locations should be reported using the parameter alias instead of the internal name.
extra[ExtraBehavior](../../../build/tools/extrabehavior.md?sid=build_tools_extrabehavior)Defines how the validator should handle unexpected extra arguments (e.g., ignore, allow, or forbid).
validate_by_alias`boolnull`
validate_by_name`boolnull`