PyCharm 2020.1ヘルプ

コード参照情報

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

定義

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

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

Quick Definition popup

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

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

パラメーター情報

パラメーター情報ポップアップはメソッドと関数呼び出しのパラメータ名を表示します。エディターに左括弧を入力するか、候補リストからメソッドを選択すると、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. Add cases for which you do not want to see the hints to the ブラックリスト section. To add a case, click the inline hint in your code, press Alt+Enter and select 現在のメソッドのヒントを表示しない

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

クイック・ドキュメント

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

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

  • Hover the mouse over the necessary symbol to view its documentation, or place the caret at the symbol and press Ctrl+Q ( 表示 | クイック・ドキュメント ).

    Press Ctrl+Q again to switch between the popup and the toolbar.

    Quick Documentation Window

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

Click icons actions more in the popup to change the font size, display the quick documentation toolbar, or go to the source code.

Disable quick documentation on mouseover

  • In the 設定/環境設定 dialog Ctrl+Alt+S , go to エディター | コード編集 | クイック・ドキュメント and clear the マウス移動でクイック・ドキュメントを表示する checkbox.

    You can also click icons actions more in the popup and disable the Show on Mouse Move option.

In this case, to view documentation for a symbol at caret, press Ctrl+Q or select 表示 | クイック・ドキュメント from the main menu.

外部ドキュメント

外部のドキュメントは、Webブラウザで必要な情報を開き、関連するシンボルにナビゲートし、同時に参照できるように情報を保持することができます。

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

外部ドキュメントの参照

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

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

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

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

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

    Adding a URL for numpy documentation

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

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

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

    Modifying the URL for the matplotlib documentation

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

生産性のヒント

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

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

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

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

最終更新日: 2020年4月8日

関連ページ:

HTML

PyCharmは、構文やエラーの強調表示、コードスタイル、構造の検証、コード補完、デバッグセッション中のオンザフライプレビュー(ライブ編集)などを含むHTMLの強力なサポートを提供します。HTML仕様は、PyCharm設定 のページのデフォルトHTML言語レベル設定で構成可能です。デフォルトでは、W...

XML

PyCharmは以下を含む強力なXML編集サポートを提供します:検証と構文強調表示。コード補完.、インデント( , ).、フォーマットはXMLコードスタイルに準拠しています。インテンション・アクション.、バインドされていない名前空間のインポート。コード構造の表示.、ソースコード のナビゲー...

JavaScriptライブラリを構成する

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

インレイ・ヒント

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

Python 外部ドキュメント

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

PyCharmリファクタリングチュートリアル

このチュートリアルの内容:このチュートリアルでは、有理数を利用する単純なクラスの例を使用して、PyCharmで利用可能ないくつかのリファクタリングを示します。前提条件:次の前提条件が満たされていることを確認してください。PyCharmバージョン2016.2以降で作業しています。プロジェクトはすでに作...