Ticket #9638: app_label.2.patch

django/db/models/fields/related.py

@@ -92 +92 @@
             sup.contribute_to_class(cls, name)
 
         if not cls._meta.abstract and self.rel.related_name:
-            self.rel.related_name = self.rel.related_name % {'class': cls.__name__.lower()}
+            self.rel.related_name = self.rel.related_name % {
+                    'class': cls.__name__.lower(),
+                    'app_label': cls._meta.app_label.lower(),
+                    }
 
         other = self.rel.to
         if isinstance(other, basestring):

tests/modeltests/model_inheritance/models.py

@@ -116 +116 @@
     def __unicode__(self):
         return u"%s the parking lot" % self.name
 
+#
+# Abstract base classes with related models where the sub-class has the
+# same name in a different app and inherits from the same abstract base
+# class.
+# NOTE: The actual API tests for the following classes are in
+#       model_inheritance_same_model_name/models.py - They are defined
+#       here in order to have the name conflict between apps
+#
+
+class Title(models.Model):
+    title = models.CharField(max_length=50)
+
+class NamedURL(models.Model):
+    title = models.ForeignKey(Title, related_name='attached_%(app_label)s_%(class)s_set')
+    url = models.URLField()
+
+    class Meta:
+        abstract = True
+
+class Copy(NamedURL):
+    content = models.TextField()
+
+    def __unicode__(self):
+        return self.content
+
 __test__ = {'API_TESTS':"""
 # The Student and Worker models both have 'name' and 'age' fields on them and
 # inherit the __unicode__() method, just as with normal Python subclassing.

tests/modeltests/model_inheritance_same_model_name/models.py

@@ +1 @@
+"""
+XX. Model inheritance
+
+Model inheritance across apps can result in models with the same name resulting
+in the need for an %(app_label)s format string. This app specifically tests
+this feature by redefining the Copy model from model_inheritance/models.py
+"""
+
+from django.db import models
+from modeltests.model_inheritance.models import NamedURL, Title
+
+#
+# Abstract base classes with related models
+#
+class Copy(NamedURL):
+    content = models.TextField()
+
+    def __unicode__(self):
+        return self.content
+
+
+__test__ = {'API_TESTS':"""
+# Create a Title
+>>> title = Title(title='Lorem Ipsum')
+>>> title.save()
+
+# The Title model has distinct accessors for both model_inheritance.Copy and
+# model_inheritance_same_model_name.Copy models.
+>>> title.attached_model_inheritance_copy_set.create(content='Save $ on V1agr@', url='http://v1agra.com/', title='V1agra is spam')
+<Copy: Save $ on V1agr@>
+>>> title.attached_model_inheritance_same_model_name_copy_set.create(content='The Web framework for perfectionists with deadlines.', url='http://www.djangoproject.com/', title='Django Rocks')
+<Copy: The Web framework for perfectionists with deadlines.>
+
+# The Post model doesn't have an attribute called 'attached_%(app_label)s_%(class)s_set'.
+>>> getattr(title, 'attached_%(app_label)s_%(class)s_set')
+Traceback (most recent call last):
+    ...
+AttributeError: 'Title' object has no attribute 'attached_%(app_label)s_%(class)s_set'
+
+"""}

AUTHORS

@@ -234 +234 @@
     David Krauth
     kurtiss@meetro.com
     Panos Laganakos <panos.laganakos@gmail.com>
-    lakin.wecker@gmail.com
+    Lakin Wecker <lakin.wecker@gmail.com> <lakin@structuredabstraction.com>
     Nick Lane <nick.lane.au@gmail.com>
     Stuart Langridge <http://www.kryogenix.org/>
     Paul Lanier <planier@google.com>

docs/topics/db/models.txt

@@ -858 +858 @@
 the same values for the attributes (including :attr:`~django.db.models.ForeignKey.related_name`) each time.
 
 To work around this problem, when you are using :attr:`~django.db.models.ForeignKey.related_name` in an
-abstract base class (only), part of the name should be the string
-``'%(class)s'``. This is replaced by the lower-cased name of the child class
-that the field is used in. Since each class has a different name, each related
-name will end up being different. For example::
-
+abstract base class (only), part of the name should be contain 
+``'%(app_label)s'`` and ``'%(class)s'``. ``'%(class)s'`` is replaced by the lower-cased name of the child class
+that the field is used in. ``'%(app_label)s'`` is replaced by the lower-cased name of the app the child class
+is contained within.  Each installed application name must be unique and the model class names within each app
+must also be unique, therefore the resulting name will end up being different.
+For example, given an app ``common/models.py``:: 
     class Base(models.Model):
-        m2m = models.ManyToMany(OtherModel, related_name="%(class)s_related")
+        m2m = models.ManyToMany(OtherModel, related_name="%(app_label)s_%(class)s_related")
 
         class Meta:
             abstract = True
@@ -875 +876 @@
     class ChildB(Base):
         pass
 
-The reverse name of the ``ChildA.m2m`` field will be ``childa_related``,
-whilst the reverse name of the ``ChildB.m2m`` field will be
-``childb_related``. It is up to you how you use the ``'%(class)s'`` portion to
-construct your related name, but if you forget to use it, Django will raise
+Along with another app ``rare/models.py``:: 
+    from common.models import Base
+
+    class ChildB(Base):
+        pass
+
+The reverse name of the ``commmon.ChildA.m2m`` field will be ``common_childa_related``,
+whilst the reverse name of the ``common.ChildB.m2m`` field will be
+``common_childb_related``, and finally the reverse name of the ``rare.ChildB.m2m`` field will be
+``rare_childb_related``.  It is up to you how you use the ``'%(class)s'`` and ``'%(app_label)s``
+portion to construct your related name, but if you forget to use it, Django will raise
 errors when you validate your models (or run :djadmin:`syncdb`).
 
 If you don't specify a :attr:`~django.db.models.ForeignKey.related_name` attribute for a field in an