UtilMeta - 简洁高效的 Python 后端元框架

2024-02-23 15:02 由 voidZXL 发表于 #后端开发

最近开源了我开发多年的一个 Python 后端框架：UtilMeta

项目介绍

UtilMeta 是一个用于开发 API 服务的后端元框架，基于 Python 类型注解标准高效构建声明式接口与 ORM 查询，能够自动解析请求参数与生成 OpenAPI 文档，高效开发 RESTful 接口，产出的代码简洁清晰，并且支持使用主流 Python 框架（如 Django, Flask, FastAPI, Starlette, Sanic, Tornado 等）作为运行时实现或渐进式整合

Github 仓库
中文文档

安装

pip install utilmeta

核心特性

声明式接口开发

使用 UtilMeta 框架提供的声明能力，你可以轻松开发自动校验请求与生成 OpenAPI 文档的接口，也可以编写简洁的声明式 ORM 查询（支持关系对象查询且自动避免 N + 1 问题）

下面的例子是基于 Django 模型开发一个简洁的文章查询接口

from utilmeta.core import api, orm
from django.db import models

class User(models.Model):
    username = models.CharField(max_length=20, unique=True)

class Article(models.Model):
    author = models.ForeignKey(User, related_name="articles", on_delete=models.CASCADE)
    content = models.TextField()

class UserSchema(orm.Schema[User]):
    username: str
    articles_num: int = models.Count('articles')

class ArticleSchema(orm.Schema[Article]):
    id: int
    author: UserSchema
    content: str

class ArticleAPI(api.API):
    async def get(self, id: int) -> ArticleSchema:
        return await ArticleSchema.ainit(id)

如果请求 GET /article?id=1，则会得到类似如下的结果

{
  "id": 1,
  "author": {
    "username": "alice",
    "articles_num": 3
  },
  "content": "hello world"
}

完全符合你的模式声明，并且会自动生成对应的 OpenAPI 文档，如

简洁的声明式开发可以显著降低接口开发的代码量，比如 UtilMeta 仅用 600 行代码就实现了 Realworld 博客后端, 与其他框架的对比如下

渐进式元框架

使用一套标准支持主流 Python 框架作为 HTTP 运行时实现，切换运行时实现只需要一个参数

from utilmeta import UtilMeta
from utilmeta.core import api
import django

class RootAPI(api.API):
    @api.get
    def hello(self):
        return 'world'

service = UtilMeta(
    __name__,
    name='demo',
    backend=django,    # or flask / starlette / tornado / sanic
    api=RootAPI,
    route='/api'
)

app = service.application()  # wsgi app

if __name__ == '__main__':
    service.run()

并且支持以接口为粒度渐进式接入现有项目，比如 Flask

from flask import Flask
from utilmeta.core import api, response

app = Flask(__name__)

@app.route("/")
def hello_world():
    return "<p>Hello, World!</p>"

class CalcAPI(api.API):
    @api.get
    def add(self, a: int, b: int) -> int:
        return a + b

CalcAPI.__as__(app, route='/calc')