单独常量文件中的 Django 模型选择答案

【问题标题】：Django model choice in separate constant file单独常量文件中的 Django 模型选择
【发布时间】：2020-08-18 05:04:45
【问题描述】：

根据django docs，在模型中处理选择字段的最佳方法是这样做：

class Book(models.Model):
   AVAILABLE = 'available'
   BORROWED = 'borrowed'
   ARCHIVED = 'archived'
   STATUS = [
       (AVAILABLE, 'Available to borrow'),
       (BORROWED, 'Borrowed by someone'),
       (ARCHIVED, 'Archived - not available anymore'),
   ]
   # […]
   status = models.CharField(
       max_length=32,
       choices=STATUS,
       default=AVAILABLE,
   )

但是，我的应用增长了很多，并且扩展了不同应用之间的模型互连。在某些情况下，我需要导入模型类只是为了使用常量值

例如：

# some other file
from book.models import Book

def do_stuff_if_borrowed(book):
  if (book.status == Book.BORROWED):
    # do stuff
    pass

我想尽可能避免在其他文件中导入模型，因为它会导致很多循环导入问题，总的来说我觉得这不是最干净的方法。我快速查了一下，没有人提出如何将这些模型常量外部化的解决方案，例如：

book/constants.py

AVAILABLE = 'available'
   BORROWED = 'borrowed'
   ARCHIVED = 'archived'
   STATUS = [
       (AVAILABLE, 'Available to borrow'),
       (BORROWED, 'Borrowed by someone'),
       (ARCHIVED, 'Archived - not available anymore'),
   ]

book/models.py

from .constants import STATUS, AVAILABLE

class Book(models.Model):
   status = models.CharField(
       max_length=32,
       choices=STATUS,
       default=AVAILABLE,
   )

然后如果我只需要常量，我不需要导入 Book 模型，而只需要导入 constants.py

有理由不这样做吗？

【问题讨论】：

我认为唯一的原因是您可以使用常用词 AVAILABLE ARCHIVED 已经在您的其他模型中使用，我认为您应该考虑让名称更独特，例如 BOOK_STATUS_AVAILABLE @ 987654329@，所以你不会对重复的名字感到困惑
是的，这将使常量独一无二

标签： django django-models python-import

【解决方案1】：

我正在做一个项目，我们正在考虑这样的事情。它连接到另一个服务 API，该 API 具有我们提取的指标和定义。因此，我们考虑只是定期提取这些文件并将它们存储在诸如 metrics.json 文件中，而不是在模型中使用它们。

这非常流畅且不错，但我认为您失去的是对模型更改的可见性，这些更改导致需要创建、跟踪和运行迁移。

在您的示例中，常量似乎不会真正改变，目的只是为了保持干燥。似乎您可以创建该常量文件，然后添加一个方法来为您的模型返回前缀状态，如果您确实希望它们对于每个模型更加不同。

在这种情况下，您牺牲的是直接从模型中轻松引用这些值。在文档的示例中，您可以使用 Book.STATUS_BORROWED 引用状态。但在您的示例中，您实际上必须单独导入这些常量。

我认为最好的解决方案是制作一个涵盖这一点的 mixin，并让所有需要这些状态的模型都继承自它。

class BorrowableBookMixin(models.Model):
   STATUS_AVAILABLE = 'available'
   STATUS_BORROWED = 'borrowed'
   STATUS_ARCHIVED = 'archived'
   STATUS_CHOICES = [
       (STATUS_AVAILABLE, 'Available to borrow'),
       (STATUS_BORROWED, 'Borrowed by someone'),
       (STATUS_ARCHIVED, 'Archived - not available anymore'),
   ]

   status = models.CharField(
       max_length=32,
       choices=STATUS_CHOICES,
       default=STATUS_AVAILABLE,
   )

   class Meta:
       abstract = True

【讨论】：