shuup.front.apps.auth package

Submodules

shuup.front.apps.auth.forms module

class shuup.front.apps.auth.forms.EmailAuthenticationForm(*args, **kwargs)

Bases: AuthenticationForm

The ‘request’ parameter is set for custom auth use by subclasses. The form data comes in via the standard ‘data’ kwarg.

error_messages = {'inactive': 'This account is inactive.', 'invalid_login': 'Error! Please enter a correct %(username)s and password. Note that both fields may be case-sensitive. In case of multiple accounts with same email only username can be used to log in.'}

__init__(*args, **kwargs)

The ‘request’ parameter is set for custom auth use by subclasses. The form data comes in via the standard ‘data’ kwarg.

clean_username()

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__’.

confirm_login_allowed(user)

Do not let inactive person contact user to login.

base_fields = {'password': <django.forms.fields.CharField object>, 'username': <django.contrib.auth.forms.UsernameField object>}

declared_fields = {'password': <django.forms.fields.CharField object>, 'username': <django.contrib.auth.forms.UsernameField object>}

property media

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

shuup.front.apps.auth.settings module

shuup.front.apps.auth.settings.SHUUP_AUTH_LOGIN_FORM_SPEC = 'shuup.front.apps.auth.forms.EmailAuthenticationForm'

Specify the authentication form to be used in login views

shuup.front.apps.auth.urls module

shuup.front.apps.auth.views module

class shuup.front.apps.auth.views.LoginView(**kwargs)

Bases: FormView

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

template_name = 'shuup/user/login.jinja'

form_class

alias of EmailAuthenticationForm

get_context_data(**kwargs)

Insert the form into the context dict.

get_form_kwargs()

Return the keyword arguments for instantiating the form.

get_form(form_class=None, id_prefix='auth')

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

form_valid(form)

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

get_success_url()

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

class shuup.front.apps.auth.views.LogoutView(**kwargs)

Bases: TemplateView

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

template_name = 'shuup/user/logout.jinja'

dispatch(request, *args, **kwargs)

class shuup.front.apps.auth.views.RecoverPasswordView(**kwargs)

Bases: FormView

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

template_name = 'shuup/user/recover_password.jinja'

form_class

alias of RecoverPasswordForm

success_url = '/recover-password/sent/'

form_valid(form)

class shuup.front.apps.auth.views.RecoverPasswordConfirmView(**kwargs)

Bases: FormView

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

template_name = 'shuup/user/recover_password_confirm.jinja'

form_class

alias of SetPasswordForm

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

success_url = '/recover-password/complete/'

get_form_kwargs()

Return the keyword arguments for instantiating the form.

get_target_user()

dispatch(request, *args, **kwargs)

form_valid(form)

class shuup.front.apps.auth.views.RecoverPasswordSentView(**kwargs)

Bases: TemplateView

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

template_name = 'shuup/user/recover_password_sent.jinja'

class shuup.front.apps.auth.views.RecoverPasswordCompleteView(**kwargs)

Bases: TemplateView

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

template_name = 'shuup/user/recover_password_complete.jinja'

Module contents

class shuup.front.apps.auth.AuthAppConfig(*args, **kwargs)

Bases: AppConfig

name = 'shuup.front.apps.auth'

verbose_name = 'Shuup Frontend - User Authentication'

label = 'shuup_front_auth'

provides = {'front_urls': ['shuup.front.apps.auth.urls:urlpatterns']}

See /provides for details about the provides variable.