django-permission · PyPI · Python 包索引

一个增强型权限系统，允许逻辑权限系统扩展到复杂权限

这些详情尚未通过PyPI验证

项目链接

项目描述

作者: Alisue <lambdalisue@hashnote.net>
支持的Python版本: Python 2.7, 3.3, 3.4, 3.5, 3.6
支持的Django版本: Django 1.8 - 1.11b

一个增强型权限库，它支持在Django中处理复杂的权限逻辑。

文档

http://django-permission.readthedocs.org/zh/latest/

安装

使用pip如下

$ pip install django-permission

用法

以下内容可能有助于您理解。

基本策略等，请参阅问题 #28
高级用法和示例，请参阅问题 #26

配置

将 permission 添加到您的设置模块中的 INSTALLED_APPS

INSTALLED_APPS = (
    # ...
    'permission',
)

添加我们的额外授权/身份验证后端

AUTHENTICATION_BACKENDS = (
    'django.contrib.auth.backends.ModelBackend', # default
    'permission.backends.PermissionBackend',
)

按照以下说明将逻辑权限应用到Django模型中

自动发现

类似于Django的admin包，django-permission会自动发现应用目录中的 perms.py 文件，通过运行 ``permission.autodiscover()``。此外，如果 perms.py 模块包含一个 PERMISSION_LOGICS 变量，django-permission将自动运行以下函数来应用权限逻辑。

for model, permission_logic_instance in PERMISSION_LOGICS:
    if isinstance(model, str):
        model = get_model(*model.split(".", 1))
    add_permission_logic(model, permission_logic_instance)

快速教程

将 import permission; permission.autodiscover() 添加到您的 urls.py

from django.conf.urls import patterns, include, url
from django.contrib import admin

admin.autodiscover()
# add this line
import permission; permission.autodiscover()

urlpatterns = patterns('',
    url(r'^admin/', include(admin.site.urls)),
    # ...
)

在您的应用目录中编写 perms.py

from permission.logics import AuthorPermissionLogic
from permission.logics import CollaboratorsPermissionLogic

PERMISSION_LOGICS = (
    ('your_app.Article', AuthorPermissionLogic()),
    ('your_app.Article', CollaboratorsPermissionLogic()),
)

您可以使用 PERMISSION_AUTODISCOVER_MODULE_NAME 或 PERMISSION_AUTODISCOVER_VARIABLE_NAME 分别指定不同的模块或变量名称。

应用权限逻辑

假设您编写了一个文章模型，该模型有一个 author 属性来存储文章的创建者，并且您想授予该创建者完整的控制权限（例如添加、更改和删除权限）。

您需要做的就是将 permission.logics.AuthorPermissionLogic 应用到 Article 模型，如下所示

from django.db import models
from django.contrib.auth.models import User


class Article(models.Model):
    title = models.CharField('title', max_length=120)
    body = models.TextField('body')
    author = models.ForeignKey(User)

    # this is just required for easy explanation
    class Meta:
        app_label='permission'

# apply AuthorPermissionLogic
from permission import add_permission_logic
from permission.logics import AuthorPermissionLogic
add_permission_logic(Article, AuthorPermissionLogic())

from django.db import models
from django.contrib.auth.models import User


class Article(models.Model):
    title = models.CharField('title', max_length=120)
    body = models.TextField('body')
    project = models.ForeignKey('permission.Project')

    # this is just required for easy explanation
    class Meta:
        app_label='permission'

class Project(models.Model):
    title = models.CharField('title', max_length=120)
    body = models.TextField('body')
    author = models.ForeignKey(User)

    # this is just required for easy explanation
    class Meta:
        app_label='permission'

# apply AuthorPermissionLogic to Article
from permission import add_permission_logic
from permission.logics import AuthorPermissionLogic
add_permission_logic(Article, AuthorPermissionLogic(
    field_name='project__author',
))

就是这样。现在以下代码将按预期工作

user1 = User.objects.create_user(
    username='john',
    email='john@test.com',
    password='password',
)
user2 = User.objects.create_user(
    username='alice',
    email='alice@test.com',
    password='password',
)

art1 = Article.objects.create(
    title="Article 1",
    body="foobar hogehoge",
    author=user1
)
art2 = Article.objects.create(
    title="Article 2",
    body="foobar hogehoge",
    author=user2
)

# You have to apply 'permission.add_article' to users manually because it
# is not an object permission.
from permission.utils.permissions import perm_to_permission
user1.user_permissions.add(perm_to_permission('permission.add_article'))

assert user1.has_perm('permission.add_article') == True
assert user1.has_perm('permission.change_article') == False
assert user1.has_perm('permission.change_article', art1) == True
assert user1.has_perm('permission.change_article', art2) == False

assert user2.has_perm('permission.add_article') == False
assert user2.has_perm('permission.delete_article') == False
assert user2.has_perm('permission.delete_article', art1) == False
assert user2.has_perm('permission.delete_article', art2) == True

#
# You may also be interested in django signals to apply 'add' permissions to the
# newly created users.
# https://docs.django.ac.cn/en/dev/ref/signals/#django.db.models.signals.post_save
#
from django.db.models.signals.post_save
from django.dispatch import receiver
from permission.utils.permissions import perm_to_permission

@receiver(post_save, sender=User)
def apply_permissions_to_new_user(sender, instance, created, **kwargs):
    if not created:
        return
    #
    # permissions you want to apply to the newly created user
    # YOU SHOULD NOT APPLY PERMISSIONS EXCEPT PERMISSIONS FOR 'ADD'
    # in this way, the applied permissions are not object permission so
    # if you apply 'permission.change_article' then the user can change
    # any article object.
    #
    permissions = [
        'permission.add_article',
    ]
    for permission in permissions:
        # apply permission
        # perm_to_permission is a utility to convert string permission
        # to permission instance.
        instance.user_permissions.add(perm_to_permission(permission))

请参阅http://django-permission.readthedocs.org/en/latest/_modules/permission/logics/author.html#AuthorPermissionLogic 了解此逻辑的工作原理。

现在，假设您为文章添加了一个 collaborators 属性来存储合作者，并且您想授予他们更改权限。

您需要做的就是将 permission.logics.CollaboratorsPermissionLogic 应用到 Article 模型，如下所示

from django.db import models
from django.contrib.auth.models import User


class Article(models.Model):
    title = models.CharField('title', max_length=120)
    body = models.TextField('body')
    author = models.ForeignKey(User)
    collaborators = models.ManyToManyField(User)

    # this is just required for easy explanation
    class Meta:
        app_label='permission'

# apply AuthorPermissionLogic and CollaboratorsPermissionLogic
from permission import add_permission_logic
from permission.logics import AuthorPermissionLogic
from permission.logics import CollaboratorsPermissionLogic
add_permission_logic(Article, AuthorPermissionLogic())
add_permission_logic(Article, CollaboratorsPermissionLogic(
    field_name='collaborators',
    any_permission=False,
    change_permission=True,
    delete_permission=False,
))

from django.db import models
from django.contrib.auth.models import User


class Article(models.Model):
    title = models.CharField('title', max_length=120)
    body = models.TextField('body')
    project = models.ForeignKey('permission.Project')

    # this is just required for easy explanation
    class Meta:
        app_label='permission'

class Project(models.Model):
    title = models.CharField('title', max_length=120)
    body = models.TextField('body')
    collaborators = models.ManyToManyField(User)

    # this is just required for easy explanation
    class Meta:
        app_label='permission'

# apply AuthorPermissionLogic to Article
from permission import add_permission_logic
from permission.logics import CollaboratorsPermissionLogic
add_permission_logic(Article, CollaboratorsPermissionLogic(
    field_name='project__collaborators',
))

就是这样。现在以下代码将按预期工作

user1 = User.objects.create_user(
    username='john',
    email='john@test.com',
    password='password',
)
user2 = User.objects.create_user(
    username='alice',
    email='alice@test.com',
    password='password',
)

art1 = Article.objects.create(
    title="Article 1",
    body="foobar hogehoge",
    author=user1
)
art1.collaborators.add(user2)

assert user1.has_perm('permission.change_article') == False
assert user1.has_perm('permission.change_article', art1) == True
assert user1.has_perm('permission.delete_article', art1) == True

assert user2.has_perm('permission.change_article') == False
assert user2.has_perm('permission.change_article', art1) == True
assert user2.has_perm('permission.delete_article', art1) == False

请参阅http://django-permission.readthedocs.org/en/latest/_modules/permission/logics/collaborators.html#CollaboratorsPermissionLogic 了解此逻辑的工作原理。

还有 StaffPermissionLogic 和 GroupInPermissionLogic 用于基于 is_staff 或 group 的权限逻辑。

自定义权限逻辑

您的自定义权限逻辑类必须是 permission.logics.PermissionLogic 的子类，并且必须重写 has_perm(user_obj, perm, obj=None) 方法，该方法返回布尔值。

类、方法或函数装饰器

类似于Django的permission_required，但可用于对象权限，并且可以作为类、方法或函数装饰器使用。此外，您无需为此装饰器指定对象即可进行对象权限。此装饰器会自动从请求中确定对象（因此您不能为此装饰器使用非视图类/方法/函数，但在那种情况下您仍然可以使用user.has_perm）。

>>> from permission.decorators import permission_required
>>> # As class decorator
>>> @permission_required('auth.change_user')
>>> class UpdateAuthUserView(UpdateView):
...     pass
>>> # As method decorator
>>> class UpdateAuthUserView(UpdateView):
...     @permission_required('auth.change_user')
...     def dispatch(self, request, *args, **kwargs):
...         pass
>>> # As function decorator
>>> @permission_required('auth.change_user')
>>> def update_auth_user(request, *args, **kwargs):
...     pass

覆盖内置的if 模板标签

django-permission覆盖了内置的if 标签，增加了两个操作符以处理模板中的权限。您可以使用has 关键字编写权限测试，并使用以下方式指定目标对象。

{% if user has 'blogs.add_article' %}
    <p>This user have 'blogs.add_article' permission</p>
{% elif user has 'blog.change_article' of object %}
    <p>This user have 'blogs.change_article' permission of {{object}}</p>
{% endif %}

{# If you set 'PERMISSION_REPLACE_BUILTIN_IF = False' in settings #}
{% permission user has 'blogs.add_article' %}
    <p>This user have 'blogs.add_article' permission</p>
{% elpermission user has 'blog.change_article' of object %}
    <p>This user have 'blogs.change_article' permission of {{object}}</p>
{% endpermission %}

注意

从Django 1.9开始，用户需要手动将‘permission.templatetags.permissionif’添加到‘builtins’选项中。见 - https://docs.django.ac.cn/en/1.9/releases/1.9/#django-template-base-add-to-builtins-is-removed - https://docs.django.ac.cn/en/1.9/topics/templates/#module-django.template.backends.django 或以下示例

TEMPLATES = [
    {
        'BACKEND': 'django.template.backends.django.DjangoTemplates',
        'OPTIONS': {
            'builtins': ['permission.templatetags.permissionif'],
        },
    },
]

许可证

MIT许可协议（MIT）

特此授予任何获得此软件及其相关文档文件（“软件”）副本的个人免费使用软件的权利，包括但不限于使用、复制、修改、合并、发布、分发、再许可和/或销售软件副本的权利，并允许向软件提供方提供软件的人进行上述操作，前提是遵守以下条件

项目详情

这些详情尚未通过PyPI验证

项目链接

发布历史发布通知 | RSS源

此版本

1.0.5

2020年1月7日

1.0.4

2017年3月25日

1.0.3

2017年3月25日

1.0.2

2017年3月25日

1.0.1

2017年3月25日

1.0.0

2017年3月25日

0.9.3

2016年11月12日

0.9.2

2016年1月14日

0.9.1

2015年12月9日

0.9.0

2015年12月9日

0.8.8

2015年5月28日

0.8.7

2015年4月23日

0.8.6

2015年4月23日

0.8.5

2015年3月7日

0.8.4

2015年2月18日

0.8.3

2014年10月19日

0.8.2

2014年7月15日

0.8.1

2014年7月11日

0.8.0

2014年5月27日

0.7.1

2014年4月23日

0.7.0

2014年4月22日

0.6.2

2014年4月22日

0.6.1

2014年4月21日

0.6.0

2014年4月21日

0.5.4

2014年4月21日

0.5.3

2014年4月16日

0.5.2

2014年4月16日

0.5.1

2014年1月23日

0.5.0

2014年1月13日

0.4.6

2014年1月9日

0.4.5

2012年4月30日

0.4.4

2012年3月15日

0.4.3

2012年3月15日

0.4.2

2012年3月15日

0.4.1

2012年3月15日

0.4.0

2012年3月15日

0.3.8

2012年3月14日

0.3.7

2012年3月14日

0.3.6

2012年3月13日

0.3.5

2012年3月13日

0.3.4

2012年3月9日

0.3.3

2012年3月5日

0.3.2

2012年3月5日

0.3.1

2012年3月4日

0.3.0

2012年3月4日

0.2.2

2012年3月2日

0.2.1

2012年3月2日

0.2.0

2012年3月1日

0.1.0

2012年2月29日

下载文件

下载适用于您平台的应用程序。如果您不确定要选择哪个，请了解有关安装软件包的更多信息。

源分发

django-permission-1.0.5.tar.gz (33.3 kB 查看哈希值)

上传时间 2020年1月7日 源

哈希值 for django-permission-1.0.5.tar.gz

django-permission-1.0.5.tar.gz 的哈希值
算法	哈希摘要
SHA256	`66ac4c3a41e77f96d99394f186945211e4e9958bddbea5a55ee0c02d295b71bc`
MD5	`a389e1592920797443d9454c8648679e`
BLAKE2b-256	`6d6149689c81076c25b533217dd673dd9d81acdbe3a4b190276ab947251d6f61`

django-permission 1.0.5

导航

验证详情

维护者

未验证详情

项目链接

元数据

分类器

项目描述

文档

安装

用法

配置

自动发现

应用权限逻辑

自定义权限逻辑

类、方法或函数装饰器

覆盖内置的if 模板标签

许可证

项目详情

验证详情

维护者

未验证详情

项目链接

元数据

分类器

发布历史发布通知 | RSS源

下载文件

源分发

django-permission 1.0.5

导航

验证详情

维护者

未验证详情

项目链接

元数据

分类器

项目描述

文档

安装

用法

配置

自动发现

应用权限逻辑

自定义权限逻辑

类、方法或函数装饰器

覆盖内置的if 模板标签

许可证

项目详情

验证详情

维护者

未验证详情

项目链接

元数据

分类器

发布历史 发布通知 | RSS源

下载文件

源分发

发布历史发布通知 | RSS源