sqlean-driver

为sqlean.py提供SQLAlchemy驱动的。

目录

• 安装
• 用法
  • 扩展
  • 替代方案
• 开发
  • 运行测试和覆盖率
  • 运行检查器
  • 运行类型检查器
• 许可
• 致谢

安装

pip install sqlean-driver

用法

from sqlalchemy import create_engine, func, select

engine = create_engine("sqlite+sqlean:///:memory:?extensions=all")

with engine.connect() as conn:
    result = conn.execute(select(func.ipfamily("192.168.1.1")))
    print(result.scalar())  # 4

扩展

默认情况下，sqlean.py禁用了所有SQLite扩展。要启用所有扩展，请将extensions=all作为查询参数传递给连接字符串。或者使用逗号分隔的扩展列表以仅启用其中一些，例如extensions=ipaddr,crypto。

替代方案

请注意，您在使用 SQLAlchemy 与 sqlean.py 结合时，并不严格需要此驱动程序。您可以将 sqlean 作为 module 参数传递给 create_engine

import sqlean
from sqlalchemy import create_engine, func, select

sqlean.extensions.enable_all()
engine = create_engine("sqlite:///:memory:", module=sqlean)

with engine.connect() as conn:
    result = conn.execute(select(func.ipfamily("192.168.1.1")))
    print(result.scalar())  # 4

开发

该项目使用 Hatch 来管理开发环境，因此请确保您已安装它。

运行测试和覆盖率

运行测试，并计算所有支持的 Python 和 SQLAlchemy 版本的覆盖率

hatch run test:cov

将覆盖率输出合并为单个报告

hatch run coverage:report

运行检查器

hatch run lint:style

运行类型检查器

hatch run typing:check

许可

sqlean-driver 根据 MIT 许可证进行分发。

致谢

• 由 Anton Zhiyanov 创建 sqlean 和 sqlean.py。
• 由 Orhun Parmaksız 创建 git-cliff，该项目使用它来维护变更日志。