permission package

Subpackages

• permission.decorators package
  • Submodules
  • permission.decorators.classbase module
  • permission.decorators.functionbase module
  • permission.decorators.methodbase module
  • permission.decorators.permission_required module
  • permission.decorators.utils module
  • Module contents
• permission.logics package
  • Submodules
  • permission.logics.author module
  • permission.logics.base module
  • permission.logics.collaborators module
  • permission.logics.groupin module
  • permission.logics.oneself module
  • permission.logics.staff module
  • Module contents
• permission.templatetags package
  • Submodules
  • permission.templatetags.patch module
  • permission.templatetags.permissionif module
  • Module contents
• permission.tests package
  • Subpackages
    • permission.tests.test_decorators package
      • Submodules
      • permission.tests.test_decorators.test_classbase module
      • permission.tests.test_decorators.test_functionbase module
      • permission.tests.test_decorators.test_methodbase module
      • permission.tests.test_decorators.test_permission_required module
      • permission.tests.test_decorators.utils module
      • Module contents
    • permission.tests.test_logics package
      • Submodules
      • permission.tests.test_logics.test_author module
      • permission.tests.test_logics.test_base module
      • permission.tests.test_logics.test_collaborators module
      • permission.tests.test_logics.test_groupin module
      • permission.tests.test_logics.test_oneself module
      • permission.tests.test_logics.test_staff module
      • Module contents
    • permission.tests.test_templatetags package
      • Submodules
      • permission.tests.test_templatetags.test_permissionif module
      • Module contents
    • permission.tests.test_utils package
      • Submodules
      • permission.tests.test_utils.test_field_lookup module
      • permission.tests.test_utils.test_handlers module
      • permission.tests.test_utils.test_logics module
      • permission.tests.test_utils.test_permissions module
      • Module contents
  • Submodules
  • permission.tests.compatibility module
  • permission.tests.models module
  • permission.tests.test_backends module
  • permission.tests.test_handlers module
  • permission.tests.utils module
  • Module contents
• permission.utils package
  • Submodules
  • permission.utils.autodiscover module
  • permission.utils.field_lookup module
  • permission.utils.handlers module
  • permission.utils.logics module
  • permission.utils.permissions module
  • Module contents

Submodules

permission.backends module

Logical permission backends module

class permission.backends.PermissionBackend

Bases: object

A handler based permission backend

Methods

authenticate(username, password)

Always return None to prevent authentication within this backend.

has_module_perms(user_obj, app_label)

Check if user have permission of specified app based on registered handlers.

It will raise ObjectDoesNotExist exception when the specified string permission does not exist and PERMISSION_CHECK_PERMISSION_PRESENCE is True in settings module.

Parameters:

user_obj : django user model instance

A django user model instance which be checked

perm : string

app_label.codename formatted permission string

obj : None or django model instance

None or django model instance for object permission

Returns:

boolean

Wheter the specified user have specified permission (of specified object).

Raises:

django.core.exceptions.ObjectDoesNotExist

If the specified string permission does not exist and PERMISSION_CHECK_PERMISSION_PRESENCE is True in settings module.

has_perm(user_obj, perm, obj=None)

Check if user have permission (of object) based on registered handlers.

It will raise ObjectDoesNotExist exception when the specified string permission does not exist and PERMISSION_CHECK_PERMISSION_PRESENCE is True in settings module.

Parameters:

user_obj : django user model instance

A django user model instance which be checked

perm : string

app_label.codename formatted permission string

obj : None or django model instance

None or django model instance for object permission

Returns:

boolean

Wheter the specified user have specified permission (of specified object).

Raises:

django.core.exceptions.ObjectDoesNotExist

If the specified string permission does not exist and PERMISSION_CHECK_PERMISSION_PRESENCE is True in settings module.

supports_anonymous_user = True

supports_inactive_user = True

supports_object_permissions = True

permission.compat module

permission.compat.isiterable(x)

permission.conf module

django-permission application configure

permission.handlers module

class permission.handlers.LogicalPermissionHandler(model)

Bases: permission.handlers.PermissionHandler

Permission handler class which use permission logics to determine the permission

Attributes

Methods

has_perm(user_obj, perm, obj=None)

Check if user have permission (of object) based on specified models’s _permission_logics attribute.

The result will be stored in user_obj as a cache to reduce method call.

Parameters:

user_obj : django user model instance

A django user model instance which be checked

perm : string

app_label.codename formatted permission string

obj : None or django model instance

None or django model instance for object permission

Returns:

boolean

Wheter the specified user have specified permission (of specified object).

class permission.handlers.PermissionHandler(model_or_app_label)

Bases: object

Abstract permission handler class

Attributes

Methods

excludes

get_supported_app_labels()

Get app labels which this handler can treat. Specified with includes and excludes of this instance.

Returns:

set

A set instance of app_label

get_supported_permissions()

Get permissions which this handler can treat. Specified with includes and excludes of this instance.

Returns:

set

A set instance of app_label.codename formatted permission strings

has_module_perms(user_obj, app_label)

Check if user have permission of specified app

Parameters:

user_obj : django user model instance

A django user model instance which be checked

app_label : string

Django application name

Returns:

boolean

Wheter the specified user have any permissions of specified app

has_perm(user_obj, perm, obj=None)

Check if user have permission (of object)

Parameters:

user_obj : django user model instance

A django user model instance which be checked

perm : string

app_label.codename formatted permission string

obj : None or django model instance

None or django model instance for object permission

Returns:

boolean

Wheter the specified user have specified permission (of specified object).

Note

Sub class must override this method.

includes

permission.models module

Module contents

django-permission