shuup.admin.modules.attributes package

Subpackages

• shuup.admin.modules.attributes.views package
  • Submodules
  • shuup.admin.modules.attributes.views.edit module
    • AttributeEditView
      • AttributeEditView.model
      • AttributeEditView.template_name
      • AttributeEditView.context_object_name
      • AttributeEditView.base_form_part_classes
      • AttributeEditView.form_part_class_provide_key
      • AttributeEditView.add_form_errors_as_messages
      • AttributeEditView.get_toolbar
      • AttributeEditView.form_valid
    • AttributeDeleteView
      • AttributeDeleteView.model
      • AttributeDeleteView.post
  • shuup.admin.modules.attributes.views.list module
    • AttributeListView
      • AttributeListView.model
      • AttributeListView.default_columns
      • AttributeListView.toolbar_buttons_provider_key
      • AttributeListView.mass_actions_provider_key
      • AttributeListView.get_queryset
  • Module contents
    • AttributeEditView
      • AttributeEditView.add_form_errors_as_messages
      • AttributeEditView.base_form_part_classes
      • AttributeEditView.context_object_name
      • AttributeEditView.form_part_class_provide_key
      • AttributeEditView.form_valid
      • AttributeEditView.get_toolbar
      • AttributeEditView.model
      • AttributeEditView.template_name
    • AttributeListView
      • AttributeListView.default_columns
      • AttributeListView.get_queryset
      • AttributeListView.mass_actions_provider_key
      • AttributeListView.model
      • AttributeListView.toolbar_buttons_provider_key

Submodules

shuup.admin.modules.attributes.form_parts module

class shuup.admin.modules.attributes.form_parts.AttributeBaseFormPart(request, object=None)

Bases: FormPart

priority: int = 1

get_form_defs()

form_valid(form)

class shuup.admin.modules.attributes.form_parts.AttributeChoiceOptionsFormPart(request, object=None)

Bases: FormPart

name = 'choice_options'

priority: int = 2

formset

alias of AttributeChoiceOptionFormSet

get_form_defs()

form_valid(form)

shuup.admin.modules.attributes.forms module

class shuup.admin.modules.attributes.forms.AttributeForm(*args, **kwargs)

Bases: MultiLanguageModelForm

class Meta

Bases: object

model

alias of Attribute

fields = '__all__'

__init__(*args, **kwargs)

clean()

Avoid partially translated languages where the translated fields that are required are not set.

base_fields = {'identifier': <django.forms.fields.CharField object>, 'max_choices': <django.forms.fields.IntegerField object>, 'min_choices': <django.forms.fields.IntegerField object>, 'name': <django.forms.fields.CharField object>, 'ordering': <django.forms.fields.IntegerField object>, 'searchable': <django.forms.fields.BooleanField object>, 'type': <enumfields.forms.EnumChoiceField object>, 'visibility_mode': <enumfields.forms.EnumChoiceField object>}

declared_fields = {'name': <django.forms.fields.CharField object>}

property media

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

class shuup.admin.modules.attributes.forms.AttributeChoiceOptionForm(*args, **kwargs)

Bases: MultiLanguageModelForm

class Meta

Bases: object

model

alias of AttributeChoiceOption

fields = ('name',)

__init__(*args, **kwargs)

save(commit=True)

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 = {'name': <django.forms.fields.CharField object>}

declared_fields = {'name': <django.forms.fields.CharField object>}

property media

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

class shuup.admin.modules.attributes.forms.AttributeChoiceOptionFormSet(**kwargs)

Bases: BaseModelFormSet

model

alias of AttributeChoiceOption

form_class

alias of AttributeChoiceOptionForm

validate_min = False

min_num = 0

validate_max = False

max_num = 100

absolute_max = 100

can_delete = True

can_order = False

extra = 0

property can_delete_extra

Compatibility property for Django formsets.

__init__(**kwargs)

form(**kwargs)

get_queryset()

Module contents

class shuup.admin.modules.attributes.AttributeModule

Bases: AdminModule

name = 'Attributes'

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

get_urls()

Return type:

list[django.urls.RegexURLPattern]

get_menu_category_icons()

Return type:

dict[str,str]

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.