refactor: update multiple packages's pyproject.toml to PEP-621 (#253)

Author: piglei

.github/workflows/bkapi-client-core.yml

@@ -19,7 +19,7 @@ jobs:
       fail-fast: false
       matrix:
         python-version: ["3.6", "3.7"]
-        os: [ubuntu-20.04, macos-latest, windows-latest]
+        os: [ubuntu-20.04]
 
     steps:
     - uses: actions/checkout@v3
@@ -28,15 +28,13 @@ jobs:
       uses: actions/setup-python@v4
       with:
         python-version: ${{ matrix.python-version }}
-        cache: 'pip'
-        cache-dependency-path: 'sdks/bkapi-client-core/requirements_tox.txt'
 
-    - name: Install dependencies
-      run: |
-        python -m pip install --upgrade pip
-        python -m pip install . 'tox-gh-actions==2.12.0' -r requirements_tox.txt
-      working-directory: sdks/bkapi-client-core
+    - name: Setup uv
+      uses: astral-sh/setup-uv@v5
+
+    - name: Install Nox
+      run: uv pip install --system nox
 
-    - name: Test with tox
-      run: tox
+    - name: Run tests on ${{ matrix.os }}
       working-directory: sdks/bkapi-client-core
+      run: nox --non-interactive --error-on-missing-interpreters --session "tests(python='${{ matrix.python-version }}')" -- --full-trace

sdks/bkapi-client-core/Makefile

@@ -67,6 +67,9 @@ build: ALL
 publish: build
 	poetry publish -r pypi
 
+.PHONY: nox
+nox:
+	nox
+
 .PHONY: tox
-tox:
-	tox
+tox: nox

sdks/bkapi-client-core/README.md

@@ -16,6 +16,21 @@
 - 对 IDE 开发友好，SDK 支持常见 IDE 智能提示及补全；
 - 兼容 Python2 及 Python3 的类型补全；
 
+## 如何使用 Nox 运行测试
+
+测试分两步，先导出依赖，再执行测试：
+
+```bash
+# 使用 Python 3.11 导出 requirements.txt（包含 dev 依赖）
+# 因为 pyproject.toml 已经更新为 PEP-621 版本，所以必须使用比较新的 Python 版本来导出
+nox -s export_deps
+
+# 安装依赖并运行测试（依赖安装会以 requirements.txt 作为 constraints）
+nox -s tests
+```
+
+若依赖或锁文件有变更，请先重新执行 `nox -s export_deps`。
+
 ## SDK 使用样例
 
 ### 1. 使用 Client

sdks/bkapi-client-core/noxfile.py

@@ -0,0 +1,87 @@
+from pathlib import Path
+
+import nox
+
+nox.options.default_venv_backend = "venv"
+
+ROOT = Path(__file__).parent.resolve()
+ALL_PYTHON = ["3.6", "3.7"]
+REQUESTS_VERSIONS = ["2.20", "2.26"]
+REQUIREMENTS_PATH = ROOT / "requirements.txt"
+
+
+def _ensure_requirements_exported(session) -> Path:
+    if REQUIREMENTS_PATH.exists():
+        return REQUIREMENTS_PATH
+
+    session.error("requirements.txt not found. Run `nox -s export_deps` first.")
+    return REQUIREMENTS_PATH
+
+
+def install_with_constraints(session, *args: str, **kwargs) -> None:
+    """
+    Install packages constrained by exported requirements.txt.
+
+    This function is a wrapper for nox.sessions.Session.install. It
+    invokes pip to install packages inside of the session's virtualenv.
+    Additionally, pip is passed a constraints file generated from
+    Poetry's lock file, to ensure that the packages are pinned to the
+    versions specified in poetry.lock.
+    """
+    requirements = _ensure_requirements_exported(session)
+    session.install(
+        f"--constraint={requirements}",
+        "--use-deprecated=legacy-resolver",
+        *args,
+        **kwargs,
+    )
+
+
+@nox.session(python="3.11", reuse_venv=True)
+def export_deps(session):
+    """Export dependencies from Poetry to requirements.txt. When running tests later, the
+    requirements.txt file will be used as a constraints file to ensure that the same version
+    of each dependency is used.
+    """
+    session.run("python", "-m", "ensurepip", "--upgrade")
+    session.install("poetry")
+    session.run("poetry", "self", "add", "poetry-plugin-export@latest")
+    session.run(
+        "poetry",
+        "export",
+        "--with=dev",
+        "--format=requirements.txt",
+        "--without-hashes",
+        f"--output={REQUIREMENTS_PATH}",
+    )
+
+
+@nox.session(reuse_venv=True)
+@nox.parametrize("python", ALL_PYTHON)
+def tests(session):
+    session.run("python", "-m", "ensurepip", "--upgrade")
+    session.run("python", "-m", "pip", "install", "--upgrade", "pip<24", "setuptools<68", "wheel")
+    # Install main dependencies
+    install_with_constraints(
+        session,
+        "-v",
+        "requests",
+        "curlify",
+        "typing-extensions",
+        "six",
+    )
+    # Install test dependencies
+    install_with_constraints(
+        session,
+        "pytest",
+        "pytest-django",
+        "pytest-mock",
+        "requests-mock",
+        "Faker",
+        "django",
+        "prometheus-client",
+    )
+
+    for version in REQUESTS_VERSIONS:
+        session.install(f"requests=={version}")
+        session.run("pytest", "tests", *session.posargs)