Fixed #13211 -- Added the `Group` API reference and a `Permission` API example to the `contrib.auth` documentation. Thanks to b14ck for the report and to jpaulett and CrazyGir for the patch.

git-svn-id: http://code.djangoproject.com/svn/django/trunk@16849 bcc190cf-cafb-0310-a4f2-bffc1f526a37
This commit is contained in:
Julien Phalip 2011-09-18 07:24:16 +00:00
parent e63fa0ff83
commit 9316671eff
1 changed files with 46 additions and 7 deletions

View File

@ -131,7 +131,7 @@ Methods
.. class:: models.User .. class:: models.User
:class:`~django.contrib.auth.models.User` objects have two many-to-many :class:`~django.contrib.auth.models.User` objects have two many-to-many
fields: models.User. ``groups`` and ``user_permissions``. fields: ``groups`` and ``user_permissions``.
:class:`~django.contrib.auth.models.User` objects can access their related :class:`~django.contrib.auth.models.User` objects can access their related
objects in the same way as any other :doc:`Django model objects in the same way as any other :doc:`Django model
</topics/db/models>`: </topics/db/models>`:
@ -1403,12 +1403,7 @@ API reference
.. currentmodule:: django.contrib.auth.models .. currentmodule:: django.contrib.auth.models
.. class:: Permission .. class:: models.Permission
Just like users, permissions are implemented in a Django model that lives
in `django/contrib/auth/models.py`_.
.. _django/contrib/auth/models.py: http://code.djangoproject.com/browser/django/trunk/django/contrib/auth/models.py
Fields Fields
~~~~~~ ~~~~~~
@ -1437,6 +1432,26 @@ data-access methods like any other :doc:`Django model </ref/models/instances>`.
.. currentmodule:: django.contrib.auth .. currentmodule:: django.contrib.auth
Programmatically creating permissions
-------------------------------------
While custom permissions can be defined within a model's ``Meta`` class, you
can also create permissions directly. For example, you can create the
``can_publish`` permission for a ``BlogPost`` model in ``myapp``::
from django.contrib.auth.models import Group, Permission
from django.contrib.contenttypes.models import ContentType
content_type = ContentType.objects.get(app_label='myapp', model='BlogPost')
permission = Permission.objects.create(codename='can_publish',
name='Can Publish Posts',
content_type=content_type)
The permission can then be assigned to a
:class:`~django.contrib.auth.models.User` via its ``user_permissions``
attribute or to a :class:`~django.contrib.auth.models.Group` via its
``permissions`` attribute.
Authentication data in templates Authentication data in templates
================================ ================================
@ -1529,6 +1544,30 @@ group ``'Special users'``, and you could write code that could, say, give them
access to a members-only portion of your site, or send them members-only email access to a members-only portion of your site, or send them members-only email
messages. messages.
API reference
-------------
.. class:: models.Group
Fields
~~~~~~
:class:`~django.contrib.auth.models.Group` objects have the following fields:
.. attribute:: Group.name
Required. 80 characters or fewer. Any characters are permitted. Example:
``'Awesome Users'``.
.. attribute:: Group.permissions
Many-to-many field to :class:`~django.contrib.auth.models.Permissions`::
group.permissions = [permission_list]
group.permissions.add(permission, permission, ...)
group.permissions.remove(permission, permission, ...)
group.permissions.clear()
.. _authentication-backends: .. _authentication-backends:
Other authentication sources Other authentication sources