shuup.admin.modules.service_providers package

Subpackages

Submodules

shuup.admin.modules.service_providers.forms module

class shuup.admin.modules.service_providers.forms.CustomCarrierForm(**kwargs)[source]

Bases: ShuupAdminForm

class Meta[source]

Bases: object

model

alias of CustomCarrier

exclude = ('identifier',)
base_fields = {'enabled': <django.forms.fields.BooleanField object>, 'logo': <filer.fields.image.AdminImageFormField object>, 'name': <django.forms.fields.CharField object>, 'shops': <django.forms.models.ModelMultipleChoiceField object>, 'supplier': <django.forms.models.ModelChoiceField 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.service_providers.forms.CustomPaymentProcessorForm(**kwargs)[source]

Bases: ShuupAdminForm

class Meta[source]

Bases: object

model

alias of CustomPaymentProcessor

exclude = ('identifier',)
base_fields = {'enabled': <django.forms.fields.BooleanField object>, 'logo': <filer.fields.image.AdminImageFormField object>, 'name': <django.forms.fields.CharField object>, 'rounding_mode': <enumfields.forms.EnumChoiceField object>, 'rounding_quantize': <django.forms.fields.DecimalField object>, 'shops': <django.forms.models.ModelMultipleChoiceField object>, 'supplier': <django.forms.models.ModelChoiceField object>}
declared_fields = {'name': <django.forms.fields.CharField object>}
property media

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

shuup.admin.modules.service_providers.wizard_form_defs module

class shuup.admin.modules.service_providers.wizard_form_defs.ServiceWizardFormDef(name, form_class, template_name, request, extra_js='')[source]

Bases: TemplatedWizardFormDef

priority = 0
__init__(name, form_class, template_name, request, extra_js='')[source]
visible()[source]
class shuup.admin.modules.service_providers.wizard_form_defs.ManualShippingWizardFormDef(request)[source]

Bases: ServiceWizardFormDef

priority = 1000
__init__(request)[source]
class shuup.admin.modules.service_providers.wizard_form_defs.ManualPaymentWizardFormDef(request)[source]

Bases: ServiceWizardFormDef

priority = 1000
__init__(request)[source]

shuup.admin.modules.service_providers.wizard_forms module

class shuup.admin.modules.service_providers.wizard_forms.ServiceWizardForm(**kwargs)[source]

Bases: ShuupAdminForm

__init__(**kwargs)[source]
is_active()[source]
get_service_choice(provider)[source]
get_service()[source]
get_payment_method()[source]
get_shipping_method()[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 = {'service_name': <django.forms.fields.CharField object>}
declared_fields = {'service_name': <django.forms.fields.CharField object>}
property media

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

class shuup.admin.modules.service_providers.wizard_forms.ManualShippingWizardForm(**kwargs)[source]

Bases: ServiceWizardForm

__init__(**kwargs)[source]
class Meta[source]

Bases: object

model

alias of CustomCarrier

fields = ('name',)
base_fields = {'name': <django.forms.fields.CharField object>, 'service_description': <django.forms.fields.CharField object>, 'service_name': <django.forms.fields.CharField object>}
declared_fields = {'name': <django.forms.fields.CharField object>, 'service_description': <django.forms.fields.CharField object>, 'service_name': <django.forms.fields.CharField object>}
property media

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

class shuup.admin.modules.service_providers.wizard_forms.ManualPaymentWizardForm(**kwargs)[source]

Bases: ServiceWizardForm

__init__(**kwargs)[source]
class Meta[source]

Bases: object

model

alias of CustomPaymentProcessor

fields = ('name',)
base_fields = {'name': <django.forms.fields.CharField object>, 'service_description': <django.forms.fields.CharField object>, 'service_name': <django.forms.fields.CharField object>}
declared_fields = {'name': <django.forms.fields.CharField object>, 'service_description': <django.forms.fields.CharField object>, 'service_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.service_providers.ServiceProviderModule[source]

Bases: AdminModule

name = 'Service Providers'
category = 'Payment and Shipping'
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_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