具有自定义方案的 Django URLField

rgo*_*gov 5 django

Djangodjango.db.models.URLField使用一个django.core.validators.URLValidator

class URLField(CharField):
    default_validators = [validators.URLValidator()]
Run Code Online (Sandbox Code Playgroud)

因为它没有指定要接受的方案,所以 URLValidator 默认为这个集合:

schemes = ['http', 'https', 'ftp', 'ftps']
Run Code Online (Sandbox Code Playgroud)

我希望我的 URLField 接受ssh://URL,所以我尝试了这个:

class SSHURLField(models.URLField):
  '''URL field that accepts URLs that start with ssh:// only.'''
  default_validators = [URLValidator(schemes=['ssh'])]
Run Code Online (Sandbox Code Playgroud)

但是,当我尝试使用有效ssh://URL保存新对象时,我被拒绝了。

如果我跳过从 URLField 继承并直接从 CharField 继承,也会发生这种情况:(编辑:实际上这在我重新创建数据库后确实有效。我不确定为什么前者不起作用。)

class SSHURLField(models.CharField):
  '''URL field that accepts URLs that start with ssh:// only.'''
  default_validators = [URLValidator(schemes=['ssh'])]

  def __init__(self, *args, **kwargs):
    kwargs['max_length'] = 64
    super(SSHURLField, self).__init__(*args, **kwargs)
Run Code Online (Sandbox Code Playgroud)

当我在测试中直接使用 URLValidator 时,它可以工作:

def test_url(url):
  try:
    URLValidator(schemes=['ssh'])(url)
    return True
  except:
    return False

>>> test_url('ssh://example.com/')
True

>>> test_url('http://example.com/')
False
Run Code Online (Sandbox Code Playgroud)

Jos*_*eph 7

正如@IainDillingham 在评论中提到的,这是 Django 中的一个错误:覆盖子类 ModelField 的 default_validator 不一定覆盖与该基类关联的 FormField 的 default_validator。

对于您的示例 django.db.models.URLField,我们可以看到其关联的表单字段[0]是 django.forms.fields.URLField [1]。因此,这里的解决方法是也覆盖def formfield(...)您的自定义SSHURLField,以使用相同的验证器引用自定义 django.forms.fields.URLField 子类,如下所示:

from django.core import validators
from django.db import models
from django.forms.fields import URLField as FormURLField

class SSHURLFormField(FormURLField):
    default_validators = [validators.URLValidator(schemes=['ssh'])]

class SSHURLField(models.URLField):  
    '''URL field that accepts URLs that start with ssh:// only.'''  
    default_validators = [validators.URLValidator(schemes=['ssh'])]  

    def formfield(self, **kwargs):
        return super(SSHURLField, self).formfield(**{
            'form_class': SSHURLFormField,
        })
Run Code Online (Sandbox Code Playgroud)

[0] https://github.com/django/django/blob/e17088a108e604cad23b000a83189fdd02a8a2f9/django/db/models/fields/初始化的.py#L2275,L2293
[1] https://github.com/django/django/blob /e17088a108e604cad23b000a83189fdd02a8a2f9/django/forms/fields.py#L650