如何获取Django模型字段对应的Python原生类型？

问题描述 #

给定如下Django模型代码：

class SomeModel(models.Model):
    instance_name = models.UnknownField(max_length=255)
    instance_id = models.IntegerField()

需要实现一个函数，输入模型类和字段名，返回该字段对应的Python原生类型（如str、int等），函数定义如下：

def find_out_the_field_python_type(model: Model, field_name: str) -> type:
    # 示例：model = SomeModel, field_name = instance_id 时返回 int
    return

尝试过以下代码：

instance_id_field = SomeModel._meta.get_field('instance_id')
# 获取字段的Python表示
python_representation = instance_id_field.get_internal_type()
print(python_representation)
# 返回 'IntegerField'

遇到的问题：get_internal_type()返回的是Django字段类型名称，并非所需的Python原生类型。

解决方案 #

提供两种可靠的实现方式，可根据需求选择：

方法1：利用字段的to_python()方法 #

Django的每个字段都实现了to_python()方法，该方法负责将数据库值转换为对应的Python原生类型。我们可以传入字段的默认值或合适的空值，通过转换后的结果获取类型：

from django.db.models import Model

def find_out_the_field_python_type(model: Model, field_name: str) -> type:
    field = model._meta.get_field(field_name)
    # 获取用于测试的初始值
    if field.has_default():
        test_value = field.default
    else:
        # 根据字段特性选择合适的测试值
        test_value = None if field.null else "" if field.empty_strings_allowed else 0
    # 转换后返回类型
    return type(field.to_python(test_value))

方法2：建立字段类型映射表 #

直接将Django字段类型与Python原生类型建立映射关系，这种方式更可控，可自定义映射规则：

from django.db.models import Model
from django.db.models.fields import (
    IntegerField, CharField, BooleanField, FloatField,
    DateField, DateTimeField, DecimalField
)

def find_out_the_field_python_type(model: Model, field_name: str) -> type:
    field = model._meta.get_field(field_name)
    # 字段类型到原生类型的映射表
    type_mapping = {
        IntegerField: int,
        CharField: str,
        BooleanField: bool,
        FloatField: float,
        DateField: str,  # 若需要datetime.date类型可直接返回datetime.date
        DateTimeField: str,  # 若需要datetime.datetime类型可直接返回datetime.datetime
        DecimalField: float,  # 或decimal.Decimal，根据业务需求选择
        # 可继续添加其他字段类型的映射
    }
    # 匹配字段所属类型
    for django_field_type, python_type in type_mapping.items():
        if isinstance(field, django_field_type):
            return python_type
    # 未匹配到的字段默认返回str，也可选择抛出异常
    return str

说明 #

• 方法1通用性更强，能适配大多数内置及自定义字段（只要自定义字段正确实现了to_python()方法）。
• 方法2灵活性更高，可根据业务需求调整映射规则，比如将日期类型直接映射为字符串而非date/datetime对象。

内容的提问来源于stack exchange，提问作者Ivan