0. はじめに
株式会社ディー・エヌ・エーに入社し，MLOps エンジニアをやっている @a5chin です．
0.1. 背景
2024/08/20 に Astral 社から以下のブログが発表されました．
Python のランタイム・パッケージングを uv 一つで置き換えることができるという発表でした．
Today, we're announcing a series of features that extend uv beyond a pip alternative, and into an end-to-end solution for managing Python projects, command-line tools, single-file scripts, and even Python itself.
本記事では，以前に紹介した『【Rye + uv + Ruff】Docker で VS Code の Dev Container 上に快適な Python 環境を構築する』の続編で，Python パッケージツールを統一した uv を使って開発環境を整備し直していきます．
0.2. 成果物
成果物としては以前の『【Rye + uv + Ruff】Docker で VS Code の Dev Container 上に快適な Python 環境を構築する』と変わりありません．
図 1: Dev Container 上で開発をすると Ruff による自動フォーマット[1]と pre-commit が走る
0.3. 事前準備
本記事で作成したリポジトリを動かすためには，Docker Desktop と VS Code のダウンロード，VS Code 上で Dev Container のインストールが必要です．
また，以下コマンドでリポジトリを clone すると，今後進めやすくなるので clone することをおすすめします．
git clone https://github.com/a5chin/python-uv
0.3.1. Docker Desktop のダウンロード
上記リンクからお使いの OS に合った Docker Desktop をダウンロードしてください↑
Docker Desktop は Mac や Windows に簡単にインストールできるアプリケーションです．
これにより，コンテナ化アプリケーションやマイクロサービスを構築し共有することができます．
0.3.2. VS Code のダウンロード
上記リンクからお使いの OS に合った VS Code をダウンロードしてください↑
VS Code は Microsoft 社から無償で提供されており，Windows, macOS, および Linux で使用できる，軽量ながら強力なソースコードエディターです．
拡張機能によって，全体的な機能に加えてさらに機能を追加することでより快適に開発することができます．
0.3.3. Dev Container のインストール
VS Code 上で VS Code の拡張機能である，Dev Container をインストールしてください．
VS Code 上で⇧⌘xと入力すると，サイドに Extensions が開くのでms-vscode-remote.remote-containersと入力して，出てきた拡張機能をインストールしてください．
Dev Container は Microsoft が開発している VS Code の拡張機能です．
Dev Container を使うことで，VS Code から Docker コンテナを開発環境として使用できます．
1. 結論
| Step | Save | commit | GitHub Actions |
|---|---|---|---|
| Python Formatter (Ruff) | ✅ | ✅ | ✅ |
| Python Linter (Ruff) | ⛔ | ✅ | ✅ |
| Docker Linter (Hadolint) | ⛔ | ✅ | ✅ |
| pytest | ⛔ | ⛔ | ✅ |
| docker build | ⛔ | ⛔ | ✅ |
上記対応表の様に，私が設定した Dev Countainer 上で開発をすることによって，Format[1:1], Lint[2], Test[3], Build[4] を自動化しています．
1.1. 実際の操作画面
Python プログラムを保存して，git で commit した時の操作画面です．
高速でとても快適です！
図 2: Dev Container 上で開発をすると Ruff による自動フォーマット[1:2]と pre-commit が走る
2. Docker で開発環境を整える
以下では，主に Docker について解説していきます．
Dev Container は Docker コンテナを開発環境として作成するからです．
2.1. uv を使える様にする
uv は，上記 GitHub リポジトリで Astral 社が開発している Python のプロジェクト管理ツールです．
Rust[5] で開発されているため，とても高速に動作します．
以下のフローで Docker コンテナ内で uv を使える様にします．
- uv の インストーラー をダウンロードする
- uv を使える様に Path を通す
- ダウンロードした uv の所有者を変更する
Dev Container では vscode ユーザーで作業するので，ダウンロードした uv フォルダの所有者を vscode ユーザーに変更することをおすすめします．
所有者を root から変更しない場合は，VS Code 上で uv の設定ファイルを書き換えることができないからです．
FROM debian:bookworm-slim AS builder
WORKDIR /opt
# The installer requires curl (and certificates) to download the release archive
# hadolint ignore=DL3008
RUN apt-get update && \
apt-get install -y --no-install-recommends \
ca-certificates \
curl
SHELL [ "/bin/bash", "-o", "pipefail", "-c" ]
# Download the latest installer
+ ADD https://astral.sh/uv/install.sh /uv-installer.sh
# Run the installer then remove it
+ RUN sh /uv-installer.sh && rm /uv-installer.sh
# uv を使える様に Path を通す
+ ENV CARGO_HOME="/opt/.cargo/bin"
+ ENV PATH="$CARGO_HOME/:$PATH"
+ RUN chown -R vscode $CARGO_HOME
2.2. Ruff を使える様にする
図 3: Lint[2:1] する際のスピード比較
Ruff は，上記 GitHub リポジトリで Astral 社が開発している Python 用の Formatter[1:3], Linter[2:2] です．
Rust[5:1] で書かれているため高速で，なんと Pylint[6] の 200 倍以上のスピードです！
.python-versionで指定した Python と pyproject.toml, uv.lockで指定したパッケージを uv を使ってインストールします．
FROM debian:bookworm-slim AS builder
WORKDIR /opt
# The installer requires curl (and certificates) to download the release archive
# hadolint ignore=DL3008
RUN apt-get update && \
apt-get install -y --no-install-recommends \
ca-certificates \
curl
SHELL [ "/bin/bash", "-o", "pipefail", "-c" ]
# Download the latest installer
ADD https://astral.sh/uv/install.sh /uv-installer.sh
# Run the installer then remove it
RUN sh /uv-installer.sh && rm /uv-installer.sh
ENV CARGO_HOME="/opt/.cargo/bin"
ENV PATH="$CARGO_HOME/:$PATH"
+ COPY ./.python-version ./pyproject.toml ./uv.lock ./
+ RUN uv python pin "$(cat .python-version)" && \
+ uv sync --dev
RUN chown -R vscode $CARGO_HOME
2.3.1. Ruff の設定
Ruff の設定はruff.tomlファイルで設定を書くことができ，基本的に公式から流用しています．
しかし，上記ドキュメントには Conflict してしまう設定は ignore することを推奨すると書かれていたので，追記しています．
# Exclude a variety of commonly ignored directories.
exclude = [
".bzr",
".direnv",
".eggs",
".git",
".git-rewrite",
".hg",
".ipynb_checkpoints",
".mypy_cache",
".nox",
".pants.d",
".pyenv",
".pytest_cache",
".pytype",
".ruff_cache",
".svn",
".tox",
".venv",
".vscode",
"__pypackages__",
"_build",
"buck-out",
"build",
"dist",
"node_modules",
"site-packages",
"venv",
]
# Same as Black.
line-length = 88
indent-width = 4
# Assume Python 3.12
target-version = "py312"
[lint]
# Enable Pyflakes (`F`) and a subset of the pycodestyle (`E`) codes by default.
select = ["ALL"]
+ ignore = [
+ "COM812", "COM819",
+ "D100", "D203", "D213", "D300",
+ "E111", "E114", "E117",
+ "ISC001", "ISC002",
+ "Q000", "Q001", "Q002", "Q003",
+ "W191",
+ ]
# Allow fix for all enabled rules (when `--fix`) is provided.
fixable = ["ALL"]
unfixable = []
# Allow unused variables when underscore-prefixed.
dummy-variable-rgx = "^(_+|(_+[a-zA-Z0-9_]*[a-zA-Z0-9]+?))$"
[format]
# Like Black, use double quotes for strings.
quote-style = "double"
# Like Black, indent with spaces, rather than tabs.
indent-style = "space"
# Like Black, respect magic trailing commas.
skip-magic-trailing-comma = false
# Like Black, automatically detect the appropriate line ending.
line-ending = "auto"
2.3.2. Dev Container の設定
.devcontainer/devcontainer.jsonの様に Dev Container の設定をすることで，保存時に自動フォーマット[1:4]されます．
{
"name": "uv",
"build": {
"context": "..",
"dockerfile": "Dockerfile"
},
"features": {
"ghcr.io/dhoeric/features/hadolint:1": {}
},
"customizations": {
"vscode": {
"extensions": [
"charliermarsh.ruff",
"codezombiech.gitignore",
"eamodio.gitlens",
"exiasr.hadolint",
"kevinrose.vsc-python-indent",
"mosapride.zenkaku",
"ms-azuretools.vscode-docker",
"ms-python.python",
"njpwerner.autodocstring",
"oderwat.indent-rainbow",
"pkief.material-icon-theme",
"shardulm94.trailing-spaces",
"usernamehw.errorlens",
"yzhang.markdown-all-in-one"
],
"settings": {
"python.defaultInterpreterPath": "/root/.local/share/uv/python",
"[python]": {
"editor.defaultFormatter": "charliermarsh.ruff",
"editor.codeActionsOnSave": {
"source.fixAll.ruff": "explicit",
"source.organizeImports.ruff": "explicit"
},
"editor.formatOnSave": true
},
"files.insertFinalNewline": true,
"files.trimTrailingWhitespace": true,
"terminal.integrated.defaultProfile.linux": "zsh",
"terminal.integrated.profiles.linux": {
"zsh": {
"path": "/bin/zsh"
}
}
}
}
},
"postCreateCommand": "uv sync --dev",
"postStartCommand": "uv run pre-commit install",
"remoteUser": "vscode"
}
2.4. Multi-stage builds
Docker の Multi-stage builds（マルチステージビルド）を使うことで Docker イメージを削減することができます．
1 段階目のビルドで必要なパッケージをダウンロードし，2 段階目のビルドに必要なファイルだけを渡しています．
+ FROM debian:bookworm-slim AS builder
WORKDIR /opt
# The installer requires curl (and certificates) to download the release archive
# hadolint ignore=DL3008
RUN apt-get update && \
apt-get install -y --no-install-recommends \
ca-certificates \
curl
SHELL [ "/bin/bash", "-o", "pipefail", "-c" ]
# Download the latest installer
ADD https://astral.sh/uv/install.sh /uv-installer.sh
# Run the installer then remove it
- RUN sh /uv-installer.sh && rm /uv-installer.sh
+ RUN sh /uv-installer.sh
+ FROM mcr.microsoft.com/vscode/devcontainers/base:bookworm
ENV CARGO_HOME="/opt/.cargo/bin"
ENV PATH="$CARGO_HOME/:$PATH"
WORKDIR /opt
+ COPY /root/.cargo/bin/uv $CARGO_HOME/uv
COPY ./.python-version ./
# sync は devcontainer.json で明示するため不必要
RUN uv python pin "$(cat .python-version)"
- uv sync --dev
RUN chown -R vscode $CARGO_HOME
3. おまけ
ブランチ毎に機能を分けていく予定なので，機能を追加次第更新していきます．
3.1. jupyter ブランチ
Jupyter Notebook もフォーマットできるようにしました．
主に Jupyter Notebook を使用する時に切り替えるブランチです．
3.2. rye ブランチ
『【Rye + uv + Ruff】Docker で VS Code の Dev Container 上に快適な Python 環境を構築する』で作成した成果物です．
必要がなくなってしまったので，泣く泣くのアーカイブ用です．
4. まとめ
本記事では，VS Code の Dev Container 上に uv と Ruff を使って爆速で快適な Python 環境を構築する方法について解説しました．
皆さんが快適な Python ライフを送れることを願います💫
Discussion