shuup.front.checkout package

Submodules

shuup.front.checkout.addresses module

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

Bases: TaxNumberCleanMixin, ModelForm

class Meta

Bases: object

model

alias of CompanyContact

fields = ('name', 'tax_number')

__init__(**kwargs)

clean()

Hook for doing any extra form-wide cleaning after Field.clean() has been called on every field. Any ValidationError raised by this method will not be associated with a particular field; it will have a special-case association with the field named ‘__all__’.

base_fields = {'name': <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.front.checkout.addresses.SavedAddressForm(owner, kind, **kwargs)

Bases: Form

kind_to_role_map = {'billing': SavedAddressRole.BILLING, 'shipping': SavedAddressRole.SHIPPING}

__init__(owner, kind, **kwargs)

base_fields = {'addresses': <django.forms.fields.ChoiceField object>}

declared_fields = {'addresses': <django.forms.fields.ChoiceField object>}

property media

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

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

Bases: CheckoutPhaseViewMixin, 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

property address_kinds

get_form(form_class=None)

Return an instance of the form to be used in this view.

get_initial()

Return the initial data to use for forms on this view.

is_valid()

form_valid(form)

If the form is valid, redirect to the supplied URL.

process()

get_context_data(**kwargs)

Insert the form into the context dict.

shuup.front.checkout.checkout_method module

class shuup.front.checkout.checkout_method.CheckoutMethodChoices(value)

Bases: Enum

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: Form

base_fields = {'register': <django.forms.fields.ChoiceField object>}

declared_fields = {'register': <django.forms.fields.ChoiceField object>}

property media

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

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

Bases: CheckoutPhaseViewMixin, 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)

Return an instance of the form to be used in this view.

is_visible_for_user()

should_skip()

is_valid()

form_valid(form)

If the form is valid, redirect to the supplied URL.

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: CheckoutPhaseViewMixin, 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: Form

__init__(*args, **kwargs)

clean()

Hook for doing any extra form-wide cleaning after Field.clean() has been called on every field. Any ValidationError raised by this method will not be associated with a particular field; it will have a special-case association with the field named ‘__all__’.

base_fields = {'accept_terms': <django.forms.fields.BooleanField object>, 'comment': <django.forms.fields.CharField object>, 'marketing': <django.forms.fields.BooleanField object>, 'product_ids': <django.forms.fields.CharField object>}

declared_fields = {'accept_terms': <django.forms.fields.BooleanField object>, 'comment': <django.forms.fields.CharField object>, 'marketing': <django.forms.fields.BooleanField object>, 'product_ids': <django.forms.fields.CharField object>}

property media

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

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

Bases: CheckoutPhaseViewMixin, 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()

Return the keyword arguments for instantiating the form.

get_context_data(**kwargs)

Insert the form into the context dict.

form_valid(form)

If the form is valid, redirect to the supplied URL.

create_order()

shuup.front.checkout.empty module

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

Bases: CheckoutPhaseViewMixin, 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: Widget

__init__(attrs=None, choices=())

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

Render the widget as an HTML string.

property media

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

Bases: ModelChoiceIterator

choice(obj)

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

Bases: Form

__init__(*args, **kwargs)

limit_method_fields()

base_fields = {}

declared_fields = {}

property media

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

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

Bases: CheckoutPhaseViewMixin, 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()

Return the keyword arguments for instantiating the form.

form_valid(form)

If the form is valid, redirect to the supplied URL.

get_initial()

Return the initial data to use for forms on this view.

get_context_data(**kwargs)

Insert the form into the context dict.

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

Bases: _MethodDependentCheckoutPhase, 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()

Return type:

shuup.core.models.Service

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

Bases: _MethodDependentCheckoutPhase, 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()

Return type:

shuup.core.models.Service

Module contents

class shuup.front.checkout.BasicServiceCheckoutPhaseProvider

Bases: 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.

__init__(checkout_process=None, horizontal_template=True, *args, **kwargs)

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.

property basket

The basket used in this checkout phase.

Return type:

shuup.front.basket.objects.BaseBasket

property 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.

property storage

title = None

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

Bases: object

Initialize this checkout process.

__init__(phase_specs, phase_kwargs, view=None)

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.

property 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)

property phases

Iterable[CheckoutPhaseViewMixin]

Type:

rtype

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.

abstractmethod 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: CheckoutProcess

Initialize this checkout process.

horizontal_template = False