PyCharm 2019.2ヘルプ

入門

PyCharmはPython専用の開発統合環境(IDE)であり、Python開発者に幅広い不可欠なツールを提供し、密接に統合されて生産的なPython、Web、およびデータサイエンスの開発に便利な環境を作成します。

PyCharm の使い方

PyCharm のエディション

PyCharmには、ProfessionalCommunity、およびEducational (Edu:教育)の3つのエディションがあります。CommunityおよびEduエディションはオープンソースのプロジェクトであり、無料ですが、機能は少ないです。PyCharm Eduはコースを提供し、Pythonを使用したプログラミングの学習に役立ちます。Professionalエディションは有償であり、優れたツールと機能のセットを提供します。詳細については、エディション比較マトリックス(英語)を参照してください。

サポートされる言語

PyCharmを使用すると、Pythonでアプリケーションを開発できます。

  • Python 2 : バージョン2.7

  • Python 3 : バージョン3.5からバージョン3.8まで

さらに、Professionalエディションでは、Django、Flask、およびPyramidアプリケーションを開発できます。また、HTML(HTML5を含む)、CSS、JavaScript、およびXMLを完全にサポートしています。これらの言語はプラグインを介してIDEにバンドルされており、デフォルトでオンになっています。他の言語およびフレームワークのサポートは、プラグインを介して追加することもできます(macOSユーザーの場合は設定 | プラグイン またはPyCharm | 環境設定 | プラグインにアクセスして、詳細を確認するか、最初のIDEの起動時に設定します)。

サポートされるプラットフォーム

PyCharmは、Windows、macOS、およびLinuxで動作するクロスプラットフォームIDEです。システム要件を確認します。

要件

最小

推奨

RAM

4 GBの空きRAM

8 GBの総システムRAM

ディスク容量

2.キャッシュ用に5 GBともう1 GB

5 GB以上の空き容量があるSSDドライブ

モニターの解像度

1024x768

1920×1080

オペレーティング・システム

以下の公式にリリースされた64ビットバージョン:

  • Microsoft Windows 7 SP1以降

  • macOS 10.11以降

  • Gnome、KDE、またはUnity DEをサポートするすべてのLinuxディストリビューション

プレリリース版はサポートされていません。

最新の64ビットバージョンのWindows、macOS、またはLinux (たとえば、Debian、Ubuntu、RHELなどです。)

PyCharmのインストールに関する支援が必要な場合は、インストール手順を参照してください: PyCharmをインストールする

PyCharmを使ってPythonで開発を始めるには、PyCharmをダウンロードし、インストールして起動する必要があります。(プラットフォームによって異なる)。

ステップ 1. PyCharmでプロジェクトを開く/作成する

なぜプロジェクトが必要なのですか?

PyCharmですることはすべて、プロジェクトのコンテキスト内で行われます。これは、コーディング支援、一括リファクタリング、コーディングスタイルの一貫性などの基盤として機能します。

IDE内のプロジェクトで作業を開始するには、次の3つのオプションがあります。

既存のプロジェクトを開く

コンピューターに保存されている既存のプロジェクトの1つを開くことから始めます。ようこそ画面の最近のプロジェクトの一覧からプロジェクトを選択するか、開く をクリックします。

Welcome screen

それ以外の場合は、既存のソースファイル用のプロジェクトを作成できます。ファイルメニューの 開く コマンドを選択し、ソースが存在するディレクトリーを指定します。PyCharmはあなたのソースからあなたのためにプロジェクトを作成します。詳細はセクション既存のソースコードからプロジェクトをインポートするを参照してください。

バージョン管理から既存のプロジェクトをチェックアウトする

VCSストレージまたはリポジトリからソースをダウンロードすることもできます。Git(GitHub)、Mercurial、Subversion、Perforce(Professionalエディションのみでサポート)を選択し、資格情報を入力してストレージにアクセスします。

次に、ソースへのパスを入力し、リポジトリをローカルホストにクローンします。

Clone a repository

詳細はセクションバージョン管理を参照してください。

最初からプロジェクトを作成する

  1. プロジェクトを作成するには、次のいずれかを実行します。

    • メインメニューから、ファイル | 新規プロジェクトを選択します。

    • ようこそ画面で、新規プロジェクトの作成をクリックします。

    新規プロジェクトダイアログが開きます。

  2. 新規プロジェクトダイアログで、プロジェクト名とその場所を指定します。ダイアログは、PyCharmエディションによって異なる場合があります。

    Creating a new project

    Creating a PyCharm helps implement new project

  3. 次に、Expand the node をクリックしてプロジェクト・インタープリターノードを展開し、対応するラジオボタンをクリックして新しい環境または既存のインタープリターを選択します。以下の手順は、選択によって異なります。

    • 次の環境を使用 : このオプションが選択されている場合は、仮想環境を作成するために使用するツールを選択してください。そのためには、リストをクリックしてVirtualenvPipenv、またはCondaを選択します。

      次に、新しい仮想環境の場所とベースインタープリターを指定します。必要に応じて、グローバル site-packages を継承するすべてのプロジェクトで使用可能にするチェックボックスをクリックします。

    • 既存インタープリター : このオプションが選択されている場合は、リストから目的のインタープリターを選択するか、(目的のインタープリターが見つからない場合) Open をクリックしてインタープリターを選択します。詳細はPythonインタープリターを設定するを参照してください。

新しいプロジェクトが作成されます。

Sample Python project

Pythonファイルの作成

プロジェクトツールウィンドウでプロジェクトルートを選択してから、メインメニューからファイル | 新規 ...を選択するか、Alt+Insertを押します。

Create a Python file

ポップアップからオプションPython ファイルを選択し、新しいファイル名を入力します。

Creating a new Python file

PyCharmは新しいPythonファイルを作成し、編集用に開きます。

New Python file

プロジェクトインタープリターを設定する

新しいプロジェクトを作成するときは、プロジェクトインタープリターを追加して設定する必要があります。設定/環境設定ダイアログ(Ctrl+Alt+S)で、プロジェクト・インタープリターをクリックし、次に Add project interpreterをクリックし、追加 ...を選択します。プロジェクトの詳細に応じて、以下を選択できます。

ステップ 2. 周囲を見る

初めてPyCharmを起動したとき、または開いているプロジェクトがないときは、ようこそ画面が表示されます。プロジェクトの作成またはオープン、バージョン管理からのプロジェクトのチェックアウト、ドキュメントの表示、およびIDEの構成など、IDEへの主な入り口を紹介します。

プロジェクトを開くと、メインウィンドウがいくつかの論理領域に分割されて表示されます: ここで主要なUI要素を見てみましょう:

Project view, Editor, and Tool Windows
  1. 左側のプロジェクト・ビューにプロジェクトファイルが表示されます。

  2. エディターの右側にあり、実際にコードを書いています。開いているファイル間を簡単に移動するためのタブがあります。

  3. エディター上のナビゲーション・バーを使用すると、アプリケーションを素早く実行してデバッグすることができます。また、基本的なVCS アクションを実行できます。

  4. 左ガターは、エディターの横にある縦のストライプで、ブレークポイントを表示し、定義/宣言のようにコード階層をナビゲートする便利な方法を提供します。また、回線番号と回線ごとのVCS履歴も表示されます。

  5. エディターの右側にある右ガター。PyCharmは常にコードの品質を監視し、常にコードインスペクションの結果を正しいガターに表示します。エラー、警告など。右上隅のインジケーターは、ファイル全体に対するコードインスペクションの全体的なステータスを示します。

  6. ツール・ウィンドウはワークスペースの下部と側面に取り付けられた特殊なウィンドウで、プロジェクト管理、ソースコードの検索とナビゲーション、バージョン管理システムとの統合などの一般的なタスクへのアクセスを提供します。

  7. ステータスバーはあなたのプロジェクトとIDE全体のステータスを示し、ファイルエンコーディング、行セパレーター、インスペクションプロファイルなどのような様々な警告と情報メッセージを表示します。プロジェクトインタープリターの設定にすばやくアクセスすることもできます。

また、PyCharmウィンドウの左下隅にあるステータスバーには、ボタン Show tool window bars または Hide tool window barsが表示されます。このボタンは、ツールウィンドウバーの表示を切り替えます。このボタンの上にマウスポインタを置くと、現在利用可能なツールウィンドウのリストが表示されます:

Tool window quick access

ツールウィンドウの表示と非表示の詳細については、ユーザーインターフェースの概要ツールウィンドウバーを表示または非表示にするページを参照してください。

ステップ 3. 環境をカスタマイズする

IDEを自由に微調整して、ニーズに完全に合ったものになるようにします。ファイル | 設定 (macOSユーザーの場合はPyCharm | 環境設定)にアクセスして、使用可能なカスタマイズオプションのリストを確認してください。

外観

最初に微調整するのは、一般的な「ルック・アンド・フィール」です。ファイル | 設定 | 外観および振る舞い | 外観(macOSユーザーの場合はPyCharm | 環境設定 | 外観および振る舞い | 外観)を選択して、IDE テーマを選択します:デフォルトのライトテーマ、またはより暗い設定を希望する場合はDarcula。

エディター

ファイル | 設定 | エディター(macOSユーザーのためのPyCharm | 環境設定 | エディター)で利用可能な多くのページはエディターの振る舞いのあらゆる面を調整できます。ここでは、一般的な設定(ドラッグアンドドロップの有効化、スクロール設定など)から、使用可能な各言語およびユースケースの色設定、タブおよびコードの折りたたみ設定、コード補完の動作まで、さまざまなオプションを利用できます。そして後置テンプレートさえも。

詳細はセクションプロジェクトとIDEの設定を参照してください。

コード・スタイル

コード・スタイルファイル | 設定 | エディター | コード・スタイル(macOSユーザーの場合はPyCharm | 環境設定 | エディター | コード・スタイル)で各言語に定義できます。独自のコーディングスタイルスキームを作成して保存することもできます。

Code style settings

詳細は、コードスタイルの設定およびコード品質支援のヒントとコツ、またはコードをきれいに見せる方法を参照してください。

キーマップ

PyCharmはキーボード中心のアプローチを採用しています。つまり、IDEで可能なすべてのアクションがキーボードショートカットにマッピングされています。

使うキーボードショートカットのセットはあなたの最も親密な習慣の一つです - あなたの指はキーの特定の組み合わせを「覚えて」い、この習慣を変えることはされるより簡単に言われます。PyCharmはデフォルトのキーマップ(メインメニューからヘルプ | キーマップ・リファレンスを選択)を提供し、あなたのコーディングを本当に生産的で便利にします。ただし、ファイル | 設定 | キーマップ変更することはいつでも変更できます(macOSユーザーの場合はPyCharm | 環境設定 | キーマップ)。

事前定義されたキーマップ(Emacs、Visual Studio、Eclipse、NetBeansなど)もあり、既存のキーマップに基づいて独自のキーマップを作成することもできます。

vi / Vimで最も生産的に感じるなら、エミュレーションモードはあなたに両方の長所を与えます。IDEでIdeaVimプラグインを有効にしてvimキーマップを選択します。

詳細はセクションキーボードショートカットの設定を参照してください。

ステップ 4. スマートアシスタンスによるコード

PyCharmは重要なことに集中できるようにルーチンを処理します。貴重な時間を無駄にすることなく、エラーのないアプリケーションを作成するには、次のコーディング機能を使用します。

コード補完

コード補完は、作業しているファイルの種類に関係なく、時間を節約してくれます。

基本補完機能は、名前を入力して即座に名前を入力するときに機能します。

スマート型補完機能は、現在作業中のコンテキストを分析し、その分析に基づいてより正確な提案を提供します。

Smart code completion

インテンション・アクション

PyCharmは現在何をしているかに注目し、あなたの時間をより節約するためにインテンションアクションと呼ばれるスマートな提案をします。電球で示されて、インテンション行動は正しいことに自動的な変化を適用することを可能にしました(間違っているかもしれないコードのための速い修正を提供するコードインスペクションと対照的に)。コンストラクターにいくつかのパラメータとフィールド初期化子を追加するのを忘れましたか? PyCharmでは問題ありません。電球をクリックして(または Alt+Enterを押して)推奨されるオプションの1つを選択します。

Intention Action

使用可能なインテンションアクションの全リストは、macOSユーザーの場合はファイル | 設定 | エディター | インテンションまたはPyCharm | 環境設定 | エディター | インテンションにあります。

ステップ 5. コードをきれいに保つ

PyCharmはあなたのコードを監視し、正確かつ清潔に保ちます。潜在的なエラーと問題を検出し、クイックフィックスを提案します。

IDEが未使用のコード、無限ループ、およびあなたの注意を必要とする他の多くのものを見つけるたびに、電球が表示されます。それをクリックするか、Alt+Enterを押して修正を適用します。

利用可能なインスペクションの完全なリストは、設定 | エディター | インスペクション(またはmacOSユーザーの場合はPyCharm | 環境設定 | エディター | インスペクション)にあります。それらのいくつかを無効にするか、他を有効にして、さらに各インスペクションの重大度を調整します。それをエラーと見なすべきか、単なる警告と見なすべきかを決めます。

ステップ 6. いくつかのコードを生成する

PyCharmで利用可能なコード生成オプションを使用すると、コードの記述がはるかに簡単かつ迅速になります。コード | 生成メニュー Alt+Insert は、使用箇所からシンボルを作成するのに役立ち、いくつかの機能をオーバーライド/実装することを提案します。

Generate code

ライブテンプレート(コード | ライブ・テンプレートの挿入を選択するか Ctrl+Jを押す)を使用してコード構造全体を作成します。設定/環境設定ダイアログ(Ctrl+Alt+S)(macOSユーザーの場合は設定 | エディター | ライブ・テンプレートまたはPyCharm | 環境設定 | エディター | ライブ・テンプレート)で、すぐに使用できるライブテンプレートを参照できます。

あなたの開発にとって特に重要な何かを欠いていると思うなら、独自のものでこのテンプレートのセットを拡張してください。また、コードを完全な構成要素で素早く囲むことを検討してください(コード | 囲むを選択するか Ctrl+Alt+Tを押します。例: if ステートメントを選択します。

Surround code

得るでしょう:

Surrounded code

ステップ 7. あなたの方法を見つける

プロジェクトが大きいとき、または他の誰かのコードを操作しなければならないときは、探しているものを素早く見つけてコードを詳しく調べることが重要です。これが、PyCharmがどんなに複雑なコードでも自分のやり方を見つけるのに役立つ一連のナビゲーションおよび検索機能を備えている理由です。

これらの検索機能を使用すると、現在開いているファイル Ctrl+Fまたはプロジェクト全体 Ctrl+Shift+Fの両方で、コードの断片を見つけて置き換えることができます。

使用箇所を検索する

特定のシンボルが使用されている場所を見つけるために、PyCharmは使用箇所の検索 Alt+F7を介したフルスケール検索を提案します。

Find usages

プロジェクトのナビゲーション

インポートや呼び出しの階層を使って、ファイル構造を見るだけで多くのことを知ることができます:

File structure

また、次の場所に移動できます。

左側のガターにあるアイコンもナビゲーションに役立ちます:

タイムラインをナビゲートする

プロジェクトでのすべてのアクティビティを記憶して、PyCharmは最近使ったファイル Ctrl+E または最近変更したファイル Shift+Alt+Cに簡単にナビゲートできます。

変更履歴を確認するには、戻る/進むナビゲーション(Ctrl+Alt+Left / Ctrl+Alt+Right)を使用するか、最後の編集場所 Ctrl+Shift+Backspaceに移動してください。

どこでも検索

探しているものについて一般的な考えがある場合は、既存のナビゲーション機能のいずれかを使用して、対応する要素を見つけることができます: しかし、本当にあらゆる面で何かを探したいと思ったらどうしますか?答えはどこでも検索を使用することです!

それを試すには、ウィンドウの右上にある虫めがねのボタンをクリックするか、ダブルシフト(Shiftを2回押して)を呼び出してください。

search everything window

ステップ 8. 実行、デバッグ、テスト

コードを操作して何ができるのかを発見したら、今度はアプリを実行、デバッグ、テストしましょう。

実行

アプリケーションを実行する最も簡単な方法は、エディターでその背景を右クリックしてから、コンテキストメニューから実行 <名前>を選択することです。

Running code

Pythonスクリプトに __main__ 句が含まれている場合は、左のガターで Run icon ボタンをクリックして、目的のコマンドを選択します。

実行構成

PyCharmを使用して実行、デバッグ、またはテスト操作を実行する場合は、常にそのパラメータを使用して、既存の実行/デバッグ構成のいずれかに基づいてプロセスを開始します。

初めてアプリケーションを実行すると、PyCharmは自動的に一時的な実行/デバッグ構成を作成します。デフォルトのパラメータを指定または変更して永続的な実行 / デバッグ設定として保存するように変更できます。

使用可能なすべてのオプションを表示するには、実行/デバッグ構成ダイアログ実行 | 構成の編集を開きます: 例:ビルド段階の前後にいくつかのスクリプトを実行したい場合は、外部ツールを作成することで簡単にこれを行うことができます:

Run/Debug configuration

設定を実行するには、Shift+F10を押します。

デバッグ

アプリケーションはランタイムエラーに遭遇しますか?その原因を突き止めるためには、デバッグをする必要があります。PyCharmはすべてのプラットフォームでデバッガをサポートしています。

デバッグは、プログラムの実行を中断するブレークポイントを配置することから始まり、プログラムデータを探索することができます。ブレークポイントを表示させたい行の左のガターをクリックするだけです。

アプリケーションのデバッグを開始するには、Shift+F9を押します。次に、プログラム実行のステップ(実行メニューまたはデバッグツールウィンドウの利用可能なオプションを参照)を実行し、任意の式を評価し、監視を追加し、変数に手動で値を設定します。

Debug tool window

詳細はセクションデバッグを参照してください。

テスト

アプリケーションをテストすることをお勧めします。PyCharmは、できるだけ簡単に行うことができます。

PyCharmを使用すると、次のことができます。

数字については、テストランナータブのセクションを参照してください。

PyCharmはPythonの主要なテストフレームワークをすべてサポートしています:

これらのフレームワークのそれぞれについて、PyCharmは独自の実行/デバッグ構成を提供します。

詳細については、チュートリアルステップ 3. 最初のPythonアプリケーションをテストするテストを実行するセクションを参照してください。

ステップ 9. ソースコードをバージョン管理に置く

VCS

ソースコードをバージョン管理下に置いている場合、PyCharmがGit(またはGitHub)、Mercurial、Perforce(Professionalエディションのみでサポート)、Subversionなどの多くの一般的なバージョン管理システムと統合されることを知ってうれしいでしょう。特定のVCSに固有の資格情報と設定を指定するには、設定 | バージョン管理(またはmacOSユーザーの場合はPyCharm | 環境設定 | バージョン管理)に移動します。

VCSメニューは、使用可能なコマンドについての手がかりを与えます。例:ローカルの変更ビュー:VCS | 変更の表示(または単に Alt+9を押してください)から変更を確認し、コミットし、変更リストを作成できます。また、エディターの上にあるナビゲーションバーのVCSの基本コマンドもいくつか見つかります。

Version Control System

詳細はセクションバージョン管理を参照してください。

ローカル・ヒストリー

伝統的なバージョン管理に加えて、ローカルヒストリーを使うことができます。ローカル・ヒストリーを使用すると、PyCharmはソースコードに加えた変更、リファクタリングの結果などを自動的に追跡します。

ローカル・ヒストリーは常に有効です。ファイルまたはフォルダーを表示するには、VCS | ローカル・ヒストリー | ヒストリーの表示を選択してローカル・ヒストリーを起動します。変更内容を確認したり、元に戻したり、パッチを作成したりできます。

ステップ 10: リモート開発

PyCharmでは、リモートに配置されたプロジェクトインタープリターを使用できます。設定/環境設定ダイアログ(Ctrl+Alt+S)で、ページプロジェクト・インタープリターを選択し、Interpreter settingsをクリックして)追加を選択します。

Add an interpreter

次のリモートインタープリターを追加して設定できます。

まず、ローカルアプリケーションを一部のリモートサーバーにデプロイできます。デプロイサーバーについては、Webサーバーとの同期の構成を参照してください。アプリケーションをデプロイすると、リモートで実行、デバッグ、テストを行うことができます。PyCharmはローカルとリモートフォルダーを比較し、ローカルコピーをサーバー上にデプロイされたものと同期させますにも役立ちます。

ステップ 11. データベース

既に気づいたことがあるように、さまざまなタイプのプロジェクト(Djangoなど)を作成するには、データソースが必要です。また、ソース・コードにSQL文を挿入することも可能です。

PyCharmでは、データベースを作成することはできませんが、データベースを管理および照会するための機能が用意されています。特定のデータベースへのアクセスが許可されると、PyCharm内でデータベースの構造を反映した1つ以上のデータソースを設定し、データベースアクセスクレデンシャルを保存できます。この情報に基づいて、PyCharmはデータベースへの接続を確立し、そこに含まれる情報を検索または変更する機能を提供します。

データベースへのアクセスは、データベースツールウィンドウ表示 | ツール・ウィンドウ | データベース)によって提供されます。このツールウィンドウでは、データベースを操作できます。データベースのデータ構造を表示および変更したり、関連する他のタスクを実行したりすることができます。

DB tool window

詳細はデータベース・ツールおよび SQLを参照してください。

ステップ 12. それだけです! 先に進んで開発を楽しみましょう!

PyCharmの重要な機能のこの簡単な概要により、素早く開始できることを願っています。開発者の生活をより簡単で楽しいものにするための重要な機能がたくさんあり、ソースコードがよりすっきりしてきれいになります。ここで最初のいくつかのステップを踏み、ちょうどいいタイミングだと感じたら深く掘り下げてみてください。PyCharmを楽しみましょう。

質問がある場合は、当社のディスカッションフォーラム(英語)ツイッター(英語)、およびブログ(英語)にアクセスして、ニュース、更新、役立つヒントやコツを見つけてください。また、サポートチーム(英語) )やPyCharm 課題追跡(英語)システムに課題を報告することをheしないでください。

最終更新日: 2019年11月6日

関連ページ:

PyCharmをインストールする

PyCharmは、Windows、macOS、およびLinuxオペレーティングシステムで一貫したエクスペリエンスを提供するクロスプラットフォームIDEです。PyCharmはデフォルトでは英語です。日本語化したい場合は、インストール後、初めて起動する前に日本語化マニュアルを参照してください。PyCha...

プロジェクトのオープン、再オープン、クローズ

PyCharmでは、複数のプロジェクトを異なるウィンドウで同時に開くことができます。デフォルトでは、別のプロジェクトを開いている間にプロジェクトを開くたびに、PyCharmは同じウィンドウでプロジェクトを開くか新しいウィンドウでプロジェクトを開くかを選択するように求めます。必要に応じて、システム設定...

既存のソースコードからプロジェクトをインポートする

外部で、つまり別のIDEまたは専用のエディターで作成された既存のソースコードを中心にプロジェクトを設定できます。PyCharmはコードベースを分析し、設定を含む.ideaディレクトリーを追加します。既存のソースコードからプロジェクトを作成する:既存のソースコードから新しいプロジェクトを作成するにはメ...

バージョン管理

VCS 操作のポップアップ( または)を使用すると、VCS関連のコマンドをすばやく呼び出すことができます。ポップアップ内のアクションのリストは、現在有効になっているVCSによって異なります。VCS 操作ポップアップコマンドのリストは構成可能です-PyCharm設定 のページで追加または削除できます。...

ようこそ画面

プロジェクトが開かれていない場合、PyCharmはようこそ画面を表示します。例:PyCharmを初めて実行したとき、またはプロジェクトの唯一開いているインスタンスを閉じたとき。この画面から、新しいプロジェクトを作成したり、バージョン管理から既存のプロジェクトをインポート、開いたり、チェックアウトした...

仮想環境を構成する

PyCharmでは、virtualenvツールを使用してプロジェクト固有の分離された仮想環境を作成できます。仮想環境の主な目的は、他のPythonプロジェクトに関係なく、特定のプロジェクトの設定と依存関係を管理することです。virtualenvツールはPyCharmにバンドルされているため、ユーザー...