PyCharm 2020.3 ヘルプ

コード参照情報

このセクションでは、シンボルの定義を表示し、ドキュメント参照を表示し、ビューパラメーター情報機能を使用する方法について説明します。

定義

PyCharm では、タグ、クラス、フィールド、メソッド、関数などのシンボルがプロジェクトでどのように定義されているかを確認することができます。この目的のために、IDE にはクイック定義ポップアップがあります。

  • シンボルの定義を表示するには、エディターでシンボルを選択し、Ctrl+Shift+I を押します(または表示 | クイック定義をクリックします)。

Quick Definition popup

または、Ctrl キーを押したまま、任意の記号にカーソルを合わせます。PyCharm は、シンボルをリンクとして表示し、その定義をツールチップに表示します。このリンクをクリックして、シンボルの定義にジャンプします。

Jump to the selected definition

右上隅のOpen in Find tool windowアイコンをクリックして、検索ツールウィンドウで定義を開きます。編集用に定義のソースコードを開き、ポップアップを閉じるには、Edit Sourceアイコン F4 をクリックします。ポップアップを閉じずに定義を開くには、Show Source Ctrl+Enter をクリックします。

型定義

クイック型定義機能を使用すると、編集中のコードから切り替えることなく、変数、フィールド、メソッド、またはその他のシンボルの型定義をポップアップで表示できます。

  • タイプ定義を表示するシンボルにキャレットを置き、表示 | クイック型定義を選択します。

    Viewing type definition in a popup

PyCharm には、このアクションのデフォルトのキーボードショートカットはありませんが、設定で手動で構成できます。カスタムショートカットの構成方法の詳細については、キーボードショートカットを設定するを参照してください。

パラメーター情報

パラメーター情報ポップアップはメソッドと関数呼び出しのパラメーター名を表示します。エディターに左括弧を入力するか、候補リストからメソッドを選択すると、PyCharm は 1 秒以内に使用可能なすべてのメソッドシグネチャーを含むポップアップを自動的に表示します(1000 ミリ秒)。

ポップアップが閉じている場合、または IDE がポップアップを自動的に表示しないように構成されている場合は、ポップアップを明示的に呼び出すことができます。これを行うには、Ctrl+P を押します(または表示 | パラメーター情報をクリックします)。

View Parameter Info

完全なメソッドまたは関数のシグネチャーを表示する

デフォルトでは、パラメーター情報ポップアップには簡単なシグネチャーが表示されます。メソッド名と返される型を含む完全なシグネチャーを表示するように IDE を設定できます。

  • 設定 / 環境設定ダイアログ Ctrl+Alt+Sエディター | 一般 | コード補完に移動し、完全なメソッドシグネチャーを表示するチェックボックスを選択します。

必要なサードパーティの JavaScript ライブラリをプロジェクトのソースパスに含めてください。そうしないと、パラメーターの名前は表示されません。

パラメーター情報ポップアップを設定する

  1. 設定 / 環境設定ダイアログ Ctrl+Alt+S で、エディター | 一般 | コード補完に移動します。

  2. パラメーター情報のポップアップをミリ秒単位で表示するフィールドに、ポップアップが表示されるまでの時間をミリ秒単位で指定します。

ポップアップが自動的に表示されないようにするには、パラメーター情報のポップアップをミリ秒単位で表示するチェックボックスをオフにします。

インレイヒント

インレイヒントは、エディターに表示される特別なマーカーであり、呼び出されたメソッドが期待するパラメーターの名前など、コードに関する追加情報を提供します。他の型のヒントは、注釈、メソッドのパラメーター、使用箇所などについて通知します(言語によって異なります)。

一部のヒントはデフォルトで有効になっています。

設定 / 環境設定 | エディター | インレイヒントでインレイヒントを微調整できます。各タイプの機能の詳細な説明については、インレイヒントを参照してください。

パラメーターヒント例外リストを構成する

特定のメソッドのパラメーターヒントを表示したくない場合は、例外を使用してリストを構成できます。デフォルトでは、例外リストには多くの事前定義されたメソッドが含まれています。リストからメソッドを削除して、そのヒントを表示したり、新しいメソッドを追加してヒントをエディターで非表示にしたりできます。

  1. 設定 / 環境設定ダイアログ Ctrl+Alt+S で、エディター | インレイヒントを選択し、必要な言語をクリックします。

  2. 中央のセクションのリストでパラメーターのヒントを選択します。

    ヒントを構成するためのオプションが右側で使用可能になります。

  3. ヒントをブラックリストセクションに表示したくないメソッドを追加します。

  4. ヒントを表示したくないケースをブラックリストセクションに追加します。ケースを追加するには、コード内のインラインヒントをクリックし、Alt+Enter を押して現在のメソッドのヒントを表示しないを選択します。

  5. 変更を適用し、ダイアログを閉じます。

クイックドキュメント

クイックドキュメントポップアップを使用して、任意のシンボルまたはメソッドシグネチャーの情報を素早く取得できます。

PyCharm は、PEP-257(英語) に従って作成されたインラインドキュメントを認識します。

  • 必要な記号の上にマウスを移動してそのドキュメントを表示するか、記号にキャレットを置き、Ctrl+Q表示 | クイックドキュメント)を押します。

    もう一度 Ctrl+Q を押して、ポップアップとツールバーを切り替えます。

    Quick Documentation Window

    トップレベル要素(この例では math)または関連するタイプ(この例では float)のドキュメントをプレビューするには、ドキュメントトピックのリンクをクリックしてください。

ポップアップでthe Show Options Menu iconをクリックしてフォントサイズを変更するか、クイックドキュメントツールバーを表示するか、ソースコードに移動します。

マウスオーバー時にクイックドキュメントを無効にする

  • 設定 / 環境設定ダイアログ Ctrl+Alt+S で、エディター | コード編集 | クイックドキュメントに移動し、マウス移動でクイックドキュメントを表示するチェックボックスをオフにします。

    ポップアップでthe Show Options Menu iconをクリックして、マウス移動時に表示するオプションを無効にすることもできます。

この場合、キャレットにあるシンボルのドキュメントを表示するには、Ctrl+Q を押すか、メインメニューから表示 | クイックドキュメントを選択します。

外部ドキュメント

外部ドキュメントは、Web ブラウザーで必要な情報を開くため、関連するシンボルに移動し、同時にさらに参照できるように情報を保持できます。

PyCharm は SciPy、NumPy(英語)PyGTK(英語)、Python インタープリター用にインストールした他のモジュールのドキュメントを表示します。外部のドキュメントは、設定 / 環境設定の外部ドキュメントページで正しく設定する必要があります。

外部ドキュメントの参照

  • Web ブラウザーのキャレットにある記号のドキュメントを表示するには、Shift+F1 を押すか、メインメニューから表示 | 外部ドキュメントを選択します。

外部ドキュメントを見るには、まずドキュメントの URL を構成する必要があります。PyCharm には、pandas、wx、kivy、PySide、PyQt5、PyQt4、matplotlib、pyramid、flask、gtk の URL が付属しています。事前定義された URL のセットを変更するか、プロジェクト設定 / 環境設定に新しい URL を追加することができます。

外部ドキュメントを設定する

  1. 設定 / 環境設定ダイアログ Ctrl+Alt+Sツール | 外部ドキュメントを開きます。

    Configuring external documentation
  2. 新しいドキュメントの URL を追加するには、the Add buttonをクリックします。開いたダイアログで、モジュール名と対応する外部文書の URL を指定します。

    Adding a URL for numpy documentation

    外部文書がローカルにある場合は、それへのローカルパスを指定してください。

  3. 事前設定されている文書の URL を変更するには、ツール | 外部ドキュメントダイアログで文書モジュールを選択してダブルクリックするか、the Edit buttonをクリックします。

  4. URL パターンを設定するには、使用可能なマクロフィールドでマクロを選択して挿入ボタンをクリックします。

    Modifying the URL for the matplotlib documentation

    各文書モジュールはそれぞれ固有の構造を持っているため、マクロを追加するときは注意してください。

PyCharm では、変数または式の型をポップアップで表示できます。これは、コード要素に関する完全な情報が必要ない場合に役立ちます。

  • 必要なコード要素にキャレットを置き、Ctrl+Shift+P を押す(またはメインメニューから表示 | 型情報を選択する)。

生産性のヒント

ツールチップのテキストをクリップボードにコピーする

ツールチップのテキストをクリップボードにコピーするには、Alt (Linux の場合は Ctrl+Alt)を押しながらツールチップをクリックします。

コンテキスト情報を表示する

現在のメソッドまたはクラスの宣言が表示されていない場合は、Alt+Q を押すことでツールチップに表示できます。

関連ページ:

HTML

PyCharm は、構文やエラーのハイライト、コードスタイル、構造の検証、コード補完、デバッグセッション中のオンザフライプレビュー(ライブ編集)などを含む HTML の強力なサポートを提供します。HTML 仕様は、設定 / 環境設定の言語およびフレームワーク | スキーマと DTDページのデフォルト...

XML

PyCharm は、構造の検証、フォーマット、インデント(XML コードスタイルによる 、バインドされていない名前空間のインポート、コード構造の表示、タグのアンラップと削除、インスタンスドキュメントからのDTD ファイルとスキーマの生成を含む XML を強力にサポートします。構文およびエラーのハイ...

キーボードショートカットを設定する

PyCharm 標準のキーボードショートカット PDF は、公式ショートカット一覧 PDF 日本語版から入手できます。ローカルに保存しておいて活用しましょう。PyCharm には定義済みのキーマップがいくつか含まれており、頻繁に使用するショートカットをカスタマイズできます。キーマップ構成を表示するに...

JavaScript ライブラリを構成する

PyCharm では、ライブラリは、PyCharm が編集するプロジェクトコードから取得する関数とメソッドに加えて、PyCharm の内部知識に関数とメソッドが追加されたファイルまたはファイルのセットです。プロジェクトの範囲では、そのライブラリはデフォルトで書き込み保護されています。PyCharm

インレイヒント

インレイヒントは、エディターに表示される特別なマーカーであり、呼び出されたメソッドが期待するパラメーターの名前など、コードに関する追加情報を提供します。他の型のヒントは、注釈、メソッドのパラメーター、使用箇所などについて通知します(言語によって異なります)。インレイヒント設定では、ヒントで取得する情...

外部ドキュメント

Windows および Linux 用のmacOS の外部ドキュメント :外部ドキュメントを見るには、まずドキュメントの URL を構成する必要があります。PyCharm には、pandas、wx、kivy、PySide、PyQt5、PyQt4、matplotlib、pyramid、flask、gt...