shuup.front.checkout package

Submodules

shuup.front.checkout.addresses module

class shuup.front.checkout.addresses.CompanyForm(**kwargs)

Bases: shuup.front.utils.companies.TaxNumberCleanMixin, django.forms.models.ModelForm

class Meta

Bases: object

model

alias of CompanyContact

fields = ('name', 'tax_number')

clean()

base_fields = OrderedDict([('name', <django.forms.fields.CharField object>), ('tax_number', <django.forms.fields.CharField object>)])

declared_fields = OrderedDict()

media

class shuup.front.checkout.addresses.SavedAddressForm(owner, kind, **kwargs)

Bases: django.forms.forms.Form

kind_to_role_map = {'shipping': <SavedAddressRole.SHIPPING: 1>, 'billing': <SavedAddressRole.BILLING: 2>}

base_fields = OrderedDict([('addresses', <django.forms.fields.ChoiceField object>)])

declared_fields = OrderedDict([('addresses', <django.forms.fields.ChoiceField object>)])

media

class shuup.front.checkout.addresses.AddressesPhase(checkout_process=None, horizontal_template=True, *args, **kwargs)

Bases: shuup.front.checkout.CheckoutPhaseViewMixin, django.views.generic.edit.FormView

Initialize a checkout phase view.

Parameters:

• checkout_process (shuup.front.checkout.CheckoutProcess|None) – The checkout process of this phase.
• horizontal_template (bool) – Set this to False if you want to use single page checkout.

identifier = 'addresses'

title = 'Addresses'

template_name = 'shuup/front/checkout/addresses.jinja'

address_form_classes = {}

company_form_class

alias of CompanyForm

saved_address_form_class

alias of SavedAddressForm

address_kinds

get_form(form_class=None)

get_initial()

is_valid()

form_valid(form)

process()

get_context_data(**kwargs)

shuup.front.checkout.checkout_method module

class shuup.front.checkout.checkout_method.CheckoutMethodChoices

Bases: enumfields.enums.Enum

An enumeration.

CHECKOUT_AS_GUEST = 0

REGISTER = 1

class shuup.front.checkout.checkout_method.ChooseToRegisterForm(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, field_order=None, use_required_attribute=None, renderer=None)

Bases: django.forms.forms.Form

base_fields = OrderedDict([('register', <django.forms.fields.ChoiceField object>)])

declared_fields = OrderedDict([('register', <django.forms.fields.ChoiceField object>)])

media

class shuup.front.checkout.checkout_method.CheckoutMethodPhase(checkout_process=None, horizontal_template=True, *args, **kwargs)

Bases: shuup.front.checkout.CheckoutPhaseViewMixin, shuup.front.apps.auth.views.LoginView

Initialize a checkout phase view.

Parameters:

• checkout_process (shuup.front.checkout.CheckoutProcess|None) – The checkout process of this phase.
• horizontal_template (bool) – Set this to False if you want to use single page checkout.

identifier = 'checkout_method'

title = 'Checkout Method Choice'

template_name = 'shuup/front/checkout/checkout_method.jinja'

login_form_key = 'login'

checkout_method_choice_key = 'checkout_method_choice'

get_form(form_class=None)

is_visible_for_user()

should_skip()

is_valid()

form_valid(form)

process()

get_initial_form_group_kwargs()

Returns the keyword arguments for instantiating the form group.

class shuup.front.checkout.checkout_method.RegisterPhase(checkout_process=None, horizontal_template=True, *args, **kwargs)

Bases: shuup.front.checkout.CheckoutPhaseViewMixin, shuup.front.apps.registration.views.RegistrationNoActivationView

Initialize a checkout phase view.

Parameters:

• checkout_process (shuup.front.checkout.CheckoutProcess|None) – The checkout process of this phase.
• horizontal_template (bool) – Set this to False if you want to use single page checkout.

identifier = 'register'

title = 'Register'

template_name = 'shuup/front/checkout/register.jinja'

is_visible_for_user()

should_skip()

is_valid()

process()

shuup.front.checkout.confirm module

class shuup.front.checkout.confirm.ConfirmForm(*args, **kwargs)

Bases: django.forms.forms.Form

clean()

base_fields = OrderedDict([('product_ids', <django.forms.fields.CharField object>), ('accept_terms', <django.forms.fields.BooleanField object>), ('marketing', <django.forms.fields.BooleanField object>), ('comment', <django.forms.fields.CharField object>)])

declared_fields = OrderedDict([('product_ids', <django.forms.fields.CharField object>), ('accept_terms', <django.forms.fields.BooleanField object>), ('marketing', <django.forms.fields.BooleanField object>), ('comment', <django.forms.fields.CharField object>)])

media

class shuup.front.checkout.confirm.ConfirmPhase(checkout_process=None, horizontal_template=True, *args, **kwargs)

Bases: shuup.front.checkout.CheckoutPhaseViewMixin, django.views.generic.edit.FormView

Initialize a checkout phase view.

Parameters:

• checkout_process (shuup.front.checkout.CheckoutProcess|None) – The checkout process of this phase.
• horizontal_template (bool) – Set this to False if you want to use single page checkout.

identifier = 'confirm'

title = 'Confirmation'

template_name = 'shuup/front/checkout/confirm.jinja'

form_class

alias of ConfirmForm

process()

is_valid()

get_form_kwargs()

get_context_data(**kwargs)

form_valid(form)

create_order()

shuup.front.checkout.empty module

class shuup.front.checkout.empty.EmptyPhase(checkout_process=None, horizontal_template=True, *args, **kwargs)

Bases: shuup.front.checkout.CheckoutPhaseViewMixin, django.views.generic.base.TemplateView

Initialize a checkout phase view.

Parameters:

• checkout_process (shuup.front.checkout.CheckoutProcess|None) – The checkout process of this phase.
• horizontal_template (bool) – Set this to False if you want to use single page checkout.

identifier = 'empty'

title = 'Empty Basket'

template_name = 'shuup/front/checkout/empty.jinja'

process()

post(request, *args, **kwargs)

shuup.front.checkout.methods module

class shuup.front.checkout.methods.MethodWidget(attrs=None, choices=())

Bases: django.forms.widgets.Widget

render(name, value, attrs=None, renderer=None)

media

class shuup.front.checkout.methods.MethodChoiceIterator(field)

Bases: django.forms.models.ModelChoiceIterator

choice(obj)

class shuup.front.checkout.methods.MethodsForm(*args, **kwargs)

Bases: django.forms.forms.Form

limit_method_fields()

base_fields = OrderedDict()

declared_fields = OrderedDict()

media

class shuup.front.checkout.methods.MethodsPhase(checkout_process=None, horizontal_template=True, *args, **kwargs)

Bases: shuup.front.checkout.CheckoutPhaseViewMixin, django.views.generic.edit.FormView

Initialize a checkout phase view.

Parameters:

• checkout_process (shuup.front.checkout.CheckoutProcess|None) – The checkout process of this phase.
• horizontal_template (bool) – Set this to False if you want to use single page checkout.

identifier = 'methods'

title = 'Shipping & Payment'

template_name = 'shuup/front/checkout/methods.jinja'

form_class

alias of MethodsForm

is_valid()

process()

get_form_kwargs()

form_valid(form)

get_initial()

get_context_data(**kwargs)

class shuup.front.checkout.methods.ShippingMethodPhase(checkout_process=None, horizontal_template=True, *args, **kwargs)

Bases: shuup.front.checkout.methods._MethodDependentCheckoutPhase, django.views.generic.base.View

Initialize a checkout phase view.

Parameters:

• checkout_process (shuup.front.checkout.CheckoutProcess|None) – The checkout process of this phase.
• horizontal_template (bool) – Set this to False if you want to use single page checkout.

identifier = 'shipping'

get_method()

class shuup.front.checkout.methods.PaymentMethodPhase(checkout_process=None, horizontal_template=True, *args, **kwargs)

Bases: shuup.front.checkout.methods._MethodDependentCheckoutPhase, django.views.generic.base.View

Initialize a checkout phase view.

Parameters:

• checkout_process (shuup.front.checkout.CheckoutProcess|None) – The checkout process of this phase.
• horizontal_template (bool) – Set this to False if you want to use single page checkout.

identifier = 'payment'

get_method()

Module contents

class shuup.front.checkout.BasicServiceCheckoutPhaseProvider

Bases: shuup.front.checkout.ServiceCheckoutPhaseProvider

Helper for implementing basic ServiceCheckoutPhaseProvider.

This helper should be useful for most cases, where one only has to provide a checkout phase for certain service provider type just by initializing some predefined class.

get_checkout_phase(checkout_process, service)

Get checkout phase for given service.

Return type:shuup.front.checkout.CheckoutPhaseViewMixin|None

phase_class = None

service_provider_class = None

class shuup.front.checkout.CheckoutPhaseViewMixin(checkout_process=None, horizontal_template=True, *args, **kwargs)

Bases: object

Initialize a checkout phase view.

Parameters:

• checkout_process (shuup.front.checkout.CheckoutProcess|None) – The checkout process of this phase.
• horizontal_template (bool) – Set this to False if you want to use single page checkout.

basket

The basket used in this checkout phase.

Return type:shuup.front.basket.objects.BaseBasket

checkout_process

Get the checkout process of this phase.

Return type:shuup.front.checkout.CheckoutProcess

final = False

get_context_data(**kwargs)

get_success_url(*args, **kwargs)

get_url()

identifier = None

is_valid()

is_visible_for_user()

next_phase = None

phases = ()

previous_phase = None

process()

request = None

reset()

should_skip()

classmethod spawn_phases(checkout_process)

Returns an iterator of new phases generated by this phase for the given checkout process

Parameters:checkout_process (shuup.front.checkout.CheckoutProcess) – The checkout process to check for new phases.

storage

title = None

class shuup.front.checkout.CheckoutProcess(phase_specs, phase_kwargs, view=None)

Bases: object

Initialize this checkout process.

add_phase_attributes(target_phase, current_phase=None)

Add phase instance attributes (previous, next, etc) to the given target phase, using the optional current_phase as the current phase for previous and next.

This is exposed as a public API for the benefit of phases that need to do sub-phase initialization and dispatching, such as method phases.

basket

The basket used in this checkout process.

Return type:shuup.front.basket.objects.BaseBasket

complete()

To be called from a phase (self.checkout_process.complete()) when the checkout process is complete.

get_current_phase(requested_phase_identifier)

get_next_phase(current_phase, target_phase)

get_phase_url(phase)

get_previous_phase(current_phase, target_phase)

horizontal_template = True

instantiate_phase_class(phase_class, **extra_kwargs)

phases

Return type:Iterable[CheckoutPhaseViewMixin]

prepare_current_phase(phase_identifier)

reset()

class shuup.front.checkout.ServiceCheckoutPhaseProvider

Bases: object

Interface for providing checkout phase for a service.

Items specified in front_service_checkout_phase_provider provide category should implement this interface.

get_checkout_phase(checkout_process, service)

Get checkout phase for given service.

If this provider is for another service, then the return value will be None.

Return type:shuup.front.checkout.CheckoutPhaseViewMixin|None

class shuup.front.checkout.VerticalCheckoutProcess(phase_specs, phase_kwargs, view=None)

Bases: shuup.front.checkout.CheckoutProcess

Initialize this checkout process.

horizontal_template = False