shuup.admin.modules.shops package

Subpackages

Submodules

shuup.admin.modules.shops.forms module

shuup.admin.modules.shops.forms.get_currency_choices()[source]
class shuup.admin.modules.shops.forms.ShopBaseForm(**kwargs)[source]

Bases: ProtectedFieldsMixin, ShuupAdminForm

change_protect_field_text = 'This field cannot be changed since there are existing orders for this shop.'
class Meta[source]

Bases: object

model

alias of Shop

exclude = ('owner', 'options', 'contact_address')
widgets = {'labels': <shuup.admin.forms.widgets.QuickAddLabelMultiSelect object>}
__init__(**kwargs)[source]
clean_domain()[source]
base_fields = {'currency': <django.forms.fields.CharField object>, 'description': <django.forms.fields.CharField object>, 'domain': <django.forms.fields.CharField object>, 'favicon': <filer.fields.image.AdminImageFormField object>, 'labels': <django.forms.models.ModelMultipleChoiceField object>, 'logo': <filer.fields.image.AdminImageFormField object>, 'maintenance_message': <django.forms.fields.CharField object>, 'maintenance_mode': <django.forms.fields.BooleanField object>, 'name': <django.forms.fields.CharField object>, 'prices_include_tax': <django.forms.fields.BooleanField object>, 'public_name': <django.forms.fields.CharField object>, 'short_description': <django.forms.fields.CharField object>, 'staff_members': <django.forms.models.ModelMultipleChoiceField object>, 'status': <enumfields.forms.EnumChoiceField object>}
declared_fields = {'description': <django.forms.fields.CharField object>, 'maintenance_message': <django.forms.fields.CharField object>, 'name': <django.forms.fields.CharField object>, 'public_name': <django.forms.fields.CharField object>, 'short_description': <django.forms.fields.CharField object>}
property media

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

class shuup.admin.modules.shops.forms.ContactAddressForm(data=None, files=None, auto_id='id_%s', prefix=None, initial=None, error_class=<class 'django.forms.utils.ErrorList'>, label_suffix=None, empty_permitted=False, instance=None, use_required_attribute=None, renderer=None)[source]

Bases: ModelForm

class Meta[source]

Bases: object

model

alias of MutableAddress

fields = ('prefix', 'name', 'suffix', 'name_ext', 'phone', 'email', 'street', 'street2', 'street3', 'postal_code', 'city', 'region_code', 'region', 'country', 'tax_number', 'latitude', 'longitude')
base_fields = {'city': <django.forms.fields.CharField object>, 'country': <django_countries.fields.LazyTypedChoiceField object>, 'email': <django.forms.fields.EmailField object>, 'latitude': <django.forms.fields.DecimalField object>, 'longitude': <django.forms.fields.DecimalField object>, 'name': <django.forms.fields.CharField object>, 'name_ext': <django.forms.fields.CharField object>, 'phone': <django.forms.fields.CharField object>, 'postal_code': <django.forms.fields.CharField object>, 'prefix': <django.forms.fields.CharField object>, 'region': <django.forms.fields.CharField object>, 'region_code': <django.forms.fields.CharField object>, 'street': <django.forms.fields.CharField object>, 'street2': <django.forms.fields.CharField object>, 'street3': <django.forms.fields.CharField object>, 'suffix': <django.forms.fields.CharField object>, 'tax_number': <django.forms.fields.CharField object>}
declared_fields = {}
property media

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

class shuup.admin.modules.shops.forms.ShopWizardForm(**kwargs)[source]

Bases: ShuupAdminForm

class Meta[source]

Bases: object

model

alias of Shop

fields = ('public_name', 'logo', 'currency', 'prices_include_tax')
labels = {'public_name': 'Shop name'}
__init__(**kwargs)[source]
save()[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 = {'currency': <django.forms.fields.CharField object>, 'logo': <filer.fields.image.AdminImageFormField object>, 'prices_include_tax': <django.forms.fields.BooleanField object>, 'public_name': <django.forms.fields.CharField object>}
declared_fields = {'public_name': <django.forms.fields.CharField object>}
property media

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

class shuup.admin.modules.shops.forms.ShopAddressWizardForm(**kwargs)[source]

Bases: ModelForm

class Meta[source]

Bases: object

model

alias of MutableAddress

fields = ('first_name', 'last_name', 'phone', 'street', 'street2', 'postal_code', 'city', 'country', 'region_code', 'region')
widgets = {'region_code': <django.forms.widgets.Select object>}
labels = {'postal_code': 'Zip/Postal code', 'region_code': 'State/Province', 'street': 'Address', 'street2': 'Address (2)'}
help_texts = {'city': 'The city in which your shop is located.', 'country': 'The country in which your shop is located.', 'postal_code': 'The shop zip/postal code.', 'street': 'The shop street address. This may be used to provide estimated shipping costs.'}
__init__(**kwargs)[source]
save()[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 = {'city': <django.forms.fields.CharField object>, 'country': <django_countries.fields.LazyTypedChoiceField object>, 'first_name': <django.forms.fields.CharField object>, 'last_name': <django.forms.fields.CharField object>, 'phone': <django.forms.fields.CharField object>, 'postal_code': <django.forms.fields.CharField object>, 'region': <django.forms.fields.CharField object>, 'region_code': <django.forms.fields.CharField object>, 'street': <django.forms.fields.CharField object>, 'street2': <django.forms.fields.CharField object>}
declared_fields = {'first_name': <django.forms.fields.CharField object>, 'last_name': <django.forms.fields.CharField object>}
property media

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

Module contents

class shuup.admin.modules.shops.ShopModule[source]

Bases: AdminModule

name = 'Shops'
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_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_search_results(request, query)[source]
Return type:

list[shuup.admin.base.SearchResult]

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.