将Django Model转换为字典格式的实用函数

YHUK • 2024-10-04 00:22 • 编程

一、前言

在Django应用程序中，进行数据库操作主要使用Django的ORM框架，这个框架可以方便的将数据库中的表映射成为Python类，然后通过这个类就可以进行数据库的增删改查等操作了。ORM框架提供了manager、queryset等对象来帮助我们更加方便的操作数据库。然而，在一些情况下，我们需要将Django的Model对象转换成Python字典，以便于对返回数据进行处理、或者我们希望将Model对象序列化成JSON字符串。这篇文章将介绍从Django Model转换为Python字典的实用函数。

二、实现

通过以下代码，我们可以实现将Django的Model对象转换为Python字典。

def model_to_dict(instance, fields=None, exclude=None):
    """
    :param instance: Django model对象
    :param fields: 显示字段
    :param exclude: 排除字段
    :return: 返回python字典格式数据
    """
    data = {}
    if not exclude:
        exclude = []
    if not fields:
        fields = []
    model_fields = instance._meta.get_fields()
    for field in model_fields:
        name = field.name
        if name not in exclude and (not fields or name in fields):
            try:
                value = getattr(instance, field.name)
                if callable(value):
                    data[name] = value()
                else:
                    data[name] = value
            except Exception as e:
                print(e)
    return data

三、参数说明

该函数需要传给它实例化的Django Model对象（instance），然后可以指定该Model对象转换为字典的字段列表（fields）和需要禁止转换的字段列表（exclude）。如果fields没有值，那么所有的字段都会被转换。

四、使用方法

在Django的models.py文件中定义Model

from django.db import models

class Author(models.Model):
    name = models.CharField(max_length=50)
    email = models.EmailField(max_length=100)
    website = models.URLField(blank=True)

    def __str__(self):
        return self.name

在views.py文件中调用model_to_dict函数，如下：

from django.shortcuts import render
from .models import Author
from .utils import model_to_dict

def author_detail(request, pk):
    author = Author.objects.get(pk=pk)
    author_dict = model_to_dict(author)
    return render(request, 'author_detail.html', {'author': author_dict})

在templates中使用转换后的字典数据，使用{{ author.name}}、{{ author.email }}、{{ author.website }}来获取值。

五、总结

以上即是将Django Model转换为字典的实用函数，使得我们可以很方便地对返回数据进行处理，或者对Model进行序列化成JSON字符串。

原创文章，作者：YHUK，如若转载，请注明出处：https://www.506064.com/n/139442.html