shuup.campaigns.admin_module package

Subpackages

Submodules

shuup.campaigns.admin_module.form_parts module

class shuup.campaigns.admin_module.form_parts.SalesRangesForm(**kwargs)[source]

Bases: ModelForm

class Meta[source]

Bases: object

model: alias of ContactGroupSalesRange

fields = ['min_value', 'max_value']

labels = {'max_value': 'Maximum value', 'min_value': 'Minimum value'}

help_texts = {'max_value': 'Leave empty for no maximum'}

__init__(**kwargs)[source]

base_fields = {'max_value': <shuup.core.fields.FormattedDecimalFormField object>, 'min_value': <shuup.core.fields.FormattedDecimalFormField object>}

declared_fields = {}

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

class shuup.campaigns.admin_module.form_parts.SalesRangesFormPart(request, **kwargs)[source]

Bases: FormPart

priority: int = 3

name = 'contact_group_sales_ranges'

form: alias of SalesRangesForm

__init__(request, **kwargs)[source]

get_form_defs()[source]

form_valid(form)[source]

class shuup.campaigns.admin_module.form_parts.CampaignBaseFormPart(*args, **kwargs)[source]

Bases: FormPart

priority: int = -1000

form: Type[Any] | None = None

__init__(*args, **kwargs)[source]

get_form_defs()[source]

form_valid(form)[source]

class shuup.campaigns.admin_module.form_parts.CatalogBaseFormPart(*args, **kwargs)[source]

Bases: CampaignBaseFormPart

form: alias of CatalogCampaignForm

class shuup.campaigns.admin_module.form_parts.BasketBaseFormPart(*args, **kwargs)[source]

Bases: CampaignBaseFormPart

form: alias of BasketCampaignForm

class shuup.campaigns.admin_module.form_parts.BaseFormPart(request, form, name, owner)[source]

Bases: FormPart

formset: Type[Any] | None = None

template_name = 'shuup/campaigns/admin/_edit_form.jinja'

__init__(request, form, name, owner)[source]

get_form_defs()[source]

form_valid(form)[source]

class shuup.campaigns.admin_module.form_parts.BasketConditionsFormPart(request, form, name, owner)[source]

Bases: BaseFormPart

formset: alias of BasketConditionsFormSet

class shuup.campaigns.admin_module.form_parts.BasketDiscountEffectsFormPart(request, form, name, owner)[source]

Bases: BaseFormPart

formset: alias of BasketDiscountEffectsFormSet

class shuup.campaigns.admin_module.form_parts.BasketLineEffectsFormPart(request, form, name, owner)[source]

Bases: BaseFormPart

formset: alias of BasketLineEffectsFormSet

class shuup.campaigns.admin_module.form_parts.CatalogConditionsFormPart(request, form, name, owner)[source]

Bases: BaseFormPart

formset: alias of CatalogConditionsFormSet

class shuup.campaigns.admin_module.form_parts.CatalogFiltersFormPart(request, form, name, owner)[source]

Bases: BaseFormPart

formset: alias of CatalogFiltersFormSet

class shuup.campaigns.admin_module.form_parts.CatalogEffectsFormPart(request, form, name, owner)[source]

Bases: BaseFormPart

formset: alias of CatalogEffectsFormSet

shuup.campaigns.admin_module.form_sets module

class shuup.campaigns.admin_module.form_sets.BaseFormset(*args, **kwargs)[source]

Bases: BaseModelFormSet

model = None

validate_min = False

min_num = 0

validate_max = False

max_num = 20

absolute_max = 20

can_delete = True

can_order = False

extra = 0

__init__(*args, **kwargs)[source]

form_class: Type[Any] | None = None

get_name()[source]

get_queryset()[source]

form(**kwargs)[source]

property empty_form

property can_delete_extra

class shuup.campaigns.admin_module.form_sets.BasketConditionsFormSet(*args, **kwargs)[source]

Bases: BaseFormset

model: alias of BasketCondition

get_queryset()[source]

property empty_form

property can_delete_extra

class shuup.campaigns.admin_module.form_sets.EffectsFormset(*args, **kwargs)[source]

Bases: BaseFormset

form(**kwargs)[source]

property empty_form

property can_delete_extra

class shuup.campaigns.admin_module.form_sets.BasketDiscountEffectsFormSet(*args, **kwargs)[source]

Bases: EffectsFormset

model: alias of BasketDiscountEffect

get_queryset()[source]

class shuup.campaigns.admin_module.form_sets.BasketLineEffectsFormSet(*args, **kwargs)[source]

Bases: EffectsFormset

model: alias of BasketLineEffect

get_queryset()[source]

class shuup.campaigns.admin_module.form_sets.CatalogConditionsFormSet(*args, **kwargs)[source]

Bases: BaseFormset

model: alias of ContextCondition

get_queryset()[source]

property empty_form

property can_delete_extra

class shuup.campaigns.admin_module.form_sets.CatalogFiltersFormSet(*args, **kwargs)[source]

Bases: BaseFormset

model: alias of CatalogFilter

get_queryset()[source]

property empty_form

property can_delete_extra

class shuup.campaigns.admin_module.form_sets.CatalogEffectsFormSet(*args, **kwargs)[source]

Bases: EffectsFormset

model: alias of ProductDiscountEffect

get_queryset()[source]

shuup.campaigns.admin_module.sections module

class shuup.campaigns.admin_module.sections.ProductCampaignsSection[source]

Bases: Section

identifier: str = 'product_campaigns'

name: str | Any = 'Active Basket Campaigns'

icon: str = 'fa-bullhorn'

template: str = 'shuup/campaigns/admin/_product_campaigns.jinja'

classmethod visible_for_object(product, request=None)[source]

Returns whether this sections must be visible for the provided object (e.g. order).

:return whether this section must be shown in order section list, defaults to false :rtype: bool

classmethod get_context_data(product, request=None)[source]

Returns additional information to be used in the template.

To fetch this data in the template, you must first add it to your request’s context

e.g. `context[admin_order_section.identifier] =: System Message: WARNING/2 (/home/runner/work/shuup/shuup/shuup/campaigns/admin_module/sections.py:docstring of shuup.campaigns.admin_module.sections.ProductCampaignsSection.get_context_data, line 5); backlink

Inline interpreted text or phrase reference start-string without end-string.

admin_order_section.get_context_data(self.object)`

:return additional context data :rtype: object|None

shuup.campaigns.admin_module.utils module

shuup.campaigns.admin_module.utils.get_formparts_for_provide_key(user, provide_key)[source]

shuup.campaigns.admin_module.utils.get_extra_permissions_for_admin_module()[source]

Module contents

class shuup.campaigns.admin_module.CampaignAdminModule[source]

Bases: AdminModule

name = 'Campaigns'

get_urls()[source]

Return type:: list[django.urls.RegexURLPattern]

get_menu_category_icons()[source]

Return type:: dict[str,str]

get_menu_entries(request)[source]

Return type:: list[shuup.admin.base.MenuEntry]

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:

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][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.