0

0

深入理解SQLAlchemy自定义列的初始化行为与kwargs处理

心靈之曲

心靈之曲

发布时间:2025-09-25 10:47:12

|

410人浏览过

|

来源于php中文网

原创

深入理解SQLAlchemy自定义列的初始化行为与kwargs处理

本文深入解析SQLAlchemy中自定义列__init__方法在继承场景下被重复调用及kwargs参数传递的机制。解释了这是ORM映射过程中,基类与子类列复制的正常行为,第二次调用时的kwargs包含父类默认参数。文章指导开发者理解并有效管理这些参数。

在开发基于sqlalchemy的应用程序时,尤其是在自定义数据库列并结合模型继承时,开发者可能会遇到一些关于列初始化行为的困惑。一个常见的问题是,自定义列的__init__方法在模型启动时被多次调用,并且在后续调用中,其kwargs参数不再是空的,而是包含了某些预期的或非预期的值。

问题描述:自定义列__init__的异常行为

考虑以下一个使用Flask-SQLAlchemy构建的最小示例,其中定义了一个自定义列CustomColumn,它继承自sqlalchemy.Column,并在其__init__方法中设置了default值和comment属性:

from flask import Flask
from sqlalchemy import Column, INTEGER
from flask_sqlalchemy import SQLAlchemy

app = Flask(__name__)
app.config["SQLALCHEMY_DATABASE_URI"] = "sqlite:////tmp/test.db"
db = SQLAlchemy(app)


class CustomColumn(Column):
    def __init__(self, *args, **kwargs):
        # 在这里设置默认值,将覆盖可能传入的同名参数
        kwargs["default"] = 0
        super().__init__(*args, **kwargs)
        self.comment = "My comment"


class BaseModel(db.Model):
    __abstract__ = True

    my_column = CustomColumn()


class MyModel(BaseModel):
    id = Column("id", INTEGER(), primary_key=True)


if __name__ == '__main__':
    app.run(debug=True) # 通常在开发环境使用debug=True

在运行上述应用时,开发者可能会观察到CustomColumn.__init__方法被调用了两次。第一次调用时,kwargs参数如预期是空的。然而,第二次调用时,kwargs中却包含了"default": 0和"comment": "My comment"等值,这与开发者期望的每次都接收空kwargs的行为不符,也引发了对为何会重复调用的疑问。

SQLAlchemy内部机制解析

要理解这种行为,我们需要深入了解SQLAlchemy的ORM(对象关系映射)映射过程以及它如何处理继承的模型和列。

__init__为何被调用两次?

  1. 第一次调用:基类定义时 当Python解释器处理BaseModel类的定义时,my_column = CustomColumn()这行代码会立即执行,实例化一个CustomColumn对象。此时,CustomColumn.__init__被首次调用,kwargs通常是空的(除非在my_column = CustomColumn(...)处显式传递了参数)。这个实例是BaseModel类级别的,用于定义抽象基类的结构。

  2. 第二次调用:子类映射时 当MyModel类被定义并由SQLAlchemy的ORM进行映射时,SQLAlchemy会处理模型的继承关系。对于从BaseModel继承的列(如my_column),SQLAlchemy不会直接使用BaseModel中定义的同一个CustomColumn实例。相反,为了确保每个子类拥有独立的列定义和配置,SQLAlchemy会为MyModel生成一个my_column的 副本。这个复制过程(或称为“克隆”/“重新实例化”)会再次触发CustomColumn.__init__方法的调用。

    这种机制确保了即使父类和子类共享相同的列名,它们也可以拥有独立的配置,例如子类可以覆盖父类列的某些属性。

第二次调用时kwargs为何非空?

在第二次调用CustomColumn.__init__时,kwargs中包含的值,例如"default": 0和"comment": "My comment",实际上是SQLAlchemy在进行列复制时,从父类列定义中提取并传递给新实例的参数。

具体来说:

  • 默认参数传递: SQLAlchemy在处理列时,会将其内部识别的,或从Column的__init__签名中提取的默认参数,传递给新创建的列实例。这意味着,如果你在CustomColumn.__init__中调用super().__init__(*args, **kwargs),并且kwargs中包含了Column构造函数接受的参数(如default、nullable、primary_key等),SQLAlchemy会尝试在复制时保留这些信息。
  • 自定义属性: 像self.comment = "My comment"这样的自定义属性,虽然不是直接通过kwargs传递给Column基类的,但如果SQLAlchemy的内部机制在复制列时能够识别并传递这些“额外”的列元数据,它们也可能出现在kwargs中(这取决于SQLAlchemy的具体版本和内部实现细节,但通常它会传递Column构造函数已知的参数)。在原始问题中,kwargs["comment"]的出现可能意味着comment属性在某些内部处理中被重新包装并传递了。

因此,第二次调用时的kwargs并非随机,而是SQLAlchemy为了确保继承的列能够正确地复制其原有配置而有意传递的参数。

参数管理与最佳实践

理解了上述机制后,我们可以更好地管理自定义列的参数:

甲骨文AI协同平台
甲骨文AI协同平台

专门用于甲骨文研究的革命性平台

下载
  1. 接受并利用这种行为: 这种重复调用和kwargs传递是SQLAlchemy设计的正常部分,旨在提供灵活的列继承。通常情况下,无需尝试阻止这种行为。

  2. 覆盖或合并参数:

    • 覆盖 (Override): 如果你希望CustomColumn始终具有特定的default值(如示例中的kwargs["default"] = 0),那么在CustomColumn.__init__中直接赋值给kwargs是正确的做法。这将确保你的自定义逻辑优先于SQLAlchemy可能从父列传递过来的任何默认值。
    • 条件合并 (Conditional Merge): 如果你希望只有在kwargs中没有特定参数时才设置你的默认值,可以进行条件检查。例如:
      class CustomColumn(Column):
          def __init__(self, *args, **kwargs):
              if "default" not in kwargs:
                  kwargs["default"] = 0
              super().__init__(*args, **kwargs)
              # ... 其他逻辑

      这种方式允许外部调用者通过传入default参数来覆盖你的自定义默认值,同时在你没有显式指定时提供一个回退。

  3. 避免在__init__中进行昂贵的副作用操作: 由于__init__可能会被多次调用,应避免在其中执行昂贵的数据库操作、网络请求或任何具有全局副作用的代码。__init__的主要职责应该是初始化对象的状态。

示例代码与分析

回到最初的示例代码:

class CustomColumn(Column):
    def __init__(self, *args, **kwargs):
        kwargs["default"] = 0  # 这里的赋值会覆盖任何传入或从父类继承的'default'值
        super().__init__(*args, **kwargs)
        self.comment = "My comment" # 这是一个自定义属性

在这个实现中,kwargs["default"] = 0语句会确保无论kwargs在第二次调用时是否已经包含default键,它的值都将被强制设置为0。这正是覆盖父类或SQLAlchemy内部默认值的有效方式。self.comment = "My comment"则是一个在CustomColumn实例上设置的自定义属性,它与kwargs的传递机制相对独立,但如果SQLAlchemy在内部处理时也将其视为需要复制的元数据,它也可能以某种形式出现在后续的kwargs中。

总结

SQLAlchemy中自定义列的__init__方法在继承场景下被多次调用,并且kwargs参数在第二次调用时非空,是ORM映射过程中的正常行为。第一次调用发生在基类定义时,第二次调用发生在子类映射时,目的是为子类创建独立的列副本。第二次调用时的kwargs包含了SQLAlchemy从父列定义中提取的默认参数。开发者应理解这一机制,并通过在__init__中显式赋值来覆盖或条件合并参数,以确保自定义逻辑的正确执行。避免在__init__中执行具有昂贵副作用的操作,以维护代码的健壮性和性能。

相关专题

更多
python开发工具
python开发工具

php中文网为大家提供各种python开发工具,好的开发工具,可帮助开发者攻克编程学习中的基础障碍,理解每一行源代码在程序执行时在计算机中的过程。php中文网还为大家带来python相关课程以及相关文章等内容,供大家免费下载使用。

769

2023.06.15

python打包成可执行文件
python打包成可执行文件

本专题为大家带来python打包成可执行文件相关的文章,大家可以免费的下载体验。

661

2023.07.20

python能做什么
python能做什么

python能做的有:可用于开发基于控制台的应用程序、多媒体部分开发、用于开发基于Web的应用程序、使用python处理数据、系统编程等等。本专题为大家提供python相关的各种文章、以及下载和课程。

764

2023.07.25

format在python中的用法
format在python中的用法

Python中的format是一种字符串格式化方法,用于将变量或值插入到字符串中的占位符位置。通过format方法,我们可以动态地构建字符串,使其包含不同值。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

639

2023.07.31

python教程
python教程

Python已成为一门网红语言,即使是在非编程开发者当中,也掀起了一股学习的热潮。本专题为大家带来python教程的相关文章,大家可以免费体验学习。

1325

2023.08.03

python环境变量的配置
python环境变量的配置

Python是一种流行的编程语言,被广泛用于软件开发、数据分析和科学计算等领域。在安装Python之后,我们需要配置环境变量,以便在任何位置都能够访问Python的可执行文件。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

549

2023.08.04

python eval
python eval

eval函数是Python中一个非常强大的函数,它可以将字符串作为Python代码进行执行,实现动态编程的效果。然而,由于其潜在的安全风险和性能问题,需要谨慎使用。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

579

2023.08.04

scratch和python区别
scratch和python区别

scratch和python的区别:1、scratch是一种专为初学者设计的图形化编程语言,python是一种文本编程语言;2、scratch使用的是基于积木的编程语法,python采用更加传统的文本编程语法等等。本专题为大家提供scratch和python相关的文章、下载、课程内容,供大家免费下载体验。

709

2023.08.11

Java编译相关教程合集
Java编译相关教程合集

本专题整合了Java编译相关教程,阅读专题下面的文章了解更多详细内容。

9

2026.01.21

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
最新Python教程 从入门到精通
最新Python教程 从入门到精通

共4课时 | 10.5万人学习

Django 教程
Django 教程

共28课时 | 3.3万人学习

SciPy 教程
SciPy 教程

共10课时 | 1.2万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号