Ticket #17750: 0001-Fixed-17750-User.get_profile-now-accepts-cached-argu.patch

django/contrib/auth/models.py

@@ -371 +371 @@
         """
         send_mail(subject, message, from_email, [self.email])
 
-    def get_profile(self):
+    def get_profile(self, cached=True):
         """
         Returns site-specific profile for this user. Raises
         SiteProfileNotAvailable if this site does not allow profiles.
         """
-        if not hasattr(self, '_profile_cache'):
+        if not cached or not hasattr(self, '_profile_cache'):
             from django.conf import settings
             if not getattr(settings, 'AUTH_PROFILE_MODULE', False):
                 raise SiteProfileNotAvailable(

docs/topics/auth.txt

@@ -258 +258 @@
         :attr:`~django.contrib.auth.models.User.from_email` is ``None``, Django
         uses the :setting:`DEFAULT_FROM_EMAIL`.
 
-    .. method:: models.User.get_profile()
+    .. method:: models.User.get_profile(cached=True)
+
+        .. versionchanged:: 1.5
+        The ``cached`` argument was added.
 
         Returns a site-specific profile for this user. Raises
         :exc:`django.contrib.auth.models.SiteProfileNotAvailable` if the
@@ -267 +270 @@
         have a profile. For information on how to define a site-specific user
         profile, see the section on `storing additional user information`_ below.
 
+        By default it caches the result to prevent hitting the database
+        multiple times, however if the data is changed after calling it the
+        first time, subsequent calls will return the original unchanged object.
+        To force hitting the database again simply set ``cached`` to ``False``.
+
 .. _storing additional user information: #storing-additional-information-about-users
 
 Manager functions

new file tests/regressiontests/user_profile/models.py

@@ +1 @@
+from django.db import models
+from django.contrib.auth.models import User
+
+class UserProfile(models.Model):
+    user = models.OneToOneField(User, related_name="user_profile")
+    dance = models.CharField(max_length=100)

new file tests/regressiontests/user_profile/tests.py

@@ +1 @@
+from django.conf import settings
+from django.test import TestCase
+from django.test.utils import override_settings
+from django.contrib.auth.models import User
+from models import UserProfile
+
+
+class ProfileTestCase(TestCase):
+    def tearDown(self):
+        try:
+            user = User.objects.get(username="janet")
+        except User.DoesNotExist:
+            pass
+        else:
+            user.delete()
+
+
+    @override_settings(AUTH_PROFILE_MODULE="user_profile.UserProfile")
+    def test_get_profile_cache(self):
+        janet = User.objects.create_user('janet', 'janet@example.com')
+
+        profile = UserProfile(user=janet, dance='Tango')
+        profile.save()
+
+        self.assertEqual(janet.get_profile().dance, 'Tango')
+
+        profile.dance='Salsa'
+        profile.save()
+
+        # Testing with kwarg
+        self.assertEqual(janet.get_profile().dance, 'Tango')
+        self.assertEqual(janet.get_profile(cached=False).dance, 'Salsa')
+
+        profile.dance='Polka'
+        profile.save()
+
+        # Testing with arg
+        self.assertEqual(janet.get_profile().dance, 'Salsa')
+        self.assertEqual(janet.get_profile(False).dance, 'Polka')
+        self.assertEqual(janet.get_profile().dance, 'Polka')