Fixed #37021 -- Added Permission.user_perm_str property.

For use in checking user permissions via has_perm().

Co-authored-by: 사재혁 <jaehyuck.sa.dev@gmail.com>

Author: 2 people

django/contrib/auth/models.py

@@ -79,6 +79,11 @@ class Meta:
     def __str__(self):
         return "%s | %s" % (self.content_type, self.name)
 
+    @property
+    def user_perm_str(self):
+        """String representation for the user permission check."""
+        return f"{self.content_type.app_label}.{self.codename}"
+
     def natural_key(self):
         return (self.codename, *self.content_type.natural_key())
 

docs/ref/contrib/auth.txt

@@ -405,6 +405,16 @@ Methods
 :class:`~django.contrib.auth.models.Permission` objects have the standard
 data-access methods like any other :doc:`Django model </ref/models/instances>`.
 
+.. class:: models.Permission
+    :noindex:
+
+    .. attribute:: user_perm_str
+
+        .. versionadded:: 6.1
+
+        Returns the string representation for use in :meth:`has_perm
+        <django.contrib.auth.models.User.has_perm>`.
+
 ``Group`` model
 ===============
 

docs/releases/6.1.txt

@@ -129,6 +129,9 @@ Minor features
 * :attr:`.Permission.name` and :attr:`.Permission.codename` values are now
   renamed when renaming models via a migration.
 
+* The new :attr:`.Permission.user_perm_str` property returns the string
+  suitable to use with :meth:`.User.has_perm`.
+
 :mod:`django.contrib.contenttypes`
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 

docs/topics/auth/default.txt

@@ -243,6 +243,15 @@ to test for basic permissions you should use:
 The :class:`~django.contrib.auth.models.Permission` model is rarely accessed
 directly.
 
+The :class:`~django.contrib.auth.models.Permission` model provides a helper
+property, :attr:`~django.contrib.auth.models.Permission.user_perm_str`,
+that returns the string representation that can be used to check permission
+using the :meth:`~django.contrib.auth.models.User.has_perm` method.
+
+.. versionchanged:: 6.1
+
+    The ``user_perm_str`` property was added.
+
 Groups
 ------
 

tests/auth_tests/test_models.py

@@ -635,3 +635,7 @@ def test_str(self):
         self.assertEqual(
             str(p), "Auth_Tests | custom email field | Can view custom email field"
         )
+
+    def test_user_perm_str(self):
+        p = Permission.objects.get(codename="view_customemailfield")
+        self.assertEqual(p.user_perm_str, "auth_tests.view_customemailfield")