使用Pony ORM或sqlalchemy时，在哪里创建数据库对象？

Question

我开始尝试使用对象关系映射器（特别是Pony ORM）。

在Pony中，所有实体定义都继承自类db.Entity。然而，为了做到这一点，当然db需要首先在某个地方创建对象。（db.Entity有点类似于sqlalchemy中的声明性基础，所以我相信下面的问题对于sqlalchemy也同样有效）

我在 Pony ORM 文档中看到的所有示例都提供了内联示例，其中数据库对象db只是在声明实体之前在解释器提示符中声明。

这给我留下了一个问题：我应该在“真实”项目中在哪里创建我的数据库对象？

特别考虑这样的情况：我希望将实体定义与实际使用这些实体的位置分开（假设我只想构建一个漂亮的 ORM 包装器包来访问数据库，然后应该在多个不同的其他项目中使用该数据库）。然后我可能希望用户提供db根据他们的需要配置的自己的对象，以便访问数据库。

一些示例代码：

假设我有一个存储人员和地址的数据库，我的包my_orm应该为该数据库提供一个 ORM，然后将其用于app.py：

my_orm/初始化.py

from my_orm.person import Person
from my_orm.address import Address

my_orm/person.py：

from pony.orm import Required

class Person(db.Entity): # Where should `db` be defined?
    name = Required(str)
    age = Required(int)

my_orm/address.py：

from pony.orm import Required

class Address(db.Entity): # Where should `db` be defined?. Must be the same `db` object as in person.py
    street_name = Required(str)
    zip_code = Required(int)

应用程序.py

from pony.orm import Database
db = Database()
import my_orm

除了看起来很丑之外，因为它将导入与数据库的创建混合在一起，这也会引发错误NameError: name 'db' is not defined。那么我应该做什么呢？

Answer 1

有多种组织代码的方法。

1. 将所有实体放在一个文件中

对于简单和中型项目来说，这是一种便捷的方法。这是最简单的，也许你可以这样开始。您可以Database在实体定义之前在此文件中定义对象：

模型.py

from pony.orm import Database, Required, Optional

db = orm.Database()

class Person(db.Entity):
    name = Required(str)
    addresses = Set('Address') # or Set(lambda: Address)

class Address(db.Entity):
    street_name = Required(str)
    persons = Set('Person')

主要.py

from models import db, Person, Address
from settings import db_params
from pony.orm import db_session, select

db.bind(**db_params)
db.generate_mapping(create_tables=True)

with db_session:
    persons = select(p for p in Person if p.age > 20)[:]

这种方式比较简单，适合中型项目，可以入手

2. 在函数内部定义实体

如果您想连接到Database同一程序中的多个不同实例，这可能很有用

模型.py

from pony.orm import Required, Optional

def define_entities(db):
    class Person(db.Entity):
        name = Required(str)
        addresses = Set('Address')

    class Address(db.Entity):
        street_name = Required(str)
        persons = Set('Person')

主要.py

from models import define_entities
from settings import db_params
from pony.orm import Database, db_session, select

db = Database()
define_entities(db)
db.bind(**db_params)
db.generate_mapping(create_tables=True)

with db_session:
    persons = select(p for p in db.Person if p.age > 20)[:]

请注意，可以将实体类作为数据库对象的属性进行访问：db.Person。这可能很方便，因为不需要导入Person实体——访问对象就足够了db。缺点是像 PyCharm 这样的 IDE 不理解属性的含义db.Person，也不提供代码补全的建议，例如Person.name.

还可以将实体定义拆分为从不同文件导入的多个函数：

模型1.py

from pony.orm import Required, Optional

def define_entities(db):
    class Person(db.Entity):
        name = Required(str)
        addresses = Set('Address') # or: Set(lambda: db.Address)

模型2.py

from pony.orm import Required, Optional

def define_entities(db):
    class Address(db.Entity):
        street_name = Required(str)
        persons = Set('Person')  # or: Set(lambda: db.Person)

主要.py

import models1, models2
from settings import db_params
from pony.orm import Database, db_session, select

db = Database()
models1.define_entities(db)
models2.define_entities(db)
db.bind(**db_params)
db.generate_mapping(create_tables=True)

with db_session:
    persons = select(p for p in db.Person if p.age > 20)[:]

这可能有点过头了，但有时可以用于可插入架构，当应用程序启动后动态定义精确的实体集时。

3. 在单独的文件中定义实体（不在函数内部）

您可以遵循我在相应答案中描述的架构： PonyORM - 多个模型文件