devtool.py -- 一个FastAPI的开发环境便捷脚本

 

用惯了Django的manage.py所以在FastAPI的项目里，也写了一个类似的脚本：

#!/usr/bin/env python
import subprocess
import sys
from pathlib import Path

import typer

cli = typer.Typer()


def get_part(s: str) -> str:
    """根据输入的选项，返回对应的命令参数

    Usage::
        >>> get_part('1')
        'patch'
        >>> get_part('patch')
        'patch'
    """
    choices = {"1": "patch", "2": "minor", "3": "major"}
    choices.update({v: v for v in choices.values()})
    try:
        return choices[s]
    except KeyError:
        typer.echo(f"Invalid part: {s!r}")
        sys.exit(1)


def run_and_echo(cmd: str) -> int:
    """先打印出SHELL命令，然后执行它"""
    typer.echo(f"--> {cmd}")
    return subprocess.run(cmd, shell=True).returncode


def get_current_version() -> str:
    """获取pyproject.toml文件里的版本号"""
    r = subprocess.run(["poetry", "version", "-s"], capture_output=True)
    return r.stdout.decode().strip()


def exit_if_run_failed(cmd: str) -> None:
    """打印和执行SHELL命令，并在执行失败时退出脚本"""
    if rc := run_and_echo(cmd):
        sys.exit(rc)


@cli.command()
def bump():
    """根据输入的选项，执行bumpversion命令去升级版本和打标签"""
    version = get_current_version()
    typer.echo(f"Current version: {version}")
    if sys.argv[1:]:
        part = get_part(sys.argv[1])
    else:
        tip = (
            "Choices:\n1. patch\n2. minor\n3. major\n\n"
            "Which one to bump?(Leave blank to use `patch`) "
        )
        if a := input(tip).strip():
            part = get_part(a)
        else:
            part = "patch"
    parse = '"(?P<major>\d+)\.(?P<minor>\d+)\.(?P<patch>\d+)"'  # NOQA
    cmd = (
        f"bumpversion --commit --parse {parse}"
        f" --current-version {version} {part} pyproject.toml"
    )
    if part != "patch":
        cmd + " --tag"
    exit_if_run_failed(cmd)
    exit_if_run_failed("git push && git push --tags && git log -1")


class UpgradeDependencies:
    """升级依赖到最新版本
    （直接用poetry update的话，只会升级小版本，不会升级大版本）
    """

    @staticmethod
    def parse_value(version_info: str, key: str) -> str:
        """解析extras/platform等额外参数

        Usage::
            >>> parse_value('{extras = ["asyncpg"], version = "^0.19.2"}', 'extras')
            'asyncpg'
        """
        sep = key + " = "
        rest = version_info.split(sep, 1)[-1].split(",")[0]
        return rest.split("}")[0].strip().strip("[]")

    @classmethod
    def _build_args(
        cls, package_lines: list[str]
    ) -> tuple[list[str], dict[str, list[str]]]:
        args: list[str] = []  # ['uvicorn[standard]', 'fastapi']
        specials: dict[str, list[str]] = {}  # {'--platform linux': ['orjson']}
        for line in package_lines:
            if not (m := line.strip()) or m.startswith("#"):
                continue
            elif m.startswith("[tool."):
                break
            package, version_info = m.split("=", 1)
            if (package := package.strip()).lower() == "python":
                continue
            elif "markers =" in version_info:
                # markers无法从命令行里定义，所以跳过
                continue
            if (extras_tip := "extras") in version_info:
                package += "[" + cls.parse_value(version_info, extras_tip) + "]"
            item = f'"{package}@latest"'
            if (pf := "platform") in version_info:
                platform = cls.parse_value(version_info, pf)
                key = f"--{pf}={platform}"
                specials[key] = specials.get(key, []) + [item]
            elif (sc := "source") in version_info:
                source = cls.parse_value(version_info, sc)
                key = f"--{sc}={source}"
                specials[key] = specials.get(key, []) + [item]
            else:
                args.append(item)
        return args, specials

    @classmethod
    def get_args(cls) -> tuple[list[str], list[str], list[list[str]], str]:
        others: list[list[str]] = []
        main_title = "[tool.poetry.dependencies]"
        toml_file = Path(__file__).parent.resolve().parent / "pyproject.toml"
        text = toml_file.read_text("utf8").split(main_title)[-1]
        dev_flag = "--dev"
        if (dev_title := "[tool.poetry.dev-dependencies]") not in text:
            dev_flag = "--group dev"
            dev_title = "[tool.poetry.group.dev.dependencies]"
        main, dev = text.split(dev_title)
        devs = dev.split("[tool.")[0].strip().splitlines()
        mains = main.strip().splitlines()
        prod_packs, specials = cls._build_args(mains)
        if specials:
            others.extend([[k] + v for k, v in specials.items()])
        dev_packs, specials = cls._build_args(devs)
        if specials:
            others.extend([[k, dev_flag] + v for k, v in specials.items()])
        return prod_packs, dev_packs, others, dev_flag

    @classmethod
    def gen_cmd(cls) -> str:
        main_args, dev_args, others, dev_flag = cls.get_args()
        command = "poetry add"
        upgrade = "{0} {1} && {0} {3} {2}".format(
            command, " ".join(main_args), " ".join(dev_args), dev_flag
        )
        for packages in others:
            upgrade += f" && {command} {' '.join(packages)}"
        return upgrade


@cli.command()
def update():
    """升级所有依赖包到最新版"""
    exit_if_run_failed(UpgradeDependencies.gen_cmd())


def lint(remove=None):
    """格式化加静态检查"""
    remove_imports = "autoflake --in-place --remove-all-unused-imports"
    cmd = ""
    paths = "."
    if args := sys.argv[1:]:
        if (flag := "-r") in args:
            if remove is None:
                remove = True
            args = [i for i in args if i != flag]
        paths = " ".join(args)
        if remove and all(Path(i).is_file() for i in args):
            cmd = f"{remove_imports} {paths} && " + cmd
    lint_them = "{0} {2} {1} && {0} {3} {1} && {0} {4} {1} && {0} {5} {1}"
    tools = ("isort", "black", "ruff", "mypy")
    cmd += lint_them.format("poetry run", paths, *tools)
    exit_if_run_failed(cmd)


@cli.command()
def dev():
    """启动服务：相当于django的runserver"""
    cmd = "poetry run python main.py"
    if args := sys.argv[1:]:
        cmd += " " + " ".join(args)
    exit_if_run_failed(cmd)


@cli.command()
def makemigrations():
    """生成数据库迁移文件，类似Django的./manage.py makemigrations"""
    exit_if_run_failed("aerich migrate")


@cli.command()
def migrate():
    """更新数据库表结构：相当于django的./manage.py migrate"""
    exit_if_run_failed("aerich upgrade")


if __name__ == "__main__":
    cli()

 

pyproject.toml的内容如下：

[tool.poetry]
name = "huiyuan"
version = "0.1.1"
description = ""
authors = ["Waket Zheng <waketzheng@gmail.com>"]

[[tool.poetry.source]]
name = "tx"
url = "https://mirrors.cloud.tencent.com/pypi/simple/"
default = false
secondary = false

[tool.poetry.dependencies]
python = "^3.11"
fastapi = "^0.88.0"
uvicorn = "^0.20.0"
tortoise-orm = {extras = ["asyncpg"], version = "^0.19.2"}
redis = "^4.4.0"
httpx = "^0.23.1"
python-dotenv = "^0.21.0"
loguru = "^0.6.0"
aerich = "^0.7.1"
orjson = {version = "^3.8.3", platform = "linux"}
gunicorn = {version = "^20.1.0", platform = "linux"}

[tool.poetry.group.dev.dependencies]
isort = "^5.11.4"
black = "^22.12.0"
types-redis = "^4.3.21.6"
typer = {extras = ["all"], version = "^0.7.0"}
ipython = {version = "^8.7.0", platform = "drawin"}
# ruff有点大(3.7M)，采用全局安装的方式
#ruff = "*"

[tool.poetry.group.dev.dependencies.mypy]
version = "^0.991"
allow-prereleases = true

[tool.isort]
profile = "black"
known_third_party = "fastapi,tortoise"
skip = "build,.tox,.venv,migrations,.git,.pytest_cache,.mypy_cache,__init__.py"

[tool.black]
line-length = 88
target-version = ['py310']
extend-exclude = '''
# A regex preceded with ^/ will apply only to files and directories
# in the root of the project.
(
  ^/foo.py    # exclude a file named foo.py in the root of the project
  | .venv  # exclude autogenerated Protocol Buffer files anywhere in the project
)
'''

[tool.ruff]
ignore = ["D203"]
exclude = [".git", "__pycache__", ".venv", "dist"]

[tool.ruff.per-file-ignores]
"models/__init__.py" = ["F401","F403"]

[tool.mypy]
ignore_missing_imports = true
warn_no_return = false
exclude = [
    "^fabfile\\.py$",  # TOML's double-quoted strings require escaping backslashes
    'two\.pyi$',  # but TOML's single-quoted strings do not
    '^\.venv',
]
[[tool.mypy.overrides]]
module = "*.migrations.*"
ignore_errors = true


[tool.aerich]
tortoise_orm = "settings.TORTOISE_ORM"
location = "./migrations"
src_folder = "./."

[build-system]
requires = ["poetry-core>=1.0.0"]
build-backend = "poetry.core.masonry.api"

[tool.poetry.scripts]
dev="huiyuan.devtool:dev"
bump="huiyuan.devtool:bump"
lint="huiyuan.devtool:lint"
update="huiyuan.devtool:update"
makemigrations="huiyuan.devtool:makemigrations"
migrate="huiyuan.devtool:migrate"

 

使用示例：poetry run update