如何将自定义方法添加到 Django 中的模型字段？

Question

我有两个模型将使用相同的 CardNumberField() 来存储信用卡号。如何向字段添加自定义方法以屏蔽卡号？

我创建了继承自 models.Charfield 的 CardNumberField():

# CARD NUMBER FIELD
class CardNumberField(models.CharField):
    description = _('card number')

    def __init__(self, *args, **kwargs):
        kwargs['max_length'] = 19
        super().__init__(*args, **kwargs)

然后 CardNumberField() 被导入并用于我的 customers/models.py:

# CARD MODEL
class Card(models.Model):
    number = CardNumberField()
    ...

    def __str__(self):
        return 'Card [{number}]'.format(number=self.number)

...在我的 transactions/models.py:

# TRANSACTION MODEL
class Transaction(models.Model):
    card_number = CardNumberField()
    ...

    def __str__(self):
        return 'Transaction ...'

那么，如何将以下方法添加到我的 CardNumberField() 中以供我的两个模型使用？

def masked_number(self):
    # display masked card number
    number = self.number
    return number[-4:].rjust(len(number), '#')

此外，我将如何在 DRF 序列化程序中获取此字段方法 class？

Answer 1

改为使用抽象模型：

class ModelWithCardNumber(models.Model):
   card_number = models.CharField(max_length=19)
   
   @property
   def masked_number(self):
      return self.card_number[-4:].rjust(len(number), '#')
   
   class Meta:
      abstract = True


class Card(ModelWithCardNumber):
    def __str__(self):
        return 'Card [{number}]'.format(number=self.number)


class Transaction(ModelWithCardNumber):
    def __str__(self):
        return 'Transaction ...'

现在，在您的序列化程序中，您可以访问 Card.masked_number 和 Transaction.masked_number。

Answer 2

你可以重写contribute_to_class方法，不仅贡献领域，还包括一个额外的方法：

from functools import partialmethod

def _mask_number(self, field):
    number = getattr(self, field.attname)
    return number[-4:].rjust(len(number), '#')

# CARD NUMBER FIELD
class CardNumberField(models.CharField):
    description = _('card number')

    def __init__(self, *args, **kwargs):
        kwargs['max_length'] = 19
        super().__init__(*args, **kwargs)

    def <strong>contribute_to_class</strong>(self, cls, name, **kwargs):
        super().contribute_to_class(cls, name, **kwargs)
        <strong>setattr(</strong>
            cls, f'masked_{self.name}',
            partialmethod(_mask_number, field=self)
        <strong>)</strong>

如果你给一个模型class添加字段foo，它会自动添加一个masked_<i> foo</i> 方法到 class。因此，这也意味着如果您有两个或更多 CardNumberField，它将添加两个或更多 masked_<i>foo</i> 方法。

如何将自定义方法添加到 Django 中的模型字段？

How to add a custom method to a model field in Django?

python

django

django-models

django-rest-framework