flake8-sqlalchemy

一个用于SQLAlchemy代码的flake8插件。

安装

pip install flake8-sqlalchemy

配置

默认情况下，所有检查都已启用。您可以通过添加以下内容到您的setup.cfg来禁用所有检查

[flake8]
ignore = SQA

或忽略特定的检查

[flake8]
ignore = SQA100

SQA100 - sqlalchemy导入别名

检查当sqlalchemy使用别名导入时，别名是sa或db。

错误

import sqlalchemy as foo

正确

import sqlalchemy as sa
# or
import sqlalchemy as db

SQA200 - Column关键字参数comment必需

在编写Column定义时，必须提供comment关键字参数。这为列提供了内联文档，并生成将注释添加到数据库的SQL。

错误

class Users(Base):
    __tablename__ = "users"

    id = Column(Integer, primary_key=True)
    name = Column(String)

正确

class Users(Base):
    __tablename__ = "users"

    id = Column(Integer, primary_key=True, comment="User ID from Auth Service")
    name = Column(String, comment="User name: first, middle, last")

也适用于mapped_column

class Users(Base):
    __tablename__ = "users"

    id = Column(Integer, primary_key=True, comment="User ID from Auth Service")
    name = mapped_column(String, comment="User name: first, middle, last")

许可证

本项目按照MIT许可协议发布。有关完整的许可协议文本，请参阅LICENSE文件。

作者

• Mike Fiedler