スタブ

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

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

2. 新規 Python ファイルダイアログで、Python スタブを選択し、ファイル名を指定します。ファイル名は、実装ファイルの名前と同じにする必要があります。

   

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

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

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

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

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

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

   

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

   

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

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

スタブを再利用

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

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

   

2. プロジェクトインタープリターダイアログで をクリックしてすべて表示を選択し、開いたプロジェクトインタープリターダイアログで をクリックします。

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

   

4. プロジェクトをインスペクションします。スタブファイルのあるディレクトリがライブラリルートとしてマークされました。

   

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

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

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

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

2. スタブパッケージにはあらかじめ定義された名前形式があるため、検索フィールドに「-stubs」と入力して検索してください。

   

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