PyCharm 2024.1 ヘルプ

Python 統合ツール

このページを使用して、要件管理ファイル、デフォルトのテストランナー、ドキュメント文字列処理を構成します。

項目

説明

パッケージ要件ファイル

要件ファイルの名前を入力するか、参照ボタンをクリックし、パスの選択ダイアログを使用してファイルシステムから目的の要件ファイルを選択します。

Pipenv 実行可能ファイルのパス

このパスは、Python プロジェクトに Pipenv 環境を追加するために必要です。パスは、PATH 環境変数に追加された場合、システムによって自動検出できます。パスを見つけるには、OS 固有の pipenv インストール手順に従ってください。例:

  • C:\Users\jetbrains\AppData\Roaming\Python\Python37\Scripts\pipenv.exe (Windows)

  • /Users/jetbrains/.loca/bin/pipenv (macOS)

デフォルトテストランナー

テストケースのコンテキストメニューで実行を選択するたびに、PyCharm が提案するテスト実行 / デバッグ構成を選択します。

可能なオプションは次のとおりです。

  • ユニットテスト

  • pytest

  • Nosetests

  • Twisted Trial

Docstring フォーマット

PyCharm によって認識されるドキュメント文字列の形式を選択します。

選択した docstring 形式に応じて、PyCharm はスタブドキュメントのコメントを生成し、show quick documentation にテキストをレンダリングします。

  • 標準のテキスト形式 : 引用符を開いた後に Enter またはスペースを押すと、空のスタブが生成されます。クイックドキュメントはプレーンテキストとして表示されます。

  • reStructuredText: 引用符を開いた後に Enter またはスペースを押すと、reStructuredText(英語) 形式に従ってスタブドキュメントコメントが生成されます。クイックドキュメントは Docutils によってレンダリングされます。

  • Epytext: 引用符を開いた後に Enter またはスペースを押すと、スタブドキュメントコメントが epytext(英語) 形式に従って生成されます。クイックドキュメントは epydoc(英語) によってレンダリングされます。

  • NumPy : 引用符を開いた後に Enter または Space キーを押すと、NumPy(英語) 形式に従ってスタブドックコメントが生成されます。クイックドキュメントはナポレオン(英語)と Docutils によってレンダリングされます。

  • Google: 引用符を開いた後に Enter またはスペースを押すと、スタブドキュメントコメントが Google(英語) 形式に従って生成されます。クイックドキュメントはナポレオン(英語)と Docutils によってレンダリングされます。

すべての種類のドキュメント文字列機能:

  • ドキュメント文字列の適切な生成

  • インテンションアクションおよびクイックフィックスを適用した後のアップデート

  • コーディング支援

  • セクションヘッダーの自動補完

docstring に提供される情報は、コードインサイトに使用されることに注意してください。

py_docstrings.png

docstrings の Python コードを分析する

このチェックボックスが選択されている場合、PyCharm はコード例をハイライトし、構文チェックとコードインスペクションを実行します。

このチェックボックスが選択されていない場合、docstring 内のコードフラグメントは分析されません。

stdlib の外部ドキュメントをレンダリングします。

表示 | クイックドキュメントhttp://docs.python.org(英語) の標準ライブラリ関数のドキュメントを表示することができます。

Sphinx 作業ディレクトリ

.rst ファイルを含むディレクトリへのパスをここで指定します。

.txt ファイルを reStructuredText として扱う

このチェックボックスをオンにすると、拡張子が .txt のファイルは拡張子が .rst のファイルと同じようにハイライトされます。

関連ページ:

パス選択ダイアログ

このダイアログを使用して、さまざまな状況でファイルまたはフォルダーの場所を指定します。たとえば、実行する実行可能ファイル、使用する構成ファイル、テストまたはインスペクション結果をエクスポートするファイルなどを指定します。ダイアログ名と使用可能な機能は、現在実行しているタスクによって異なります(通常、不適切な機能は無効になっています)。例: 状況に応じて、1 つのアイテムのみ、またはいくつかのアイテムを選択できる場合があります。1 つまたは複数のフォルダーを選択できるが、1 つまたは複数のファイル...

Pipenv 環境を構成する

Pipenv は、Python プロジェクトの仮想環境を作成するために必要なすべての手段を提供するツールです。パッケージをインストールまたはアンインストールすると、Pipfile ファイルを介して自動的にプロジェクトパッケージが管理されます。Pipenv は、確定的なビルドを生成し、作業環境のスナップショットを作成するために使用される Pipfile.lock ファイルも生成します。これは、プロジェクトの要件とパッケージのバージョンが重要である場合、セキュリティに敏感なデプロイにとって特に役立つ可能性が...

コードリファレンス情報

このセクションでは、シンボルの定義を表示し、ドキュメント参照を表示し、ビューパラメーター情報機能を使用する方法について説明します。パラメーター情報:パラメーター情報ポップアップには、メソッド呼び出しと関数呼び出しのパラメーターの名前が表示されます。PyCharm は、エディターで左括弧を入力するか、候補リストからメソッドを選択すると、1 秒 (1000 ミリ秒) 以内に、使用可能なすべてのメソッドシグネチャーを含むポップアップを自動的に表示します。ポップアップが閉じている場合、または IDE...

外部ドキュメント

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

リモート SSH 外部ツール

このページでは、リモート外部ツールで行うことができる設定について説明します。外部ツールの追加と使用の詳細については、「外部ツール」を参照してください。ツールバーボタンを使用して、使用可能な外部ツールのリストを管理します。保持したいがメニューで使用できないツールとグループのチェックボックスをオフにします。追加新しい外部ツールを追加します。除去選択したツールまたはグループを削除します。編集選択したツールを編集します。アップ選択したツールをリスト内で上に移動します。ダウン選択したツールをリスト内で下に...