コンテンツにスキップ

Commands

コマンドライン・インターフェースを使用していくつかのことを行う方法については、すでに説明しました。 この章では、使用可能なすべてのコマンドについて説明します。

コマンドラインからヘルプを取得するには、単にpoetryを呼び出してコマンドの完全なリストを表示し、--helpといずれかを組み合わせると、より多くの情報が得られます。

Global options

  • --verbose(-vvv vvv): メッセージの冗長度を上げます。"-v"は通常の出力、"-vv"はより冗長な出力、"-vvv"はデバッグ用です。
  • --help(-h): ヘルプ情報を表示します。
  • --quiet(-q): メッセージを出力しません。
  • --ansi: ANSI出力を強制します。
  • --no-ansi: ANSI出力を無効にします。
  • --version(-V): このアプリケーションのバージョンを表示します。
  • --no-interaction(-n): 対話的な質問をしません。
  • --no-plugins: プラグインを無効にします。
  • --no-cache: Poetryのソースキャッシュを無効にします。
  • --directory=DIRECTORY(-C): Poetryコマンドの作業ディレクトリ(デフォルトは現在の作業ディレクトリ)。

new

このコマンドは、ほとんどのプロジェクトに適したディレクトリ構造を作成することで、新しいPythonプロジェクトを開始するのに役立ちます。

poetry new my-package

次のようなフォルダが作成されます。

my-package
├── pyproject.toml
├── README.md
├── my_package
│   └── __init__.py
└── tests
    └── __init__.py

プロジェクトにフォルダとは異なる名前を付けたい場合は、--nameオプションを渡します。

poetry new my-folder --name my-package

srcフォルダを使用する場合は、--srcオプションを使用します。

poetry new --src my-package

これにより、次のようなフォルダ構造が作成されます。

my-package
├── pyproject.toml
├── README.md
├── src
│   └── my_package
│       └── __init__.py
└── tests
    └── __init__.py

--nameオプションは、名前空間パッケージを検出し、必要な構造を作成するのに十分なスマートさを備えています。

poetry new --src --name my.package my-package

次の構造が作成されます。

my-package
├── pyproject.toml
├── README.md
├── src
│   └── my
│       └── package
│           └── __init__.py
└── tests
    └── __init__.py

Options

  • --interactive(-i): プロジェクトの設定を対話的に指定できます。
  • --name: 結果のパッケージ名を設定します。
  • --src: プロジェクトにsrcレイアウトを使用します。
  • --readme: readmeファイルの拡張子を指定します。デフォルトはmdです。PyPIに公開する場合は、recommendations for a PyPI-friendly READMEを念頭に置いてください。
  • --description: パッケージの説明。
  • --author: パッケージの作成者。
  • --python互換性のあるPythonバージョン。
  • --dependency: バージョン制約を必要とするパッケージ。foo: 1.0.0の形式でなければなりません。
  • --dev-dependency: 開発要件、--dependencyを参照してください。

init

This command will help you create a pyproject.toml file interactively by prompting you to provide basic information about your package.

いくつかのスマートなデフォルトを使用しながら、フィールドに入力するように対話的に要求されます。

poetry init

Options

  • --name: パッケージの名前。
  • --description: パッケージの説明。
  • --author: パッケージの作成者。
  • --python互換性のあるPythonバージョン。
  • --dependency: バージョン制約を必要とするパッケージ。foo: 1.0.0の形式でなければなりません。
  • --dev-dependency: 開発要件、--dependencyを参照してください。

install

installコマンドは、現在のプロジェクトからpyproject.tomlファイルを読み込み、依存関係を解決してインストールします。

poetry install

現在のディレクトリにpoetry.lockファイルがある場合、解決するのではなく、そこから正確なバージョンを使用します。 これにより、ライブラリを使用するすべてのユーザが同じバージョンの依存関係を取得できるようになります。

poetry.lockファイルがない場合、Poetryは依存関係の解決後に作成します。

インストールから1つ以上の依存関係グループを除外したい場合は、--withoutオプションを使用できます。

poetry install --without test,docs

Note

--no-devオプションは廃止されました。代わりに--only mainまたは--without dev表記を使用してください。

--withオプションを使って、オプションの依存関係グループを選択することもできます。

poetry install --with test,docs

onlyオプションを使って、特定の依存グループだけをインストールすることもできます。

poetry install --only test,docs

依存関係を持たずにプロジェクト自体のみをインストールするには、--only-rootフラグを使用します。

poetry install --only-root

依存関係グループの詳細については、Dependency groupsを参照してください。

環境を同期させ、ロックファイルと一致することを確認するには、--syncオプションを使用します。

poetry install --sync

--syncはグループ関連のオプションと組み合わせることができます。

poetry install --without dev --sync
poetry install --with docs --sync
poetry install --only dev --sync

-E| --extrasオプションを渡して、インストールしたいextrasを指定することもできます(詳しくは、Extrasを参照してください)。 --all-extrasを渡して、プロジェクトに定義されているすべてのエクストラをインストールします。

poetry install --extras "mysql pgsql"
poetry install -E mysql -E pgsql
poetry install --all-extras

extrasは--syncの影響を受けません。指定されていないextrasは常に削除されます。

poetry install --extras "A B"  # C is removed

デフォルトでは、poetryはinstallを実行するたびにプロジェクトのパッケージをインストールします。

$ poetry install
Installing dependencies from lock file

No dependencies to install or update

  - Installing <your-package-name> (x.x.x)

このインストールをスキップしたい場合は、--no-rootオプションを使用してください。

poetry install --no-root

--no-rootと同様に、--no-directoryを使用してディレクトリパスの依存関係をスキップすることができます。

poetry install --no-directory

これは主にCIでのキャッシュやDockerイメージの構築時に役立ちます。このオプションの詳細については、FAQ entryを参照してください。

デフォルトでは、poetryはインストール時にPythonソースファイルをバイトコードにコンパイルしません。 これにより、インストールプロセスが高速化されますが、Pythonが自動的にソースファイルをバイトコードにコンパイルするため、最初の実行にはもう少し時間がかかる場合があります。 インストール時にソースファイルをバイトコードにコンパイルしたい場合は、--compileオプションを使用できます。

poetry install --compile

Options

  • --without: 無視する依存関係グループ。
  • --with: 含めるオプションの依存性グループ。
  • --only: 含める唯一の依存関係グループ。
  • --only-root: ルートプロジェクトのみをインストールし、すべての依存関係を除外します。
  • --sync: 環境をロックされたパッケージと指定されたグループと同期させます。
  • --no-root: ルートパッケージ(プロジェクト)をインストールしません。
  • --no-directory: すべてのディレクトリパスの依存関係(推移的なものを含む)をスキップします。
  • --dry-run: 操作を出力しますが、何も実行しません(暗黙的に--verboseを有効にします)。
  • --extras(-E): インストールする機能(複数の値を指定可能)。
  • --all-extras: すべての追加機能をインストールします(--extrasと衝突します)。
  • --compile: Pythonソースファイルをバイトコードにコンパイルします。
  • --no-dev: dev依存関係をインストールしません。(非推奨、代わりに--only mainまたは--without devを使用してください)
  • --remove-untracked: ロックファイルに存在しない依存関係を削除します。(非推奨 、代わりに--syncを使用してください)

Note

--only を指定すると、--with と --without オプションは無視されます。

update

依存関係の最新バージョンを取得し、poetry.lockファイルを更新するには、updateコマンドを使用する必要があります。

poetry update

これにより、プロジェクトのすべての依存関係が解決され、正確なバージョンがpoetry.lockに書き込まれます。

すべてではなく、いくつかのパッケージだけを更新したい場合は、次のように一覧表示できます。

poetry update requests toml

pyproject.tomlファイルで指定されたversion constraintsの範囲外にある依存関係のバージョンは更新されないことに注意してください。 言い換えると、fooに指定されたバージョン制約が~2.3または2.3で、2.4が使用可能な場合、poetry update fooは何もしないことになります。 fooを更新するには、^2.3のように制約を更新する必要があります。 これにはaddコマンドを使用します。

Options

  • --without: 無視する依存関係グループ。
  • --with: 含めるオプションの依存性グループ。
  • --only: 含める唯一の依存関係グループ。
  • --dry-run: 操作を出力しますが、何も実行しません(暗黙的に--verboseを有効にします)。
  • --no-dev: 開発依存関係を更新しません。(非推奨 、代わりに--only mainまたは--without devを使用してください)
  • --lock: インストールを実行しません(ロックファイルを更新するだけです)。
  • --sync: 環境をロックされたパッケージと指定されたグループと同期させます。

Note

--onlyが指定された場合、--withと--withoutオプションは無視されます。

add

addコマンドは、必要なパッケージをpyproject.tomlに追加してインストールします。

バージョン制約を指定しない場合は、使用可能なパッケージのバージョンに基づいて適切なバージョンが選択されます。

poetry add requests pendulum

Note

デフォルトでは、パッケージはDefault Package Sourceからのみ検索されます。 デフォルトのソース(PyPI)を変更したり、Supplemental Package SourcesまたはExplicit Package Sourcesを追加して使用したりできます。

詳細については、Package Sourcesのドキュメントを参照してください。

パッケージを追加するときに制約を指定することもできます。

# Allow >=2.0.5, <3.0.0 versions
poetry add pendulum@^2.0.5

# Allow >=2.0.5, <2.1.0 versions
poetry add pendulum@~2.0.5

# Allow >=2.0.5 versions, without upper bound
poetry add "pendulum>=2.0.5"

# Allow only 2.0.5 version
poetry add pendulum==2.0.5

Note

@演算子の詳細については、Dependency specificationページを参照してください。

すでに存在するパッケージを追加しようとすると、エラーが発生します。 ただし、上記のように制約を指定すると、指定した制約を使用して依存関係が更新されます。

すでに存在する依存関係の最新バージョンを取得したい場合は、特別なlatest制約を使用できます。

poetry add pendulum@latest

Note

パッケージのバージョン制約の設定の詳細については、Dependency specificationを参照してください。

gitの依存関係を追加することもできます。

poetry add git+https://github.com/sdispater/pendulum.git

または、httpsの代わりにsshを使用します。

poetry add git+ssh://git@github.com/sdispater/pendulum.git

# or alternatively:
poetry add git+ssh://git@github.com:sdispater/pendulum.git

特定の分岐、タグ、またはリビジョンをチェックアウトする必要がある場合は、addを使用して指定できます。

poetry add git+https://github.com/sdispater/pendulum.git#develop
poetry add git+https://github.com/sdispater/pendulum.git#2.0.5

# or using SSH instead:
poetry add git+ssh://git@github.com:sdispater/pendulum.git#develop
poetry add git+ssh://git@github.com:sdispater/pendulum.git#2.0.5

またはサブディレクトリを参照します。

poetry add git+https://github.com/myorg/mypackage_with_subdirs.git@main#subdirectory=subdir

ローカルディレクトリまたはファイルを追加することもできます。

poetry add ./my-package/
poetry add ../my-package/dist/my-package-0.1.0.tar.gz
poetry add ../my-package/dist/my_package-0.1.0.whl

依存関係を編集可能モードでインストールしたい場合は、--editableオプションを使用できます。

poetry add --editable ./my-package/
poetry add --editable git+ssh://github.com/sdispater/pendulum.git#develop

または、pyproject.tomlファイルで指定することもできます。これは、ローカルディレクトリでの変更が環境に直接反映されることを意味します。

[tool.poetry.dependencies]
my-package = {path = "../my/path", develop = true}

Note

Poetry以前は、1.1のパス依存関係がデフォルトで編集可能モードでインストールされていました。 すべてのPoetryバージョンで動作が同じになるように、常にdevelop属性を明示的に設定する必要があります。

Note

develop属性はPoetry固有の機能なので、パッケージ配布メタデータには含まれていません。 つまり、Poetryを使用してプロジェクトをインストールする場合にのみ考慮されます。

インストールするパッケージに特別な機能がある場合は、パッケージを追加するときにその機能を指定できます。

poetry add "requests[security,socks]"
poetry add "requests[security,socks]~=2.22.0"
poetry add "git+https://github.com/pallets/flask.git@1.1.1[dotenv,dev]"

Warning

シェルによっては、角括弧([と])を特殊文字として扱うことがあります。予期しないシェルの展開を防ぐために、この文字を含む引数を常に引用符で囲むことをお勧めします。

特定の依存関係のグループにパッケージを追加する場合は、--group(-G)オプションを使用します。

poetry add mkdocs --group docs

依存関係グループの詳細については、Dependency groupsを参照してください。

Options

  • --group(-G): 依存関係を追加するグループ。
  • --dev(-D): パッケージを開発依存関係として追加します。(非推奨、代わりに-G devを使用してください)
  • --editable(-e): vcs/pathの依存関係を編集可能として追加します。
  • --extras(-E): 依存関係に対してアクティブにする追加。(複数の値を指定可能)
  • --optional: オプションの依存関係として追加します。
  • --python: 依存関係をインストールする必要があるPythonのバージョン。
  • --platform: 依存関係をインストールする必要があるプラットフォーム。
  • --source: パッケージのインストールに使用するソースの名前。
  • --allow-prereleases: プレリリースを受け入れます。
  • --dry-run: 操作を出力しますが、何も実行しません(暗黙的に--verboseを有効にします)。
  • --lock: インストールを実行しません(ロックファイルを更新するだけです)。

remove

removeコマンドは、現在インストールされているパッケージのリストからパッケージを削除します。

poetry remove pendulum

特定の依存関係グループからパッケージを削除したい場合は、--group(-G)オプションを使用できます。

poetry remove mkdocs --group docs

依存関係グループの詳細については、Dependency groupsを参照してください。

Options

  • --group(-G): 依存関係を削除するグループ。
  • --dev(-D): 開発依存関係からパッケージを削除します。(非推奨、代わりに-G devを使用してください)
  • --dry-run: 操作を出力しますが、何も実行しません(暗黙的に--verboseを有効にします)。
  • --lock: 操作を実行しません(ロックファイルを更新するだけです)。

show

利用可能なすべてのパッケージを一覧表示するには、showコマンドを使用します。

poetry show

特定のパッケージの詳細を表示する場合は、パッケージ名を渡します。

poetry show pendulum

name        : pendulum
version     : 1.4.2
description : Python datetimes made easy

dependencies
 - python-dateutil >=2.6.1
 - tzlocal >=1.4
 - pytzdata >=2017.2.2

required by
 - calendar >=1.4.0

Options

  • --without: 無視する依存関係グループ。
  • --why: 完全なリスト、または1つのパッケージの--treeを表示する場合は、それらが直接の依存関係であるか、他のパッケージによって要求されているかを表示します。
  • --with: 含めるオプションの依存性グループ。
  • --only: 含める唯一の依存関係グループ。
  • --no-dev: devの依存関係をリストしません。(非推奨 、代わりに--only mainまたは--without devを使用してください)
  • --tree: 依存関係をツリーとしてリストします。
  • --latest(-l): 最新のバージョンを表示します。
  • --outdated(-o): 最新のバージョンを表示します。ただし、パッケージが古い場合に限ります。
  • --all(-a): (現在のシステムと互換性のないものも含めて)すべてのパッケージを表示します。
  • --top-level(-T): 明示的に定義されたパッケージのみを表示します。

Note

--onlyが指定された場合、--withと--withoutオプションは無視されます。

build

buildコマンドは、ソースとWheelsアーカイブを構築します。

poetry build

現時点では、純粋なPythonホイールのみがサポートされていることに注意してください。

Options

  • --format(-f): フォーマットをwheelかsdistのどちらかに限定します。
  • --clean: 構築前に出力ディレクトリをクリーンアップします。
  • --local-version(-l): ローカルバージョンラベルをビルドに追加または置き換えます。
  • --output(-o): 構築アーティファクトの出力ディレクトリを設定します。デフォルトはdistです。

Note

--local-versionを使用する場合、識別子はPEP 440に準拠している必要があります。これは、プライベートパッケージのビルド番号やプラットフォームの特性などを追加する場合に便利です。

Warning

ローカルバージョン識別子は、上流プロジェクトを公開インデックスサーバに公開するときに使用すべきではありませんが、プロジェクトソースから直接作成されたプライベートビルドを識別するために使用してもよいです。

詳細については、PEP 440を参照してください。

publish

このコマンドは、以前にbuildコマンドで構築されたパッケージをリモートリポジトリに公開します。

パッケージが初めて送信された場合は、アップロード前に自動的に登録されます。

poetry publish

--buildオプションを指定すれば、パッケージをビルドすることもできます。

Note

使用可能なリポジトリの設定方法と使用方法の詳細については、Publishable Repositoriesを参照してください。

Options

  • --repository(-r):パッケージを登録するリポジトリ(デフォルト:pypi)。 configコマンドで設定されたリポジトリ名と一致する必要があります。
  • --username(-u): リポジトリにアクセスするためのユーザ名。
  • --password(-p): リポジトリにアクセスするためのパスワード。
  • --cert: リポジトリにアクセスする認証局。
  • --client-cert: リポジトリにアクセスするためのクライアント証明書。
  • --dist-dir: 構築されたアーティファクトが格納されるdistディレクトリ。デフォルトはdistです。
  • --build: 公開する前にパッケージを構築します。
  • --dry-run: パッケージのアップロード以外のすべてのアクションを実行します。
  • --skip-existing: リポジトリに既に存在するファイルからのエラーを無視します。

Note

認証情報の設定方法の詳細については、Configuring Credentialsを参照してください。

config

configコマンドを使用すると、poetry configの設定とリポジトリを編集できます。 setting-keyは構成オプション名で、setting-value1は構成値です。 使用可能なすべての設定については、Configurationを参照してください。

poetry config --list

Usage

poetry config [options] [setting-key] [setting-value1] ... [setting-valueN]

setting-keyは構成オプション名で、setting-value1は構成値です。 使用可能なすべての設定については、Configurationを参照してください。

Warning

値がハイフン(-')で始まる場合は、--`を使用してオプションの解析を終了します。

poetry config http-basic.custom-repo gitlab-ci-token -- ${GITLAB_JOB_TOKEN}

--がない場合、${GITLAB_JOB_TOKEN}がハイフンで始まると、このコマンドは失敗します。

Options

  • --unset: setting-keyという名前の設定要素を削除します。
  • --list: 現在の設定変数のリストを表示します。
  • --local: プロジェクト固有の設定を設定/取得します(ローカル設定ファイルpoetry.toml内)。

run

runコマンドは、指定されたコマンドをプロジェクトのvirtualenv内で実行します。

poetry run python -V

pyproject.tomlで定義されているスクリプトの1つを実行することもできます。

したがって、次のように定義されたスクリプトがあるとします。

[tool.poetry.scripts]
my-script = "my_module:main"

次のように実行できます。

poetry run my-script

このコマンドにはオプションがないことに注意してください。

shell

shellコマンドは、プロジェクトの仮想環境内にシェルを作成します。

デフォルトでは、現在アクティブなシェルが検出され、使用されます。それができない場合は、環境変数SHELL(*nixの場合)またはCOMSPEC(Windowsの場合)で定義されたシェルが使用されます。

仮想環境が存在しない場合は、作成されます。

poetry shell

このコマンドは、新しいシェルを起動し、仮想環境をアクティブにします。

したがって、シェルと仮想環境を適切に終了するには、"非アクティブ化"ではなく"終了"を使用する必要があります。

Note

Poetryは内部的にShearing hamプロジェクトを使用して、現在アクティブなシェルを検出しています。

check

checkコマンドは、pyproject.tomlファイルの内容と、poetry.lockファイルとの整合性を検証します。 エラーがある場合は、詳細なレポートが返されます。

Note

このコマンドは、コミット前フックとしても使用できます。詳細については、pre-commit hooksを参照してください。

poetry check

Options

  • --lock:現在のpyproject.tomlにpoetry.lockが存在することを確認します。

このコマンドは、リモートインデックス上のパッケージを検索します。

poetry search requests pendulum

lock

このコマンドは、pyproject.tomlで指定された依存関係を(インストールせずに)ロックします。

Note

デフォルトでは、すべての依存関係が利用可能な最新の互換バージョンにロックされます。ロックファイルのみを更新するには、--no-updateオプションを使用してください。 このコマンドは、コミット前フックとしても使用できます。詳細については、pre-commit hooksを参照してください。

poetry lock

Options

  • --check: poetry.lockがpyproject.tomlと整合していることを確認してください。(非推奨)代わりにpoetry check--lockを使用してください。
  • --no-update: ロックされたバージョンは更新せず、ロックファイルのみを更新します。

version

このコマンドは、プロジェクトの現在のバージョンを表示するか、プロジェクトのバージョンをバンプし、有効なバンプ規則が指定されている場合は新しいバージョンをpyproject.tomlに書き戻します。

新しいバージョンは、有効なPEP 440文字列、または有効なバンプルール:patch、minor、major、prepatch、preminor、premajor、prereleaseでなければなりません。

Note

プロジェクトにセマンティックバージョン管理を使用したい場合は、hereを参照してください。

以下の表は、この規則の効果を具体的な例で示しています。

rule before after
major 1.3.0 2.0.0
minor 2.1.4 2.2.0
patch 4.1.1 4.1.2
premajor 1.0.2 2.0.0a0
preminor 1.0.2 1.1.0a0
prepatch 1.0.2 1.0.3a0
prerelease 1.0.2 1.0.3a0
prerelease 1.0.3a0 1.0.3a1
prerelease 1.0.3b0 1.0.3b1

--next-phaseオプションを使用すると、プレリリースフェーズのバージョン数を増やすことができます。

rule before after
prerelease --next-phase 1.0.3a0 1.0.3b0
prerelease --next-phase 1.0.3b0 1.0.3rc0
prerelease --next-phase 1.0.3rc0 1.0.3

Options

  • --next-phase: 現在のバージョンのフェーズをインクリメントします。
  • --short(-s): バージョン番号のみを出力します。
  • --dry-run: pyproject.tomlファイルを更新しません。

export

このコマンドは、ロックファイルを他の形式にエクスポートします。

poetry export -f requirements.txt --output requirements.txt

Warning

このコマンドは、Export Poetry Pluginによって提供されます。 Poetryの将来のバージョンでは、このプラグインはデフォルトでインストールされなくなります。 互換性のない変更を避け、自動化を上位互換にするために、poetry-plugin-exportを明示的にインストールしてください。 プラグインのインストール方法の詳細については、Using pluginsを参照してください。

Note

このコマンドは、コミット前フックとしても使用できます。 詳細については、pre-commit hooksを参照してください。

Note

installコマンドとは異なり、このコマンドは、オプションを指定せずに使用した場合、tool.poetry.dependenciesで定義された暗黙のmainグループで定義されたプロジェクトの依存関係のみを含みます。

Options

  • --format(-f): エクスポート先のフォーマット(デフォルト: requirements.txt)。 現在、constraints.txtとrequirements.txtのみがサポートされています。
  • --output(-o): 出力ファイルの名前。省略すると 出力。
  • --dev: 開発依存関係を含めます。(非推奨 、代わりに--with devを使用してください)
  • --extras(-E): 含める追加の依存関係のセット。
  • --without: 無視する依存関係グループ。
  • --with: 含めるオプションの依存性グループ。
  • --only: 含める唯一の依存関係グループ。
  • --without-hashes: エクスポートされたファイルからハッシュを除外します。
  • --without-urls: エクスポートされたファイルからソースリポジトリのURLを除外します。
  • --with-credentials: 追加インデックス用の資格情報を含めます。

env

envコマンドは、特定のプロジェクトに関連付けられたvirtualenvと対話するためのサブコマンドを再編成します。

このコマンドの詳細については、Managing environmentsを参照してください。

cache

cacheコマンドは、Poetryのキャッシュと相互作用するサブコマンドを再編成します。

cache list

cache listコマンドはPoetryの利用可能なキャッシュを一覧表示します。

poetry cache list

cache clear

cache clearコマンドは、キャッシュされたリポジトリからパッケージを削除します。

たとえば、pypiリポジトリからパッケージのキャッシュ全体をクリアするには、次のコマンドを実行します。

poetry cache clear pypi --all

キャッシュから特定のパッケージだけを削除するには、cache:package:versionの形式でキャッシュエントリを指定する必要があります。

poetry cache clear pypi:requests:2.24.0

source

source名前空間は、Poetryプロジェクトのリポジトリソースを管理するためのサブコマンドを再編成します。

source add

source addコマンドは、ソース構成をプロジェクトに追加します。

たとえば、pypi-testソースを追加するには、次のように実行します。

poetry source add pypi-test https://test.pypi.org/simple/

デフォルトのPyPIソースで使用するために予約されているため、カスタムリポジトリにPyPIという名前を使用することはできません。ただし、PyPIの優先順位を設定することはできます。

poetry source add --priority=explicit pypi

Options

  • --default: このソースをdefaultとして設定します(PyPIを無効にします)。--priorityを優先して非推奨になりました。
  • --secondary: このソースをsecondaryソースとして設定します。--priorityを優先して非推奨になりました。
  • --priority: このソースの優先度を設定します。指定できる値は次のとおりです。default、secondary、supplemental、explicit。詳細については、Repositoriesの専用セクションを参照してください。

Note

上記のオプションは、多くても1つしか指定できません。詳細については、package sourcesを参照してください。

source show

source showコマンドは、プロジェクトに設定されているすべてのソースに関する情報を表示します。

poetry source show

オプションで、名前を指定して1つまたは複数のソースの情報を表示できます。

poetry source show pypi-test

Note

このコマンドはpyproject.toml経由で設定されたソースのみを表示し、暗黙のデフォルトPyPIは含まれません。

source remove

source removeコマンドは、設定されたソースをpyproject.tomlから削除します。

poetry source remove pypi-test

about

aboutコマンドは、現在のバージョンとpoetry-coreのバージョンを含む、Poetryに関するグローバル情報を表示します。

poetry about

help

helpコマンドは、グローバルヘルプ、または特定のコマンドのヘルプを表示します。

グローバル・ヘルプを表示するには、次の手順に従い

poetry help

特定のコマンド(例えばshow)のヘルプを表示するには:

poetry help show

Note

--helpオプションを任意のコマンドに渡して、特定のコマンドのヘルプを取得することもできます。

次に例を示します。

poetry show --help

list

listコマンドは、利用可能なすべてのPoetryコマンドを表示します。

poetry list

self

self名前空間は、Poetryのインストール自体を管理するためにサブコマンドを再編成します。

Note

このコマンドを使用すると、必要なpyproject.tomlファイルとpoetry.lockファイルがconfiguration directoryに作成されます。

Warning

特にWindowsでは、パッケージを更新または削除するselfコマンドが問題になる可能性があるため、プラグインをインストールしてPoetryを更新する他の方法をお勧めします。 詳細については、Using pluginsおよびInstalling Poetryを参照してください。

self add

self addコマンドはPoetryプラグインをインストールし、実行時に利用できるようにします。 さらに、Poetry自身の依存関係をアップグレードしたり、ランタイム環境に追加のパッケージを注入したりするためにも使用できます。

Note

self addコマンドは、addコマンドとまったく同じように動作します。ただし、管理されるパッケージがPoetryのランタイム環境用であるという点で異なります。

self addコマンドでサポートされているパッケージ仕様フォーマットは、addコマンドでサポートされているものと同じです。

たとえば、poetry-plugin-exportプラグインをインストールするには、次のコマンドを実行します。

poetry self add poetry-plugin-export

最新のpoetry-coreバージョンに更新するには、次のコマンドを実行します。

poetry self add poetry-core@latest

キーリングプロバイダartifacts-keyringを追加するには、次のコマンドを実行します。

poetry self add artifacts-keyring

Options

  • --editable(-e): vcs/pathの依存関係を編集可能として追加します。
  • --extras(-E): 依存関係に対してアクティブにする追加。(複数の値を指定可能)
  • --allow-prereleases: プレリリースを受け入れます。
  • --source: パッケージのインストールに使用するソースの名前。
  • --dry-run: 操作を出力しますが、何も実行しません(暗黙的に--verboseを有効にします)。

self update

self updateコマンドは、現在の実行時環境でPoetryバージョンを更新します。

Note

self updateコマンドは、updateコマンドとまったく同じように動作します。ただし、管理されるパッケージがPoetryのランタイム環境用であるという点で異なります。

poetry self update

Options

  • --dry-run: 操作を出力しますが、何も実行しません(暗黙的に--verboseを有効にします)。

self lock

self lockコマンドは、このPoetryインストールのシステムpyproject.tomlファイルを読み込みます。システムの依存関係は、対応するpoetry.lockファイルでロックされます。

poetry self lock

Options

  • --check:poetry.lockがpyproject.tomlと整合していることを確認してください。(非推奨)
  • --no-update:ロックされたバージョンは更新せず、ロックファイルのみを更新します。

self show

self showコマンドの動作はshowコマンドと似ていますが、Poetryの実行環境内で動作します。Poetryのインストール環境内にインストールされているすべてのパッケージが一覧表示されます。

self addによって追加された追加パッケージとその依存関係のみを表示するには、self show--addonsを使用します。

poetry self show

Options

  • --addons: インストールされているアドオンパッケージのみを表示します。
  • --tree: 依存関係をツリーとしてリストします。
  • --latest(-l): 最新のバージョンを表示します。
  • --outdated(-o): 最新のバージョンを表示します。ただし、パッケージが古い場合に限ります。

self show plugins

self show pluginsコマンドは、現在インストールされているすべてのプラグインを一覧表示します。

poetry self show plugins

self remove

self removeコマンドは、インストールされているアドオンパッケージを削除します。

poetry self remove poetry-plugin-export

Options

  • --dry-run: 操作を出力しますが、何も実行しません(暗黙的に--verboseを有効にします)。

self install

self installコマンドは、指定されたすべての追加パッケージが現在のランタイム環境にインストールされていることを確認します。

Note

self installコマンドは、installコマンドと同じように動作します。ただし、管理されるパッケージがPoetryのランタイム環境用であるという点で異なります。

poetry self install --sync

Options

  • --sync: 環境をロックされたパッケージと指定されたグループと同期させます。
  • --dry-run: 操作を出力しますが、何も実行しません(暗黙的に--verboseを有効にします)。