DictField en serializadores – Django REST Framework

En Django REST Framework, el concepto mismo de Serialización es convertir datos de base de datos a un tipo de datos que pueda ser utilizado por javascript. Cada serializador viene con algunos campos (entradas) que se van a procesar. Por ejemplo, si tiene una clase con el nombre Empleado y sus campos como Employee_id, Employee_name, is_admin, etc. Entonces, necesitará AutoField, CharField y BooleanField para almacenar y manipular datos a través de Django. De manera similar, el serializador también funciona con el mismo principio y tiene campos que se usan para crear un serializador. 
Este artículo gira en torno a DictField en serializadores en Django REST Framework.

DictField

DictField es básicamente un campo de diccionario que valida la entrada contra un diccionario de objetos.
Tiene los siguientes argumentos: 
 

  • child : una instancia de campo que debe usarse para validar los valores en el diccionario. Si no se proporciona este argumento, los valores de la asignación no se validarán.
  • allow_empty : indica si se permiten diccionarios vacíos.

Sintaxis – 
 

field_name = serializers.DictField(*args, **kwargs)

Ejemplo: 
por ejemplo, para crear un campo que valide una asignación de strings a strings, escribiría algo como esto: 
 

document = DictField(child=CharField())

¿Cómo usar DictField en serializadores?

Para explicar el uso de DictField, usemos la misma configuración de proyecto de: ¿Cómo crear una API básica usando Django Rest Framework?
Ahora que tiene un archivo llamado serializadores en su proyecto, creemos un serializador con DictField como campos. 
 

Python3

# import serializer from rest_framework
from rest_framework import serializers
 
class Geeks(object):
    def __init__(self, dictionary):
        self.dict = dictionary
 
# create a serializer
class GeeksSerializer(serializers.Serializer):
    # initialize fields
    dictionary = serializers.DictField(
    child = serializers.CharField())
     
    

Ahora vamos a crear algunos objetos e intentar serializarlos y verificar si realmente funcionan, Ejecutar, – 
 

Python manage.py shell

Ahora, ejecute los siguientes comandos de python en el shell 
 

# import everything from serializers
>>> from apis.serializers import *

# create a dictionary
>>> demo = {}
>>> demo['name'] = "Naveen"
>>> demo['age'] = 21

# create a object of type Geeks
>>> obj = Geeks(demo)

# serialize the object
>>> serializer = GeeksSerializer(obj)

# print serialized data
>>> serializer.data
{'dict': {'name': 'Naveen', 'age': '21'}}

Aquí está el resultado de todas estas operaciones en la terminal: 
 

dictfield-in-serializers-Django-REST-Framework

Validación en DictField

Tenga en cuenta que el lema principal de estos campos es impartir validaciones, como DictField valida los datos solo para objetos de diccionario. Verifiquemos si estas validaciones funcionan o no: 
 

# Create a dictionary and add invalid values
>>> data = {}
>>> data['dictionary'] = demo

# dictionary created
>>> data
{'dictionary': {'name': 'Naveen', 'age': 21}}

# deserialize the data
>>> serializer = GeeksSerializer(data=data)

# check if data is valid
>>> serializer.is_valid()
True

# check the errors
>>> serializer.errors
{}

Aquí está el resultado de estos comandos que muestra claramente que el diccionario es válido: 
 

dictfield-in-serializers

Conceptos avanzados

Las validaciones son parte de la deserialización y no de la serialización. Como se explicó anteriormente, la serialización es un proceso de conversión de datos ya creados en otro tipo de datos, por lo que no se requieren estas validaciones predeterminadas. La deserialización requiere validaciones ya que los datos deben guardarse en la base de datos o cualquier otra operación según lo especificado. Entonces, si serializa datos usando estos campos, eso funcionaría.
 

Argumentos centrales en los campos del serializador

.math-table { borde-colapso: colapsar; ancho: 100%; } .math-table td { borde: 1px sólido #5fb962; alineación de texto: izquierda! importante; relleno: 8px; } .math-table th { borde: 1px sólido #5fb962; relleno: 8px; } .math-table tr>th{ color de fondo: #c6ebd9; alineación vertical: medio; } .math-table tr:nth-child(odd) { background-color: #ffffff; }   

Argumento Descripción
solo lectura Establézcalo en True para asegurarse de que el campo se use al serializar una representación, pero no al crear o actualizar una instancia durante la deserialización.
escribir solamente Establézcalo en True para asegurarse de que el campo se pueda usar al actualizar o crear una instancia, pero no se incluya al serializar la representación.
requerido Establecer esto en False también permite omitir el atributo del objeto o la clave del diccionario de la salida al serializar la instancia.
defecto Si se establece, proporciona el valor predeterminado que se utilizará para el campo si no se proporciona ningún valor de entrada.
permitir nula Normalmente, se generará un error si se pasa Ninguno a un campo serializador. Establezca este argumento de palabra clave en Verdadero si Ninguno debe considerarse un valor válido.
fuente El nombre del atributo que se utilizará para rellenar el campo.
validadores Una lista de funciones de validación que deben aplicarse a la entrada de campo entrante y que generan un error de validación o simplemente regresan.
error de mensajes Un diccionario de códigos de error a mensajes de error.
etiqueta Una string de texto corta que se puede usar como el nombre del campo en campos de formulario HTML u otros elementos descriptivos.
texto de ayuda Una string de texto que se puede utilizar como descripción del campo en campos de formulario HTML u otros elementos descriptivos.
inicial Un valor que debe usarse para completar previamente el valor de los campos de formulario HTML.

Publicación traducida automáticamente

Artículo escrito por NaveenArora y traducido por Barcelona Geeks. The original can be accessed here. Licence: CCBY-SA

Deja una respuesta

Tu dirección de correo electrónico no será publicada. Los campos obligatorios están marcados con *