-
-
-
+
+ {% endraw %}
+ {% if cookiecutter.username_type == "email" %}
+ {% raw %}{{ user.first_name }}{% endraw %}
+ {% else %}
+ {% raw %}{{ user.username }}{% endraw %}
+ {% endif %}
+ {% raw %}
+
+
{% endblock content %}
{%- endraw %}
diff --git a/{{cookiecutter.project_slug}}/{{cookiecutter.project_slug}}/users/adapters.py b/{{cookiecutter.project_slug}}/{{cookiecutter.project_slug}}/users/adapters.py
index 371b1f935..000ca092a 100644
--- a/{{cookiecutter.project_slug}}/{{cookiecutter.project_slug}}/users/adapters.py
+++ b/{{cookiecutter.project_slug}}/{{cookiecutter.project_slug}}/users/adapters.py
@@ -55,10 +55,10 @@ class SocialAccountAdapter(DefaultSocialAccountAdapter):
if request.user.is_authenticated and request.user.email != verified_email.email:
messages.error(
request,
- """
- No es posible enlazar tu cuenta de {},
- ya que no coincide con tu correo en esta plataforma.
- """.format(
+ (
+ "No es posible enlazar tu cuenta de {}, "
+ "ya que no coincide con tu correo en esta plataforma."
+ ).format(
list(request._socialapp_cache.keys())[0].capitalize()
),
)
diff --git a/{{cookiecutter.project_slug}}/{{cookiecutter.project_slug}}/users/admin.py b/{{cookiecutter.project_slug}}/{{cookiecutter.project_slug}}/users/admin.py
index 96692ff91..adbc33421 100644
--- a/{{cookiecutter.project_slug}}/{{cookiecutter.project_slug}}/users/admin.py
+++ b/{{cookiecutter.project_slug}}/{{cookiecutter.project_slug}}/users/admin.py
@@ -21,9 +21,13 @@ class UserAdmin(auth_admin.UserAdmin):
add_form = UserAdminCreationForm
readonly_fields = ("uuid",)
fieldsets = (
+ {%- if cookiecutter.username_type == "email" %}
(None, {"fields": ("email", "password")}),
(_("Personal info"), {"fields": ("first_name", "last_name")}),
- (None, {"fields": ("uuid",)}),
+ {%- else %}
+ (None, {"fields": ("username", "password")}),
+ (_("Personal info"), {"fields": ("first_name", "last_name", "email")}),
+ {%- endif %}
(
_("Permissions"),
{
@@ -39,15 +43,16 @@ class UserAdmin(auth_admin.UserAdmin):
(_("Important dates"), {"fields": ("last_login", "date_joined")}),
)
list_display = [
- "email",
+ "{{cookiecutter.username_type}}",
"first_name",
"last_name",
"is_active",
"is_staff",
"is_superuser",
]
- search_fields = ["email", "first_name", "last_name"]
- ordering = ("email", "first_name", "last_name")
+ search_fields = ["{{cookiecutter.username_type}}", "first_name", "last_name"]
+ ordering = ("{{cookiecutter.username_type}}", "first_name", "last_name")
+ {%- if cookiecutter.username_type == "email" %}
add_fieldsets = (
(
None,
@@ -63,3 +68,21 @@ class UserAdmin(auth_admin.UserAdmin):
},
),
)
+ {%- else %}
+ add_fieldsets = (
+ (
+ None,
+ {
+ "classes": ("wide",),
+ "fields": (
+ "username",
+ "first_name",
+ "last_name",
+ "email",
+ "password1",
+ "password2",
+ ),
+ },
+ ),
+ )
+ {%- endif %}
diff --git a/{{cookiecutter.project_slug}}/{{cookiecutter.project_slug}}/users/api/serializers.py b/{{cookiecutter.project_slug}}/{{cookiecutter.project_slug}}/users/api/serializers.py
index 30c2c3166..c675449e4 100644
--- a/{{cookiecutter.project_slug}}/{{cookiecutter.project_slug}}/users/api/serializers.py
+++ b/{{cookiecutter.project_slug}}/{{cookiecutter.project_slug}}/users/api/serializers.py
@@ -6,5 +6,11 @@ from {{ cookiecutter.project_slug }}.users.models import User
class UserSerializer(serializers.ModelSerializer[User]):
class Meta:
model = User
+ {%- if cookiecutter.username_type == "email" %}
fields = ["email", "uuid", "first_name", "last_name", "url"]
- extra_kwargs = {"url": {"view_name": "api:user-detail", "lookup_field": "uuid"}}
+ {%- else %}
+ fields = ["username", "email", "uuid", "first_name", "last_name", "url"]
+ {%- endif %}
+ extra_kwargs = {
+ "url": {"view_name": "api:user-detail", "lookup_field": "uuid"}
+ }
diff --git a/{{cookiecutter.project_slug}}/{{cookiecutter.project_slug}}/users/forms.py b/{{cookiecutter.project_slug}}/{{cookiecutter.project_slug}}/users/forms.py
index 8fa71330c..99939d980 100644
--- a/{{cookiecutter.project_slug}}/{{cookiecutter.project_slug}}/users/forms.py
+++ b/{{cookiecutter.project_slug}}/{{cookiecutter.project_slug}}/users/forms.py
@@ -1,8 +1,9 @@
from allauth.account.forms import SignupForm
from allauth.socialaccount.forms import SignupForm as SocialSignupForm
-from django import forms
from django.contrib.auth import forms as admin_forms
-from django.contrib.auth import get_user_model
+{%- if cookiecutter.username_type == "email" %}
+from django.forms import EmailField
+{%- endif %}
from django.utils.translation import gettext_lazy as _
User = get_user_model()
@@ -11,7 +12,9 @@ User = get_user_model()
class UserAdminChangeForm(admin_forms.UserChangeForm):
class Meta(admin_forms.UserChangeForm.Meta): # type: ignore[name-defined]
model = User
- fields = ("email", "first_name", "last_name")
+ {%- if cookiecutter.username_type == "email" %}
+ field_classes = {"email": EmailField}
+ {%- endif %}
class UserAdminCreationForm(admin_forms.UserCreationForm):
@@ -22,14 +25,18 @@ class UserAdminCreationForm(admin_forms.UserCreationForm):
class Meta(admin_forms.UserCreationForm.Meta): # type: ignore[name-defined]
model = User
+ {%- if cookiecutter.username_type == "email" %}
fields = ("email", "first_name", "last_name")
-
+ field_classes = {"email": EmailField}
error_messages = {
- "email": {"unique": _("This email has already been taken.")}
+ "email": {"unique": _("This email has already been taken.")},
}
+ {%- else %}
+ fields = ("username", "first_name", "last_name")
error_messages = {
"username": {"unique": _("This username has already been taken.")},
}
+ {%- endif %}
class UserSignupForm(SignupForm):
diff --git a/{{cookiecutter.project_slug}}/{{cookiecutter.project_slug}}/users/migrations/0001_initial.py b/{{cookiecutter.project_slug}}/{{cookiecutter.project_slug}}/users/migrations/0001_initial.py
index 6a544021a..08aceb411 100644
--- a/{{cookiecutter.project_slug}}/{{cookiecutter.project_slug}}/users/migrations/0001_initial.py
+++ b/{{cookiecutter.project_slug}}/{{cookiecutter.project_slug}}/users/migrations/0001_initial.py
@@ -44,6 +44,36 @@ class Migration(migrations.Migration):
verbose_name="superuser status",
),
),
+ {%- if cookiecutter.username_type == "username" -%}
+ (
+ "username",
+ models.CharField(
+ error_messages={
+ "unique": "A user with that username already exists."
+ },
+ help_text="Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.",
+ max_length=150,
+ unique=True,
+ validators=[
+ django.contrib.auth.validators.UnicodeUsernameValidator()
+ ],
+ verbose_name="username",
+ ),
+ ),
+ (
+ "email",
+ models.EmailField(
+ blank=True, max_length=254, verbose_name="email address",
+ ),
+ ),
+ {%- else %}
+ (
+ "email",
+ models.EmailField(
+ unique=True, max_length=254, verbose_name="email address",
+ ),
+ ),
+ {%- endif %}
(
"is_staff",
models.BooleanField(
@@ -66,12 +96,6 @@ class Migration(migrations.Migration):
default=django.utils.timezone.now, verbose_name="date joined",
),
),
- (
- "email",
- models.EmailField(
- max_length=254, unique=True, verbose_name="email address"
- ),
- ),
(
"uuid",
models.UUIDField(
@@ -115,7 +139,11 @@ class Migration(migrations.Migration):
"abstract": False,
},
managers=[
- ('objects', {{ cookiecutter.project_slug }}.users.models.UserManager()),
+ {%- if cookiecutter.username_type == "email" %}
+ ("objects", {{cookiecutter.project_slug}}.users.models.UserManager()),
+ {%- else %}
+ ("objects", django.contrib.auth.models.UserManager()),
+ {%- endif %}
],
),
]
diff --git a/{{cookiecutter.project_slug}}/{{cookiecutter.project_slug}}/users/models.py b/{{cookiecutter.project_slug}}/{{cookiecutter.project_slug}}/users/models.py
index f81d2446f..cfd3bc447 100644
--- a/{{cookiecutter.project_slug}}/{{cookiecutter.project_slug}}/users/models.py
+++ b/{{cookiecutter.project_slug}}/{{cookiecutter.project_slug}}/users/models.py
@@ -1,14 +1,19 @@
import uuid as uuid_lib
-
+{%- if cookiecutter.username_type == "email" %}
from typing import ClassVar
-from django.contrib.auth.base_user import BaseUserManager
+{% endif -%}
from django.contrib.auth.models import AbstractUser
-from django.db import models
+from django.db.models import CharField
+{%- if cookiecutter.username_type == "email" %}
+from django.db.models import EmailField
+{%- endif %}
from django.urls import reverse
from django.utils.translation import gettext_lazy as _
+{%- if cookiecutter.username_type == "email" %}
from .managers import UserManager
+{%- endif %}
class User(AbstractUser):
@@ -18,22 +23,23 @@ class User(AbstractUser):
check forms.SignupForm and forms.SocialSignupForms accordingly.
"""
- email = models.EmailField(_("email address"), unique=True)
- username = None
uuid = models.UUIDField(
unique=True, db_index=True, default=uuid_lib.uuid4, editable=False
)
first_name = models.CharField(_("first name"), max_length=150)
last_name = models.CharField(_("last name"), max_length=150)
+ {%- if cookiecutter.username_type == "email" %}
+ email = EmailField(_("email address"), unique=True)
+ username = None # type: ignore[assignment]
USERNAME_FIELD = "email"
-
REQUIRED_FIELDS = [
"first_name",
"last_name",
]
objects: ClassVar[UserManager] = UserManager()
+ {%- endif %}
def get_absolute_url(self) -> str:
"""Get URL for user's detail view.
@@ -45,7 +51,11 @@ class User(AbstractUser):
return reverse("users:detail", kwargs={"uuid": self.uuid})
def __str__(self):
+ { % - if cookiecutter.username_type == "email" %}
return f"{self.first_name} {self.last_name}"
+ { % - else %}
+ return f"{self.username}"
+ { % - endif %}
def save(self, *args, **kwargs):
self.first_name = self.first_name.strip()
diff --git a/{{cookiecutter.project_slug}}/{{cookiecutter.project_slug}}/users/tests/test_admin.py b/{{cookiecutter.project_slug}}/{{cookiecutter.project_slug}}/users/tests/test_admin.py
index 4482d5207..96f28f965 100644
--- a/{{cookiecutter.project_slug}}/{{cookiecutter.project_slug}}/users/tests/test_admin.py
+++ b/{{cookiecutter.project_slug}}/{{cookiecutter.project_slug}}/users/tests/test_admin.py
@@ -32,16 +32,28 @@ class TestUserAdmin:
data={
"first_name": "New",
"last_name": "Admin",
+ {%- if cookiecutter.username_type == "email" %}
"email": "new-admin@example.com",
+ {%- else %}
+ "username": "test",
+ {%- endif %}
"password1": "My_R@ndom-P@ssw0rd",
"password2": "My_R@ndom-P@ssw0rd",
},
)
assert response.status_code == HTTPStatus.FOUND
+ {%- if cookiecutter.username_type == "email" %}
assert User.objects.filter(email="new-admin@example.com").exists()
+ {%- else %}
+ assert User.objects.filter(username="test").exists()
+ {%- endif %}
def test_view_user(self, admin_client):
+ {%- if cookiecutter.username_type == "email" %}
user = User.objects.get(email="admin@example.com")
+ {%- else %}
+ user = User.objects.get(username="admin")
+ {%- endif %}
url = reverse("admin:users_user_change", kwargs={"object_id": user.pk})
response = admin_client.get(url)
assert response.status_code == HTTPStatus.OK
diff --git a/{{cookiecutter.project_slug}}/{{cookiecutter.project_slug}}/users/tests/test_drf_views.py b/{{cookiecutter.project_slug}}/{{cookiecutter.project_slug}}/users/tests/test_drf_views.py
index 2b57f058c..9d5a1ef56 100644
--- a/{{cookiecutter.project_slug}}/{{cookiecutter.project_slug}}/users/tests/test_drf_views.py
+++ b/{{cookiecutter.project_slug}}/{{cookiecutter.project_slug}}/users/tests/test_drf_views.py
@@ -29,6 +29,9 @@ class TestUserViewSet:
response = view.me(request) # type: ignore[call-arg, arg-type, misc]
assert response.data == {
+ {%- if cookiecutter.username_type == "username" %}
+ "username": user.username,
+ {%- endif %}
"email": user.email,
"uuid": str(user.uuid),
"first_name": user.first_name,
diff --git a/{{cookiecutter.project_slug}}/{{cookiecutter.project_slug}}/users/tests/test_forms.py b/{{cookiecutter.project_slug}}/{{cookiecutter.project_slug}}/users/tests/test_forms.py
index b1d30fa2f..17bfc9ee4 100644
--- a/{{cookiecutter.project_slug}}/{{cookiecutter.project_slug}}/users/tests/test_forms.py
+++ b/{{cookiecutter.project_slug}}/{{cookiecutter.project_slug}}/users/tests/test_forms.py
@@ -23,7 +23,11 @@ class TestUserAdminCreationForm:
# hence cannot be created.
form = UserAdminCreationForm(
{
+ {%- if cookiecutter.username_type == "email" %}
"email": user.email,
+ {%- else %}
+ "username": user.username,
+ {%- endif %}
"first_name": user.first_name,
"last_name": user.last_name,
"password1": user.password,
@@ -33,5 +37,10 @@ class TestUserAdminCreationForm:
assert not form.is_valid()
assert len(form.errors) == 1
+ {%- if cookiecutter.username_type == "email" %}
assert "email" in form.errors
assert form.errors["email"][0] == _("This email has already been taken.")
+ {%- else %}
+ assert "username" in form.errors
+ assert form.errors["username"][0] == _("This username has already been taken.")
+ {%- endif %}