Coffee bytes

Blog de desarrollo web con Python y Javascript

Eduardo Zepeda

¿Para que sirve Django genericForeignkey?

El lunes, 22 de febrero de 2021

por Eduardo Zepeda

Tiempo de lectura: 3 minutos

Quieres usar Django para relacionar un modelo con otro usando una llave foránea, pero el modelo que quieres relacionar es uno diferente para cada entrada de la base de datos. Django ofrece una solución a tu problema, una llave foránea genérica llamada genericForeignKey y el modelo ContentType, del que ya hable anteriormente.

El tipo de campo genericForeignkey es capaz de enlazar a diferentes tipos de modelos, lo que nos permite relacionar cualquier otro modelo con el nuestro. ¿Recuerdas que en la entrada anterior hablé de ContentType? Pues ahora sí le daremos una aplicación práctica. Si quieres repasar un poco lo anterior, visita mi entrada donde hablo de ContentType.

El campo genericForeignKey

Imagina un historial de actividades que lleve registro de lo que hace cada usuario: subir un video, borrar una canción, darle like a una publicación, etc. El objetivo de la acción de cada usuario será un modelo distinto cada vez, por lo que podemos usar genericForeignKey para crear nuestro historial.

from django.db import models
from django.contrib.contenttypes.models import ContentType
from django.contrib.contenttypes.fields import GenericForeignKey
from django.contrib.auth.models import User

class ActivityStream(models.Model)
    user = models.ForeignKey(User, on_delete=models.CASCADE)
    action = models.CharField(max_length=128)
    content_type = models.ForeignKey(ContentType, on_delete=models.CASCADE)
    object_id = models.PositiveIntegerField()
    item = GenericForeignKey('content_type', 'object_id')

A continuación te explico cada campo de nuestro modelo:

  • user: es una llave foranea normal. Es únicamente para saber a que usuario pertenece la actividad. Además, al ser una llave foránea, es obligatorio indicar que sucederá si se borra el modelo User con on_delete.
  • action: será la acción del usuario, es solo una cadena de texto con el nombre de la actividad, podemos limitarlo a opciones, pero aquí lo dejaré abierto.
  • content_type: es el modelo al que hacemos referencia, el mismo que está guardando en la tabla ContentType que crea Django automáticamente. Además, al ser una llave foránea, es obligatorio indicar que sucederá si se borra el modelo ContentType con on_delete.
  • object_id: la llave primaria o identificador del objeto al que haremos referencia.
  • item: es una abstracción que te permite acceder directamente al objeto que hacemos referencia con content_type y object_id; este campo no existe en la base de datos.

Creación de un objeto

Ahora, para crear un objeto, basta con que le pasemos la instancia de un objeto al campo item, los campos content_type y object_id se llenarán automáticamente. El resto es exactamente igual que cuando guardas cualquier instancia de un objeto en la base de datos.

from django.contrib.auth.models import User
from tuApp.models import tuModelo # Aquí va el modelo de tu app

usuario = User.objects.get(id=1) # Reemplazalo por lo que quieras
modelo = tuModelo.objects.get(id=1) # Reemplazalo por lo que quieras
activity = ActivityStream(user=user, action="accion", item=modelo)
activity.save()

Listo, si ahora revisamos el modelo que acabamos de crear, notarás que los campos content_type y object_id se han llenado automáticamente.

activity.object_id
1
activity.content_type
<ContentType: tuModelo | tuModelo>

Ahora puedes usar ese objeto para llevar a cabo un stream de actividades, un historial o lo que tú prefieras.

Recuerda que si quieres ahondar más en el tema puedes visitar la documentación oficial de Django.

Presume lo que aprendiste en redes

Únete a mi comunidad de lectores

Recibe contenido como este por correo electrónico, una vez por semana, de manera totalmente gratuita.

* Campo obligatorio