SamplexModelSSV1
pydantic model SamplexModelSSV1
Bases: SamplexModel
Un modelo Samplex que debe utilizar la versión de serialización Samplex (SSV) 1.
samplex_json
field
Tipo: str [Required]
Una cadena JSON que representa el samplex.
Validado por
cross_validate_ssv_version
ssv
field
Tipo: int [Required]
La versión de serialización de Samplex.
Restricciones
- ge = 1
- le = 1
Validado por
cross_validate_ssv_version
cross_validate_ssv_version
validator cross_validate_ssv_version
Comprueba que la versión indicada coincida con la versión codificada.
from_samplex
classmethod from_samplex(samplex, ssv=None)
Crea una instancia del modelo a partir de un samplex.
La instancia devuelta contiene una referencia al samplex proporcionado. Esta instancia puede ser devuelta por to_samplex() dependiendo del valor de use_cached. Los usuarios de esta clase son responsables de gestionar las instancias almacenadas en caché del samplex y los posibles efectos secundarios de sus modificaciones.
Parámetros
- samplex (Samplex) – El samplex que se va a codificar en el modelo.
- ssv (int | None)
Devuelve
Una nueva instancia del modelo.
to_samplex
to_samplex(use_cached=False)
Devuelve una instancia de «samplex» descodificada.
Cuando use_cached es falso, o cuando no existe ninguna versión almacenada en caché, samplex_json se descodifica y se carga en una nueva instancia. Los usuarios de esta clase son responsables de gestionar las instancias almacenadas en caché del samplex y los posibles efectos secundarios de sus modificaciones.
Parámetros
use_cached (bool) – Si se debe devolver la instancia almacenada en caché (si existe).
Devuelve
Un samplex.
Tipo de retorno
Samplex