Skip to content

Settings

Global#

cache-dir#

キャッシュディレクトリへのパスです。

デフォルトは、macOSでは$HOME/Library/Caches/uv、Linuxでは$XDG_CACHE_HOME/uvまたは$HOME/.cache/uv、Windowsでは{FOLDERID_LocalAppData}\uv\cacheです。

Default value: None

Type: str

Example usage:

[tool.uv]
cache-dir = "./.uv_cache"
cache-dir = "./.uv_cache"

compile-bytecode#

インストール後にPythonファイルをバイトコードにコンパイル。

デフォルトでは、uvはPython(.py)ファイルをバイトコード(__pycache__/*.pyc)にコンパイルしません。代わりに、モジュールが最初にインポートされたときに、コンパイルが遅延実行されます。CLIアプリケーションやDockerコンテナなど、開始時間が重要なユースケースでは、このオプションを有効にして、インストール時間を長くして開始時間を速くすることができる。

有効にすると、uvは一貫性のためにsite-packagesディレクトリ全体(現在の操作で変更されていないパッケージを含む)を処理します。pipと同様に、エラーも無視します。

Default value: false

Type: bool

Example usage:

[tool.uv]
compile-bytecode = true
compile-bytecode = true

config-settings#

PEP 517ビルドバックエンドに渡す設定で、KEY=VALUEペアで指定します。

Default value: {}

Type: dict

Example usage:

[tool.uv]
config-settings = { editable_mode = "compat" }
config-settings = { editable_mode = "compat" }

exclude-newer#

候補パッケージを、指定された日付より前にアップロードされたものに制限します。

RFC 3339タイムスタンプ(例:2006-12-02T02:07:43Z)とUTC日付(例:2006-12-02)の両方を同じ形式で受け入れます。

Default value: None

Type: str

Example usage:

[tool.uv]
exclude-newer = "2006-12-02"
exclude-newer = "2006-12-02"

extra-index-url#

--index-urlに加えて、使用するパッケージインデックスの追加URLです。

PEP 503(シンプルなリポジトリAPI)に準拠したリポジトリ、または同じ形式で作成されたローカルディレクトリを受け入れます。

このフラグで指定されたすべてのインデックスは、index_urlで指定されたインデックスよりも優先されます。複数のインデックスが指定されている場合は、それより前の値が優先されます。

複数のインデックスが存在する場合にUVの解像度方法を制御するには、index_strategyを参照してください。

Default value: []

Type: list[str]

Example usage:

[tool.uv]
extra-index-url = ["https://download.pytorch.org/whl/cpu"]
extra-index-url = ["https://download.pytorch.org/whl/cpu"]

レジストリインデックスで検出されたものに加えて、候補の分布を検索する場所です。

パスの場合、ターゲットは、最上位にwheelファイル(.whl)またはソース配布物(.tar.gzまたは.zip)としてパッケージを含むディレクトリでなければなりません。

URLの場合、ページには、上記の形式に準拠したパッケージファイルへのリンクのフラットリストを含める必要があります。

Default value: []

Type: list[str]

Example usage:

[tool.uv]
find-links = ["https://download.pytorch.org/whl/torch_stable.html"]
find-links = ["https://download.pytorch.org/whl/torch_stable.html"]

index-strategy#

複数のインデックスURLを解決するときに使用する方法です。

デフォルトでは、uvは指定されたパッケージが使用可能な最初のインデックスで停止し、解決はその最初のインデックスに存在するものに制限されます(first-match)。これにより、攻撃が同じ名前の悪意のあるパッケージをセカンダリにアップロードする可能性がある「依存関係の混乱」攻撃が防止されます。

Default value: "first-index"

Possible values:

  • "first-index":指定されたパッケージ名と一致する最初のインデックスの結果のみを使用します。
  • "unsafe-first-match":すべてのインデックスにわたってすべてのパッケージ名を検索し、次のインデックスに進む前に最初のインデックスからバージョンを調べます。
  • "unsafe-best-match":すべてのインデックスにわたってすべてのパッケージ名を検索し、見つかった「最適な」バージョンを優先します。パッケージのバージョンが複数のインデックスにある場合は、最初のインデックスのエントリのみを調べます。

Example usage:

[tool.uv]
index-strategy = "unsafe-best-match"
index-strategy = "unsafe-best-match"

index-url#

PythonパッケージインデックスのURL(デフォルトではhttps://pypi.org/simple)です。

PEP 503(シンプルなリポジトリAPI)に準拠したリポジトリ、または同じ形式で作成されたローカルディレクトリを受け入れます。

この設定で提供されるインデックスには、extra_index_urlで指定されたインデックスよりも低い優先度が与えられます。

Default value: "https://pypi.org/simple"

Type: str

Example usage:

[tool.uv]
index-url = "https://test.pypi.org/simple"
index-url = "https://test.pypi.org/simple"

keyring-provider#

インデックスURLの認証にkeyringを使います。

現在、--keyring-provider subprocessのみがサポートされています。これは、認証を処理するためにkeyringCLIを使用するようにuvを設定します。

Default value: "disabled"

Type: str

Example usage:

[tool.uv]
keyring-provider = "subprocess"
keyring-provider = "subprocess"

グローバルキャッシュからパッケージをインストールするときに使用する方法です。

デフォルトは、macOSではclone(Copy-on-Writeとも呼ばれる)、LinuxとWindowsではhardlinkです。

Default value: "clone" (macOS) or "hardlink" (Linux, Windows)

Possible values:

  • "clone":wheelからsite-packagesディレクトリにパッケージを複製(つまり、書き込み時コピー)します。
  • "copy":wheelからsite-packagesディレクトリにパッケージをコピーします。
  • "hardlink":wheelからsite-packagesディレクトリにパッケージをハードリンクします
  • "symlink":パッケージをwheelからsite-packagesディレクトリにシンボリックにリンクします。

Example usage:

[tool.uv]
link-mode = "copy"
link-mode = "copy"

managed#

プロジェクトがuvによって管理されているかどうかの設定です。falseの場合、uv runが呼び出されたときにuvはプロジェクトを無視します。

Default value: true

Type: bool

Example usage:

[tool.uv]
managed = false
managed = false

native-tls#

プラットフォームのネイティブ証明書ストアからTLS証明書をロードするかどうかの設定です。

デフォルトでは、uvはバンドルされたwebpki-rootsクレートから証明書をロードします。webpki-rootsはMozillaからの信頼できるトラストルートのセットであり、uvに含めることで移植性とパフォーマンスが向上します(特にmacOSで)。

ただし、場合によっては、特にシステムの証明書ストアに含まれている企業の信頼ルート(必須プロキシなど)に依存している場合は、プラットフォームのネイティブ証明書ストアを使用することもできます。

Default value: false

Type: bool

Example usage:

[tool.uv]
native-tls = true
native-tls = true

no-binary#

pre-buildされたwheelをインストールしません。

指定されたパッケージがビルドされ、ソースからインストールされます。リゾルバは、利用可能であれば、ビルド済みのwheelを使用してパッケージメタデータを抽出します。

Default value: false

Type: bool

Example usage:

[tool.uv]
no-binary = true
no-binary = true

no-binary-package#

特定のパッケージ用に事前に構築されたwheelをインストールしません。

Default value: []

Type: list[str]

Example usage:

[tool.uv]
no-binary-package = ["ruff"]
no-binary-package = ["ruff"]

no-build#

ソース配布物を構築しません。

有効にすると、解決は任意のPythonコードを実行しません。すでに構築されたソースディストリビューションのキャッシュされたwheelは再利用されますが、ディストリビューションの構築を必要とする操作はエラーで終了します。

Default value: false

Type: bool

Example usage:

[tool.uv]
no-build = true
no-build = true

no-build-isolation#

ソース配布を構築するときにディストリビューションを無効にします。

PEP 518で指定されたビルド依存関係がすでにインストールされていることを前提としています。

Default value: false

Type: bool

Example usage:

[tool.uv]
no-build-isolation = true
no-build-isolation = true

no-build-isolation-package#

特定のパッケージのソース配布を構築するときにディストリビューションを無効にします。

PEP 518で指定されたパッケージのビルド依存関係がすでにインストールされていることを前提としています。

Default value: []

Type: Vec<PackageName>

Example usage:

[tool.uv]
no-build-isolation-package = ["package1", "package2"]
no-build-isolation-package = ["package1", "package2"]

no-build-package#

特定のパッケージ用にソース配布物を構築しません。

Default value: []

Type: list[str]

Example usage:

[tool.uv]
no-build-package = ["ruff"]
no-build-package = ["ruff"]

no-cache#

キャッシュからの読み取りやキャッシュへの書き込みは避け、操作中は一時ディレクトリを使用します。

Default value: false

Type: bool

Example usage:

[tool.uv]
no-cache = true
no-cache = true

no-index#

すべてのレジストリインデックス(PyPIなど)を無視し、代わりに直接のURL依存関係と--find-linksで提供されるものに依存します。

Default value: false

Type: bool

Example usage:

[tool.uv]
no-index = true
no-index = true

no-sources#

依存関係を解決するときにtool.uv.sourcesテーブルを無視します。ローカルまたはGitソースを使用するのではなく、標準に準拠した公開可能なパッケージメタデータに対してロックするために使用します。

Default value: false

Type: bool

Example usage:

[tool.uv]
no-sources = true
no-sources = true

offline#

ローカルにキャッシュされたデータとローカルで使用可能なファイルのみに依存して、ネットワークアクセスを無効にします。

Default value: false

Type: bool

Example usage:

[tool.uv]
offline = true
offline = true

prerelease#

プレリリースバージョンを検討するときに使用する戦略です。

デフォルトでは、uvは、宣言された指定子(if-necessary-or-explicit)に明示的なプレリリースマーカーを含むファーストパーティ要件とともに、プレリリースを_only_publishするパッケージのプレリリースを受け入れます。

Default value: "if-necessary-or-explicit"

Possible values:

  • "disallow":すべてのプレリリースバージョンを禁止します。
  • "allow":すべてのプレリリースバージョンを許可します。
  • "if-necessary":パッケージのすべてのバージョンがプレリリースである場合、プレリリースバージョンを許可します。
  • "explicit":バージョン要件に明示的なプレリリースマーカーを持つファーストパーティパッケージのプレリリースバージョンを許可します。
  • "if-necessary-or-explicit":パッケージのすべてのバージョンがプレリリースである場合、またはパッケージのバージョン要件に明示的なプレリリースマーカーがある場合に、プレリリースバージョンを許可します。

Example usage:

[tool.uv]
prerelease = "allow"
prerelease = "allow"

preview#

実験的なプレビュー機能を有効にするかどうかの設定です。

Default value: false

Type: bool

Example usage:

[tool.uv]
preview = true
preview = true

python-downloads#

Whether to allow Python downloads.

Pythonのダウンロードを許可するかどうかの設定です。

Default value: "automatic"

Possible values:

  • "automatic":必要に応じて、管理されたPythonのインストールを自動的にダウンロードします。
  • "manual":管理されたPythonのインストールを自動的にダウンロードしません。明示的なインストールが必要です。
  • "never":Pythonのダウンロードを許可しません。

Example usage:

[tool.uv]
python-downloads = "manual"
python-downloads = "manual"

python-preference#

システム上にすでに存在するPythonインストレーションを使用するか、uvによってダウンロードおよびインストールされたPythonインストレーションを使用するかを指定します。

Default value: "only-system" (stable) or "managed" (preview)

Possible values:

  • "only-managed":管理されたPythonインストールのみを使用し、システムPythonインストールは使用しません。
  • "managed":システムPythonのインストールよりもマネージドPythonのインストールを優先します。
  • "system":管理されたPythonインストールよりもシステムPythonインストールを優先します。
  • "only-system":システムのPythonインストールのみを使用し、管理対象のPythonインストールは使用しません。

Example usage:

[tool.uv]
python-preference = "managed"
python-preference = "managed"

reinstall#

すでにインストールされているかどうかにかかわらず、すべてのパッケージを再インストールします。refreshを意味します。

Default value: false

Type: bool

Example usage:

[tool.uv]
reinstall = true
reinstall = true

reinstall-package#

すでにインストールされているかどうかにかかわらず、特定のパッケージを再インストールします。refresh-packageを意味します。

Default value: []

Type: list[str]

Example usage:

[tool.uv]
reinstall-package = ["ruff"]
reinstall-package = ["ruff"]

resolution#

特定のパッケージ要件に対して互換性のある異なるバージョンを選択するときに使用する戦略です。

デフォルトでは、uvは各パッケージの最新の互換バージョン(highest)を使用します。

Default value: "highest"

Possible values:

  • "highest":各パッケージの最も互換性の高いバージョンを解決します。
  • "lowest":各パッケージの最も互換性の低いバージョンを解決します。
  • "lowest-direct":すべての直接依存関係の最も互換性の低いバージョンと、すべての推移的依存関係の最も互換性の高いバージョンを解決します。

Example usage:

[tool.uv]
resolution = "lowest-direct"
resolution = "lowest-direct"

upgrade#

パッケージのアップグレードを許可し、既存の出力ファイル内の固定バージョンを無視します。

Default value: false

Type: bool

Example usage:

[tool.uv]
upgrade = true
upgrade = true

upgrade-package#

既存の出力ファイル内の固定バージョンを無視して、特定のパッケージのアップグレードを許可します。

スタンドアロンパッケージ名(ruff)とバージョン指定子(ruff<0.5.0)の両方を受け入れます。

Default value: []

Type: list[str]

Example usage:

[tool.uv]
upgrade-package = ["ruff"]
upgrade-package = ["ruff"]

pip#

uv pipコマンドラインインターフェイスに固有の設定です。

これらの値は、uv pip名前空間以外のコマンド(例えばuv lockuvx)を実行するときには無視されます。

all-extras#

すべてのオプションの依存関係を含めます。

pyproject.tomlsetup.py、およびsetup.cfgソースにのみ適用されます。

Default value: false

Type: bool

Example usage:

[tool.uv.pip]
all-extras = true
[pip]
all-extras = true

allow-empty-requirements#

空の要件でuv pip syncを許可します。これにより、すべてのパッケージの環境がクリアされます。

Default value: false

Type: bool

Example usage:

[tool.uv.pip]
allow-empty-requirements = true
[pip]
allow-empty-requirements = true

annotation-style#

出力ファイルに含まれる注釈コメントのスタイル。各パッケージのソースを示すために使用されます。

Default value: "split"

Possible values:

  • "line":コンマ区切りの1行に注釈を描画します。
  • "split":各注釈をそれぞれの行に描画します。

Example usage:

[tool.uv.pip]
annotation-style = "line"
[pip]
annotation-style = "line"

break-system-packages#

uvでEXTERNALLY-MANAGEDPythonインストールを変更できるようになりました。

警告:--break-system-packagesは、継続的インテグレーション(CI)環境で、aptのような外部パッケージマネージャによって管理されているPythonインストールにインストールする場合に使用することを意図しています。このようなPythonインストールでは、他のパッケージマネージャ(uvやpipなど)による変更を明示的に推奨していないため、注意して使用する必要があります。

Default value: false

Type: bool

Example usage:

[tool.uv.pip]
break-system-packages = true
[pip]
break-system-packages = true

compile-bytecode#

インストール後にPythonファイルをバイトコードにコンパイルします。

デフォルトでは、uvはPython(.py)ファイルをバイトコード(__pycache__/*.pyc)にコンパイルしません。代わりに、モジュールが最初にインポートされたときに、コンパイルが遅延実行されます。CLIアプリケーションやDockerコンテナなど、開始時間が重要なユースケースでは、このオプションを有効にして、インストール時間を長くして開始時間を速くすることができる。

有効にすると、uvは一貫性のためにsite-packagesディレクトリ全体(現在の操作で変更されていないパッケージを含む)を処理します。pipと同様に、エラーも無視します。

Default value: false

Type: bool

Example usage:

[tool.uv.pip]
compile-bytecode = true
[pip]
compile-bytecode = true

concurrent-builds#

uvが任意の時点で同時に構築するソース分布の最大数。

デフォルトは、使用可能なCPUコアの数です。

Default value: None

Type: int

Example usage:

[tool.uv.pip]
concurrent-builds = 4
[pip]
concurrent-builds = 4

concurrent-downloads#

uvが同時に実行するインフライト同時ダウンロードの最大数です。

Default value: 50

Type: int

Example usage:

[tool.uv.pip]
concurrent-downloads = 4
[pip]
concurrent-downloads = 4

concurrent-installs#

パッケージのインストールおよび解凍時に使用されるスレッドの数。

デフォルトは、使用可能なCPUコアの数です。

Default value: None

Type: int

Example usage:

[tool.uv.pip]
concurrent-installs = 4
[pip]
concurrent-installs = 4

config-settings#

PEP 517ビルドバックエンドに渡す設定で、KEY=VALUEペアで指定します。

Default value: {}

Type: dict

Example usage:

[tool.uv.pip]
config-settings = { editable_mode = "compat" }
[pip]
config-settings = { editable_mode = "compat" }

custom-compile-command#

uv pip compileによって生成される出力ファイルの先頭に含まれるヘッダコメントです。

uv pip compileをラップするカスタムビルドスクリプトとコマンドを反映するために使用されます。

Default value: None

Type: str

Example usage:

[tool.uv.pip]
custom-compile-command = "./custom-uv-compile.sh"
[pip]
custom-compile-command = "./custom-uv-compile.sh"

emit-build-options#

uv pip compileによって生成される出力ファイルに--no-binaryエントリと--only-binaryエントリを含めます。

Default value: false

Type: bool

Example usage:

[tool.uv.pip]
emit-build-options = true
[pip]
emit-build-options = true

uv pip compileによって生成される出力ファイルに--find-linksエントリを含めます。

Default value: false

Type: bool

Example usage:

[tool.uv.pip]
emit-find-links = true
[pip]
emit-find-links = true

emit-index-annotation#

各パッケージを解決するために使用されるインデックスを示すコメント注釈を含めます(例:#from https://pypi.org/simple)。

Default value: false

Type: bool

Example usage:

[tool.uv.pip]
emit-index-annotation = true
[pip]
emit-index-annotation = true

emit-index-url#

uv pip compileによって生成される出力ファイルに--index-urlエントリと--extra-index-urlエントリを含めます。

Default value: false

Type: bool

Example usage:

[tool.uv.pip]
emit-index-url = true
[pip]
emit-index-url = true

emit-marker-expression#

固定された依存関係のセットが有効である条件を示すマーカー文字列を出力するかどうかの設定です。

固定された依存関係は、マーカー式が偽であっても有効である可能性があるが、式が真である場合、要件は正しいことがわかっている。

Default value: false

Type: bool

Example usage:

[tool.uv.pip]
emit-marker-expression = true
[pip]
emit-marker-expression = true

exclude-newer#

候補パッケージを、指定された日付より前にアップロードされたものに制限します。

RFC 3339タイムスタンプ(例:2006-12-02T02:07:43Z)とUTC日付(例:2006-12-02)の両方を同じ形式で受け入れます。

Default value: None

Type: str

Example usage:

[tool.uv.pip]
exclude-newer = "2006-12-02"
[pip]
exclude-newer = "2006-12-02"

extra#

追加のグループ名からオプションの依存関係を含めます。複数回指定できます。

pyproject.tomlsetup.py、およびsetup.cfgソースにのみ適用されます。

Default value: []

Type: list[str]

Example usage:

[tool.uv.pip]
extra = ["dev", "docs"]
[pip]
extra = ["dev", "docs"]

extra-index-url#

--index-urlに加えて、使用するパッケージインデックスの追加URL。

PEP 503(シンプルなリポジトリAPI)に準拠したリポジトリ、または同じ形式で作成されたローカルディレクトリを受け入れます。

このフラグで指定されたすべてのインデックスは、index_urlで指定されたインデックスよりも優先されます。複数のインデックスが指定されている場合は、それより前の値が優先されます。

複数のインデックスが存在する場合にUVの解像度方法を制御するには、index_strategyを参照してください。

Default value: []

Type: list[str]

Example usage:

[tool.uv.pip]
extra-index-url = ["https://download.pytorch.org/whl/cpu"]
[pip]
extra-index-url = ["https://download.pytorch.org/whl/cpu"]

レジストリインデックスで検出されたものに加えて、候補の分布を検索する場所。

パスの場合、ターゲットは、最上位にwheelファイル(.whl)またはソース配布物(.tar.gzまたは.zip)としてパッケージを含むディレクトリでなければなりません。

URLの場合、ページには、上記の形式に準拠したパッケージファイルへのリンクのフラットリストを含める必要があります。

Default value: []

Type: list[str]

Example usage:

[tool.uv.pip]
find-links = ["https://download.pytorch.org/whl/torch_stable.html"]
[pip]
find-links = ["https://download.pytorch.org/whl/torch_stable.html"]

generate-hashes#

出力ファイルに配布ハッシュを含めます。

Default value: false

Type: bool

Example usage:

[tool.uv.pip]
generate-hashes = true
[pip]
generate-hashes = true

index-strategy#

複数のインデックスURLを解決するときに使用する方法。

デフォルトでは、uvは指定されたパッケージが使用可能な最初のインデックスで停止し、解決はその最初のインデックスに存在するものに制限されます(first-match)。これにより、攻撃が同じ名前の悪意のあるパッケージをセカンダリにアップロードする可能性がある「依存関係の混乱」攻撃が防止されます。

Default value: "first-index"

Possible values:

  • "first-index":指定されたパッケージ名と一致する最初のインデックスの結果のみを使用します。
  • "unsafe-first-match":すべてのインデックスにわたってすべてのパッケージ名を検索し、次のインデックスに進む前に最初のインデックスからバージョンを調べます。
  • "unsafe-best-match":すべてのインデックスにわたってすべてのパッケージ名を検索し、見つかった「最適な」バージョンを優先します。パッケージのバージョンが複数のインデックスにある場合は、最初のインデックスのエントリのみを調べます。

Example usage:

[tool.uv.pip]
index-strategy = "unsafe-best-match"
[pip]
index-strategy = "unsafe-best-match"

index-url#

PythonパッケージインデックスのURL(デフォルトではhttps://pypi.org/simple)。

PEP 503(シンプルなリポジトリAPI)に準拠したリポジトリ、または同じ形式で作成されたローカルディレクトリを受け入れます。

この設定で提供されるインデックスには、extra_index_urlで指定されたインデックスよりも低い優先度が与えられます。

Default value: "https://pypi.org/simple"

Type: str

Example usage:

[tool.uv.pip]
index-url = "https://test.pypi.org/simple"
[pip]
index-url = "https://test.pypi.org/simple"

keyring-provider#

インデックスURLの認証にkeyringを使います。

At present, only --keyring-provider subprocess is supported, which configures uv to use the keyring CLI to handle authentication.

Default value: disabled

Type: str

Example usage:

[tool.uv.pip]
keyring-provider = "subprocess"
[pip]
keyring-provider = "subprocess"

legacy-setup-py#

pyproject.tomlを使用せずにソース配布物を構築する場合は、従来のsetuptoolsの動作を使用します。

Default value: false

Type: bool

Example usage:

[tool.uv.pip]
legacy-setup-py = true
[pip]
legacy-setup-py = true

グローバルキャッシュからパッケージをインストールするときに使用する方法。

デフォルトは、macOSではclone(Copy-on-Writeとも呼ばれる)、LinuxとWindowsではhardlinkです。

Default value: "clone" (macOS) or "hardlink" (Linux, Windows)

Possible values:

  • "clone":wheelからsite-packagesディレクトリにパッケージを複製(つまり、書き込み時コピー)します。
  • "copy":wheelからsite-packagesディレクトリにパッケージをコピーします。
  • "hardlink":wheelからsite-packagesディレクトリにパッケージをハードリンクします
  • "symlink":パッケージをwheelからsite-packagesディレクトリにシンボリックにリンクします。

Example usage:

[tool.uv.pip]
link-mode = "copy"
[pip]
link-mode = "copy"

no-annotate#

uv pip compileによって生成される出力ファイルから、各パッケージのソースを示すコメント注釈を除外します。

Default value: false

Type: bool

Example usage:

[tool.uv.pip]
no-annotate = true
[pip]
no-annotate = true

no-binary#

プレビルドされたwheelをインストールしません。

指定されたパッケージがビルドされ、ソースからインストールされます。リゾルバは、利用可能であれば、ビルド済みのwheelを使用してパッケージメタデータを抽出します。

複数のパッケージを提供することができます。:all:ですべてのパッケージのバイナリを無効にします。:none:で以前に指定されたパッケージをクリアします。

Default value: []

Type: list[str]

Example usage:

[tool.uv.pip]
no-binary = ["ruff"]
[pip]
no-binary = ["ruff"]

no-build#

ソース配布物を構築しない。

有効にすると、解決は任意のPythonコードを実行しません。すでに構築されたソースディストリビューションのキャッシュされたwheelは再利用されますが、ディストリビューションの構築を必要とする操作はエラーで終了します。

--only-binary:all:のエイリアスです。:

Default value: false

Type: bool

Example usage:

[tool.uv.pip]
no-build = true
[pip]
no-build = true

no-build-isolation#

ソース配布を構築するときにディストリビューションを無効にします。

PEP 518で指定されたビルド依存関係がすでにインストールされていることを前提としています。

Default value: false

Type: bool

Example usage:

[tool.uv.pip]
no-build-isolation = true
[pip]
no-build-isolation = true

no-build-isolation-package#

特定のパッケージのソース配布を構築するときにディストリビューションを無効にします。

PEP 518で指定されたパッケージのビルド依存関係がすでにインストールされていることを前提としています。

Default value: []

Type: Vec<PackageName>

Example usage:

[tool.uv.pip]
no-build-isolation-package = ["package1", "package2"]
[pip]
no-build-isolation-package = ["package1", "package2"]

no-deps#

パッケージの依存関係を無視し、代わりに、コマンドラインに明示的にリストされたパッケージのみを結果の要件ファイルに追加します。

Default value: false

Type: bool

Example usage:

[tool.uv.pip]
no-deps = true
[pip]
no-deps = true

no-emit-package#

出力解決から省略するパッケージを指定します。その依存関係は解決に含まれます。pip-compileの--unsafe-packageオプションと同等です。

Default value: []

Type: list[str]

Example usage:

[tool.uv.pip]
no-emit-package = ["ruff"]
[pip]
no-emit-package = ["ruff"]

no-header#

uv pip compileによって生成された出力ファイルの先頭のコメントヘッダを除外します。

Default value: false

Type: bool

Example usage:

[tool.uv.pip]
no-header = true
[pip]
no-header = true

no-index#

すべてのレジストリインデックス(PyPIなど)を無視し、代わりに直接のURL依存関係と--find-linksで提供されるものに依存します。

Default value: false

Type: bool

Example usage:

[tool.uv.pip]
no-index = true
[pip]
no-index = true

no-sources#

依存関係を解決するときにtool.uv.sourcesテーブルを無視します。ローカルまたはGitソースを使用するのではなく、標準に準拠した公開可能なパッケージメタデータに対してロックするために使用されます。

Default value: false

Type: bool

Example usage:

[tool.uv.pip]
no-sources = true
[pip]
no-sources = true

no-strip-extras#

出力ファイルにエクストラを含めます。

デフォルトでは、UVはエクストラを取り除きます。エクストラによってプルインされたパッケージは、出力ファイルに依存関係として直接含まれています。さらに、--no-strip-extrasで生成された出力ファイルは、installおよびsync呼び出しで制約ファイルとして使用できません。

Default value: false

Type: bool

Example usage:

[tool.uv.pip]
no-strip-extras = true
[pip]
no-strip-extras = true

no-strip-markers#

uv pip compileによって生成される出力ファイルに環境マーカーを含めます。

デフォルトでは、UVは環境マーカを削除します。これは、compileによって生成される解像度がターゲット環境に対して正確であることのみが保証されるためです。

Default value: false

Type: bool

Example usage:

[tool.uv.pip]
no-strip-markers = true
[pip]
no-strip-markers = true

only-binary#

事前に構築されたwheelのみを使用し、ソースディストリビューションは構築しません。

有効にすると、解決は指定されたパッケージからコードを実行しません。すでに構築されたソースディストリビューションのキャッシュされたwheelは再利用されますが、ディストリビューションの構築を必要とする操作はエラーで終了します。

複数のパッケージを提供することができます。:all:ですべてのパッケージのバイナリを無効にします。:none:で以前に指定されたパッケージをクリアします。

Default value: []

Type: list[str]

Example usage:

[tool.uv.pip]
only-binary = ["ruff"]
[pip]
only-binary = ["ruff"]

output-file#

uv pip compileによって生成された要件を、指定されたrequirements.txtファイルに書き込みます。

ファイルがすでに存在する場合は、--upgradeも指定されていない限り、依存関係を解決するときに既存のバージョンが優先されます。

Default value: None

Type: str

Example usage:

[tool.uv.pip]
output-file = "requirements.txt"
[pip]
output-file = "requirements.txt"

prefix#

指定されたディレクトリの下のlibbin、およびその他の最上位レベルのフォルダに、仮想環境がその場所に存在するかのようにパッケージをインストールします。

一般的に、--pythonを使用して別の環境にインストールすることをお勧めします。--prefixを介してインストールされたスクリプトやその他のアーティファクトは、--prefixディレクトリに追加されたインタプリタではなく、インストールするインタプリタを参照するため、移植性がありません。

Default value: None

Type: str

Example usage:

[tool.uv.pip]
prefix = "./prefix"
[pip]
prefix = "./prefix"

prerelease#

プレリリースバージョンを検討するときに使用する戦略です。

デフォルトでは、uvは、宣言された指定子(if-necessary-or-explicit)に明示的なプレリリースマーカーを含むファーストパーティ要件とともに、プレリリースを_only_publishするパッケージのプレリリースを受け入れます。

Default value: "if-necessary-or-explicit"

Possible values:

  • "disallow":すべてのプレリリースバージョンを禁止します。
  • "allow":すべてのプレリリースバージョンを許可します。
  • "if-necessary":パッケージのすべてのバージョンがプレリリースである場合、プレリリースバージョンを許可します。
  • "explicit":バージョン要件に明示的なプレリリースマーカーを持つファーストパーティパッケージのプレリリースバージョンを許可します。
  • "if-necessary-or-explicit":パッケージのすべてのバージョンがプレリリースである場合、またはパッケージのバージョン要件に明示的なプレリリースマーカーがある場合に、プレリリースバージョンを許可します。

Example usage:

[tool.uv.pip]
prerelease = "allow"
[pip]
prerelease = "allow"

python#

パッケージがインストールされるPythonインタプリタです。

デフォルトでは、uvは現在の作業ディレクトリまたは任意の親ディレクトリ内の仮想環境にインストールされます。--pythonオプションを使用すると、継続的インテグレーション(CI)環境やその他の自動化されたワークフローで使用するための別のインタプリタを指定できます。

Supported formats:

サポートされる形式:

  • 3.10はWindows上でpy--list-pathsを使ってインストールされているPython 3.10を探します。
  • python3.10またはpython.exePATHで指定された名前のバイナリを探します。
  • /home/ferris/.local/bin/python3.10は、指定されたパスで正確なPythonを使用します。

Default value: None

Type: str

Example usage:

[tool.uv.pip]
python = "3.10"
[pip]
python = "3.10"

python-platform#

要件を解決する必要があるプラットフォーム。

"target triple"として表現され、x86_64-unknown-linux-gnuaaarch64-apple-darwinのように、CPU、ベンダ、オペレーティングシステム名の観点からターゲットプラットフォームを記述する文字列です。

Default value: None

Type: str

Example usage:

[tool.uv.pip]
python-platform = "x86_64-unknown-linux-gnu"
[pip]
python-platform = "x86_64-unknown-linux-gnu"

python-version#

解決された要件でサポートされるべきPythonの最小バージョン(例えば3.83.8.17)。

パッチバージョンが省略された場合、最小パッチバージョンが想定されます。たとえば、3.83.8.0にマップされます。

Default value: None

Type: str

Example usage:

[tool.uv.pip]
python-version = "3.8"
[pip]
python-version = "3.8"

reinstall#

すでにインストールされているかどうかにかかわらず、すべてのパッケージを再インストールします。refreshを意味します。

Default value: false

Type: bool

Example usage:

[tool.uv.pip]
reinstall = true
[pip]
reinstall = true

reinstall-package#

すでにインストールされているかどうかにかかわらず、特定のパッケージを再インストールします。refresh-packageを意味します。

Default value: []

Type: list[str]

Example usage:

[tool.uv.pip]
reinstall-package = ["ruff"]
[pip]
reinstall-package = ["ruff"]

require-hashes#

各要件に一致するハッシュを要求します。

ハッシュ・チェック・モードはallまたはnothingです。有効にした場合、_all_requirementsには対応するハッシュまたはハッシュのセットを指定する必要があります。さらに、有効にした場合、_all_requirementsは正確なバージョン(例えば==1.0.0)に固定するか、直接URLで指定する必要があります。

ハッシュチェックモードでは、次のような制約が追加されます。

  • Git依存関係はサポートされていません。
  • 編集可能なインストールはサポートされていません。
  • ディレクトリではなく、特定のwheel(.whl)またはソースアーカイブ(.zip.tar.gz)を指していない限り、ローカル依存関係はサポートされません。

Default value: false

Type: bool

Example usage:

[tool.uv.pip]
require-hashes = true
[pip]
require-hashes = true

resolution#

特定のパッケージ要件に対して互換性のある異なるバージョンを選択するときに使用する戦略です。

デフォルトでは、uvは各パッケージの最新の互換バージョン(highest)を使用します。

Default value: "highest"

Possible values:

  • "highest":各パッケージの最も互換性の高いバージョンを解決します。
  • "lowest":各パッケージの最も互換性の低いバージョンを解決します。
  • "lowest-direct":すべての直接依存関係の最も互換性の低いバージョンと、すべての推移的依存関係の最も互換性の高いバージョンを解決します。

Example usage:

[tool.uv.pip]
resolution = "lowest-direct"
[pip]
resolution = "lowest-direct"

strict#

Python環境を検証して、依存関係が欠落しているパッケージやその他の問題を検出します。

Default value: false

Type: bool

Example usage:

[tool.uv.pip]
strict = true
[pip]
strict = true

system#

システムのPython環境にパッケージをインストールします。

デフォルトでは、uvは現在の作業ディレクトリまたは任意の親ディレクトリの仮想環境にインストールされます。--systemオプションは、代わりにシステムPATHで見つかった最初のPythonを使用するようuvに指示します。

警告:--systemは継続的インテグレーション(CI)環境での使用を意図しており、システムのPythonインストールを変更する可能性があるため、注意して使用する必要があります。

Default value: false

Type: bool

Example usage:

[tool.uv.pip]
system = true
[pip]
system = true

target#

パッケージは、仮想またはシステムのPython環境ではなく、指定されたディレクトリにインストールされます。パッケージは、ディレクトリの最上位にインストールされます。

Default value: None

Type: str

Example usage:

[tool.uv.pip]
target = "./target"
[pip]
target = "./target"

universal#

ユニバーサル解決を実行し、すべてのオペレーティングシステム、アーキテクチャ、およびPython実装と互換性のある単一のrequirements.txt出力ファイルの生成を試みます。

ユニバーサルモードでは、現在のPythonバージョン(またはユーザが指定した--python-version)が下限として扱われます。たとえば、--universal--python-version 3.7はPython 3.7以降のユニバーサル解像度を生成します。

Default value: false

Type: bool

Example usage:

[tool.uv.pip]
universal = true
[pip]
universal = true

upgrade#

パッケージのアップグレードを許可し、既存の出力ファイル内の固定バージョンを無視します。

Default value: false

Type: bool

Example usage:

[tool.uv.pip]
upgrade = true
[pip]
upgrade = true

upgrade-package#

既存の出力ファイル内の固定バージョンを無視して、特定のパッケージのアップグレードを許可します。

スタンドアロンパッケージ名(ruff)とバージョン指定子(ruff<0.5.0)の両方を受け入れます。

Default value: []

Type: list[str]

Example usage:

[tool.uv.pip]
upgrade-package = ["ruff"]
[pip]
upgrade-package = ["ruff"]

verify-hashes#

要件ファイルで提供されたハッシュを検証します。

--require-hashesとは異なり、--verify-hashesはすべての要件がハッシュを持つことを要求するわけではありません。代わりに、ハッシュを含む要件のハッシュを検証することに限定されます。

Default value: false

Type: bool

Example usage:

[tool.uv.pip]
verify-hashes = true
[pip]
verify-hashes = true

workspace#

exclude#

ワークスペースメンバとして除外するパッケージ。パッケージがmembersexcludeの両方に一致する場合、そのパッケージは除外されます。

globと明示パスの両方をサポートします。

glob構文の詳細については、globdocumentationを参照してください。

Default value: []

Type: list[str]

Example usage:

[tool.uv.workspace]
exclude = ["member1", "path/to/member2", "libs/*"]
[workspace]
exclude = ["member1", "path/to/member2", "libs/*"]

members#

ワークスペースメンバとして含めるパッケージ。

globと明示パスの両方をサポートします。

glob構文の詳細については、globdocumentationを参照してください。

Default value: []

Type: list[str]

Example usage:

[tool.uv.workspace]
members = ["member1", "path/to/member2", "libs/*"]
[workspace]
members = ["member1", "path/to/member2", "libs/*"]