PyCharm 2026.1 Help

スタブ

PyCharm は、 Python スタブファイル .pyi 拡張子でサポートしています。 これらのファイルを使用すると、Python 2 と 3 の両方に Python 3 構文を使用して 型ヒントを指定できます。

独自の実装用のスタブファイルを作成する

  1. ターゲット実装が存在するディレクトリに移動します。 メインメニューから ファイル | 新規 を選択し、次に Python ファイル を選択します(または、 Alt+Insert ショートカットを使用します)。

  2. 新規 Python ファイル ダイアログで、 Python スタブ を選択し、ファイル名を指定します。 ファイル名は実装ファイルと同じ名前にしてください。

    新しいスタブファイル

    Enter を押してアクションを完了します。

便宜上、別のディレクトリを作成して、スタブとその実装を保持できます。 これは他のプロジェクトで スタブを再利用するのに役立ちます。

外部実装用のスタブファイルを作成する

ご使用の環境にインストールされているパッケージにある一部の実装用のスタブファイルを作成できます。

  1. スタブ用の ディレクトリを作成します。 ディレクトリを右クリックし、コンテキストメニューから ディレクトリをマーク | ソースルート を選択します。

  2. ディレクトリで、実装パッケージに対応する階層を再作成します。

    スタブ実装パッケージに対応する構造の作成
  3. 作成された構造内で、ターゲットディレクトリに移動し、メインメニューから ファイル | 新規 を選択し、次に Python ファイル を選択します (または、 Alt+Insert ショートカットを使用します)。 新規 Python ファイル ダイアログで、 Python スタブ を選択し、ファイル名を指定します。 Enter を押すとファイルが作成されます。 その他の必要なファイルはスタブディレクトリに置くことができます。

    外部実装用のスタブを作成する

スタブとその実装の間を移動する

PyCharm は、スタブを持つコード要素の左側ガターにアスタリスクを表示します。 アスタリスクをクリックして、スタブとその実装の間を移動します。

スタブから実装へ

    スタブを再利用

    他の PyCharm プロジェクトでもスタブにアクセスできるようにできます。

    1. プロジェクトインタープリター セレクターを ステータスバー でクリックし、 インタープリターの設定 を選択します。

      インタープリター設定メニュー
    2. プロジェクトインタープリター ダイアログで 閲覧 をクリックして すべて表示 を選択し、開いた プロジェクトインタープリター ダイアログで Show paths for the selected interpreter をクリックします。

    3. インタープリターのパス ダイアログで、 追加ボタン をクリックして新しいパスレコードを追加します:

      パスを追加する
    4. プロジェクトをインスペクションします。

      ライブラリルートとしてマークされているスタブディレクトリ

    このプロジェクトインタープリターを使用して他のプロジェクトを操作するときはいつでも、追加したパスを通じてこのスタブライブラリにアクセスできるようになります。

    スタブパッケージをインストールする

    より広範囲に使用するには、スタブパッケージを作成して pypi リポジトリにアップロードできます。 詳細については、 Python プロジェクトガイドのパッケージ化(英語)を参照してください。 PEP-561(英語) サポートを使用すると、プロジェクトインタープリター用のスタブパッケージをインストールできます。

    1. パッケージをインストールします。 必要に応じて、 リポジトリの管理 をクリックして、スタブパッケージが存在するリポジトリを追加します。

    2. スタブパッケージはあらかじめ決まった名前の形式を持つため、検索フィールドに「-stubs」と入力して探します。

      スタブパッケージをインストールする
    3. パッケージのインストール をクリックしてインストールを完了します。

    2026 年 6 月 1 日