Convenient shortcuts to manage or check object permissions.
Assigns permission to user/group and object pair.
Parameters: |
|
---|
We can assign permission for Model instance for specific user:
>>> from django.contrib.sites.models import Site
>>> from django.contrib.auth.models import User, Group
>>> from guardian.shortcuts import assign
>>> site = Site.objects.get_current()
>>> user = User.objects.create(username='joe')
>>> assign("change_site", user, site)
<UserObjectPermission: example.com | joe | change_site>
>>> user.has_perm("change_site", site)
True
... or we can assign permission for group:
>>> group = Group.objects.create(name='joe-group')
>>> user.groups.add(group)
>>> assign("delete_site", group, site)
<GroupObjectPermission: example.com | joe-group | delete_site>
>>> user.has_perm("delete_site", site)
True
Global permissions
This function may also be used to assign standard, global permissions if obj parameter is omitted. Added Permission would be returned in that case:
>>> assign("sites.change_site", user)
<Permission: sites | site | Can change site>
Removes permission from user/group and object pair.
Parameters: |
|
---|
Returns permissions for given user/group and object pair, as list of strings.
Returns queryset of all Permission objects for the given class. It is possible to pass Model as class or instance.
Returns queryset of all User objects with any object permissions for the given obj.
Parameters: |
|
---|
Example:
>>> from django.contrib.auth.models import User
>>> from django.contrib.flatpages.models import FlatPage
>>> from guardian.shortcuts import assign, get_users_with_perms
>>>
>>> page = FlatPage.objects.create(title='Some page', path='/some/page/')
>>> joe = User.objects.create_user('joe', 'joe@example.com', 'joesecret')
>>> assign('change_flatpage', joe, page)
>>>
>>> get_users_with_perms(page)
[<User: joe>]
>>>
>>> get_users_with_perms(page, attach_perms=True)
{<User: joe>: [u'change_flatpage']}
Returns queryset of all Group objects with any object permissions for the given obj.
Parameters: |
|
---|
Example:
>>> from django.contrib.auth.models import Group
>>> from django.contrib.flatpages.models import FlatPage
>>> from guardian.shortcuts import assign, get_groups_with_perms
>>>
>>> page = FlatPage.objects.create(title='Some page', path='/some/page/')
>>> admins = Group.objects.create(name='Admins')
>>> assign('change_flatpage', group, page)
>>>
>>> get_groups_with_perms(page)
[<Group: admins>]
>>>
>>> get_groups_with_perms(page, attach_perms=True)
{<Group: admins>: [u'change_flatpage']}
Returns queryset of objects for which given user has all permissions present at perms.
Parameters: |
|
---|---|
Raises: |
|
Example:
>>> from guardian.shortcuts import get_objects_for_user
>>> joe = User.objects.get(username='joe')
>>> get_objects_for_user(joe, ['auth.change_group'])
[]
>>> from guardian.shortcuts import assign
>>> group = Group.objects.create('some group')
>>> assign('auth.change_group', joe, group)
>>> get_objects_for_user(joe, ['auth.change_group'])
[<Group some group>]