ns-orm 0.0.0

A ORM built on Pydantic models.

ns-orm

一个参考 Django ORM 设计的轻量级 ORM（不依赖 SQLAlchemy），以 Pydantic 作为模型层，支持同步/异步、CRUD、关联预取与最小建表能力。

数据库连接/连接池由 lesscode-database 负责，ns-orm 仅消费“执行器”来执行 SQL。

更多功能与完整用法见 doc/index.md。

安装

pip install ns-orm

数据库驱动与连接方式由 lesscode-database 决定。

快速开始（同步）

from typing import Optional

from typing_extensions import Annotated

from ns_orm import Database, ForeignKey, Int, Model, String, create_all
from ns_orm.dialects import dialect_from_url


class User(Model):
    id: Annotated[Optional[int], Int(primary_key=True)] = None
    name: Annotated[str, String(max_length=50)]


class Post(Model):
    id: Annotated[Optional[int], Int(primary_key=True)] = None
    user_id: Annotated[int, ForeignKey("User", on_delete="CASCADE")]
    title: Annotated[str, String(max_length=200)]


executor = ...  # 由 lesscode-database 创建
db = Database(executor=executor, dialect=dialect_from_url("sqlite"))
create_all(db, [User, Post])

u = User.objects.using(db).create(name="alice")
Post.objects.using(db).create(user_id=u.id, title="hello")

posts = Post.objects.using(db).prefetch_related("user").all()
print(posts[0].user.name)

快速开始（异步）

from ns_orm import AsyncDatabase, acreate_all
from ns_orm.dialects import dialect_from_url

executor = ...  # 由 lesscode-database 创建（异步执行器）
db = AsyncDatabase(executor=executor, dialect=dialect_from_url("sqlite"))
await acreate_all(db, [User, Post])

u = await User.objects.using(db).acreate(name="alice")
posts = await Post.objects.using(db).filter(user_id=u.id).prefetch_related("user").all()

迁移命令

见 doc/migrations.md。

打包与发布

见 doc/release.md。