chore: uvへ移行する(Dockerコンテナ以外) (#1616)

Co-authored-by: Hiroshiba <[email protected]>

Author: nanae772

.gitattributes

@@ -1,5 +1,5 @@
 test/**/__snapshots__/**/*.json linguist-generated=true
 
-* text=auto
+* text=auto eol=lf
 *.png -text
 *.wav -text

.github/actions/prepare_python/action.yml

@@ -2,18 +2,9 @@ name: "Prepare Python"
 description: "Python ランタイムと依存パッケージをインストールし、Python バージョンを出力する"
 
 inputs:
-  only-export-python-version:
-    description: "Python バージョンの出力のみをおこなうか否か"
+  dependency-group:
+    description: "uv の依存パッケージインストール時に指定するグループ"
     required: false
-    default: "false"
-  requirements-suffix:
-    description: "依存パッケージインストール時に `requirements` へ付ける接尾語"
-    required: false
-    default: ""
-  python-version:
-    description: "インストールされる Python ランタイムのバージョン。デフォルト値はこのリポジトリが想定する Python バージョン。"
-    required: false
-    default: "3.11.9"
 outputs:
   python-version:
     description: "Python version"
@@ -22,19 +13,25 @@ outputs:
 runs:
   using: "composite"
   steps:
-    - name: <Setup> Set up Python
-      if: ${{ inputs.only-export-python-version == 'false' }}
-      uses: actions/setup-python@v5
+    - name: <Setup> Install uv
+      uses: astral-sh/setup-uv@v5
       with:
-        python-version: ${{ inputs.python-version }}
-        cache: pip
+        enable-cache: false # TODO: uvの上手いキャッシュのやり方を考える
 
     - name: <Setup> Install Python dependencies
-      if: ${{ inputs.only-export-python-version == 'false' }}
-      run: python -m pip install -r requirements${{ inputs.requirements-suffix }}.txt
+      run: |
+        if [[ -n "${{ inputs.dependency-group }}" ]]; then
+          uv sync --group ${{ inputs.dependency-group }}
+        else
+          uv sync
+        fi
       shell: bash
 
     - name: <Deploy> Export Python version
       id: export-python-version
-      run: echo "python-version=${{ inputs.python-version }}" >> $GITHUB_OUTPUT
+      run: |
+        PYTHON_VERSION=$(
+          uv run python -c 'import platform; print(platform.python_version())'
+        )
+        echo "python-version=${PYTHON_VERSION}" >> "$GITHUB_OUTPUT"
       shell: bash

.github/workflows/build-docs.yml

@@ -27,7 +27,7 @@ jobs:
         uses: ./.github/actions/prepare_python
 
       - name: <Build> Make documents
-        run: PYTHONPATH=. python tools/make_docs.py
+        run: PYTHONPATH=. uv run tools/make_docs.py
 
       - name: <Deploy> Deploy documents to GitHub Pages
         uses: peaceiris/actions-gh-pages@v4

.github/workflows/build-engine-container.yml

@@ -105,8 +105,6 @@ jobs:
       - name: <Setup> Prepare Python version
         id: prepare-python
         uses: ./.github/actions/prepare_python
-        with:
-          only-export-python-version: true
 
       - name: <Setup> Set up Docker Buildx
         id: buildx
@@ -145,7 +143,7 @@ jobs:
           {
             echo "tags<<EOF"
 
-            python3 tools/generate_docker_image_names.py \
+            uv run tools/generate_docker_image_names.py \
               --repository "${{ env.IMAGE_NAME }}" \
               --version "${{ needs.config.outputs.version_or_latest }}" \
               --prefix "${{ matrix.prefixes }}"
@@ -218,8 +216,6 @@ jobs:
       - name: <Setup> Prepare Python version
         id: prepare-python
         uses: ./.github/actions/prepare_python
-        with:
-          only-export-python-version: true
 
       - name: <Setup> Set up Docker Buildx
         id: buildx

.github/workflows/build-engine-package.yml

@@ -288,7 +288,7 @@ jobs:
       - name: <Setup> Prepare Python Runtime / Python Dependencies
         uses: ./.github/actions/prepare_python
         with:
-          requirements-suffix: "-build"
+          dependency-group: build
 
       - name: <Setup> Prepare custom PyInstaller
         if: runner.os == 'Windows'
@@ -299,7 +299,7 @@ jobs:
           # try 5 times, sleep 5 seconds before retry
           for _ in $(seq 5); do
             EXIT_CODE=0
-            python3 -c "import pyopenjtalk; pyopenjtalk._lazy_init()" || EXIT_CODE=$?
+            uv run python -c "import pyopenjtalk; pyopenjtalk._lazy_init()" || EXIT_CODE=$?
 
             if [ "$EXIT_CODE" = "0" ]; then
               break
@@ -441,7 +441,7 @@ jobs:
           cp resources/engine_manifest_assets/dependency_licenses.json licenses.json
 
       - name: <Build> Generate filemap.json
-        run: python tools/generate_filemap.py --target_dir resources/character_info
+        run: uv run tools/generate_filemap.py --target_dir resources/character_info
 
       - name: <Build> Build VOICEVOX ENGINE run.py
         run: |
@@ -471,7 +471,7 @@ jobs:
           CORE_MODEL_DIR_PATH="download/core/model" \
           LIBCORE_PATH="$LIBCORE_PATH" \
           LIBONNXRUNTIME_PATH="$LIBONNXRUNTIME_PATH" \
-          pyinstaller --noconfirm run.spec
+          uv run pyinstaller --noconfirm run.spec
 
       # Because PyInstaller does not copy dynamic loaded libraries,
       # manually move DLL dependencies into `dist/run/` (cache already saved)

.github/workflows/test-engine-container.yml

@@ -44,7 +44,7 @@ jobs:
       - name: <Setup> Prepare Python Runtime / Python Dependencies
         uses: ./.github/actions/prepare_python
         with:
-          requirements-suffix: "-dev"
+          dependency-group: dev
 
       - name: <Setup> Declare variables
         id: docker_vars
@@ -86,4 +86,4 @@ jobs:
           exit 1
 
       - name: <Test> Test ENGINE application docker container
-        run: python tools/check_release_build.py --skip_run_process --skip_check_manifest --dist_dir dist/
+        run: uv run tools/check_release_build.py --skip_run_process --skip_check_manifest --dist_dir dist/

.github/workflows/test-engine-package.yml

@@ -69,7 +69,7 @@ jobs:
       - name: <Setup> Prepare Python Runtime / Python Dependencies
         uses: ./.github/actions/prepare_python
         with:
-          requirements-suffix: "-dev"
+          dependency-group: dev
 
       - name: <Setup> Download ENGINE package
         run: |
@@ -84,4 +84,4 @@ jobs:
         run: chmod +x dist/run
 
       - name: <Test> Test ENGINE package
-        run: python tools/check_release_build.py --dist_dir dist/
+        run: uv run tools/check_release_build.py --dist_dir dist/

.github/workflows/test-security.yml

@@ -20,7 +20,7 @@ jobs:
       - name: <Setup> Prepare Python Runtime / Python Dependencies
         uses: ./.github/actions/prepare_python
         with:
-          requirements-suffix: "-dev"
+          dependency-group: dev
 
       - name: <Test> Check Python dependency security
         uses: pypa/[email protected]

.github/workflows/test.yml

@@ -23,43 +23,43 @@ jobs:
       - name: <Setup> Prepare Python Runtime / Python Dependencies
         uses: ./.github/actions/prepare_python
         with:
-          requirements-suffix: "-dev"
+          dependency-group: dev
 
-      - name: <Test> Validate poetry.lock
+      - name: <Test> Validate uv.lock
         run: |
-          poetry lock
+          uv lock
           git diff --exit-code
 
       - name: <Test> Check dependency lists
         run: |
-          poetry export --without-hashes -o requirements.txt.check
-          poetry export --without-hashes --with dev -o requirements-dev.txt.check
-          poetry export --without-hashes --with build -o requirements-build.txt.check
+          uv export --no-annotate --no-hashes --no-header -o requirements.txt.check
+          uv export --group dev --no-annotate --no-hashes --no-header -o requirements-dev.txt.check
+          uv export --group build --no-annotate --no-hashes --no-header -o requirements-build.txt.check
 
           diff -q requirements.txt requirements.txt.check || \
           diff -q requirements-dev.txt requirements-dev.txt.check || \
           diff -q requirements-build.txt requirements-build.txt.check > /dev/null
           if [ $? = 1 ]; then
-            echo "poetry export has some diff"
+            echo "uv export has some diff"
             exit 1
           fi
 
       - name: <Test> Check linting
-        run: ruff check
+        run: uv run ruff check
 
       - name: <Test> Check formatting
-        run: ruff format --check
+        run: uv run ruff format --check
 
       - name: <Test> Check typing
-        run: mypy .
+        run: uv run mypy .
 
       - name: <Test> Test codes and coverage
-        run: coverage run --omit=test/* -m pytest
+        run: uv run coverage run --omit=test/* -m pytest
 
       - name: <Deploy> Submit coverage results to Coveralls
         if: runner.os == 'Linux'
         # Coveralls へのアップロードが失敗しても CI は継続させる
-        run: coveralls --service=github || echo "::warning::Coveralls failed, but continuing"
+        run: uv run coveralls --service=github || echo "::warning::Coveralls failed, but continuing"
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 
@@ -68,7 +68,7 @@ jobs:
 
       - name: <Test> Test names by checking typo
         if: runner.os == 'Linux'
-        run: typos
+        run: uv run typos
 
   lint-builders:
     runs-on: ubuntu-22.04

.pre-commit-config.yaml

@@ -5,46 +5,46 @@ repos:
     hooks:
       - id: check-linting
         name: check-linting
-        entry: ruff check
+        entry: uv run ruff check
         language: python
         types: [file, python]
         stages: [pre-push]
         pass_filenames: false
       - id: check-formatting
         name: check-formatting
-        entry: ruff format --check
+        entry: uv run ruff format --check
         language: python
         types: [file, python]
         stages: [pre-push]
         pass_filenames: false
       - id: check-typing
         name: check-typing
-        entry: mypy .
+        entry: uv run mypy .
         language: python
         types: [file, python]
         stages: [pre-push]
         pass_filenames: false
-      - id: poetry-check # `pyproject.toml` と `poetry.lock` が整合する
-        name: poetry-check
-        entry: poetry check
+      - id: uv-check # `pyproject.toml` と `uv.lock` が整合する
+        name: uv-check
+        entry: uv lock --check
         language: python
         stages: [pre-push]
         pass_filenames: false
-      - id: poetry-export
-        name: poetry-export
-        entry: poetry export --without-hashes -o requirements.txt
+      - id: uv-export
+        name: uv-export
+        entry: uv export --no-annotate --no-hashes --no-header -o requirements.txt
         language: python
         stages: [pre-push]
         pass_filenames: false
-      - id: poetry-export-dev
-        name: poetry-export-dev
-        entry: poetry export --without-hashes --with dev -o requirements-dev.txt
+      - id: uv-export-dev
+        name: uv-export-dev
+        entry: uv export --group dev --no-annotate --no-hashes --no-header -o requirements-dev.txt
         language: python
         stages: [pre-push]
         pass_filenames: false
-      - id: poetry-export-build
-        name: poetry-export-build
-        entry: poetry export --without-hashes --with build -o requirements-build.txt
+      - id: uv-export-build
+        name: uv-export-build
+        entry: uv export --group build --no-annotate --no-hashes --no-header -o requirements-build.txt
         language: python
         stages: [pre-push]
         pass_filenames: false