PyCharm 2021.1 ヘルプ

コードリファレンス情報

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

定義

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

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

Quick Definition popup

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

Jump to the selected definition

検索ツールウィンドウで定義を開くことができます。これを行うには、ポップアップの右上隅にある Options アイコンをクリックし、Open in Find tool window 検索ツールウィンドウで開くをクリックします。

編集用の定義のソースコードを開いてポップアップを閉じるには、Options アイコンをクリックしてから、Edit ソースの編集F4 )をクリックします。

型定義

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

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

    Viewing type definition in a popup

    編集用の定義のソースコードを開いてポップアップを閉じるには、Options アイコンをクリックしてから、Edit ソースの編集F4 )をクリックします。

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

CLion は、構文とエラーのハイライト、コードスタイルに従ったフォーマット、構造検証、コード補完、デバッグセッション中のオンザフライプレビュー(ライブ編集)またはコードエディターの専用プレビュータブを含む HTML の強力なサポートを提供します。HTML 仕様は、設定 / 環境設定の言語およびフレームワーク | スキーマと DTD ページのデフォルトの HTML 言語レベル設定で構成できます。デフォルトでは、W3C の HTML 5.0 仕様が想定されています。HTML ファイルを作成する:メ...

XML | PyCharm

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

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

PyCharm には定義済みのキーマップがいくつか含まれており、頻繁に使用するショートカットをカスタマイズできます。キーマップ構成を表示するには、設定 / 環境設定ダイアログを開き、キーマップを選択します。PyCharm は、環境に基づいて事前定義されたキーマップを自動的に提案します。使用している OS と一致することを確認するか、使用している別の IDE またはエディターからのショートカットと一致するものを選択してください(たとえば、Emacs)。定義済みのキーマップは変更できません。ショー...

JavaScript ライブラリを構成する | PyCharm

PyCharm では、ライブラリは、PyCharm が編集するプロジェクトコードから取得する関数とメソッドに加えて、PyCharm の内部知識に関数とメソッドが追加されたファイルまたはファイルのセットです。プロジェクトの範囲では、そのライブラリはデフォルトで書き込み保護されています。PyCharm は、コーディング支援(つまり、コード補完、構文ハイライト、ナビゲーション、ドキュメントの参照)を強化するためにのみライブラリを使用します。ライブラリはプロジェクトの依存関係を管理する方法ではありません...

インレイヒント | PyCharm

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

外部ドキュメント | PyCharm

外部ドキュメント:Python 外部ドキュメントを表示するには、最初にドキュメントの URL を構成する必要があります。PyCharm には、pandas、wx、kivy、PySide、PyQt5、PyQt4、matplotlib、pyramid、flask、gtk の URL が付属しています。事前定義された URL のセットを変更するか、プロジェクト設定 / 環境設定に新しい URL を追加できます。詳細は外部ドキュメントを設定するを参照してください。モジュール名この列には、を呼び出すか、...