from django.core.exceptions import ImproperlyConfigured
from django.db.models.fields import CharField, DecimalField
from django.utils.translation import gettext_lazy as _
from phonenumber_field.modelfields import PhoneNumberField
from oscar.core import validators
from oscar.forms import fields
from oscar.models.fields.autoslugfield import AutoSlugField
# https://github.com/django/django/blob/64200c14e0072ba0ffef86da46b2ea82fd1e019a/django/db/models/fields/subclassing.py#L31-L44
[docs]class Creator(object):
"""
A placeholder class that provides a way to set the attribute on the model.
"""
def __init__(self, field):
self.field = field
# pylint: disable=W0622
def __get__(self, obj, type=None):
if obj is None:
return self
return obj.__dict__[self.field.name]
def __set__(self, obj, value):
obj.__dict__[self.field.name] = self.field.to_python(value)
[docs]class ExtendedURLField(CharField):
description = _("URL")
def __init__(self, *args, **kwargs):
kwargs["max_length"] = kwargs.get("max_length", 200)
CharField.__init__(self, *args, **kwargs)
self.validators.append(validators.ExtendedURLValidator())
def formfield(self, **kwargs):
"""
As with CharField, this will cause URL validation to be performed
twice.
"""
defaults = {
"form_class": fields.ExtendedURLField,
}
defaults.update(kwargs)
return super().formfield(**defaults)
def deconstruct(self):
"""
deconstruct() is needed by Django's migration framework
"""
name, path, args, kwargs = super().deconstruct()
# We have a default value for max_length; remove it in that case
if self.max_length == 200:
del kwargs["max_length"]
return name, path, args, kwargs
[docs]class PositiveDecimalField(DecimalField):
"""
A simple subclass of ``django.db.models.fields.DecimalField`` that
restricts values to be non-negative.
"""
def formfield(self, **kwargs):
"""
Return a :py:class:`django.forms.Field` instantiated with a ``min_value`` of 0.
"""
return super().formfield(min_value=0)
[docs]class UppercaseCharField(CharField):
"""
A simple subclass of ``django.db.models.fields.CharField`` that
restricts all text to be uppercase.
"""
def contribute_to_class(self, cls, name, private_only=False, **kwargs):
super().contribute_to_class(cls, name, private_only=private_only, **kwargs)
setattr(cls, self.name, Creator(self))
def from_db_value(self, value, *args, **kwargs):
return self.to_python(value)
def to_python(self, value):
"""
Cast the supplied value to uppercase
"""
val = super().to_python(value)
if isinstance(val, str):
return val.upper()
else:
return val
[docs]class NullCharField(CharField):
"""
CharField that stores '' as None and returns None as ''
Useful when using unique=True and forms. Implies null==blank==True.
Django's CharField stores '' as None, but does not return None as ''.
"""
description = "CharField that stores '' as None and returns None as ''"
def __init__(self, *args, **kwargs):
if not kwargs.get("null", True) or not kwargs.get("blank", True):
raise ImproperlyConfigured("NullCharField implies null==blank==True")
kwargs["null"] = kwargs["blank"] = True
super().__init__(*args, **kwargs)
def contribute_to_class(self, cls, name, private_only=False, **kwargs):
super().contribute_to_class(cls, name, private_only=private_only, **kwargs)
setattr(cls, self.name, Creator(self))
def from_db_value(self, value, *args, **kwargs):
value = self.to_python(value)
# If the value was stored as null, return empty string instead
return value if value is not None else ""
def get_prep_value(self, value):
prepped = super().get_prep_value(value)
return prepped if prepped != "" else None
def deconstruct(self):
"""
deconstruct() is needed by Django's migration framework
"""
name, path, args, kwargs = super().deconstruct()
del kwargs["null"]
del kwargs["blank"]
return name, path, args, kwargs