SamplexModelSSV1
pydantic model SamplexModelSSV1
Bases: SamplexModel
Um modelo Samplex restrito a usar a versão de serialização Samplex (SSV) 1.
samplex_json
field
Tipo: str [Required]
Uma string JSON que representa o samplex.
Validado por
cross_validate_ssv_version
ssv
field
Tipo: int [Required]
A versão de serialização do Samplex.
Limitadores
- ge = 1
- le = 1
Validado por
cross_validate_ssv_version
cross_validate_ssv_version
validator cross_validate_ssv_version
Verifique se a versão informada corresponde à versão codificada.
from_samplex
classmethod from_samplex(samplex, ssv=None)
Criar uma instância do modelo a partir de um samplex.
A instância retornada possui uma referência ao samplex fornecido. Esta instância pode ser retornada por, to_samplex() dependendo do valor de use_cached. Os usuários desta classe são responsáveis por gerenciar as instâncias em cache do samplex e os possíveis efeitos colaterais de suas modificações.
Parâmetros
- samplex (Samplex) – O samplex a ser codificado no modelo.
- ssv (int | None)
Retorna
Uma nova instância do modelo.
to_samplex
to_samplex(use_cached=False)
Retorna uma instância decodificada do samplex.
Quando use_cached é falso, ou quando não existe nenhuma versão em cache, samplex_json é decodificado e carregado em uma nova instância. Os usuários desta classe são responsáveis por gerenciar as instâncias em cache do samplex e os possíveis efeitos colaterais de suas modificações.
Parâmetros
use_cached (bool) – Se deve retornar a instância armazenada em cache (caso exista).
Retorna
Um samplex.
Tipo de retorno
Samplex