shuup.admin.modules.users package

Subpackages

Submodules

shuup.admin.modules.users.mass_actions module

class shuup.admin.modules.users.mass_actions.UserMassActionProvider[source]

Bases: object

classmethod get_mass_actions_for_view(view)[source]
class shuup.admin.modules.users.mass_actions.ResetPasswordAction[source]

Bases: PicotableMassAction

label = 'Send Reset Password Email'
identifier = 'mass_action_user_reset_password_email'
process(request, ids)[source]

Process the given ids in masses.

Parameters:

  • request – WSGIRequest

  • ids – list of ids.

Returns:

None

Module contents

class shuup.admin.modules.users.UserModule[source]

Bases: AdminModule

name = 'Users'
breadcrumbs_menu_entry = <shuup.admin.base.MenuEntry object>
get_urls()[source]
Return type:

list[django.urls.RegexURLPattern]

get_permissions_help_texts() → Dict[str, str | Any][source]

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.

get_menu_entries(request)[source]
Return type:

list[shuup.admin.base.MenuEntry]

get_search_results(request, query)[source]
Return type:

list[shuup.admin.base.SearchResult]

get_help_blocks(request, kind)[source]
Parameters:

  • request (django.http.request.HttpRequest) – Request.

  • kind (str) – block kind. Currently “setup” or “quicklink”.

Return type:

list[shuup.admin.views.home.HelpBlock]

get_model_url(object, kind, shop=None)[source]

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:
Returns:

The reversed URL or none.

Return type:

str|None

get_extra_permissions() → Iterable[str][source]

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]