shuup.admin.modules.categories package

Subpackages

Submodules

shuup.admin.modules.categories.form_parts module

class shuup.admin.modules.categories.form_parts.CategoryBaseFormPart(request, object=None)[source]

Bases: FormPart

priority: int = -1000
get_form_defs()[source]
form_valid(form)[source]
class shuup.admin.modules.categories.form_parts.CategoryProductFormPart(request, object=None)[source]

Bases: FormPart

priority: int = 1
name = 'products'
get_form_defs()[source]
form_valid(form)[source]

shuup.admin.modules.categories.forms module

class shuup.admin.modules.categories.forms.CategoryBaseForm(request, **kwargs)[source]

Bases: ShuupAdminForm

class Meta[source]

Bases: object

model

alias of Category

fields = ('parent', 'status', 'ordering', 'visibility', 'visible_in_menu', 'visibility_groups', 'name', 'image', 'description', 'slug')
widgets = {'description': <shuup.admin.forms.widgets.TextEditorWidget object>, 'parent': <shuup.admin.forms.widgets.QuickAddCategorySelect object>, 'status': <class 'django.forms.widgets.RadioSelect'>, 'visibility': <class 'django.forms.widgets.RadioSelect'>}
__init__(request, **kwargs)[source]
clean_parent()[source]
save(commit=True)[source]

Save this form’s self.instance object if commit=True. Otherwise, add a save_m2m() method to the form which can be called after the instance is saved manually at a later time. Return the model instance.

base_fields = {'description': <django.forms.fields.CharField object>, 'image': <filer.fields.image.AdminImageFormField object>, 'name': <django.forms.fields.CharField object>, 'ordering': <django.forms.fields.IntegerField object>, 'parent': <mptt.forms.TreeNodeChoiceField object>, 'slug': <django.forms.fields.SlugField object>, 'status': <enumfields.forms.EnumChoiceField object>, 'visibility': <enumfields.forms.EnumChoiceField object>, 'visibility_groups': <django.forms.models.ModelMultipleChoiceField object>, 'visible_in_menu': <django.forms.fields.BooleanField object>}
declared_fields = {'description': <django.forms.fields.CharField object>, 'name': <django.forms.fields.CharField object>, 'slug': <django.forms.fields.SlugField object>}
property media

Return all media required to render the widgets on this form.

class shuup.admin.modules.categories.forms.CategoryProductForm(shop, category, **kwargs)[source]

Bases: Form

__init__(shop, category, **kwargs)[source]
save()[source]
base_fields = {'additional_products': <shuup.admin.forms.fields.ObjectSelect2MultipleField object>, 'primary_products': <shuup.admin.forms.fields.ObjectSelect2MultipleField object>, 'remove_products': <django.forms.fields.MultipleChoiceField object>}
declared_fields = {'additional_products': <shuup.admin.forms.fields.ObjectSelect2MultipleField object>, 'primary_products': <shuup.admin.forms.fields.ObjectSelect2MultipleField object>, 'remove_products': <django.forms.fields.MultipleChoiceField object>}
property media

Return all media required to render the widgets on this form.

Module contents

class shuup.admin.modules.categories.CategoryModule[source]

Bases: AdminModule

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

list[django.urls.RegexURLPattern]

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]

get_permissions_help_texts() → Iterable[str][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.