shuup.admin.modules.permission_groups package

Subpackages

• shuup.admin.modules.permission_groups.views package
  • Submodules
  • shuup.admin.modules.permission_groups.views.edit module
    • PermissionGroupForm
      • PermissionGroupForm.Meta
        • PermissionGroupForm.Meta.model
        • PermissionGroupForm.Meta.exclude
      • PermissionGroupForm.__init__
      • PermissionGroupForm.clean
      • PermissionGroupForm.save
      • PermissionGroupForm.base_fields
      • PermissionGroupForm.declared_fields
      • PermissionGroupForm.media
    • PermissionGroupEditView
      • PermissionGroupEditView.model
      • PermissionGroupEditView.form_class
      • PermissionGroupEditView.template_name
      • PermissionGroupEditView.context_object_name
      • PermissionGroupEditView.add_form_errors_as_messages
  • shuup.admin.modules.permission_groups.views.list module
    • PermissionGroupListView
      • PermissionGroupListView.model
      • PermissionGroupListView.default_columns
      • PermissionGroupListView.toolbar_buttons_provider_key
      • PermissionGroupListView.mass_actions_provider_key
      • PermissionGroupListView.get_context_data
  • Module contents
    • PermissionGroupEditView
      • PermissionGroupEditView.add_form_errors_as_messages
      • PermissionGroupEditView.context_object_name
      • PermissionGroupEditView.form_class
      • PermissionGroupEditView.model
      • PermissionGroupEditView.template_name
    • PermissionGroupListView
      • PermissionGroupListView.default_columns
      • PermissionGroupListView.get_context_data
      • PermissionGroupListView.mass_actions_provider_key
      • PermissionGroupListView.model
      • PermissionGroupListView.toolbar_buttons_provider_key

Module contents

class shuup.admin.modules.permission_groups.PermissionGroupModule

Bases: AdminModule

name = 'Granular Permission Groups'

breadcrumbs_menu_entry = <shuup.admin.base.MenuEntry object>

get_urls()

Return type:

list[django.urls.RegexURLPattern]

get_menu_entries(request)

Return type:

list[shuup.admin.base.MenuEntry]

get_model_url(object, kind, shop=None)

Retrieve an admin URL for the given object of the kind kind.

A falsy value must be returned if the module does not know how to reverse the given object.

Parameters:

• object (django.db.models.Model) – A object instance (or object class).

• kind (str) – URL kind. Currently “detail”, “list” or “new”.

• shop (shuup.core.models.Shop|None) – The shop that owns the resource.

Returns:

The reversed URL or none.

Return type:

str|None

get_extra_permissions() → Iterable[str]

Define custom extra permissions for admin module for option to limit certain parts of the admin module based on per user permission string. Should return unique list permission strings across the installation to prevent unwanted side effects.

Return type:

list[str]

get_permissions_help_texts() → Iterable[str]

Returns a dictionary where the keys is the permission identifier and the value is a help text that can help the user to understand where the permissions is used and how it works.