本記事ではUVの使用方法をメモします。
公式ドキュメントはこちらです。
インストール
pipxを使ったインストール方法は以下です。pipx以外のインストール方法は公式ドキュメントのインストールのセクションをご確認ください。
pipx install uvPython管理
特定のバージョンのPythonをインストールするには以下を実行します。
uv python install 3.12プロジェクトでPythonバージョンを固定するにはpinを実行します。
uv python pin 3.12すると、.python-versionが作成され、Pythonバージョンが保存されます。
仮想環境の作成
venvコマンドで環境を作成します。
uv venvその後、次のコマンドで仮想環境を有効化できます。
source .venv/bin/activateプロジェクト管理
uv initでプロジェクトを初期化します。
uv init uv-test
cd uv-test初期化すると、以下のディレクトリ構成でファイルが作成されます。
uv-test
├── main.py
├── pyproject.toml
└── README.mdpyproject.tomlは以下のようになっています。
# pyproject.toml
[project]
name = "uv-test"
version = "0.1.0"
description = "Add your description here"
readme = "README.md"
requires-python = ">=3.12"
dependencies = []
ライブラリの追加・削除・インストール
ライブラリを追加するにはuv addを実行します。
uv add pandas開発環境のみにライブラリを追加するにはdevオプションをつけます。
uv add --dev pytestパッケージを削除したいときはuv removeを使います。
uv remove pytestpyproject.tomlでライブラリのバージョン指定を追加する場合、以下を参考に追記します。
[project]
name = "albatross"
version = "0.1.0"
dependencies = [
# Any version in this range
"tqdm >=4.66.2,<5",
# Exactly this version of torch
"torch ==2.2.2",
# Install transformers with the torch extra
"transformers[torch] >=4.39.3,<5",
# Only install this package on older python versions
# See "Environment Markers" for more information
"importlib_metadata >=7.1.0,<8; python_version < '3.10'",
"mollymawk ==0.1.0"
]uvは uv pip コマンドで、pip互換のインターフェースを提供しています。そのため、以下のコマンドでインストールされているライブラリの一覧を確認できます。
uv pip listuv.lockに従い、プロジェクトの全てのライブラリをインストールするにはuv syncを実行します。
uv sync
# 開発環境の依存関係を除外してインストールするとき
uv sync --no-devDocker with uv
uvを使ったDockerfileの作成例は以下の通りです。
なお、公式ドキュメントの関連箇所はこちらです。
FROM python:3.12 AS builder
# install uv
COPY --from=ghcr.io/astral-sh/uv:0.7.19 /uv /uvx /bin/
# use the system Python environment
ENV UV_PROJECT_ENVIRONMENT="/usr/local/"
WORKDIR /sample
COPY pyproject.toml uv.lock ./
RUN uv sync --locked --no-cache --no-dev
FROM python:3.12-slim-bookworm AS runner
RUN apt-get update && apt-get upgrade -y
COPY --from=builder /usr/local/lib/python3.12/site-packages /usr/local/lib/python3.12/site-packages
COPY app/ /sample/app/
WORKDIR /sample
CMD ["echo", "sample"]上記では、builderイメージでuvを使ってライブラリをインストールした後、runnerイメージにライブラリをコピーしています。
また、仮想環境を作らず直接仮想環境でない Python の環境にライブラリをインストールしています。これは、Poetryの時に virtualenvs.create false を指定していたのですが、なるべくその時のコードを流用したく同様のことを行いたかったためです。
コメント