如何将 max_length 添加到 allauth 用户名答案

【问题标题】：How to add max_length to allauth username如何将 max_length 添加到 allauth 用户名
【发布时间】：2018-11-06 00:05:01
【问题描述】：

我使用 Django allauth 作为我的 django 站点的用户帐户框架。文档显示有一个ACCOUNT_USERNAME_MIN_LENGTH，但由于某种原因没有ACCOUNT_USERNAME_MAX_LENGTH。

有没有办法为用户名创建最大长度？

这是我的自定义 allauth 注册表单 - 也许我可以在这里做点什么？：

class AllauthSignupForm(forms.Form):

    captcha = ReCaptchaField(
        public_key=config("RECAPTCHA_PUBLIC_KEY"),
        private_key=config("RECAPTCHA_PRIVATE_KEY"),
    )

    class Meta:
        model = User

    def signup(self, request, user):
        """ Required, or else it throws deprecation warnings """
        pass

编辑：试图继承 SignupView

draft1/forms.py

class AllauthSignupForm(SignupForm):
    def __init__(self, *args, **kwargs):
        super(AllauthSignupForm, self).__init__(*args, **kwargs)
        self.fields['username']['validators'] += MaxLengthValidator(150,
                                                                    "Username should be less than 150 character long")

    captcha = ReCaptchaField(
        public_key=config("RECAPTCHA_PUBLIC_KEY"),
        private_key=config("RECAPTCHA_PRIVATE_KEY"),
    )

    class Meta:
        model = User

    def signup(self, request, user):
        """ Required, or else it throws deprecation warnings """
        pass

draft1/views.py

from allauth.account.views import SignupView

class MySignupView(SignupView):
    form_class = AllauthSignupForm

allauth/account/urls.py

url(r"^signup/$", MySignupView.as_view(), name="account_signup"),

draft1/settings.py

ACCOUNT_SIGNUP_FORM_CLASS = 'draft1.forms.AllauthSignupForm'

以上代码返回此错误：

Traceback (most recent call last):
  File "/Users/zorgan/Desktop/postr1/lib/python3.5/site-packages/django/utils/autoreload.py", line 228, in wrapper
    fn(*args, **kwargs)
  File "/Users/zorgan/Desktop/postr1/lib/python3.5/site-packages/django/core/management/commands/runserver.py", line 125, in inner_run
    self.check(display_num_errors=True)
  File "/Users/zorgan/Desktop/postr1/lib/python3.5/site-packages/django/core/management/base.py", line 359, in check
    include_deployment_checks=include_deployment_checks,
  File "/Users/zorgan/Desktop/postr1/lib/python3.5/site-packages/django/core/management/base.py", line 346, in _run_checks
    return checks.run_checks(**kwargs)
  File "/Users/zorgan/Desktop/postr1/lib/python3.5/site-packages/django/core/checks/registry.py", line 81, in run_checks
    new_errors = check(app_configs=app_configs)
  File "/Users/zorgan/Desktop/postr1/lib/python3.5/site-packages/django/core/checks/urls.py", line 16, in check_url_config
    return check_resolver(resolver)
  File "/Users/zorgan/Desktop/postr1/lib/python3.5/site-packages/django/core/checks/urls.py", line 26, in check_resolver
    return check_method()
  File "/Users/zorgan/Desktop/postr1/lib/python3.5/site-packages/django/urls/resolvers.py", line 254, in check
    for pattern in self.url_patterns:
  File "/Users/zorgan/Desktop/postr1/lib/python3.5/site-packages/django/utils/functional.py", line 35, in __get__
    res = instance.__dict__[self.name] = self.func(instance)
  File "/Users/zorgan/Desktop/postr1/lib/python3.5/site-packages/django/urls/resolvers.py", line 405, in url_patterns
    patterns = getattr(self.urlconf_module, "urlpatterns", self.urlconf_module)
  File "/Users/zorgan/Desktop/postr1/lib/python3.5/site-packages/django/utils/functional.py", line 35, in __get__
    res = instance.__dict__[self.name] = self.func(instance)
  File "/Users/zorgan/Desktop/postr1/lib/python3.5/site-packages/django/urls/resolvers.py", line 398, in urlconf_module
    return import_module(self.urlconf_name)
  File "/Users/zorgan/Desktop/postr1/lib/python3.5/importlib/__init__.py", line 126, in import_module
    return _bootstrap._gcd_import(name[level:], package, level)
  File "<frozen importlib._bootstrap>", line 986, in _gcd_import
  File "<frozen importlib._bootstrap>", line 969, in _find_and_load
  File "<frozen importlib._bootstrap>", line 958, in _find_and_load_unlocked
  File "<frozen importlib._bootstrap>", line 673, in _load_unlocked
  File "<frozen importlib._bootstrap_external>", line 665, in exec_module
  File "<frozen importlib._bootstrap>", line 222, in _call_with_frames_removed
  File "/Users/zorgan/Desktop/vorsso/venvor/draft1/urls.py", line 6, in <module>
    from . import views
  File "/Users/zorgan/Desktop/vorsso/venvor/draft1/views.py", line 11, in <module>
    from .forms import UserSettingsForm
  File "/Users/zorgan/Desktop/vorsso/venvor/draft1/forms.py", line 8, in <module>
    from allauth.account.forms import SignupForm
  File "/Users/zorgan/Desktop/postr1/lib/python3.5/site-packages/allauth/account/forms.py", line 228, in <module>
    class BaseSignupForm(_base_signup_form_class()):
  File "/Users/zorgan/Desktop/postr1/lib/python3.5/site-packages/allauth/account/forms.py", line 216, in _base_signup_form_class
    fc_classname))
django.core.exceptions.ImproperlyConfigured: Module "draft1.forms" does not define a "AllauthSignupForm" class

【问题讨论】：

我已经创建了这个 pull request 关于添加 ACCOUNT_USERNAME_MAX_LENGTH 设置

标签： python django django-allauth

【解决方案1】：

您应该使用如下所示的最大长度验证器。更多关于验证器的文档here。

from django.core.validators import MaxLengthValidator
from allauth.account.forms import SignupForm
class AllauthSignupForm(SignupForm):
    def __init__(self, *args, **kwargs):
        self.fields['username']['validators'] += MaxLengthValidator(150, "Username should be less than 150 character long")

【讨论】：

试过了，但收到此错误'SignupForm' object has no attribute 'fields' .. 有什么想法吗？
您的表单应该像我编辑的帖子一样扩展 allauth SignupForm。
另外我认为您使用 self.username 访问用户名字段
当我将 forms.Form 更改为 SignupForm 时，会出现此错误：django.core.exceptions.ImproperlyConfigured: Module "draft1.forms" does not define a "AllauthSignupForm" class - 有什么想法吗？
我认为你需要先调用超级__init__：super(AllauthSignupForm, self).__init__(*args, **kwargs)才能使用self.fields

【解决方案2】：

不确定这是否是最好的方法，但它有效。

扩展SignupForm 后，将username 字段完全更改为具有max_length 参数的新字段。

from django import forms
from django.utils.translation import ugettext_lazy as _
from allauth.account.forms import SignupForm

class AllauthSignupForm(SignupForm):
    username = forms.CharField(label=_("Username"),
                               min_length=5,
                               max_length=20, # Change this 
                               widget=forms.TextInput(
                                   attrs={'placeholder':
                                              _('Username'),
                                          'autofocus': 'autofocus'}))

【讨论】：

当我将forms.Form 更改为SignupForm 时出现此错误：django.core.exceptions.ImproperlyConfigured: Module "draft1.forms" does not define a "AllauthSignupForm" class - 知道吗？我也导入了SignupForm
@Zorgan 检查这个：github.com/pennersr/django-allauth/issues/…

【解决方案3】：

我想解释一下为什么没有ACCOUNT_USERNAME_MAX_LENGTH。如果你打开源代码你会看到max_length验证器来自username模型字段https://github.com/pennersr/django-allauth/blob/330bf899dd77046fd0510221f3c12e69eb2bc64d/allauth/account/forms.py#L277

username_field.max_length = get_username_max_length()

其中get_username_max_length 是从User 模型https://github.com/pennersr/django-allauth/blob/8fbbf8c1d32832d72de5ed1c7fd77600af57ea6f/allauth/utils.py#L64 实际提取max_length 值的函数

def get_username_max_length():
    from .account.app_settings import USER_MODEL_USERNAME_FIELD
    if USER_MODEL_USERNAME_FIELD is not None:
        User = get_user_model()
        max_length = User._meta.get_field(USER_MODEL_USERNAME_FIELD).max_length
    else:
        max_length = 0
    return max_length

第一种方法：所以你可以直接在 User 的模型 username 字段上更改 max_length 值，如果你有它交换的话。

我认为覆盖表单字段或__init__ 方法实际上不会像其他答案所建议的那样起作用，因为max_length 的分配发生在ACCOUNT_SIGNUP_FORM_CLASShttps://github.com/pennersr/django-allauth/blob/330bf899dd77046fd0510221f3c12e69eb2bc64d/allauth/account/forms.py#L259 的子类中

class BaseSignupForm(_base_signup_form_class()):

其中_base_signup_form_class 是获取ACCOUNT_SIGNUP_FORM_CLASS 的函数

第二种方法：是继承SignupView并覆盖它的SignupForm读取Override signup view django-allauth和How to customize user profile when using django-allauth

在SignupForm 中，您实际上可以执行@MehdiB 或@PeterSobhi 建议的操作。

ImproperlyConfigured 出现问题是因为https://github.com/pennersr/django-allauth/issues/1792

所以你确定这些表单是按照https://github.com/pennersr/django-allauth/issues/1749#issuecomment-304628013在不同的python模块中定义的

# base/forms.py 
# this is form that your ACCOUNT_SIGNUP_FORM_CLASS is points to
class BaseSignupForm(forms.Form):

    captcha = ReCaptchaField(
        public_key=config("RECAPTCHA_PUBLIC_KEY"),
        private_key=config("RECAPTCHA_PRIVATE_KEY"),
    )

    class Meta:
        model = User

    def signup(self, request, user):
        """ Required, or else it throws deprecation warnings """
        pass

# data1/forms.py
# this is your signup form
from django.core.validators import MaxLengthValidator
from allauth.account.forms import SignupForm

class MySignupForm(SignupForm):
    def __init__(self, *args, **kwargs):
        super(MySignupForm, self).__init__(*args, **kwargs)
        self.fields['username']['validators'] += MaxLengthValidator(150, "Username should be less than 150 character long")

# views.py

from allauth.account.views import SignupView
class MySignupView(SignupView):
    form_class = MySignupForm

# urls.py

url(r"^signup/$", MySignupView.as_view(), name="account_signup"),

【讨论】：

感谢您的建议。我尝试了第二种方法，但出现ImproperlyConfigured: Module "draft1.forms" does not define a "AllauthSignupForm" class 错误。不知道为什么 - 如果你想看的话，我已经在编辑中添加了我的代码和 Traceback。
刚刚尝试过 - 没有错误但是它并没有减少max_length。我的设置是ACCOUNT_SIGNUP_FORM_CLASS = 'draft1.forms.BaseSignupForm'，我确保这 2 个表单位于 2 个不同的模块中，但仍然无法正常工作。知道为什么吗？
@Zorgan 你用的是什么数据库？
我使用 postrgresql (psycopg2) 作为我的数据库
@Zorgan 你确定你使用的是覆盖视图而不是默认视图吗？

【解决方案4】：

尝试使用您的表单中的全名导入：从 allauth.accouts 导入表单作为 AllauthForms 类 AllauthSignupForm（AllauthForms.SignupForm）： ....

我没有对此进行测试，很抱歉我用手机发布了这个我会尽快重新格式化答案

【讨论】：

【解决方案5】：

这可以通过扩展DefaultAccountAdapter 类并覆盖clean_username 方法来快速完成。您还需要在我们的自定义验证后再次引用clean_username 以完成其他内置验证。

可以按如下方式进行。

from allauth.account.adapter import DefaultAccountAdapter
from django.forms import ValidationError

class UsernameMaxAdapter(DefaultAccountAdapter):

    def clean_username(self, username):
        if len(username) > 'Your Max Size':
            raise ValidationError('Please enter a username value less than the current one')
        return DefaultAccountAdapter.clean_username(self,username) # For other default validations.

最后，在你的settings.py中指向子类

ACCOUNT_ADAPTER = 'YourProject.adapter.UsernameMaxAdapter'

参考：https://github.com/pennersr/django-allauth/blob/8fbbf8c1d32832d72de5ed1c7fd77600af57ea6f/allauth/account/adapter.py#L244

【讨论】：

非常感谢！我已经尝试了所有方法，这是唯一有效的方法，而且非常简单。