Campos de carga de archivos 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 los campos de carga de archivos en serializadores en Django REST Framework. Hay dos campos principales: FileField e ImageField.
 

campo de archivo

FileField es básicamente una representación de archivo. Realiza la validación estándar de FileField de Django. Este campo es el mismo que FileField – Django Models .
Tiene los siguientes argumentos:  

• max_length : designa la longitud máxima para el nombre del archivo.
• allow_empty_file : designa si se permiten archivos vacíos.
• use_url : si se establece en True, los valores de string de URL se utilizarán para la representación de salida. Si se establece en False, se utilizarán valores de string de nombre de archivo para la representación de salida. El valor predeterminado es el valor de la clave de configuración UPLOADED_FILES_USE_URL, que es True a menos que se establezca lo contrario.

Sintaxis – 

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

campo de imagen

ImageField es una representación de imagen. Valida que el contenido del archivo cargado coincida con un formato de imagen conocido. Esto es lo mismo que ImageField – Formas Django
Tiene los siguientes argumentos –  

• max_length : designa la longitud máxima para el nombre del archivo.
• allow_empty_file : designa si se permiten archivos vacíos.
• use_url : si se establece en True, los valores de string de URL se utilizarán para la representación de salida. Si se establece en False, se utilizarán valores de string de nombre de archivo para la representación de salida. El valor predeterminado es el valor de la clave de configuración UPLOADED_FILES_USE_URL, que es True a menos que se establezca lo contrario.

Sintaxis – 

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

¿Cómo usar los campos de carga de archivos en los serializadores?

Para explicar el uso de los campos de carga de archivos, 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 FileField e ImageField como campos. 

# import serializer from rest_framework
from rest_framework import serializers
 
class Geeks(object):
    def __init__(self, files, image):
        self.files = files
        self.image = image
 
# create a serializer
class GeeksSerializer(serializers.Serializer):
    # initialize fields
    files = serializers.FileField()
    image = serializers.ImageField()

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 objects of type Text File and Image
>>> from django.core.files import File
>>> text_file = File(open("test.txt"), 'rb')
>>> image_file = File(open("test.jpeg"), 'rb')

# create a object of type Geeks
>>> obj = Geeks(text_file, image_file)

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

# print serialized data
>>> serializer.data
{'files': None, 'image': None}

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

Validación en los campos de carga de archivos

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

# Create a dictionary and add invalid values
>>> data = {}
>>> data['files'] = text_file
>>> data['image_file'] = "invalid"

# dictionary created
>>> data
{'files': , 'image_file': 'invalid'}

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

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

# check the errors
>>> serializer.errors
{'image': [ErrorDetail(string='No file was submitted.', code='required')]}

Aquí está el resultado de estos comandos que muestra claramente que la imagen no es válida y el archivo es válido: 

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; }