1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
|
.. _forms:
.. module:: django_registration.forms
Base form classes
=================
Several form classes are provided with django-registration,
covering common cases for gathering account information and
implementing common constraints for user registration. These forms
were designed with django-registration's built-in registration
workflows in mind, but may also be useful in other situations.
.. class:: RegistrationForm
A form for registering an account. This is a subclass of Django's
built-in :class:`~django.contrib.auth.forms.UserCreationForm`, and
has the following fields, all of which are required:
`username`
The username to use for the new account.
`email`
The email address to use for the new account.
`password1`
The password to use for the new account.
`password2`
The password to use for the new account, repeated to catch
typos.
.. note:: **Validation of usernames**
Django supplies a default regex-based validator for usernames in
its base :class:`~django.contrib.auth.models.AbstractBaseUser`
implementation, allowing any word character along with the
following set of additional characters: `.`, `@`, `+`, and
`-`.
Because it's a subclass of Django's
:class:`~django.contrib.auth.forms.UserCreationForm`,
:class:`RegistrationForm` will inherit the base validation
defined by Django. It also applies some custom validators to the
username:
:class:`~django_registration.validators.ReservedNameValidator`,
and
:func:`~django_registration.validators.validate_confusables`.
.. note:: **Validation of email addresses**
django-registration applies two additional validators --
:class:`~django_registration.validators.HTML5EmailValidator` and
:func:`~django_registration.validators.validate_confusables_email`
-- to the email address.
The HTML5 validator uses `the HTML5 email-validation rule
<https://html.spec.whatwg.org/multipage/input.html#e-mail-state-(type=email)>`_
(as implemented on HTML's `input type="email"`), which is more
restrictive than the email RFCs. The purpose of this validator
is twofold: to match the behavior of HTML5, and to simplify
django-registration's other validators. The full RFC grammar for
email addresses is enormously complex despite most of its
features rarely if ever being used legitimately, so disallowing
those features allows other validators to interact with a much
simpler format, ensuring performance, reliability and safety.
.. note:: **Custom user models**
If you are using `a custom user model
<https://docs.djangoproject.com/en/stable/topics/auth/customizing/#substituting-a-custom-user-model>`_,
you **must** subclass this form and tell it to use your custom
user model instead of Django's default user model. If you do
not, django-registration will deliberately crash with an error
message reminding you to do this. See :ref:`the custom user
compatibility guide <custom-user>` for details.
.. class:: RegistrationFormCaseInsensitive
A subclass of :class:`RegistrationForm` which enforces
case-insensitive uniqueness of usernames, by applying
:class:`~django_registration.validators.CaseInsensitiveUnique`
to the username field.
.. note:: **Unicode case handling**
This form will normalize the username value to form NFKC,
matching Django's default approach to Unicode normalization. it
will then case fold the value, and use a case-insensitive
(`iexact`) lookup to determine if a user with the same username
already exists; the results of this query may depend on the
quality of your database's Unicode implementation, and on
configuration details. The results may also be surprising to
developers who are primarily used to English/ASCII text, as
Unicode's case rules can be quite complex.
.. class:: RegistrationFormTermsOfService
A subclass of :class:`RegistrationForm` which adds one additional,
required field:
`tos`
A checkbox indicating agreement to the site's terms of
service/user agreement.
.. class:: RegistrationFormUniqueEmail
A subclass of :class:`RegistrationForm` which enforces uniqueness
of email addresses in addition to uniqueness of usernames, by
applying
:class:`~django_registration.validators.CaseInsensitiveUnique` to
the email field.
|
