shuup.admin.views package

Submodules

shuup.admin.views.auth module

class shuup.admin.views.auth.LogoutView(**kwargs)

Bases: LogoutView

Constructor. Called in the URLconf; can contain helpful extra keyword arguments, and other things.

template_name = 'shuup/admin/auth/logout.jinja'

class shuup.admin.views.auth.LoginView(**kwargs)

Bases: LoginView

Constructor. Called in the URLconf; can contain helpful extra keyword arguments, and other things.

form_class

alias of EmailAuthenticationForm

shuup.admin.views.dashboard module

class shuup.admin.views.dashboard.DashboardView(**kwargs)

Bases: TemplateView

Constructor. Called in the URLconf; can contain helpful extra keyword arguments, and other things.

template_name = 'shuup/admin/dashboard/dashboard.jinja'

get_context_data(**kwargs)

get(request, *args, **kwargs)

shuup.admin.views.edit module

class shuup.admin.views.edit.EditObjectView(**kwargs)

Bases: View

Constructor. Called in the URLconf; can contain helpful extra keyword arguments, and other things.

get(request)

shuup.admin.views.home module

class shuup.admin.views.home.HelpBlockCategory(value)

Bases: Enum

PRODUCTS = 1

ORDERS = 2

CAMPAIGNS = 3

CONTACTS = 4

STOREFRONT = 5

GENERAL = 200

class shuup.admin.views.home.SimpleHelpBlock(text, **kwargs)

Bases: object

__init__(text, **kwargs)

class shuup.admin.views.home.HomeView(**kwargs)

Bases: TemplateView

Constructor. Called in the URLconf; can contain helpful extra keyword arguments, and other things.

template_name = 'shuup/admin/home/home.jinja'

get_context_data(**kwargs)

shuup.admin.views.impersonate module

shuup.admin.views.impersonate.stop_impersonating_staff(request)

shuup.admin.views.menu module

class shuup.admin.views.menu.MenuView(**kwargs)

Bases: TemplateView

Constructor. Called in the URLconf; can contain helpful extra keyword arguments, and other things.

template_name = 'shuup/admin/base/_main_menu.jinja'

class shuup.admin.views.menu.MenuToggleView(**kwargs)

Bases: View

Constructor. Called in the URLconf; can contain helpful extra keyword arguments, and other things.

post(request, *args, **kwargs)

shuup.admin.views.password module

class shuup.admin.views.password.RequestPasswordView(**kwargs)

Bases: FormView

Constructor. Called in the URLconf; can contain helpful extra keyword arguments, and other things.

template_name = 'shuup/admin/auth/request_password.jinja'

get_form_class()

Return the form class to use.

get_success_url()

Return the URL to redirect to after processing a valid form.

get_form_kwargs()

Return the keyword arguments for instantiating the form.

form_valid(form)

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

class shuup.admin.views.password.ResetPasswordView(**kwargs)

Bases: FormView

Constructor. Called in the URLconf; can contain helpful extra keyword arguments, and other things.

template_name = 'shuup/admin/auth/reset_password.jinja'

success_url = '/sa/'

token_generator = <django.contrib.auth.tokens.PasswordResetTokenGenerator object>

get_form_class()

Return the form class to use.

get_form_kwargs()

Return the keyword arguments for instantiating the form.

get_target_user()

dispatch(request, *args, **kwargs)

form_valid(form)

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

shuup.admin.views.search module

shuup.admin.views.search.get_search_results(request, query)

class shuup.admin.views.search.SearchView(**kwargs)

Bases: View

Constructor. Called in the URLconf; can contain helpful extra keyword arguments, and other things.

get(request, *args, **kwargs)

shuup.admin.views.select module

class shuup.admin.views.select.MultiselectAjaxView(**kwargs)

Bases: TemplateView

This view is deprecated and it will be removed on version 3.

Constructor. Called in the URLconf; can contain helpful extra keyword arguments, and other things.

model = None

search_fields: List[str] = []

result_limit = 20

init_search_fields(cls)

Configure the fields to use for searching.

If the cls object has a search_fields attribute, it will be used, otherwise, the class will be inspected and the attribute name or translations__name will mainly be used.

Other fields will be used for already known cls instances.

get_data(request, *args, **kwargs)

get(request, *args, **kwargs)

class shuup.admin.views.select.ObjectSelectorView(**kwargs)

Bases: TemplateView

Base class for responding to searches from select2 components.

Constructor. Called in the URLconf; can contain helpful extra keyword arguments, and other things.

get(request, *args, **kwargs)

class shuup.admin.views.select.BaseAdminObjectSelector(selector, shop, user, supplier=None, *args, **kwargs)

Bases: object

search_limit = 20

model: Type[Any] | None = None

__init__(selector, shop, user, supplier=None, *args, **kwargs)

classmethod get_selector_for_model(model)

classmethod handles_selector(selector) → bool

classmethod handle_subclass_selector(selector, parent_model)

has_permission() → bool

get_objects(search_term, *args, **kwargs) → Iterable[Tuple[int, str]] | List[Dict[str, Any]]

shuup.admin.views.tour module

class shuup.admin.views.tour.TourView(**kwargs)

Bases: View

Constructor. Called in the URLconf; can contain helpful extra keyword arguments, and other things.

post(request, *args, **kwargs)

shuup.admin.views.wizard module

class shuup.admin.views.wizard.WizardFormDefMixin(**kwargs)

Bases: object

__init__(**kwargs)

class shuup.admin.views.wizard.WizardFormDef(**kwargs)

Bases: WizardFormDefMixin, FormDef

class shuup.admin.views.wizard.TemplatedWizardFormDef(**kwargs)

Bases: WizardFormDefMixin, TemplatedFormDef

class shuup.admin.views.wizard.WizardPane(request, object=None)

Bases: FormPart

identifier = ''

title = ''

text = ''

icon = ''

can_skip = False

editable = True

visible()

Returns whether this pane is visible for editing.

valid()

Returns whether this pane is valid and should be included in wizard pane list.

class shuup.admin.views.wizard.WizardView(**kwargs)

Bases: TemplateView

Constructor. Called in the URLconf; can contain helpful extra keyword arguments, and other things.

template_name = 'shuup/admin/wizard/wizard.jinja'

panes

get_all_pane_forms()

current_pane

get_final_pane_identifier()

get_context_data(**kwargs)

get_form_group_for_pane(pane)

get_form()

form_valid(form)

form_invalid(form)

post(request, *args, **kwargs)

get(request, *args, **kwargs)

Module contents