o
    Zh5                     @  s   U d Z ddlmZ ddlmZmZmZmZ ddlm	Z	m
Z
mZ ddlmZmZ dZdZded	< G d
d deZed Zded< G dd deZG dd deZG dd deeZG dd deeZdZded< G dd deeZdS )z!!! abstract "Usage Documentation"
    [Build a Plugin](../concepts/plugins.md#build-a-plugin)

Plugin interface for Pydantic plugins, and related types.
    )annotations)AnyCallableLiteral
NamedTuple)
CoreConfig
CoreSchemaValidationError)Protocol	TypeAlias)PydanticPluginProtocolBaseValidateHandlerProtocolValidatePythonHandlerProtocolValidateJsonHandlerProtocolValidateStringsHandlerProtocolNewSchemaReturnsSchemaTypePath
SchemaKindvtuple[ValidatePythonHandlerProtocol | None, ValidateJsonHandlerProtocol | None, ValidateStringsHandlerProtocol | None]r   r   c                   @  s"   e Zd ZU dZded< ded< dS )r   zQPath defining where `schema_type` was defined, or where `TypeAdapter` was called.strmodulenameN)__name__
__module____qualname____doc____annotations__ r   r   O/var/www/html/lang_env/lib/python3.10/site-packages/pydantic/plugin/__init__.pyr      s   
 r   )Z	BaseModelZTypeAdapter	dataclassZcreate_modelZvalidate_callr   c                   @  s   e Zd ZdZdddZdS )r   z5Protocol defining the interface for Pydantic plugins.schemar   schema_typer   schema_type_pathr   schema_kindr   configCoreConfig | Noneplugin_settingsdict[str, object]returnr   c                 C  s   t d)a  This method is called for each plugin every time a new [`SchemaValidator`][pydantic_core.SchemaValidator]
        is created.

        It should return an event handler for each of the three validation methods, or `None` if the plugin does not
        implement that method.

        Args:
            schema: The schema to validate against.
            schema_type: The original type which the schema was created from, e.g. the model class.
            schema_type_path: Path defining where `schema_type` was defined, or where `TypeAdapter` was called.
            schema_kind: The kind of schema to validate against.
            config: The config to use for validation.
            plugin_settings: Any plugin settings.

        Returns:
            A tuple of optional event handlers for each of the three validation methods -
                `validate_python`, `validate_json`, `validate_strings`.
        z9Pydantic plugins should implement `new_schema_validator`.)NotImplementedError)selfr    r!   r"   r#   r$   r&   r   r   r   new_schema_validator)   s   z+PydanticPluginProtocol.new_schema_validatorN)r    r   r!   r   r"   r   r#   r   r$   r%   r&   r'   r(   r   )r   r   r   r   r+   r   r   r   r   r   &   s    r   c                   @  s:   e Zd ZU dZded< 	 ddd	ZdddZdddZdS )r   zBase class for plugin callbacks protocols.

    You shouldn't implement this protocol directly, instead use one of the subclasses with adds the correctly
    typed `on_error` method.
    zCallable[..., None]on_enterresultr   r(   Nonec                 C     dS )z{Callback to be notified of successful validation.

        Args:
            result: The result of the validation.
        Nr   )r*   r-   r   r   r   
on_successS      z&BaseValidateHandlerProtocol.on_successerrorr	   c                 C  r/   )znCallback to be notified of validation errors.

        Args:
            error: The validation error.
        Nr   )r*   r2   r   r   r   on_error[   r1   z$BaseValidateHandlerProtocol.on_error	exception	Exceptionc                 C  r/   )zCallback to be notified of validation exceptions.

        Args:
            exception: The exception raised during validation.
        Nr   )r*   r4   r   r   r   on_exceptionc   r1   z(BaseValidateHandlerProtocol.on_exceptionN)r-   r   r(   r.   )r2   r	   r(   r.   )r4   r5   r(   r.   )r   r   r   r   r   r0   r3   r6   r   r   r   r   r   I   s   
 

r   c                   @  s*   e Zd ZdZddddddddddZdS )r   z4Event handler for `SchemaValidator.validate_python`.N)strictfrom_attributescontextself_instanceby_aliasby_nameinputr   r7   bool | Noner8   r9   dict[str, Any] | Noner:   
Any | Noner;   r<   r(   r.   c                C  r/   )a  Callback to be notified of validation start, and create an instance of the event handler.

        Args:
            input: The input to be validated.
            strict: Whether to validate the object in strict mode.
            from_attributes: Whether to validate objects as inputs by extracting attributes.
            context: The context to use for validation, this is passed to functional validators.
            self_instance: An instance of a model to set attributes on from validation, this is used when running
                validation from the `__init__` method of a model.
            by_alias: Whether to use the field's alias to match the input data to an attribute.
            by_name: Whether to use the field's name to match the input data to an attribute.
        Nr   )r*   r=   r7   r8   r9   r:   r;   r<   r   r   r   r,   o   s   z&ValidatePythonHandlerProtocol.on_enter)r=   r   r7   r>   r8   r>   r9   r?   r:   r@   r;   r>   r<   r>   r(   r.   r   r   r   r   r,   r   r   r   r   r   l   s    r   c                   @  s(   e Zd ZdZdddddddddZdS )r   z2Event handler for `SchemaValidator.validate_json`.N)r7   r9   r:   r;   r<   r=   str | bytes | bytearrayr7   r>   r9   r?   r:   r@   r;   r<   r(   r.   c                C  r/   )a  Callback to be notified of validation start, and create an instance of the event handler.

        Args:
            input: The JSON data to be validated.
            strict: Whether to validate the object in strict mode.
            context: The context to use for validation, this is passed to functional validators.
            self_instance: An instance of a model to set attributes on from validation, this is used when running
                validation from the `__init__` method of a model.
            by_alias: Whether to use the field's alias to match the input data to an attribute.
            by_name: Whether to use the field's name to match the input data to an attribute.
        Nr   )r*   r=   r7   r9   r:   r;   r<   r   r   r   r,      s   z$ValidateJsonHandlerProtocol.on_enter)r=   rB   r7   r>   r9   r?   r:   r@   r;   r>   r<   r>   r(   r.   rA   r   r   r   r   r      s    r   zdict[str, StringInput]StringInputc                   @  s&   e Zd ZdZddddddddZdS )r   z5Event handler for `SchemaValidator.validate_strings`.N)r7   r9   r;   r<   r=   rC   r7   r>   r9   r?   r;   r<   r(   r.   c                C  r/   )a  Callback to be notified of validation start, and create an instance of the event handler.

        Args:
            input: The string data to be validated.
            strict: Whether to validate the object in strict mode.
            context: The context to use for validation, this is passed to functional validators.
            by_alias: Whether to use the field's alias to match the input data to an attribute.
            by_name: Whether to use the field's name to match the input data to an attribute.
        Nr   )r*   r=   r7   r9   r;   r<   r   r   r   r,      s   z'ValidateStringsHandlerProtocol.on_enter)r=   rC   r7   r>   r9   r?   r;   r>   r<   r>   r(   r.   rA   r   r   r   r   r      s    r   N)r   
__future__r   typingr   r   r   r   Zpydantic_corer   r   r	   typing_extensionsr
   r   __all__r   r   r   r   r   r   r   r   rC   r   r   r   r   r   <module>   s    ##