Settings設定
Project metadataプロジェクトメタデータ
build-constraint-dependenciesbuild-constraint-dependencies
Constraints to apply when solving build dependencies.ビルド依存関係を解決する際に適用する制約。
Build constraints are used to restrict the versions of build dependencies that are selected when building a package during resolution or installation.ビルド制約は、パッケージの解決またはインストール中に選択されるビルド依存関係のバージョンを制限するために使用されます。
Including a package as a constraint will not trigger installation of the package during a build; instead, the package must be requested elsewhere in the project's build dependency graph.パッケージを制約として含めることは、ビルド中にパッケージのインストールをトリガーしません; 代わりに、パッケージはプロジェクトのビルド依存関係グラフの他の場所で要求される必要があります。
Note注意
In uv lock, uv sync, and uv run, uv will only read build-constraint-dependencies from
the pyproject.toml at the workspace root, and will ignore any declarations in other
workspace members or uv.toml files.uv lock、uv sync、およびuv runでは、uvはワークスペースのルートにあるpyproject.tomlからのみbuild-constraint-dependenciesを読み取り、他のワークスペースメンバーやuv.tomlファイルの宣言は無視します。
Default value: []デフォルト値: []
Type: list[str]タイプ: list[str]
Example usage:使用例:
[tool.uv]
# Ensure that the setuptools v60.0.0 is used whenever a package has a build dependency
# on setuptools.
build-constraint-dependencies = ["setuptools==60.0.0"]
conflictsconflicts
Declare collections of extras or dependency groups that are conflicting (i.e., mutually exclusive).相互に排他的なエクストラまたは依存関係グループのコレクションを宣言します。
It's useful to declare conflicts when two or more extras have mutually
incompatible dependencies. For example, extra foo might depend
on numpy==2.0.0 while extra bar depends on numpy==2.1.0. While these
dependencies conflict, it may be the case that users are not expected to
activate both foo and bar at the same time, making it possible to
generate a universal resolution for the project despite the incompatibility.2つ以上のエクストラが相互に互換性のない依存関係を持つ場合、競合を宣言することは有用です。たとえば、エクストラfooはnumpy==2.0.0に依存し、エクストラbarはnumpy==2.1.0に依存するかもしれません。これらの依存関係は競合しますが、ユーザーが同時にfooとbarの両方をアクティブにすることが期待されていない場合、互換性のないにもかかわらずプロジェクトの普遍的な解決を生成することが可能です。
By making such conflicts explicit, uv can generate a universal resolution for a project, taking into account that certain combinations of extras and groups are mutually exclusive. In exchange, installation will fail if a user attempts to activate both conflicting extras.このような競合を明示化することで、uvはプロジェクトのための普遍的な解決策を生成できます。特定のエクストラとグループの組み合わせが相互に排他的であることを考慮に入れます。その代わりに、ユーザーが競合するエクストラの両方をアクティブにしようとすると、インストールは失敗します。
Default value: []デフォルト値: []
Type: list[list[dict]]タイプ: list[list[dict]]
Example usage:使用例:
[tool.uv]
# Require that `package[extra1]` and `package[extra2]` are resolved
# in different forks so that they cannot conflict with one another.
conflicts = [
[
{ extra = "extra1" },
{ extra = "extra2" },
]
]
# Require that the dependency groups `group1` and `group2`
# are resolved in different forks so that they cannot conflict
# with one another.
conflicts = [
[
{ group = "group1" },
{ group = "group2" },
]
]
constraint-dependenciesconstraint-dependencies
Constraints to apply when resolving the project's dependencies.プロジェクトの依存関係を解決する際に適用する制約。
Constraints are used to restrict the versions of dependencies that are selected during resolution.制約は、解決中に選択される依存関係のバージョンを制限するために使用されます。
Including a package as a constraint will not trigger installation of the package on its own; instead, the package must be requested elsewhere in the project's first-party or transitive dependencies.パッケージを制約として含めることは、そのパッケージを単独でインストールすることをトリガーしません; 代わりに、そのパッケージはプロジェクトのファーストパーティまたは遷移的依存関係のどこかで要求される必要があります。
Note注意
In uv lock, uv sync, and uv run, uv will only read constraint-dependencies from
the pyproject.toml at the workspace root, and will ignore any declarations in other
workspace members or uv.toml files.uv lock、uv sync、およびuv runでは、uvはワークスペースのルートにあるpyproject.tomlからのみconstraint-dependenciesを読み取り、他のワークスペースメンバーやuv.tomlファイルの宣言は無視します。
Default value: []デフォルト値: []
Type: list[str]タイプ: list[str]
Example usage:使用例:
[tool.uv]
# Ensure that the grpcio version is always less than 1.65, if it's requested by a
# direct or transitive dependency.
constraint-dependencies = ["grpcio<1.65"]
default-groupsdefault-groups
The list of dependency-groups to install by default.デフォルトでインストールするdependency-groupsのリスト。
Can also be the literal "all" to default enable all groups.すべてのグループをデフォルトで有効にするために、リテラル"all"を指定することもできます。
Default value: ["dev"]デフォルト値: ["dev"]
Type: str | list[str]タイプ: str | list[str]
Example usage:使用例:
dependency-groupsdependency-groups
Additional settings for dependency-groups.dependency-groupsの追加設定。
Currently this can only be used to add requires-python constraints
to dependency groups (typically to inform uv that your dev tooling
has a higher python requirement than your actual project).現在、これは依存関係グループに requires-python 制約を追加するためにのみ使用できます(通常、あなたの開発ツールが実際のプロジェクトよりも高いPython要件を持っていることをuvに通知するため)。
This cannot be used to define dependency groups, use the top-level
[dependency-groups] table for that.これは依存関係グループを定義するためには使用できません。代わりに、最上位の [dependency-groups] テーブルを使用してください。
Default value: []デフォルト値: []
Type: dictタイプ: dict
Example usage:使用例:
dev-dependenciesdev-dependencies
The project's development dependencies.プロジェクトの開発依存関係。
Development dependencies will be installed by default in uv run and uv sync, but will
not appear in the project's published metadata.開発依存関係は、デフォルトで uv run と uv sync でインストールされますが、プロジェクトの公開メタデータには表示されません。
Use of this field is not recommend anymore. Instead, use the dependency-groups.dev field
which is a standardized way to declare development dependencies. The contents of
tool.uv.dev-dependencies and dependency-groups.dev are combined to determine the final
requirements of the dev dependency group.このフィールドの使用はもはや推奨されていません。代わりに、開発依存関係を宣言するための標準化された方法である dependency-groups.dev フィールドを使用してください。 tool.uv.dev-dependencies と dependency-groups.dev の内容が結合されて、dev 依存関係グループの最終的な要件が決定されます。
Default value: []デフォルト値: []
Type: list[str]タイプ: list[str]
Example usage:使用例:
environmentsenvironments
A list of supported environments against which to resolve dependencies.依存関係を解決するためのサポートされている環境のリスト。
By default, uv will resolve for all possible environments during a uv lock operation.
However, you can restrict the set of supported environments to improve performance and avoid
unsatisfiable branches in the solution space.デフォルトでは、uv lock操作中にすべての可能な環境に対して解決されます。
ただし、パフォーマンスを向上させ、解決空間内の満たされないブランチを避けるために、
サポートされている環境のセットを制限することができます。
These environments will also be respected when uv pip compile is invoked with the
--universal flag.これらの環境は、uv pip compileが
--universalフラグを使用して呼び出されたときにも尊重されます。
Default value: []デフォルト値: []
Type: str | list[str]タイプ: str | list[str]
Example usage:使用例:
[tool.uv]
# Resolve for macOS, but not for Linux or Windows.
environments = ["sys_platform == 'darwin'"]
exclude-dependenciesexclude-dependencies
Dependencies to exclude when resolving the project's dependencies.プロジェクトの依存関係を解決する際に除外する依存関係。
Excludes are used to prevent a package from being selected during resolution, regardless of whether it's requested by any other package. When a package is excluded, it will be omitted from the dependency list entirely.除外は、他のパッケージによって要求されているかどうかに関係なく、解決中にパッケージが選択されるのを防ぐために使用されます。パッケージが除外されると、それは依存関係リストから完全に省かれます。
Including a package as an exclusion will prevent it from being installed, even if it's requested by transitive dependencies. This can be useful for removing optional dependencies or working around packages with broken dependencies.パッケージを除外として含めると、推移的依存関係によって要求されていても、そのパッケージがインストールされるのを防ぎます。これは、オプションの依存関係を削除したり、壊れた依存関係を持つパッケージを回避したりするのに役立ちます。
Note注意
In uv lock, uv sync, and uv run, uv will only read exclude-dependencies from
the pyproject.toml at the workspace root, and will ignore any declarations in other
workspace members or uv.toml files.uv lock、uv sync、および uv run では、uvはワークスペースのルートにある pyproject.toml からのみ exclude-dependencies を読み取り、他のワークスペースメンバーや uv.toml ファイル内の宣言は無視します。
Default value: []デフォルト値: []
Type: list[str]タイプ: list[str]
Example usage:使用例:
[tool.uv]
# Exclude Werkzeug from being installed, even if transitive dependencies request it.
exclude-dependencies = ["werkzeug"]
indexindex
The indexes to use when resolving dependencies.依存関係を解決する際に使用するインデックス。
Accepts either a repository compliant with PEP 503 (the simple repository API), or a local directory laid out in the same format.PEP 503(シンプルリポジトリAPI)に準拠したリポジトリ、または同じ形式でレイアウトされたローカルディレクトリを受け入れます。
Indexes are considered in the order in which they're defined, such that the first-defined
index has the highest priority. Further, the indexes provided by this setting are given
higher priority than any indexes specified via index_url or
extra_index_url. uv will only consider the first index that contains
a given package, unless an alternative index strategy is specified.インデックスは定義された順序で考慮され、最初に定義されたインデックスが最も高い優先度を持ちます。さらに、この設定で提供されたインデックスは、index_url または extra_index_url を介して指定されたインデックスよりも高い優先度が与えられます。uvは、指定されたパッケージを含む最初のインデックスのみを考慮し、代替の インデックス戦略 が指定されていない限り、他のインデックスは無視します。
If an index is marked as explicit = true, it will be used exclusively for the
dependencies that select it explicitly via [tool.uv.sources], as in:インデックスが explicit = true とマークされている場合、それは [tool.uv.sources] を介して明示的に選択された依存関係のみに独占的に使用されます。例としては、
[[tool.uv.index]]
name = "pytorch"
url = "https://download.pytorch.org/whl/cu121"
explicit = true
[tool.uv.sources]
torch = { index = "pytorch" }
If an index is marked as default = true, it will be moved to the end of the prioritized list, such that it is
given the lowest priority when resolving packages. Additionally, marking an index as default will disable the
PyPI default index.インデックスが default = true とマークされている場合、それは優先リストの最後に移動され、パッケージを解決する際に最も低い優先度が与えられます。さらに、インデックスをデフォルトとしてマークすると、PyPIのデフォルトインデックスが無効になります。
Default value: []デフォルト値: []
Type: dictタイプ: dict
Example usage:使用例:
managedmanaged
Whether the project is managed by uv. If false, uv will ignore the project when
uv run is invoked.プロジェクトがuvによって管理されているかどうか。falseの場合、uv runが呼び出されたときにuvはプロジェクトを無視します。
Default value: trueデフォルト値: true
Type: boolタイプ: bool
Example usage:使用例:
override-dependenciesoverride-dependencies
Overrides to apply when resolving the project's dependencies.プロジェクトの依存関係を解決する際に適用されるオーバーライド。
Overrides are used to force selection of a specific version of a package, regardless of the version requested by any other package, and regardless of whether choosing that version would typically constitute an invalid resolution.オーバーライドは、他のパッケージによって要求されたバージョンに関係なく、特定のパッケージの特定のバージョンの選択を強制するために使用されます。また、そのバージョンを選択することが通常無効な解決策となるかどうかにも関係ありません。
While constraints are additive, in that they're combined with the requirements of the constituent packages, overrides are absolute, in that they completely replace the requirements of any constituent packages.制約は構成パッケージの要件と組み合わされる加算的ですが、オーバーライドは構成パッケージの要件を完全に置き換える絶対的なものです。
Including a package as an override will not trigger installation of the package on its own; instead, the package must be requested elsewhere in the project's first-party or transitive dependencies.パッケージをオーバーライドとして含めることは、そのパッケージを単独でインストールするトリガーにはなりません; 代わりに、そのパッケージはプロジェクトのファーストパーティまたは遷移的依存関係のどこかで要求される必要があります。
Note注意
In uv lock, uv sync, and uv run, uv will only read override-dependencies from
the pyproject.toml at the workspace root, and will ignore any declarations in other
workspace members or uv.toml files.uv lock、uv sync、およびuv runでは、uvはワークスペースのルートにあるpyproject.tomlからのみoverride-dependenciesを読み取り、他のワークスペースメンバーやuv.tomlファイルの宣言は無視します。
Default value: []デフォルト値: []
Type: list[str]タイプ: list[str]
Example usage:使用例:
[tool.uv]
# Always install Werkzeug 2.3.0, regardless of whether transitive dependencies request
# a different version.
override-dependencies = ["werkzeug==2.3.0"]
packagepackage
Whether the project should be considered a Python package, or a non-package ("virtual") project.プロジェクトがPythonパッケージとして扱われるべきか、非パッケージ("仮想")プロジェクトであるべきか。
Packages are built and installed into the virtual environment in editable mode and thus require a build backend, while virtual projects are not built or installed; instead, only their dependencies are included in the virtual environment.パッケージはビルドされ、編集可能モードで仮想環境にインストールされるため、ビルドバックエンドが必要ですが、仮想プロジェクトはビルドやインストールされることはなく、その依存関係のみが仮想環境に含まれます。
Creating a package requires that a build-system is present in the pyproject.toml, and
that the project adheres to a structure that adheres to the build backend's expectations
(e.g., a src layout).パッケージを作成するには、build-systemがpyproject.tomlに存在し、プロジェクトがビルドバックエンドの期待に沿った構造(例:srcレイアウト)を遵守する必要があります。
Default value: trueデフォルト値: true
Type: boolタイプ: bool
Example usage:使用例:
required-environmentsrequired-environments
A list of required platforms, for packages that lack source distributions.ソース配布がないパッケージに必要なプラットフォームのリスト。
When a package does not have a source distribution, it's availability will be limited to the platforms supported by its built distributions (wheels). For example, if a package only publishes wheels for Linux, then it won't be installable on macOS or Windows.パッケージにソース配布がない場合、その利用可能性はビルドされた配布(ホイール)によってサポートされるプラットフォームに制限されます。たとえば、パッケージがLinux用のホイールのみを公開している場合、macOSやWindowsにはインストールできません。
By default, uv requires each package to include at least one wheel that is compatible with
the designated Python version. The required-environments setting can be used to ensure that
the resulting resolution contains wheels for specific platforms, or fails if no such wheels
are available.デフォルトでは、uvは各パッケージに指定されたPythonバージョンと互換性のある少なくとも1つのwheelを含めることを要求します。required-environments設定を使用すると、結果の解決に特定のプラットフォーム用のwheelが含まれることを保証するか、そのようなwheelが利用できない場合は失敗します。
While the environments setting limits the set of environments that uv will consider when
resolving dependencies, required-environments expands the set of platforms that uv must
support when resolving dependencies.environments設定は、uvが依存関係を解決する際に考慮する環境のセットを制限しますが、required-environmentsは、uvが依存関係を解決する際に必ずサポートしなければならないプラットフォームのセットを拡張します。
For example, environments = ["sys_platform == 'darwin'"] would limit uv to solving for
macOS (and ignoring Linux and Windows). On the other hand, required-environments = ["sys_platform == 'darwin'"]
would require that any package without a source distribution include a wheel for macOS in
order to be installable.例えば、environments = ["sys_platform == 'darwin'"]は、uvをmacOSの解決に制限し(LinuxとWindowsを無視します)。一方、required-environments = ["sys_platform == 'darwin'"]は、ソース配布がないパッケージがインストール可能であるためにはmacOS用のwheelを含むことを要求します。
Default value: []デフォルト値: []
Type: str | list[str]タイプ: str | list[str]
Example usage:使用例:
[tool.uv]
# Require that the package is available for macOS ARM and x86 (Intel).
required-environments = [
"sys_platform == 'darwin' and platform_machine == 'arm64'",
"sys_platform == 'darwin' and platform_machine == 'x86_64'",
]
sourcessources
The sources to use when resolving dependencies.依存関係を解決する際に使用するソース。
tool.uv.sources enriches the dependency metadata with additional sources, incorporated
during development. A dependency source can be a Git repository, a URL, a local path, or an
alternative registry.tool.uv.sourcesは、開発中に組み込まれた追加のソースで依存関係のメタデータを豊かにします。依存関係のソースは、Gitリポジトリ、URL、ローカルパス、または代替レジストリである可能性があります。
See Dependencies for more.依存関係については、さらに詳しくはご覧ください。
Default value: {}デフォルト値: {}
Type: dictタイプ: dict
Example usage:使用例:
[tool.uv.sources]
httpx = { git = "https://github.com/encode/httpx", tag = "0.27.0" }
pytest = { url = "https://files.pythonhosted.org/packages/6b/77/7440a06a8ead44c7757a64362dd22df5760f9b12dc5f11b6188cd2fc27a0/pytest-8.3.3-py3-none-any.whl" }
pydantic = { path = "/path/to/pydantic", editable = true }
build-backendbuild-backend
Settings for the uv build backend (uv_build).uv build backend (uv_build) の設定。
Note that those settings only apply when using the uv_build backend, other build backends
(such as hatchling) have their own configuration.これらの設定は uv_build バックエンドを使用している場合にのみ適用されることに注意してください。他のビルドバックエンド(hatchling など)は独自の設定を持っています。
All options that accept globs use the portable glob patterns from PEP 639.すべてのオプションは、PEP 639 のポータブルグロブパターンを使用します。
datadata
Data includes for wheels.データはホイール用のものです。
Each entry is a directory, whose contents are copied to the matching directory in the wheel
in <name>-<version>.data/(purelib|platlib|headers|scripts|data). Upon installation, this
data is moved to its target location, as defined by
https://docs.python.org/3.12/library/sysconfig.html#installation-paths. Usually, small
data files are included by placing them in the Python module instead of using data includes.各エントリはディレクトリであり、その内容はホイール内の一致するディレクトリにコピーされます
<name>-<version>.data/(purelib|platlib|headers|scripts|data) に。インストール時に、このデータは
https://docs.python.org/3.12/library/sysconfig.html#installation-paths で定義されたターゲット位置に移動されます。通常、小さなデータファイルはデータインクルードを使用するのではなく、Pythonモジュールに配置することで含まれます。
scripts: Installed to the directory for executables,<venv>/binon Unix or<venv>\Scriptson Windows. This directory is added toPATHwhen the virtual environment is activated or when usinguv run, so this data type can be used to install additional binaries. Consider usingproject.scriptsinstead for Python entrypoints.scripts: 実行可能ファイル用のディレクトリにインストールされます。Unixでは<venv>/bin、Windowsでは<venv>\Scriptsです。このディレクトリは、仮想環境がアクティブ化されるときやuv runを使用するときにPATHに追加されるため、このデータタイプは追加のバイナリをインストールするために使用できます。Pythonエントリポイントにはproject.scriptsを使用することを検討してください。-
data: Installed over the virtualenv environment root.data: 仮想環境のルートにインストールされました。Warning: This may override existing files!警告: これにより既存のファイルが上書きされる可能性があります!
-
headers: Installed to the include directory. Compilers building Python packages with this package as build requirement use the include directory to find additional header files.headers: インクルードディレクトリにインストールされました。Pythonパッケージをこのパッケージをビルド要件として使用してビルドするコンパイラは、追加のヘッダーファイルを見つけるためにインクルードディレクトリを使用します。 purelibandplatlib: Installed to thesite-packagesdirectory. It is not recommended to use these two options.purelibとplatlib:site-packagesディレクトリにインストールされました。これらの2つのオプションを使用することは推奨されません。
Default value: {}デフォルト値: {}
Type: dict[str, str]タイプ: dict[str, str]
Example usage:使用例:
default-excludesdefault-excludes
If set to false, the default excludes aren't applied.もし false に設定されている場合、デフォルトの除外は適用されません。
Default excludes: __pycache__, *.pyc, and *.pyo.デフォルトの除外: __pycache__, *.pyc, および *.pyo.
Default value: trueデフォルト値: true
Type: boolタイプ: bool
Example usage:使用例:
module-namemodule-name
The name of the module directory inside module-root.module-root内のモジュールディレクトリの名前。
The default module name is the package name with dots and dashes replaced by underscores.デフォルトのモジュール名は、ドットとダッシュがアンダースコアに置き換えられたパッケージ名です。
Package names need to be valid Python identifiers, and the directory needs to contain a
__init__.py. An exception are stubs packages, whose name ends with -stubs, with the stem
being the module name, and which contain a __init__.pyi file.パッケージ名は有効なPython識別子である必要があり、ディレクトリには__init__.pyが含まれている必要があります。例外として、名前が-stubsで終わるスタブパッケージがあり、その幹がモジュール名で、__init__.pyiファイルを含んでいます。
For namespace packages with a single module, the path can be dotted, e.g., foo.bar or
foo-stubs.bar.単一モジュールの名前空間パッケージの場合、パスはドットで区切ることができます。例えば、foo.barやfoo-stubs.barのように。
For namespace packages with multiple modules, the path can be a list, e.g.,
["foo", "bar"]. We recommend using a single module per package, splitting multiple
packages into a workspace.複数のモジュールを持つ名前空間パッケージの場合、パスはリストにすることができます。例えば、["foo", "bar"]のように。複数のパッケージをワークスペースに分割し、パッケージごとに単一のモジュールを使用することをお勧めします。
Note that using this option runs the risk of creating two packages with different names but the same module names. Installing such packages together leads to unspecified behavior, often with corrupted files or directory trees.このオプションを使用すると、異なる名前の2つのパッケージが同じモジュール名を持つリスクがあります。このようなパッケージを一緒にインストールすると、未定義の動作を引き起こし、しばしばファイルやディレクトリツリーが破損します。
Default value: Noneデフォルト値: None
Type: str | list[str]タイプ: str | list[str]
Example usage:使用例:
module-rootmodule-root
The directory that contains the module directory.モジュールディレクトリを含むディレクトリ。
Common values are src (src layout, the default) or an empty path (flat layout).一般的な値は src(srcレイアウト、デフォルト)または空のパス(フラットレイアウト)です。
Default value: "src"デフォルト値: "src"
Type: strタイプ: str
Example usage:使用例:
namespacenamespace
Build a namespace package.名前空間パッケージを構築します。
Build a PEP 420 implicit namespace package, allowing more than one root __init__.py.PEP 420の暗黙の名前空間パッケージを構築し、複数のルート__init__.pyを許可します。
Use this option when the namespace package contains multiple root __init__.py, for
namespace packages with a single root __init__.py use a dotted module-name instead.名前空間パッケージが複数のルート__init__.pyを含む場合はこのオプションを使用します。
単一のルート__init__.pyを持つ名前空間パッケージには、ドット付きのmodule-nameを使用してください。
To compare dotted module-name and namespace = true, the first example below can be
expressed with module-name = "cloud.database": There is one root __init__.py database.
In the second example, we have three roots (cloud.database, cloud.database_pro,
billing.modules.database_pro), so namespace = true is required.ドット付きのmodule-nameとnamespace = trueを比較するために、以下の最初の例は
module-name = "cloud.database"として表現できます:ルート__init__.py databaseがあります。
2番目の例では、3つのルート(cloud.database、cloud.database_pro、
billing.modules.database_pro)があるため、namespace = trueが必要です。
src
└── cloud
└── database
├── __init__.py
├── query_builder
│ └── __init__.py
└── sql
├── parser.py
└── __init__.py
src
├── cloud
│ ├── database
│ │ ├── __init__.py
│ │ ├── query_builder
│ │ │ └── __init__.py
│ │ └── sql
│ │ ├── __init__.py
│ │ └── parser.py
│ └── database_pro
│ ├── __init__.py
│ └── query_builder.py
└── billing
└── modules
└── database_pro
├── __init__.py
└── sql.py
Default value: falseデフォルト値:false
Type: boolタイプ:bool
Example usage:使用例:
source-excludesource-exclude
Glob expressions which files and directories to exclude from the source distribution.ソース配布から除外するファイルとディレクトリのグロブ式。
Default value: []デフォルト値:[]
Type: list[str]タイプ: list[str]
Example usage:使用例:
source-includesource-include
Glob expressions which files and directories to additionally include in the source distribution.ソース配布に追加で含めるファイルとディレクトリを指定するGlob式。
pyproject.toml and the contents of the module directory are always included.pyproject.tomlとモジュールディレクトリの内容は常に含まれます。
Default value: []デフォルト値: []
Type: list[str]タイプ: list[str]
Example usage:使用例:
wheel-excludewheel-exclude
Glob expressions which files and directories to exclude from the wheel.ホイールから除外するファイルとディレクトリを指定するGlob式。
Default value: []デフォルト値: []
Type: list[str]タイプ: list[str]
Example usage:使用例:
workspaceworkspace
excludeexclude
Packages to exclude as workspace members. If a package matches both members and
exclude, it will be excluded.ワークスペースメンバーとして除外するパッケージ。パッケージが members と exclude の両方に一致する場合、それは除外されます。
Supports both globs and explicit paths.グロブと明示的なパスの両方をサポートしています。
For more information on the glob syntax, refer to the glob documentation.グロブ構文の詳細については、glob ドキュメントを参照してください。
Default value: []デフォルト値: []
Type: list[str]タイプ: list[str]
Example usage:使用例:
membersmembers
Packages to include as workspace members.ワークスペースメンバーとして含めるパッケージ。
Supports both globs and explicit paths.グロブと明示的なパスの両方をサポートします。
For more information on the glob syntax, refer to the glob documentation.グロブ構文の詳細については、glob ドキュメントを参照してください。
Default value: []デフォルト値: []
Type: list[str]タイプ: list[str]
Example usage:使用例:
Configuration設定
add-boundsadd-bounds
The default version specifier when adding a dependency.依存関係を追加する際のデフォルトのバージョン指定子。
When adding a dependency to the project, if no constraint or URL is provided, a constraint
is added based on the latest compatible version of the package. By default, a lower bound
constraint is used, e.g., >=1.2.3.プロジェクトに依存関係を追加する際、制約やURLが提供されていない場合、パッケージの最新の互換性のあるバージョンに基づいて制約が追加されます。デフォルトでは、下限制約が使用されます。例:>=1.2.3。
When --frozen is provided, no resolution is performed, and dependencies are always added
without constraints.--frozenが指定されている場合、解決は行われず、依存関係は常に制約なしで追加されます。
This option is in preview and may change in any future release.このオプションはプレビュー中であり、将来のリリースで変更される可能性があります。
Default value: "lower"デフォルト値: "lower"
Possible values:可能な値:
"lower": Only a lower bound, e.g.,>=1.2.3"lower": 下限のみ、例:>=1.2.3"major": Allow the same major version, similar to the semver caret, e.g.,>=1.2.3, <2.0.0"major": 同じメジャーバージョンを許可、semverのキャレットに似ています。例:>=1.2.3, <2.0.0"minor": Allow the same minor version, similar to the semver tilde, e.g.,>=1.2.3, <1.3.0"minor": 同じマイナーバージョンを許可、semverのチルダに似ています。例:>=1.2.3, <1.3.0"exact": Pin the exact version, e.g.,==1.2.3"exact": 正確なバージョンを固定、例:==1.2.3
Example usage:使用例:
allow-insecure-hostallow-insecure-host
Allow insecure connections to host.ホストへの不正接続を許可します。
Expects to receive either a hostname (e.g., localhost), a host-port pair (e.g.,
localhost:8080), or a URL (e.g., https://localhost).ホスト名(例:localhost)、ホスト-ポートのペア(例:localhost:8080)、またはURL(例:https://localhost)を受け取ることを期待します。
WARNING: Hosts included in this list will not be verified against the system's certificate
store. Only use --allow-insecure-host in a secure network with verified sources, as it
bypasses SSL verification and could expose you to MITM attacks.WARNING: このリストに含まれるホストは、システムの証明書ストアに対して検証されません。--allow-insecure-hostは、SSL検証をバイパスし、MITM攻撃にさらされる可能性があるため、確認済みのソースを持つ安全なネットワークでのみ使用してください。
Default value: []デフォルト値: []
Type: list[str]タイプ: list[str]
Example usage:使用例:
cache-dircache-dir
Path to the cache directory.キャッシュディレクトリへのパス。
Defaults to $XDG_CACHE_HOME/uv or $HOME/.cache/uv on Linux and macOS, and
%LOCALAPPDATA%\uv\cache on Windows.LinuxおよびmacOSでは$XDG_CACHE_HOME/uvまたは$HOME/.cache/uv、Windowsでは%LOCALAPPDATA%\uv\cacheがデフォルトです。
Default value: Noneデフォルト値: None
Type: strタイプ: str
Example usage:使用例:
cache-keyscache-keys
The keys to consider when caching builds for the project.プロジェクトのビルドをキャッシュする際に考慮すべきキー。
Cache keys enable you to specify the files or directories that should trigger a rebuild when
modified. By default, uv will rebuild a project whenever the pyproject.toml, setup.py,
or setup.cfg files in the project directory are modified, or if a src directory is
added or removed, i.e.:キャッシュキーを使用すると、変更されたときに再ビルドをトリガーすべきファイルやディレクトリを指定できます。デフォルトでは、pyproject.toml、setup.py、またはsetup.cfgファイルがプロジェクトディレクトリで変更されると、uvはプロジェクトを再ビルドします。また、srcディレクトリが追加または削除された場合にも再ビルドされます。つまり、
cache-keys = [{ file = "pyproject.toml" }, { file = "setup.py" }, { file = "setup.cfg" }, { dir = "src" }]
As an example: if a project uses dynamic metadata to read its dependencies from a
requirements.txt file, you can specify cache-keys = [{ file = "requirements.txt" }, { file = "pyproject.toml" }]
to ensure that the project is rebuilt whenever the requirements.txt file is modified (in
addition to watching the pyproject.toml).例えば、プロジェクトが動的メタデータを使用してrequirements.txtファイルから依存関係を読み込む場合、cache-keys = [{ file = "requirements.txt" }, { file = "pyproject.toml" }]を指定することで、requirements.txtファイルが変更されるたびにプロジェクトが再ビルドされることを保証できます(pyproject.tomlも監視することに加えて)。
Globs are supported, following the syntax of the glob
crate. For example, to invalidate the cache whenever a .toml file in the project directory
or any of its subdirectories is modified, you can specify cache-keys = [{ file = "**/*.toml" }].
Note that the use of globs can be expensive, as uv may need to walk the filesystem to
determine whether any files have changed.グロブは、globクレートの構文に従ってサポートされています。例えば、プロジェクトディレクトリ内またはそのサブディレクトリ内の.tomlファイルが変更されるたびにキャッシュを無効にするには、cache-keys = [{ file = "**/*.toml" }]を指定できます。グロブの使用はコストがかかる場合があることに注意してください。なぜなら、uvはファイルシステムを歩いて変更されたファイルがあるかどうかを判断する必要があるからです。
Cache keys can also include version control information. For example, if a project uses
setuptools_scm to read its version from a Git commit, you can specify cache-keys = [{ git = { commit = true }, { file = "pyproject.toml" }]
to include the current Git commit hash in the cache key (in addition to the
pyproject.toml). Git tags are also supported via cache-keys = [{ git = { commit = true, tags = true } }].キャッシュキーにはバージョン管理情報も含めることができます。例えば、プロジェクトがsetuptools_scmを使用してGitコミットからバージョンを読み込む場合、cache-keys = [{ git = { commit = true }, { file = "pyproject.toml" }]を指定することで、キャッシュキーに現在のGitコミットハッシュを含めることができます(pyproject.tomlに加えて)。Gitタグもcache-keys = [{ git = { commit = true, tags = true } }]を介してサポートされています。
Cache keys can also include environment variables. For example, if a project relies on
MACOSX_DEPLOYMENT_TARGET or other environment variables to determine its behavior, you can
specify cache-keys = [{ env = "MACOSX_DEPLOYMENT_TARGET" }] to invalidate the cache
whenever the environment variable changes.キャッシュキーには環境変数も含めることができます。例えば、プロジェクトがMACOSX_DEPLOYMENT_TARGETやその他の環境変数に依存して動作を決定する場合、cache-keys = [{ env = "MACOSX_DEPLOYMENT_TARGET" }]を指定することで、環境変数が変更されるたびにキャッシュを無効にできます。
Cache keys only affect the project defined by the pyproject.toml in which they're
specified (as opposed to, e.g., affecting all members in a workspace), and all paths and
globs are interpreted as relative to the project directory.キャッシュキーは、それらが指定されたpyproject.tomlによって定義されたプロジェクトにのみ影響を与えます(例えば、ワークスペース内のすべてのメンバーに影響を与えるのではなく)、すべてのパスとグロブはプロジェクトディレクトリに対して相対的に解釈されます。
Default value: [{ file = "pyproject.toml" }, { file = "setup.py" }, { file = "setup.cfg" }]デフォルト値: [{ file = "pyproject.toml" }, { file = "setup.py" }, { file = "setup.cfg" }]
Type: list[dict]タイプ: list[dict]
Example usage:使用例:
check-urlcheck-url
Check an index URL for existing files to skip duplicate uploads.重複アップロードをスキップするために、インデックスURLをチェックします。
This option allows retrying publishing that failed after only some, but not all files have been uploaded, and handles error due to parallel uploads of the same file.このオプションは、すべてのファイルがアップロードされる前に失敗した公開を再試行することを可能にし、同じファイルの並列アップロードによるエラーを処理します。
Before uploading, the index is checked. If the exact same file already exists in the index, the file will not be uploaded. If an error occurred during the upload, the index is checked again, to handle cases where the identical file was uploaded twice in parallel.アップロード前に、インデックスがチェックされます。インデックスに同じファイルが既に存在する場合、そのファイルはアップロードされません。アップロード中にエラーが発生した場合、インデックスが再度チェックされ、同一のファイルが並列で2回アップロードされた場合に対処します。
The exact behavior will vary based on the index. When uploading to PyPI, uploading the same
file succeeds even without --check-url, while most other indexes error.正確な動作はインデックスによって異なります。PyPIにアップロードする場合、--check-urlなしでも同じファイルのアップロードは成功しますが、他のほとんどのインデックスではエラーになります。
The index must provide one of the supported hashes (SHA-256, SHA-384, or SHA-512).インデックスは、サポートされているハッシュのいずれか(SHA-256、SHA-384、またはSHA-512)を提供する必要があります。
Default value: Noneデフォルト値: None
Type: strタイプ: str
Example usage:使用例:
compile-bytecodecompile-bytecode
Compile Python files to bytecode after installation.インストール後にPythonファイルをバイトコードにコンパイルします。
By default, uv does not compile Python (.py) files to bytecode (__pycache__/*.pyc);
instead, compilation is performed lazily the first time a module is imported. For use-cases
in which start time is critical, such as CLI applications and Docker containers, this option
can be enabled to trade longer installation times for faster start times.デフォルトでは、uvはPython(.py)ファイルをバイトコード(__pycache__/*.pyc)にコンパイルしません;代わりに、モジュールが初めてインポートされるときに遅延的にコンパイルが行われます。CLIアプリケーションやDockerコンテナなど、起動時間が重要なユースケースでは、このオプションを有効にすることで、より長いインストール時間と引き換えに、より速い起動時間を得ることができます。
When enabled, uv will process the entire site-packages directory (including packages that are not being modified by the current operation) for consistency. Like pip, it will also ignore errors.有効にすると、uvは整合性のためにサイトパッケージディレクトリ全体(現在の操作によって変更されていないパッケージを含む)を処理します。pipのように、エラーも無視します。
Default value: falseデフォルト値: false
Type: boolタイプ: bool
Example usage:使用例:
concurrent-buildsconcurrent-builds
The maximum number of source distributions that uv will build concurrently at any given time.uvが同時にビルドすることができるソース配布の最大数。
Defaults to the number of available CPU cores.利用可能なCPUコアの数にデフォルト設定されています。
Default value: Noneデフォルト値: None
Type: intタイプ: int
Example usage:使用例:
concurrent-downloadsconcurrent-downloads
The maximum number of in-flight concurrent downloads that uv will perform at any given time.uvが任意の時点で実行する同時ダウンロードの最大数。
Default value: 50デフォルト値: 50
Type: intタイプ: int
Example usage:使用例:
concurrent-installsconcurrent-installs
The number of threads used when installing and unzipping packages.パッケージのインストールと解凍に使用されるスレッドの数。
Defaults to the number of available CPU cores.利用可能なCPUコアの数にデフォルト設定されています。
Default value: Noneデフォルト値: None
Type: intタイプ: int
Example usage:使用例:
config-settingsconfig-settings
Settings to pass to the PEP 517 build backend,
specified as KEY=VALUE pairs.PEP 517 ビルドバックエンドに渡す設定で、
KEY=VALUE ペアとして指定します。
Default value: {}デフォルト値: {}
Type: dictタイプ: dict
Example usage:使用例:
config-settings-packageconfig-settings-package
Settings to pass to the PEP 517 build backend for specific packages,
specified as KEY=VALUE pairs.PEP 517 ビルドバックエンドに特定のパッケージに渡す設定で、
KEY=VALUE ペアとして指定します。
Accepts a map from package names to string key-value pairs.パッケージ名から文字列のキーと値のペアへのマップを受け入れます。
Default value: {}デフォルト値: {}
Type: dictタイプ: dict
Example usage:使用例:
dependency-metadatadependency-metadata
Pre-defined static metadata for dependencies of the project (direct or transitive). When provided, enables the resolver to use the specified metadata instead of querying the registry or building the relevant package from source.プロジェクトの依存関係(直接または間接)のための事前定義された静的メタデータです。提供されると、リゾルバはレジストリをクエリしたり、関連するパッケージをソースからビルドする代わりに、指定されたメタデータを使用できるようになります。
Metadata should be provided in adherence with the Metadata 2.3 standard, though only the following fields are respected:メタデータは、Metadata 2.3標準に従って提供されるべきですが、次のフィールドのみが尊重されます:
name: The name of the package.name: パッケージの名前。- (Optional)
version: The version of the package. If omitted, the metadata will be applied to all versions of the package.(オプション)version: パッケージのバージョン。省略した場合、メタデータはパッケージのすべてのバージョンに適用されます。 - (Optional)
requires-dist: The dependencies of the package (e.g.,werkzeug>=0.14).(オプション)requires-dist: パッケージの依存関係(例:werkzeug>=0.14)。 - (Optional)
requires-python: The Python version required by the package (e.g.,>=3.10).(オプション)requires-python: パッケージが必要とするPythonのバージョン(例:>=3.10)。 - (Optional)
provides-extra: The extras provided by the package.(オプション)provides-extra: パッケージが提供する追加機能。
Default value: []デフォルト値: []
Type: list[dict]タイプ: list[dict]
Example usage:使用例:
exclude-newerexclude-newer
Limit candidate packages to those that were uploaded prior to a given point in time.候補パッケージを、指定された時点より前にアップロードされたものに制限します。
Accepts a superset of RFC 3339 (e.g.,
2006-12-02T02:07:43Z). A full timestamp is required to ensure that the resolver will
behave consistently across timezones.RFC 3339のスーパーセットを受け入れます(例: 2006-12-02T02:07:43Z)。解決者がタイムゾーンを超えて一貫して動作することを保証するために、完全なタイムスタンプが必要です。
Default value: Noneデフォルト値: None
Type: strタイプ: str
Example usage:使用例:
exclude-newer-packageexclude-newer-package
Limit candidate packages for specific packages to those that were uploaded prior to the given date.特定のパッケージの候補パッケージを、指定された日付以前にアップロードされたものに制限します。
Accepts package-date pairs in a dictionary format.辞書形式でパッケージ日付のペアを受け入れます。
Default value: Noneデフォルト値: None
Type: dictタイプ: dict
Example usage:使用例:
extra-build-dependenciesextra-build-dependencies
Additional build dependencies for packages.パッケージの追加ビルド依存関係。
This allows extending the PEP 517 build environment for the project's dependencies with
additional packages. This is useful for packages that assume the presence of packages like
pip, and do not declare them as build dependencies.これは、プロジェクトの依存関係のためにPEP 517ビルド環境を追加パッケージで拡張することを可能にします。これは、pipのようなパッケージの存在を前提とし、それらをビルド依存関係として宣言しないパッケージにとって便利です。
Default value: []デフォルト値: []
Type: dictタイプ: dict
Example usage:使用例:
extra-build-variablesextra-build-variables
Extra environment variables to set when building certain packages.特定のパッケージをビルドする際に設定する追加の環境変数。
Environment variables will be added to the environment when building the specified packages.環境変数は、指定されたパッケージをビルドする際に環境に追加されます。
Default value: {}デフォルト値: {}
Type: dict[str, dict[str, str]]タイプ: dict[str, dict[str, str]]
Example usage:使用例:
extra-index-urlextra-index-url
Extra URLs of package indexes to use, in addition to --index-url.--index-urlに加えて使用するパッケージインデックスの追加URL。
Accepts either a repository compliant with PEP 503 (the simple repository API), or a local directory laid out in the same format.PEP 503に準拠したリポジトリ、または同じ形式でレイアウトされたローカルディレクトリを受け入れます。PEP 503 (シンプルリポジトリAPI)。
All indexes provided via this flag take priority over the index specified by
index_url or index with default = true. When multiple indexes
are provided, earlier values take priority.このフラグで提供されたすべてのインデックスは、index_urlまたはindexで指定されたインデックスに対して優先されます。default = true。複数のインデックスが提供される場合、早い値が優先されます。
To control uv's resolution strategy when multiple indexes are present, see
index_strategy.複数のインデックスが存在する場合のuvの解決戦略を制御するには、index_strategyを参照してください。
(Deprecated: use index instead.)(非推奨: 代わりにindexを使用してください。)
Default value: []デフォルト値: []
Type: list[str]タイプ: list[str]
Example usage:使用例:
find-linksfind-links
Locations to search for candidate distributions, in addition to those found in the registry indexes.レジストリインデックスで見つかったものに加えて、候補の配布物を検索する場所。
If a path, the target must be a directory that contains packages as wheel files (.whl) or
source distributions (e.g., .tar.gz or .zip) at the top level.パスの場合、ターゲットはトップレベルにホイールファイル(.whl)またはソース配布(例:.tar.gzまたは.zip)を含むディレクトリでなければなりません。
If a URL, the page must contain a flat list of links to package files adhering to the formats described above.URLの場合、ページには上記の形式に従ったパッケージファイルへのリンクのフラットリストが含まれている必要があります。
Default value: []デフォルト値: []
Type: list[str]タイプ: list[str]
Example usage:使用例:
fork-strategyfork-strategy
The strategy to use when selecting multiple versions of a given package across Python versions and platforms.特定のパッケージの複数のバージョンをPythonのバージョンやプラットフォームにわたって選択する際に使用する戦略。
By default, uv will optimize for selecting the latest version of each package for each
supported Python version (requires-python), while minimizing the number of selected
versions across platforms.デフォルトでは、uvは各サポートされているPythonバージョン(requires-python)に対して各パッケージの最新バージョンを選択することを最適化し、プラットフォーム間で選択されたバージョンの数を最小限に抑えます。
Under fewest, uv will minimize the number of selected versions for each package,
preferring older versions that are compatible with a wider range of supported Python
versions or platforms.fewestの下では、uvは各パッケージの選択されたバージョンの数を最小限に抑え、より広範囲のサポートされているPythonバージョンやプラットフォームと互換性のある古いバージョンを優先します。
Default value: "requires-python"デフォルト値: "requires-python"
Possible values:可能な値:
"fewest": Optimize for selecting the fewest number of versions for each package. Older versions may be preferred if they are compatible with a wider range of supported Python versions or platforms"fewest": 各パッケージの最小限のバージョンを選択するよう最適化します。古いバージョンは、より広範囲のサポートされているPythonバージョンやプラットフォームと互換性がある場合に好まれることがあります。"requires-python": Optimize for selecting latest supported version of each package, for each supported Python version"requires-python": 各サポートされているPythonバージョンに対して、各パッケージの最新のサポートバージョンを選択するよう最適化します。
Example usage:使用例:
indexindex
The package indexes to use when resolving dependencies.依存関係を解決する際に使用するパッケージインデックス。
Accepts either a repository compliant with PEP 503 (the simple repository API), or a local directory laid out in the same format.これは、PEP 503(シンプルリポジトリAPI)に準拠したリポジトリ、または同じ形式でレイアウトされたローカルディレクトリを受け入れます。
Indexes are considered in the order in which they're defined, such that the first-defined
index has the highest priority. Further, the indexes provided by this setting are given
higher priority than any indexes specified via index_url or
extra_index_url. uv will only consider the first index that contains
a given package, unless an alternative index strategy is specified.インデックスは定義された順序で考慮され、最初に定義されたインデックスが最も高い優先度を持ちます。さらに、この設定によって提供されたインデックスは、index_urlやextra_index_urlを介して指定されたインデックスよりも高い優先度が与えられます。uvは、代替のインデックス戦略が指定されない限り、特定のパッケージを含む最初のインデックスのみを考慮します。
If an index is marked as explicit = true, it will be used exclusively for those
dependencies that select it explicitly via [tool.uv.sources], as in:インデックスがexplicit = trueとしてマークされている場合、それは[tool.uv.sources]を介して明示的に選択する依存関係のみに独占的に使用されます。例:
[[tool.uv.index]]
name = "pytorch"
url = "https://download.pytorch.org/whl/cu121"
explicit = true
[tool.uv.sources]
torch = { index = "pytorch" }
If an index is marked as default = true, it will be moved to the end of the prioritized list, such that it is
given the lowest priority when resolving packages. Additionally, marking an index as default will disable the
PyPI default index.インデックスがdefault = trueとしてマークされている場合、それは優先リストの最後に移動され、パッケージを解決する際に最も低い優先度が与えられます。さらに、インデックスをデフォルトとしてマークすると、PyPIのデフォルトインデックスが無効になります。
Default value: "[]"デフォルト値: "[]"
Type: dictタイプ: dict
Example usage:使用例:
index-strategyindex-strategy
The strategy to use when resolving against multiple index URLs.複数のインデックスURLに対して解決する際に使用する戦略。
By default, uv will stop at the first index on which a given package is available, and
limit resolutions to those present on that first index (first-index). This prevents
"dependency confusion" attacks, whereby an attacker can upload a malicious package under the
same name to an alternate index.デフォルトでは、uvは指定されたパッケージが利用可能な最初のインデックスで停止し、その最初のインデックス(first-index)に存在する解決策に制限します。これにより、攻撃者が同じ名前の悪意のあるパッケージを別のインデックスにアップロードすることによる「依存関係の混乱」攻撃を防ぎます。
Default value: "first-index"デフォルト値: "first-index"
Possible values:可能な値:
"first-index": Only use results from the first index that returns a match for a given package name"first-index": 指定されたパッケージ名に対して一致を返す最初のインデックスからの結果のみを使用します。"unsafe-first-match": Search for every package name across all indexes, exhausting the versions from the first index before moving on to the next"unsafe-first-match": すべてのインデックスで各パッケージ名を検索し、次のインデックスに移動する前に最初のインデックスからのバージョンを使い果たします。"unsafe-best-match": Search for every package name across all indexes, preferring the "best" version found. If a package version is in multiple indexes, only look at the entry for the first index"unsafe-best-match": すべてのインデックスで各パッケージ名を検索し、見つかった「最良」のバージョンを優先します。パッケージバージョンが複数のインデックスに存在する場合、最初のインデックスのエントリのみを確認します。
Example usage:使用例:
index-urlindex-url
The URL of the Python package index (by default: https://pypi.org/simple).PythonパッケージインデックスのURL(デフォルト: https://pypi.org/simple)。
Accepts either a repository compliant with PEP 503 (the simple repository API), or a local directory laid out in the same format.PEP 503(シンプルリポジトリAPI)に準拠したリポジトリ、または同じ形式でレイアウトされたローカルディレクトリを受け入れます。
The index provided by this setting is given lower priority than any indexes specified via
extra_index_url or index.この設定で提供されるインデックスは、extra_index_urlまたはindexを介して指定されたインデックスよりも優先度が低くなります。
(Deprecated: use index instead.)(非推奨: 代わりにindexを使用してください。)
Default value: "https://pypi.org/simple"デフォルト値: "https://pypi.org/simple"
Type: strタイプ: str
Example usage:使用例:
keyring-providerkeyring-provider
Attempt to use keyring for authentication for index URLs.インデックスURLの認証に keyring を使用しようとします。
At present, only --keyring-provider subprocess is supported, which configures uv to
use the keyring CLI to handle authentication.現在、--keyring-provider subprocessのみがサポートされており、これはuvが認証を処理するためにkeyring CLIを使用するように設定します。
Default value: "disabled"デフォルト値: "disabled"
Type: strタイプ: str
Example usage:使用例:
link-modelink-mode
The method to use when installing packages from the global cache.グローバルキャッシュからパッケージをインストールする際に使用する方法。
Defaults to clone (also known as Copy-on-Write) on macOS, and hardlink on Linux and
Windows.macOSではclone(コピーオンライトとも呼ばれる)がデフォルトで、LinuxおよびWindowsではhardlinkがデフォルトです。
WARNING: The use of symlink link mode is discouraged, as they create tight coupling between
the cache and the target environment. For example, clearing the cache (uv cache clean)
will break all installed packages by way of removing the underlying source files. Use
symlinks with caution.警告: symlinkリンクモードの使用は推奨されません。これはキャッシュとターゲット環境の間に強い結合を作成するためです。たとえば、キャッシュをクリアすること(uv cache clean)は、基盤となるソースファイルを削除することによってすべてのインストールされたパッケージを壊します。symlinkは注意して使用してください。
Default value: "clone" (macOS) or "hardlink" (Linux, Windows)デフォルト値: "clone" (macOS) または "hardlink" (Linux, Windows)
Possible values:可能な値:
"clone": Clone (i.e., copy-on-write) packages from the wheel into thesite-packagesdirectory"clone": ホイールからsite-packagesディレクトリにパッケージをクローン(すなわち、コピーオンライト)します。"copy": Copy packages from the wheel into thesite-packagesdirectory"copy": ホイールからsite-packagesディレクトリにパッケージをコピーします。"hardlink": Hard link packages from the wheel into thesite-packagesdirectory"hardlink": ウィールからsite-packagesディレクトリにハードリンクパッケージを作成します"symlink": Symbolically link packages from the wheel into thesite-packagesdirectory"symlink": ウィールからsite-packagesディレクトリにシンボリックリンクパッケージを作成します
Example usage:使用例:
native-tlsnative-tls
Whether to load TLS certificates from the platform's native certificate store.プラットフォームのネイティブ証明書ストアからTLS証明書を読み込むかどうか。
By default, uv loads certificates from the bundled webpki-roots crate. The
webpki-roots are a reliable set of trust roots from Mozilla, and including them in uv
improves portability and performance (especially on macOS).デフォルトでは、uvはバンドルされたwebpki-rootsクレートから証明書を読み込みます。webpki-rootsはMozillaからの信頼できるルートセットであり、これをuvに含めることでポータビリティとパフォーマンスが向上します(特にmacOSで)。
However, in some cases, you may want to use the platform's native certificate store, especially if you're relying on a corporate trust root (e.g., for a mandatory proxy) that's included in your system's certificate store.ただし、場合によっては、プラットフォームのネイティブ証明書ストアを使用したいことがあります。特に、システムの証明書ストアに含まれている企業の信頼ルート(例:必須プロキシ)に依存している場合です。
Default value: falseデフォルト値: false
Type: boolタイプ: bool
Example usage:使用例:
no-binaryno-binary
Don't install pre-built wheels.事前にビルドされたホイールをインストールしないでください。
The given packages will be built and installed from source. The resolver will still use pre-built wheels to extract package metadata, if available.指定されたパッケージはソースからビルドされ、インストールされます。リゾルバーは、利用可能な場合、パッケージメタデータを抽出するために事前ビルドされたホイールを使用します。
Default value: falseデフォルト値: false
Type: boolタイプ: bool
Example usage:使用例:
no-binary-packageno-binary-package
Don't install pre-built wheels for a specific package.特定のパッケージに対して事前ビルドされたホイールをインストールしない。
Default value: []デフォルト値: []
Type: list[str]タイプ: list[str]
Example usage:使用例:
no-buildno-build
Don't build source distributions.ソース配布物のビルドを行いません。
When enabled, resolving will not run arbitrary Python code. The cached wheels of already-built source distributions will be reused, but operations that require building distributions will exit with an error.有効にすると、解決は任意のPythonコードを実行しません。すでにビルドされたソース配布のキャッシュされたホイールが再利用されますが、配布をビルドする必要がある操作はエラーで終了します。
Default value: falseデフォルト値: false
Type: boolタイプ: bool
Example usage:使用例:
no-build-isolationno-build-isolation
Disable isolation when building source distributions.ソース配布物のビルド時に隔離を無効にします。
Assumes that build dependencies specified by PEP 518 are already installed.PEP 518で指定されたビルド依存関係がすでにインストールされていると仮定します。
Default value: falseデフォルト値: false
Type: boolタイプ: bool
Example usage:使用例:
no-build-isolation-packageno-build-isolation-package
Disable isolation when building source distributions for a specific package.特定のパッケージのソース配布物をビルドする際に隔離を無効にします。
Assumes that the packages' build dependencies specified by PEP 518 are already installed.パッケージのビルド依存関係がPEP 518によって指定されていることを前提としています。
Default value: []デフォルト値: []
Type: list[str]タイプ: list[str]
Example usage:使用例:
no-build-packageno-build-package
Don't build source distributions for a specific package.特定のパッケージのソース配布物をビルドしません。
Default value: []デフォルト値: []
Type: list[str]タイプ: list[str]
Example usage:使用例:
no-cacheno-cache
Avoid reading from or writing to the cache, instead using a temporary directory for the duration of the operation.キャッシュからの読み取りや書き込みを避け、操作の間は一時ディレクトリを使用してください。
Default value: falseデフォルト値: false
Type: boolタイプ: bool
Example usage:使用例:
no-indexno-index
Ignore all registry indexes (e.g., PyPI), instead relying on direct URL dependencies and
those provided via --find-links.すべてのレジストリインデックス(例:PyPI)を無視し、直接URL依存関係と--find-linksを介して提供されるものに依存します。
Default value: falseデフォルト値: false
Type: boolタイプ: bool
Example usage:使用例:
no-sourcesno-sources
Ignore the tool.uv.sources table when resolving dependencies. Used to lock against the
standards-compliant, publishable package metadata, as opposed to using any local or Git
sources.tool.uv.sources テーブルを依存関係の解決時に無視します。これは、ローカルまたは Git ソースを使用するのではなく、標準準拠の公開可能なパッケージメタデータに対してロックするために使用されます。
Default value: falseデフォルト値: false
Type: boolタイプ: bool
Example usage:使用例:
offlineoffline
Disable network access, relying only on locally cached data and locally available files.ネットワークアクセスを無効にし、ローカルにキャッシュされたデータとローカルで利用可能なファイルのみに依存します。
Default value: falseデフォルト値: false
Type: boolタイプ: bool
Example usage:使用例:
prereleaseprerelease
The strategy to use when considering pre-release versions.プレリリースバージョンを考慮する際に使用する戦略。
By default, uv will accept pre-releases for packages that only publish pre-releases,
along with first-party requirements that contain an explicit pre-release marker in the
declared specifiers (if-necessary-or-explicit).デフォルトでは、uvはのみプレリリースを公開するパッケージと、宣言された指定子に明示的なプレリリースマーカーを含むファーストパーティの要件に対してプレリリースを受け入れます(if-necessary-or-explicit)。
Default value: "if-necessary-or-explicit"デフォルト値: "if-necessary-or-explicit"
Possible values:可能な値:
"disallow": Disallow all pre-release versions"disallow": すべてのプレリリースバージョンを禁止"allow": Allow all pre-release versions"allow": すべてのプレリリースバージョンを許可"if-necessary": Allow pre-release versions if all versions of a package are pre-release"if-necessary": すべてのバージョンがプレリリースである場合にプレリリースバージョンを許可"explicit": Allow pre-release versions for first-party packages with explicit pre-release markers in their version requirements"explicit": バージョン要件に明示的なプレリリースマーカーを持つファーストパーティパッケージに対してプレリリースバージョンを許可"if-necessary-or-explicit": Allow pre-release versions if all versions of a package are pre-release, or if the package has an explicit pre-release marker in its version requirements"if-necessary-or-explicit": すべてのバージョンがプレリリースである場合、またはパッケージのバージョン要件に明示的なプレリリースマーカーがある場合にプレリリースバージョンを許可
Example usage:使用例:
previewpreview
Whether to enable experimental, preview features.実験的なプレビュー機能を有効にするかどうか。
Default value: falseデフォルト値: false
Type: boolタイプ: bool
Example usage:使用例:
publish-urlpublish-url
The URL for publishing packages to the Python package index (by default: https://upload.pypi.org/legacy/).パッケージをPythonパッケージインデックスに公開するためのURL(デフォルト: https://upload.pypi.org/legacy/)。
Default value: "https://upload.pypi.org/legacy/"デフォルト値: "https://upload.pypi.org/legacy/"
Type: strタイプ: str
Example usage:使用例:
pypy-install-mirrorpypy-install-mirror
Mirror URL to use for downloading managed PyPy installations.管理されたPyPyインストールをダウンロードするためのミラーURL。
By default, managed PyPy installations are downloaded from downloads.python.org.
This variable can be set to a mirror URL to use a different source for PyPy installations.
The provided URL will replace https://downloads.python.org/pypy in, e.g., https://downloads.python.org/pypy/pypy3.8-v7.3.7-osx64.tar.bz2.デフォルトでは、管理されたPyPyインストールはdownloads.python.orgからダウンロードされます。
この変数は、PyPyインストールの異なるソースを使用するためにミラーURLに設定できます。
提供されたURLは、例えばhttps://downloads.python.org/pypyの代わりに使用されます。https://downloads.python.org/pypy/pypy3.8-v7.3.7-osx64.tar.bz2。
Distributions can be read from a
local directory by using the file:// URL scheme.ディストリビューションはfile:// URLスキームを使用してローカルディレクトリから読み取ることができます。
Default value: Noneデフォルト値: None
Type: strタイプ: str
Example usage:使用例:
python-downloadspython-downloads
Whether to allow Python downloads.Pythonのダウンロードを許可するかどうか。
Default value: "automatic"デフォルト値: "automatic"
Possible values:可能な値:
"automatic": Automatically download managed Python installations when needed"automatic": 必要に応じて管理されたPythonインストールを自動的にダウンロードします"manual": Do not automatically download managed Python installations; require explicit installation"manual": 管理されたPythonインストールを自動的にダウンロードせず、明示的なインストールを要求します"never": Do not ever allow Python downloads"never": Pythonのダウンロードを決して許可しません
Example usage:使用例:
python-downloads-json-urlpython-downloads-json-url
URL pointing to JSON of custom Python installations.カスタムPythonインストールのJSONを指すURL。
Default value: Noneデフォルト値: None
Type: strタイプ: str
Example usage:使用例:
python-install-mirrorpython-install-mirror
Mirror URL for downloading managed Python installations.管理されたPythonインストールをダウンロードするためのミラーURL。
By default, managed Python installations are downloaded from python-build-standalone.
This variable can be set to a mirror URL to use a different source for Python installations.
The provided URL will replace https://github.com/astral-sh/python-build-standalone/releases/download in, e.g., https://github.com/astral-sh/python-build-standalone/releases/download/20240713/cpython-3.12.4%2B20240713-aarch64-apple-darwin-install_only.tar.gz.デフォルトでは、管理されたPythonインストールはpython-build-standaloneからダウンロードされます。
この変数は、Pythonインストールの異なるソースを使用するためにミラーURLに設定できます。
提供されたURLは、例えばhttps://github.com/astral-sh/python-build-standalone/releases/downloadを置き換えます。https://github.com/astral-sh/python-build-standalone/releases/download/20240713/cpython-3.12.4%2B20240713-aarch64-apple-darwin-install_only.tar.gzのように。
Distributions can be read from a local directory by using the file:// URL scheme.配布物は、file:// URL スキームを使用してローカルディレクトリから読み取ることができます。
Default value: Noneデフォルト値: None
Type: strタイプ: str
Example usage:使用例:
python-preferencepython-preference
Whether to prefer using Python installations that are already present on the system, or those that are downloaded and installed by uv.システムに既に存在するPythonインストールを優先して使用するか、 uvによってダウンロードされインストールされたPythonインストールを使用するか。
Default value: "managed"デフォルト値: "managed"
Possible values:可能な値:
"only-managed": Only use managed Python installations; never use system Python installations"only-managed": 管理されたPythonインストールのみを使用し、システムのPythonインストールは決して使用しない"managed": Prefer managed Python installations over system Python installations"managed": システムPythonインストールよりも管理されたPythonインストールを優先します"system": Prefer system Python installations over managed Python installations"system": 管理されたPythonインストールよりもシステムPythonインストールを優先します"only-system": Only use system Python installations; never use managed Python installations"only-system": システムPythonインストールのみを使用し、管理されたPythonインストールは決して使用しません
Example usage:使用例:
reinstallreinstall
Reinstall all packages, regardless of whether they're already installed. Implies refresh.すべてのパッケージを再インストールします。すでにインストールされているかどうかに関係なく、refreshを含意します。
Default value: falseデフォルト値: false
Type: boolタイプ: bool
Example usage:使用例:
reinstall-packagereinstall-package
Reinstall a specific package, regardless of whether it's already installed. Implies
refresh-package.特定のパッケージを再インストールします。すでにインストールされているかどうかにかかわらず。refresh-packageを含意します。
Default value: []デフォルト値: []
Type: list[str]タイプ: list[str]
Example usage:使用例:
required-versionrequired-version
Enforce a requirement on the version of uv.uvのバージョンに対する要件を強制します。
If the version of uv does not meet the requirement at runtime, uv will exit with an error.uvのバージョンが実行時に要件を満たさない場合、uvはエラーで終了します。
Accepts a PEP 440 specifier, like ==0.5.0 or >=0.5.0.PEP 440の指定子を受け入れます。例えば、==0.5.0や>=0.5.0のように。
Default value: nullデフォルト値: null
Type: strタイプ: str
Example usage:使用例:
resolutionresolution
The strategy to use when selecting between the different compatible versions for a given package requirement.特定のパッケージ要件に対して異なる互換バージョンを選択する際に使用する戦略。
By default, uv will use the latest compatible version of each package (highest).デフォルトでは、uvは各パッケージの最新の互換バージョン(highest)を使用します。
Default value: "highest"デフォルト値: "highest"
Possible values:可能な値:
"highest": Resolve the highest compatible version of each package"highest": 各パッケージの最高互換バージョンを解決する"lowest": Resolve the lowest compatible version of each package"lowest": 各パッケージの最低互換バージョンを解決する"lowest-direct": Resolve the lowest compatible version of any direct dependencies, and the highest compatible version of any transitive dependencies"lowest-direct": 直接依存関係の最低互換バージョンを解決し、間接依存関係の最高互換バージョンを解決する
Example usage:使用例:
trusted-publishingtrusted-publishing
Configure trusted publishing.信頼できる公開を設定します。
By default, uv checks for trusted publishing when running in a supported environment, but ignores it if it isn't configured.デフォルトでは、uvはサポートされている環境で実行されるときに信頼された公開をチェックしますが、設定されていない場合は無視します。
uv's supported environments for trusted publishing include GitHub Actions and GitLab CI/CD.uvの信頼された公開のサポートされている環境には、GitHub ActionsとGitLab CI/CDが含まれます。
Default value: automaticデフォルト値: automatic
Type: strタイプ: str
Example usage:使用例:
upgradeupgrade
Allow package upgrades, ignoring pinned versions in any existing output file.パッケージのアップグレードを許可し、既存の出力ファイルに固定されたバージョンを無視します。
Default value: falseデフォルト値: false
Type: boolタイプ: bool
Example usage:使用例:
upgrade-packageupgrade-package
Allow upgrades for a specific package, ignoring pinned versions in any existing output file.特定のパッケージのアップグレードを許可し、既存の出力ファイルのピン留めされたバージョンを無視します。
Accepts both standalone package names (ruff) and version specifiers (ruff<0.5.0).スタンドアロンのパッケージ名(ruff)とバージョンスペシファイア(ruff<0.5.0)の両方を受け入れます。
Default value: []デフォルト値: []
Type: list[str]タイプ: list[str]
Example usage:使用例:
pippip
Settings that are specific to the uv pip command-line interface.uv pip コマンドラインインターフェースに特有の設定。
These values will be ignored when running commands outside the uv pip namespace (e.g.,
uv lock, uvx).uv pip 名前空間の外でコマンドを実行する際には、これらの値は無視されます(例:uv lock, uvx)。
all-extrasall-extras
Include all optional dependencies.すべてのオプション依存関係を含めます。
Only applies to pyproject.toml, setup.py, and setup.cfg sources.これはpyproject.toml、setup.py、およびsetup.cfgソースにのみ適用されます。
Default value: falseデフォルト値: false
Type: boolタイプ: bool
Example usage:使用例:
allow-empty-requirementsallow-empty-requirements
Allow uv pip sync with empty requirements, which will clear the environment of all
packages.空の要件で uv pip sync を許可し、環境内のすべてのパッケージをクリアします。
Default value: falseデフォルト値: false
Type: boolタイプ: bool
Example usage:使用例:
annotation-styleannotation-style
The style of the annotation comments included in the output file, used to indicate the source of each package.出力ファイルに含まれる注釈コメントのスタイルで、各パッケージのソースを示すために使用されます。
Default value: "split"デフォルト値: "split"
Possible values:可能な値:
"line": Render the annotations on a single, comma-separated line"line": 注釈をカンマ区切りの単一行にレンダリングします"split": Render each annotation on its own line"split": 各注釈を独自の行にレンダリングします
Example usage:使用例:
break-system-packagesbreak-system-packages
Allow uv to modify an EXTERNALLY-MANAGED Python installation.uvがEXTERNALLY-MANAGEDなPythonインストールを変更できるようにします。
WARNING: --break-system-packages is intended for use in continuous integration (CI)
environments, when installing into Python installations that are managed by an external
package manager, like apt. It should be used with caution, as such Python installations
explicitly recommend against modifications by other package managers (like uv or pip).警告: --break-system-packages は継続的インテグレーション (CI) 環境での使用を目的としています。
外部パッケージマネージャーによって管理されている Python インストールにインストールする際に使用します。
例えば apt のようなものです。 他のパッケージマネージャー(uv や pip など)による変更を明示的に推奨しないため、注意して使用する必要があります。
Default value: falseデフォルト値: false
Type: boolタイプ: bool
Example usage:使用例:
compile-bytecodecompile-bytecode
Compile Python files to bytecode after installation.インストール後にPythonファイルをバイトコードにコンパイルします。
By default, uv does not compile Python (.py) files to bytecode (__pycache__/*.pyc);
instead, compilation is performed lazily the first time a module is imported. For use-cases
in which start time is critical, such as CLI applications and Docker containers, this option
can be enabled to trade longer installation times for faster start times.デフォルトでは、uvはPython(.py)ファイルをバイトコード(__pycache__/*.pyc)にコンパイルしません。
代わりに、モジュールが最初にインポートされるときに遅延的にコンパイルが行われます。CLIアプリケーションやDockerコンテナなど、起動時間が重要なユースケースでは、このオプションを有効にすることで、より長いインストール時間と引き換えに、より速い起動時間を得ることができます。
When enabled, uv will process the entire site-packages directory (including packages that are not being modified by the current operation) for consistency. Like pip, it will also ignore errors.有効にすると、uvは整合性のためにサイトパッケージディレクトリ全体(現在の操作によって変更されていないパッケージを含む)を処理します。pipのように、エラーも無視します。
Default value: falseデフォルト値: false
Type: boolタイプ: bool
Example usage:使用例:
config-settingsconfig-settings
Settings to pass to the PEP 517 build backend,
specified as KEY=VALUE pairs.PEP 517ビルドバックエンドに渡す設定で、KEY=VALUEペアとして指定されます。
Default value: {}デフォルト値: {}
Type: dictタイプ: dict
Example usage:使用例:
config-settings-packageconfig-settings-package
Settings to pass to the PEP 517 build backend for specific packages,
specified as KEY=VALUE pairs.PEP 517 ビルドバックエンドに特定のパッケージに渡す設定で、KEY=VALUE ペアとして指定されます。
Default value: {}デフォルト値: {}
Type: dictタイプ: dict
Example usage:使用例:
custom-compile-commandcustom-compile-command
The header comment to include at the top of the output file generated by uv pip compile.uv pip compileによって生成される出力ファイルの先頭に含めるヘッダーコメント。
Used to reflect custom build scripts and commands that wrap uv pip compile.uv pip compileをラップするカスタムビルドスクリプトやコマンドを反映するために使用されます。
Default value: Noneデフォルト値: None
Type: strタイプ: str
Example usage:使用例:
dependency-metadatadependency-metadata
Pre-defined static metadata for dependencies of the project (direct or transitive). When provided, enables the resolver to use the specified metadata instead of querying the registry or building the relevant package from source.プロジェクトの依存関係(直接または間接)のための事前定義された静的メタデータです。提供されると、リゾルバはレジストリをクエリしたり、関連するパッケージをソースからビルドする代わりに、指定されたメタデータを使用できるようになります。
Metadata should be provided in adherence with the Metadata 2.3 standard, though only the following fields are respected:メタデータは、Metadata 2.3標準に従って提供されるべきですが、尊重されるのは以下のフィールドのみです:
name: The name of the package.name: パッケージの名前。- (Optional)
version: The version of the package. If omitted, the metadata will be applied to all versions of the package.(オプション)version: パッケージのバージョン。省略した場合、メタデータはパッケージのすべてのバージョンに適用されます。 - (Optional)
requires-dist: The dependencies of the package (e.g.,werkzeug>=0.14).(オプション)requires-dist: パッケージの依存関係(例:werkzeug>=0.14)。 - (Optional)
requires-python: The Python version required by the package (e.g.,>=3.10).(オプション)requires-python: パッケージが必要とするPythonのバージョン(例:>=3.10)。 - (Optional)
provides-extra: The extras provided by the package.(オプション)provides-extra: パッケージが提供する追加機能。
Default value: []デフォルト値: []
Type: list[dict]タイプ: list[dict]
Example usage:使用例:
emit-build-optionsemit-build-options
Include --no-binary and --only-binary entries in the output file generated by uv pip compile.uv pip compileによって生成された出力ファイルに--no-binaryおよび--only-binaryのエントリを含めます。
Default value: falseデフォルト値: false
Type: boolタイプ: bool
Example usage:使用例:
emit-find-linksemit-find-links
Include --find-links entries in the output file generated by uv pip compile.uv pip compileによって生成された出力ファイルに--find-linksのエントリを含めます。
Default value: falseデフォルト値: false
Type: boolタイプ: bool
Example usage:使用例:
emit-index-annotationemit-index-annotation
Include comment annotations indicating the index used to resolve each package (e.g.,
# from https://pypi.org/simple).各パッケージを解決するために使用されるインデックスを示すコメント注釈を含めます(例:# from https://pypi.org/simple)。
Default value: falseデフォルト値: false
Type: boolタイプ: bool
Example usage:使用例:
emit-index-urlemit-index-url
Include --index-url and --extra-index-url entries in the output file generated by uv pip compile.uv pip compileによって生成された出力ファイルに--index-urlおよび--extra-index-urlエントリを含めます。
Default value: falseデフォルト値: false
Type: boolタイプ: bool
Example usage:使用例:
emit-marker-expressionemit-marker-expression
Whether to emit a marker string indicating the conditions under which the set of pinned dependencies is valid.ピン留めされた依存関係のセットが有効である条件を示すマーカー文字列を出力するかどうか。
The pinned dependencies may be valid even when the marker expression is false, but when the expression is true, the requirements are known to be correct.マーカー式がfalseであっても、ピン留めされた依存関係は有効である可能性がありますが、式がtrueのときは、要件が正しいことが知られています。
Default value: falseデフォルト値: false
Type: boolタイプ: bool
Example usage:使用例:
exclude-newerexclude-newer
Limit candidate packages to those that were uploaded prior to a given point in time.候補パッケージを、指定された時点より前にアップロードされたものに制限します。
Accepts a superset of RFC 3339 (e.g.,
2006-12-02T02:07:43Z). A full timestamp is required to ensure that the resolver will
behave consistently across timezones.RFC 3339のスーパーセットを受け入れます(例:2006-12-02T02:07:43Z)。解決者がタイムゾーンを超えて一貫して動作することを保証するために、完全なタイムスタンプが必要です。
Default value: Noneデフォルト値: None
Type: strタイプ: str
Example usage:使用例:
exclude-newer-packageexclude-newer-package
Limit candidate packages for specific packages to those that were uploaded prior to the given date.特定のパッケージの候補パッケージを、指定された日付以前にアップロードされたものに制限します。
Accepts package-date pairs in a dictionary format.辞書形式でパッケージと日付のペアを受け入れます。
Default value: Noneデフォルト値: None
Type: dictタイプ: dict
Example usage:使用例:
extraextra
Include optional dependencies from the specified extra; may be provided more than once.指定されたエクストラからオプションの依存関係を含めます; 複数回提供することができます。
Only applies to pyproject.toml, setup.py, and setup.cfg sources.これはpyproject.toml、setup.py、およびsetup.cfgソースにのみ適用されます。
Default value: []デフォルト値: []
Type: list[str]タイプ: list[str]
Example usage:使用例:
extra-build-dependenciesextra-build-dependencies
Additional build dependencies for packages.パッケージの追加ビルド依存関係。
This allows extending the PEP 517 build environment for the project's dependencies with
additional packages. This is useful for packages that assume the presence of packages like
pip, and do not declare them as build dependencies.これにより、プロジェクトの依存関係のためにPEP 517ビルド環境を追加パッケージで拡張できます。これは、pipのようなパッケージの存在を前提とし、それらをビルド依存関係として宣言しないパッケージに便利です。
Default value: []デフォルト値: []
Type: dictタイプ: dict
Example usage:使用例:
extra-build-variablesextra-build-variables
Extra environment variables to set when building certain packages.特定のパッケージをビルドする際に設定する追加の環境変数。
Environment variables will be added to the environment when building the specified packages.環境変数は、指定されたパッケージをビルドする際に環境に追加されます。
Default value: {}デフォルト値: {}
Type: dict[str, dict[str, str]]タイプ: dict[str, dict[str, str]]
Example usage:使用例:
extra-index-urlextra-index-url
Extra URLs of package indexes to use, in addition to --index-url.--index-urlに加えて使用するパッケージインデックスの追加URL。
Accepts either a repository compliant with PEP 503 (the simple repository API), or a local directory laid out in the same format.PEP 503(シンプルリポジトリAPI)に準拠したリポジトリ、または同じ形式でレイアウトされたローカルディレクトリを受け入れます。
All indexes provided via this flag take priority over the index specified by
index_url. When multiple indexes are provided, earlier values take priority.このフラグを介して提供されたすべてのインデックスは、index_urlで指定されたインデックスよりも優先されます。複数のインデックスが提供される場合、早い値が優先されます。
To control uv's resolution strategy when multiple indexes are present, see
index_strategy.複数のインデックスが存在する場合のuvの解決戦略を制御するには、index_strategyを参照してください。
Default value: []デフォルト値: []
Type: list[str]タイプ: list[str]
Example usage:使用例:
find-linksfind-links
Locations to search for candidate distributions, in addition to those found in the registry indexes.レジストリインデックスに見つかるものに加えて、候補の配布物を検索する場所。
If a path, the target must be a directory that contains packages as wheel files (.whl) or
source distributions (e.g., .tar.gz or .zip) at the top level.パスの場合、ターゲットはトップレベルにホイールファイル(.whl)またはソース配布物(例:.tar.gzまたは.zip)を含むディレクトリでなければなりません。
If a URL, the page must contain a flat list of links to package files adhering to the formats described above.URLの場合、ページは上記の形式に従ったパッケージファイルへのリンクのフラットリストを含む必要があります。
Default value: []デフォルト値: []
Type: list[str]タイプ: list[str]
Example usage:使用例:
fork-strategyfork-strategy
The strategy to use when selecting multiple versions of a given package across Python versions and platforms.特定のパッケージの複数のバージョンをPythonのバージョンやプラットフォームにわたって選択する際に使用する戦略。
By default, uv will optimize for selecting the latest version of each package for each
supported Python version (requires-python), while minimizing the number of selected
versions across platforms.デフォルトでは、uvは各サポートされているPythonバージョン(requires-python)に対して各パッケージの最新バージョンを選択するよう最適化し、プラットフォーム間で選択されたバージョンの数を最小限に抑えます。
Under fewest, uv will minimize the number of selected versions for each package,
preferring older versions that are compatible with a wider range of supported Python
versions or platforms.fewestの下では、uvは各パッケージの選択されたバージョンの数を最小限に抑え、より広範囲のサポートされているPythonバージョンやプラットフォームと互換性のある古いバージョンを優先します。
Default value: "requires-python"デフォルト値: "requires-python"
Possible values:可能な値:
"fewest": Optimize for selecting the fewest number of versions for each package. Older versions may be preferred if they are compatible with a wider range of supported Python versions or platforms"fewest": 各パッケージの選択されたバージョンの数を最小限に抑えるよう最適化します。より広範囲のサポートされているPythonバージョンやプラットフォームと互換性がある場合、古いバージョンが優先されることがあります。"requires-python": Optimize for selecting latest supported version of each package, for each supported Python version"requires-python": 各サポートされているPythonバージョンに対して各パッケージの最新のサポートされているバージョンを選択するよう最適化します。
Example usage:使用例:
generate-hashesgenerate-hashes
Include distribution hashes in the output file.出力ファイルに配布ハッシュを含めます。
Default value: falseデフォルト値: false
Type: boolタイプ: bool
Example usage:使用例:
groupgroup
Include the following dependency groups.次の依存関係グループを含めます。
Default value: Noneデフォルト値: None
Type: list[str]タイプ: list[str]
Example usage:使用例:
index-strategyindex-strategy
The strategy to use when resolving against multiple index URLs.複数のインデックスURLに対して解決する際に使用する戦略。
By default, uv will stop at the first index on which a given package is available, and
limit resolutions to those present on that first index (first-index). This prevents
"dependency confusion" attacks, whereby an attacker can upload a malicious package under the
same name to an alternate index.デフォルトでは、uvは指定されたパッケージが利用可能な最初のインデックスで停止し、その最初のインデックスに存在するものに解決を制限します (first-index)。これにより、攻撃者が同じ名前の悪意のあるパッケージを別のインデックスにアップロードすることによる「依存関係の混乱」攻撃を防ぎます。
Default value: "first-index"デフォルト値: "first-index"
Possible values:可能な値:
"first-index": Only use results from the first index that returns a match for a given package name"first-index": 指定されたパッケージ名に対して一致する最初のインデックスからの結果のみを使用します。"unsafe-first-match": Search for every package name across all indexes, exhausting the versions from the first index before moving on to the next"unsafe-first-match": すべてのインデックスで各パッケージ名を検索し、次のインデックスに移る前に最初のインデックスからのバージョンをすべて消費します。"unsafe-best-match": Search for every package name across all indexes, preferring the "best" version found. If a package version is in multiple indexes, only look at the entry for the first index"unsafe-best-match": すべてのインデックスで各パッケージ名を検索し、見つかった「最良」のバージョンを優先します。パッケージバージョンが複数のインデックスに存在する場合、最初のインデックスのエントリのみを確認します。
Example usage:使用例:
index-urlindex-url
The URL of the Python package index (by default: https://pypi.org/simple).PythonパッケージインデックスのURL(デフォルト: https://pypi.org/simple)。
Accepts either a repository compliant with PEP 503 (the simple repository API), or a local directory laid out in the same format.PEP 503(シンプルリポジトリAPI)に準拠したリポジトリ、または同じ形式でレイアウトされたローカルディレクトリを受け入れます。
The index provided by this setting is given lower priority than any indexes specified via
extra_index_url.この設定で提供されるインデックスは、extra_index_urlを介して指定されたインデックスよりも優先度が低くなります。
Default value: "https://pypi.org/simple"デフォルト値: "https://pypi.org/simple"
Type: strタイプ: str
Example usage:使用例:
keyring-providerkeyring-provider
Attempt to use keyring for authentication for index URLs.インデックスURLの認証に keyring を使用しようとします。
At present, only --keyring-provider subprocess is supported, which configures uv to
use the keyring CLI to handle authentication.現在、--keyring-provider subprocess のみがサポートされており、これは uv が keyring CLI を使用して認証を処理するように構成します。
Default value: disabledデフォルト値: disabled
Type: strタイプ: str
Example usage:使用例:
link-modelink-mode
The method to use when installing packages from the global cache.グローバルキャッシュからパッケージをインストールする際に使用する方法。
Defaults to clone (also known as Copy-on-Write) on macOS, and hardlink on Linux and
Windows.macOS では clone(コピーオンライトとも呼ばれる)がデフォルトで、Linux および Windows では hardlink がデフォルトです。
WARNING: The use of symlink link mode is discouraged, as they create tight coupling between
the cache and the target environment. For example, clearing the cache (uv cache clean)
will break all installed packages by way of removing the underlying source files. Use
symlinks with caution.警告: シンボリックリンクモードの使用は推奨されません。これは、キャッシュとターゲット環境の間に強い結合を生じさせるためです。例えば、キャッシュをクリアすること(uv cache clean)は、基盤となるソースファイルを削除することによって、すべてのインストールされたパッケージを壊してしまいます。シンボリックリンクは注意して使用してください。
Default value: "clone" (macOS) or "hardlink" (Linux, Windows)デフォルト値: "clone" (macOS) または "hardlink" (Linux, Windows)
Possible values:可能な値:
"clone": Clone (i.e., copy-on-write) packages from the wheel into thesite-packagesdirectory"clone": ホイールからsite-packagesディレクトリにパッケージをクローン(すなわち、コピーオンライト)します。"copy": Copy packages from the wheel into thesite-packagesdirectory"copy": ホイールからsite-packagesディレクトリにパッケージをコピーします。"hardlink": Hard link packages from the wheel into thesite-packagesdirectory"hardlink": ホイールからsite-packagesディレクトリにパッケージをハードリンクします。"symlink": Symbolically link packages from the wheel into thesite-packagesdirectory"symlink": ホイールからsite-packagesディレクトリにパッケージをシンボリックリンクします。
Example usage:使用例:
no-annotateno-annotate
Exclude comment annotations indicating the source of each package from the output file
generated by uv pip compile.uv pip compile によって生成された出力ファイルから、各パッケージのソースを示すコメントアノテーションを除外します。
Default value: falseデフォルト値: false
Type: boolタイプ: bool
Example usage:使用例:
no-binaryno-binary
Don't install pre-built wheels.事前にビルドされたホイールをインストールしないでください。
The given packages will be built and installed from source. The resolver will still use pre-built wheels to extract package metadata, if available.指定されたパッケージはソースからビルドされ、インストールされます。リゾルバーは、利用可能な場合、パッケージメタデータを抽出するために事前ビルドされたホイールを使用します。
Multiple packages may be provided. Disable binaries for all packages with :all:.
Clear previously specified packages with :none:.複数のパッケージを指定できます。すべてのパッケージのバイナリを無効にするには :all: を使用します。以前に指定したパッケージをクリアするには :none: を使用します。
Default value: []デフォルト値: []
Type: list[str]タイプ: list[str]
Example usage:使用例:
no-buildno-build
Don't build source distributions.ソース配布物のビルドを行いません。
When enabled, resolving will not run arbitrary Python code. The cached wheels of already-built source distributions will be reused, but operations that require building distributions will exit with an error.有効にすると、解決は任意のPythonコードを実行しません。既にビルドされたソース配布のキャッシュされたホイールが再利用されますが、配布をビルドする必要がある操作はエラーで終了します。
Alias for --only-binary :all:.--only-binary :all:のエイリアスです。
Default value: falseデフォルト値: false
Type: boolタイプ: bool
Example usage:使用例:
no-build-isolationno-build-isolation
Disable isolation when building source distributions.ソース配布物のビルド時に隔離を無効にします。
Assumes that build dependencies specified by PEP 518 are already installed.PEP 518 で指定されたビルド依存関係が既にインストールされていると仮定します。
Default value: falseデフォルト値: false
Type: boolタイプ: bool
Example usage:使用例:
no-build-isolation-packageno-build-isolation-package
Disable isolation when building source distributions for a specific package.特定のパッケージのソース配布物をビルドする際に隔離を無効にします。
Assumes that the packages' build dependencies specified by PEP 518 are already installed.PEP 518で指定されたパッケージのビルド依存関係がすでにインストールされていることを前提とします。
Default value: []デフォルト値: []
Type: list[str]タイプ: list[str]
Example usage:使用例:
no-depsno-deps
Ignore package dependencies, instead only add those packages explicitly listed on the command line to the resulting requirements file.パッケージの依存関係を無視し、コマンドラインに明示的にリストされたパッケージのみを結果の要件ファイルに追加します。
Default value: falseデフォルト値: false
Type: boolタイプ: bool
Example usage:使用例:
no-emit-packageno-emit-package
Specify a package to omit from the output resolution. Its dependencies will still be
included in the resolution. Equivalent to pip-compile's --unsafe-package option.出力解決から除外するパッケージを指定します。その依存関係は解決に含まれます。これは、pip-compileの--unsafe-packageオプションと同等です。
Default value: []デフォルト値: []
Type: list[str]タイプ: list[str]
Example usage:使用例:
no-extrano-extra
Exclude the specified optional dependencies if all-extras is supplied.all-extrasが指定された場合、指定されたオプションの依存関係を除外します。
Default value: []デフォルト値: []
Type: list[str]タイプ: list[str]
Example usage:使用例:
no-headerno-header
Exclude the comment header at the top of output file generated by uv pip compile.uv pip compileによって生成された出力ファイルの先頭にあるコメントヘッダーを除外します。
Default value: falseデフォルト値: false
Type: boolタイプ: bool
Example usage:使用例:
no-indexno-index
Ignore all registry indexes (e.g., PyPI), instead relying on direct URL dependencies and
those provided via --find-links.すべてのレジストリインデックス(例:PyPI)を無視し、直接URL依存関係および--find-linksを介して提供されるものに依存します。
Default value: falseデフォルト値: false
Type: boolタイプ: bool
Example usage:使用例:
no-sourcesno-sources
Ignore the tool.uv.sources table when resolving dependencies. Used to lock against the
standards-compliant, publishable package metadata, as opposed to using any local or Git
sources.tool.uv.sources テーブルを依存関係の解決時に無視します。これは、ローカルまたは Git ソースを使用するのではなく、標準準拠の公開可能なパッケージメタデータに対してロックするために使用されます。
Default value: falseデフォルト値: false
Type: boolタイプ: bool
Example usage:使用例:
no-strip-extrasno-strip-extras
Include extras in the output file.出力ファイルにエクストラを含めます。
By default, uv strips extras, as any packages pulled in by the extras are already included
as dependencies in the output file directly. Further, output files generated with
--no-strip-extras cannot be used as constraints files in install and sync invocations.デフォルトでは、uv は extras を除去します。extras によって引き込まれるパッケージは、すでに出力ファイルの依存関係として直接含まれているためです。さらに、--no-strip-extras で生成された出力ファイルは、install および sync の呼び出しで制約ファイルとして使用できません。
Default value: falseデフォルト値: false
Type: boolタイプ: bool
Example usage:使用例:
no-strip-markersno-strip-markers
Include environment markers in the output file generated by uv pip compile.uv pip compileによって生成された出力ファイルに環境マーカーを含めます。
By default, uv strips environment markers, as the resolution generated by compile is
only guaranteed to be correct for the target environment.デフォルトでは、compileによって生成される解決はターゲット環境に対してのみ正しいことが保証されているため、uvは環境マーカーを削除します。
Default value: falseデフォルト値: false
Type: boolタイプ: bool
Example usage:使用例:
only-binaryonly-binary
Only use pre-built wheels; don't build source distributions.事前にビルドされたホイールのみを使用します。ソース配布物をビルドしません。
When enabled, resolving will not run code from the given packages. The cached wheels of already-built source distributions will be reused, but operations that require building distributions will exit with an error.有効にすると、指定されたパッケージからコードが実行されることはありません。既にビルドされたソース配布のキャッシュされたホイールが再利用されますが、配布をビルドする必要がある操作はエラーで終了します。
Multiple packages may be provided. Disable binaries for all packages with :all:.
Clear previously specified packages with :none:.複数のパッケージを指定できます。すべてのパッケージのバイナリを無効にするには:all:を使用します。以前に指定したパッケージをクリアするには:none:を使用します。
Default value: []デフォルト値: []
Type: list[str]タイプ: list[str]
Example usage:使用例:
output-fileoutput-file
Write the requirements generated by uv pip compile to the given requirements.txt file.uv pip compileによって生成された要件を指定されたrequirements.txtファイルに書き込みます。
If the file already exists, the existing versions will be preferred when resolving
dependencies, unless --upgrade is also specified.ファイルが既に存在する場合、依存関係を解決する際には既存のバージョンが優先されます。ただし、--upgradeも指定されている場合を除きます。
Default value: Noneデフォルト値: None
Type: strタイプ: str
Example usage:使用例:
prefixprefix
Install packages into lib, bin, and other top-level folders under the specified
directory, as if a virtual environment were present at that location.指定されたディレクトリの下にあるlib、bin、およびその他のトップレベルフォルダーにパッケージをインストールします。まるでその場所に仮想環境が存在するかのように。
In general, prefer the use of --python to install into an alternate environment, as
scripts and other artifacts installed via --prefix will reference the installing
interpreter, rather than any interpreter added to the --prefix directory, rendering them
non-portable.一般的に、代替環境にインストールするためには--pythonの使用を推奨します。--prefixを介してインストールされたスクリプトやその他のアーティファクトは、--prefixディレクトリに追加されたインタプリタではなく、インストールを行ったインタプリタを参照するため、移植性がありません。
Default value: Noneデフォルト値: None
Type: strタイプ: str
Example usage:使用例:
prereleaseprerelease
The strategy to use when considering pre-release versions.プレリリースバージョンを考慮する際に使用する戦略。
By default, uv will accept pre-releases for packages that only publish pre-releases,
along with first-party requirements that contain an explicit pre-release marker in the
declared specifiers (if-necessary-or-explicit).デフォルトでは、uvはのみプレリリースを公開するパッケージのプレリリースを受け入れ、
明示的なプレリリースマーカーを含むファーストパーティの要件を受け入れます。
宣言された指定子内で(if-necessary-or-explicit)。
Default value: "if-necessary-or-explicit"デフォルト値: "if-necessary-or-explicit"
Possible values:可能な値:
"disallow": Disallow all pre-release versions"disallow": すべてのプレリリースバージョンを禁止"allow": Allow all pre-release versions"allow": すべてのプレリリースバージョンを許可"if-necessary": Allow pre-release versions if all versions of a package are pre-release"if-necessary": すべてのバージョンがプレリリースである場合にプレリリースバージョンを許可"explicit": Allow pre-release versions for first-party packages with explicit pre-release markers in their version requirements"explicit": 明示的なプレリリースマーカーを持つファーストパーティパッケージのためにプレリリースバージョンを許可します。"if-necessary-or-explicit": Allow pre-release versions if all versions of a package are pre-release, or if the package has an explicit pre-release marker in its version requirements"if-necessary-or-explicit": すべてのバージョンがプレリリースである場合、またはパッケージが明示的なプレリリースマーカーを持つ場合にプレリリースバージョンを許可します。
Example usage:使用例:
pythonpython
The Python interpreter into which packages should be installed.パッケージをインストールするためのPythonインタープリター。
By default, uv installs into the virtual environment in the current working directory or
any parent directory. The --python option allows you to specify a different interpreter,
which is intended for use in continuous integration (CI) environments or other automated
workflows.デフォルトでは、uvは現在の作業ディレクトリまたは親ディレクトリの仮想環境にインストールします。--pythonオプションを使用すると、異なるインタープリターを指定できます。これは、継続的インテグレーション(CI)環境やその他の自動化されたワークフローでの使用を意図しています。
Supported formats:
- 3.10 looks for an installed Python 3.10 in the registry on Windows (see
py --list-paths), or python3.10 on Linux and macOS.
- python3.10 or python.exe looks for a binary with the given name in PATH.
- /home/ferris/.local/bin/python3.10 uses the exact Python at the given path.サポートされているフォーマット:
- 3.10は、WindowsのレジストリでインストールされたPython 3.10を探します(py --list-pathsを参照)、またはLinuxおよびmacOSではpython3.10を探します。
- python3.10またはpython.exeは、PATH内の指定された名前のバイナリを探します。
- /home/ferris/.local/bin/python3.10は、指定されたパスの正確なPythonを使用します。
Default value: Noneデフォルト値: None
Type: strタイプ: str
Example usage:使用例:
python-platformpython-platform
The platform for which requirements should be resolved.要件を解決すべきプラットフォーム。
Represented as a "target triple", a string that describes the target platform in terms of
its CPU, vendor, and operating system name, like x86_64-unknown-linux-gnu or
aarch64-apple-darwin.「ターゲットトリプル」として表現され、CPU、ベンダー、およびオペレーティングシステム名に関してターゲットプラットフォームを説明する文字列で、x86_64-unknown-linux-gnuやaarch64-apple-darwinのようになります。
Default value: Noneデフォルト値: None
Type: strタイプ: str
Example usage:使用例:
python-versionpython-version
The minimum Python version that should be supported by the resolved requirements (e.g.,
3.8 or 3.8.17).解決された要件がサポートすべき最小のPythonバージョン(例:3.8または3.8.17)です。
If a patch version is omitted, the minimum patch version is assumed. For example, 3.8 is
mapped to 3.8.0.パッチバージョンが省略された場合、最小のパッチバージョンが仮定されます。例えば、3.8は3.8.0にマッピングされます。
Default value: Noneデフォルト値: None
Type: strタイプ: str
Example usage:使用例:
reinstallreinstall
Reinstall all packages, regardless of whether they're already installed. Implies refresh.すべてのパッケージを再インストールします。すでにインストールされているかどうかに関係ありません。refreshを含みます。
Default value: falseデフォルト値: false
Type: boolタイプ: bool
Example usage:使用例:
reinstall-packagereinstall-package
Reinstall a specific package, regardless of whether it's already installed. Implies
refresh-package.特定のパッケージを再インストールします。すでにインストールされているかどうかに関係ありません。refresh-packageを含みます。
Default value: []デフォルト値: []
Type: list[str]タイプ: list[str]
Example usage:使用例:
require-hashesrequire-hashes
Require a matching hash for each requirement.各要件に対して一致するハッシュを要求します。
Hash-checking mode is all or nothing. If enabled, all requirements must be provided
with a corresponding hash or set of hashes. Additionally, if enabled, all requirements
must either be pinned to exact versions (e.g., ==1.0.0), or be specified via direct URL.ハッシュチェックモードは全てか無かです。有効にすると、すべての要件には対応するハッシュまたはハッシュのセットが提供されなければなりません。さらに、有効にすると、すべての要件は正確なバージョンに固定される必要があります(例:==1.0.0)、または直接URLで指定される必要があります。
Hash-checking mode introduces a number of additional constraints:ハッシュチェックモードは、いくつかの追加の制約を導入します:
- Git dependencies are not supported.Git依存関係はサポートされていません。
- Editable installations are not supported.編集可能なインストールはサポートされていません。
- Local dependencies are not supported, unless they point to a specific wheel (
.whl) or source archive (.zip,.tar.gz), as opposed to a directory.ローカル依存関係はサポートされていません。ただし、特定のホイール(.whl)またはソースアーカイブ(.zip、.tar.gz)を指す場合は除きます。
Default value: falseデフォルト値: false
Type: boolタイプ: bool
Example usage:使用例:
resolutionresolution
The strategy to use when selecting between the different compatible versions for a given package requirement.特定のパッケージ要件に対して異なる互換バージョンを選択する際に使用する戦略。
By default, uv will use the latest compatible version of each package (highest).デフォルトでは、uvは各パッケージの最新の互換バージョン(highest)を使用します。
Default value: "highest"デフォルト値: "highest"
Possible values:可能な値:
"highest": Resolve the highest compatible version of each package"highest": 各パッケージの最も互換性のあるバージョンを解決します"lowest": Resolve the lowest compatible version of each package"lowest": 各パッケージの最も低い互換性のあるバージョンを解決します"lowest-direct": Resolve the lowest compatible version of any direct dependencies, and the highest compatible version of any transitive dependencies"lowest-direct": 直接依存関係の最も低い互換性のあるバージョンを解決し、間接依存関係の最も高い互換性のあるバージョンを解決します
Example usage:使用例:
strictstrict
Validate the Python environment, to detect packages with missing dependencies and other issues.Python環境を検証し、依存関係が欠けているパッケージやその他の問題を検出します。
Default value: falseデフォルト値: false
Type: boolタイプ: bool
Example usage:使用例:
systemsystem
Install packages into the system Python environment.パッケージをシステムのPython環境にインストールします。
By default, uv installs into the virtual environment in the current working directory or
any parent directory. The --system option instructs uv to instead use the first Python
found in the system PATH.デフォルトでは、uvは現在の作業ディレクトリまたは親ディレクトリの仮想環境にインストールされます。--systemオプションは、uvにシステムのPATHで見つかった最初のPythonを使用するよう指示します。
WARNING: --system is intended for use in continuous integration (CI) environments and
should be used with caution, as it can modify the system Python installation.警告: --systemは継続的インテグレーション(CI)環境での使用を意図しており、システムのPythonインストールを変更する可能性があるため、注意して使用する必要があります。
Default value: falseデフォルト値: false
Type: boolタイプ: bool
Example usage:使用例:
targettarget
Install packages into the specified directory, rather than into the virtual or system Python environment. The packages will be installed at the top-level of the directory.指定されたディレクトリにパッケージをインストールします。仮想環境やシステムPython環境にはインストールされません。パッケージはディレクトリのトップレベルにインストールされます。
Default value: Noneデフォルト値: None
Type: strタイプ: str
Example usage:使用例:
torch-backendtorch-backend
The backend to use when fetching packages in the PyTorch ecosystem.PyTorchエコシステム内でパッケージを取得する際に使用するバックエンド。
When set, uv will ignore the configured index URLs for packages in the PyTorch ecosystem, and will instead use the defined backend.設定されると、uvはPyTorchエコシステム内のパッケージに対して構成されたインデックスURLを無視し、 代わりに定義されたバックエンドを使用します。
For example, when set to cpu, uv will use the CPU-only PyTorch index; when set to cu126,
uv will use the PyTorch index for CUDA 12.6.例えば、cpuに設定されると、uvはCPU専用のPyTorchインデックスを使用します; cu126に設定されると、
uvはCUDA 12.6用のPyTorchインデックスを使用します。
The auto mode will attempt to detect the appropriate PyTorch index based on the currently
installed CUDA drivers.autoモードは、現在インストールされているCUDAドライバーに基づいて適切なPyTorchインデックスを検出しようとします。
This option is in preview and may change in any future release.このオプションはプレビュー中であり、将来のリリースで変更される可能性があります。
Default value: nullデフォルト値: null
Type: strタイプ: str
Example usage:使用例:
universaluniversal
Perform a universal resolution, attempting to generate a single requirements.txt output
file that is compatible with all operating systems, architectures, and Python
implementations.ユニバーサル解決を実行し、すべてのオペレーティングシステム、アーキテクチャ、およびPython実装と互換性のある単一のrequirements.txt出力ファイルを生成しようとします。
In universal mode, the current Python version (or user-provided --python-version) will be
treated as a lower bound. For example, --universal --python-version 3.7 would produce a
universal resolution for Python 3.7 and later.ユニバーサルモードでは、現在のPythonバージョン(またはユーザー提供の--python-version)が下限として扱われます。例えば、--universal --python-version 3.7はPython 3.7以降のユニバーサル解決を生成します。
Default value: falseデフォルト値: false
Type: boolタイプ: bool
Example usage:使用例:
upgradeupgrade
Allow package upgrades, ignoring pinned versions in any existing output file.パッケージのアップグレードを許可し、既存の出力ファイルに固定されたバージョンを無視します。
Default value: falseデフォルト値: false
Type: boolタイプ: bool
Example usage:使用例:
upgrade-packageupgrade-package
Allow upgrades for a specific package, ignoring pinned versions in any existing output file.特定のパッケージのアップグレードを許可し、既存の出力ファイル内の固定バージョンを無視します。
Accepts both standalone package names (ruff) and version specifiers (ruff<0.5.0).スタンドアロンのパッケージ名(ruff)とバージョンスペシファイア(ruff<0.5.0)の両方を受け入れます。
Default value: []デフォルト値: []
Type: list[str]タイプ: list[str]
Example usage:使用例:
verify-hashesverify-hashes
Validate any hashes provided in the requirements file.要求ファイルに提供されたハッシュを検証します。
Unlike --require-hashes, --verify-hashes does not require that all requirements have
hashes; instead, it will limit itself to verifying the hashes of those requirements that do
include them.--require-hashesとは異なり、--verify-hashesはすべての要求にハッシュが必要ではありません。代わりに、ハッシュを含む要求のハッシュを検証することに制限されます。
Default value: trueデフォルト値: true
Type: boolタイプ: bool
Example usage:使用例: