¿Para qué se utiliza `related_name` en Django?

Question

¿Cuál es el argumento related_name útil para los campos ManyToManyField y ForeignKey? Por ejemplo, dado el siguiente código, ¿cuál es el efecto de related_name='maps'?

class Map(db.Model): 
    members = models.ManyToManyField(User, related_name='maps', 
            verbose_name=_('members')) 

Answer 1

El atributo related_name especifica el nombre de la relación inversa entre el modelo User de nuevo a su modelo.

Si no especifica un related_name, Django crea automáticamente una utilizando el nombre de su modelo con el sufijo _set, por ejemplo User.map_set.all().

Si hace especifique, p. Ej. related_name=maps en el modelo User, User.map_set seguirá funcionando, pero la sintaxis User.maps. es, obviamente, un poco más limpia y menos torpe; por ejemplo, si tiene un objeto de usuario current_user, puede usar current_user.maps.all() para obtener todas las instancias de su modelo Map que tengan relación con current_user.

El Django documentation tiene más detalles.

Answer 2

Para agregar al nombre relacionado con la respuesta existente es imprescindible en caso de que haya 2 FK en el modelo que apuntan a la misma tabla. Por ejemplo en el caso de Bill de material

@with_author 
class BOM(models.Model): 
    name = models.CharField(max_length=200,null=True, blank=True) 
    description = models.TextField(null=True, blank=True) 
    tomaterial = models.ForeignKey(Material, related_name = 'tomaterial') 
    frommaterial = models.ForeignKey(Material, related_name = 'frommaterial') 
    creation_time = models.DateTimeField(auto_now_add=True, blank=True) 
    quantity = models.DecimalField(max_digits=19, decimal_places=10) 

Así que cuando usted tendrá que acceder a estos datos sólo se puede utilizar el nombre relacionado

bom = material.tomaterial.all().order_by('-creation_time') 

No está funcionando de otra manera (al menos yo no era capaz omitir el uso del nombre relacionado en caso de 2 FK en la misma tabla.)