クイックスタートガイド

サポートされている言語

PyCharm で Python の開発を始めるには、プラットフォームに応じて python.org から Python をダウンロードしてインストールする必要があります。

PyCharm は、以下の Python バージョンをサポートしています：

• Python 2: バージョン 2.7

• Python 3: バージョン 3.9 からバージョン 3.15 まで

さらに、 Pro モードでは、Django のサポート、Flask、Pyramid アプリケーションの開発もできます。 また、HTML（HTML5 を含む）、CSS、JavaScript、XML にも完全対応しています。これらの言語はプラグイン経由で IDE にバンドルされており、デフォルトで有効化されています。 他の言語やフレームワークもプラグインで追加できます（詳細や初回 IDE 起動時の設定方法は 設定 | プラグイン または macOS ユーザーは PyCharm | 設定 | プラグイン をご覧ください）。

既存プロジェクトを開く

まず、コンピューターに保存されている既存のプロジェクトを 1 つ 開きます。 'ようこそ' 画面の左側にある最近のプロジェクトリストから 1 つを選択するか、 オープン をクリックします。

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

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

VCS ストレージまたはリポジトリからソースをダウンロードすることもできます。 ようこそ画面で VCS から取得 をクリックし、Git（GitHub）、Mercurial、Subversion、Perforce（PyCharm Pro のみサポート）を選択します。

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

詳細については、 バージョン管理​ を参照してください。

新規プロジェクトを作成する

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

• ファイル | 新規プロジェクト へ

• ようこそ画面の左ペインで、 新規… をクリックします。

PyCharm では Python プロジェクトのみを作成できますが、PyCharm Pro では Web フレームワークプロジェクトを作成するためのさまざまなオプションがあります。

詳細は Python プロジェクトを作成する を参照してください。

新しいプロジェクトを作成するときは、プロジェクトで Python コードを実行するために Python インタープリターを指定する必要があります。 マシンで使用できるようにするには、少なくとも 1 つの Python のインストール(英語)が必要です。

新しいプロジェクトの場合、PyCharm は分離された 仮想環境: venv、 pipenv、 poetry 、または Conda を作成します。 作業中に、変更したり、新しいインタープリターを作成したりできます。 インタープリター用にインストールされたパッケージをすばやくプレビューし、 Python パッケージ ツールウィンドウで新しいパッケージを追加することもできます。

詳細は、 Python インタープリターを構成するを参照してください。

Python ファイルを作成する

コード補完

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

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

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

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

PyCharm はユーザーの作業内容を監視し、 インテンションアクションと呼ばれるスマートな提案でより多くの時間を節約します。 バルブで示されるインテンションアクションでは、 正しいコードに自動変更を適用できます (正しくない可能性のあるコードのクイックフィックスを提供するコードインスペクションとは対照的です)。 コンストラクターにいくつかのパラメーターとフィールド初期化子を追加するのを忘れていませんか ? PyCharm では問題ありません。 バルブをクリックして (または Alt+Enter を押して)、提案されたオプションのいずれかを選択します。

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

コードをきれいに保つ

PyCharm はコードを監視し、正確かつクリーンに保つよう努めます。 潜在的なエラーと問題を検出し、 クイックフィックスを提案します。

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

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

コードを生成する

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

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

開発に特に重要なものが欠落している場合は、このテンプレートセットを独自のもので拡張してください。 また、コードを完全な構造ですばやく 囲むことを検討してください（コード | 囲む を選択するか Ctrl+Alt+T を押します。 例: if ステートメントを使用:

基本的な検索

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

使用箇所を検索する

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

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

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

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

• 名前によるクラス、ファイル、シンボル。

• 宣言 Ctrl+B。

• ベースクラス / ベース関数 Ctrl+U.

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

タイムラインを移動する

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

変更履歴を確認するには、次のアクションを使用します。

• 戻る​ Ctrl+Alt+Left

• 進む​ Ctrl+Alt+Right

• Last Edit Location Ctrl+Shift+Backspace

アクションの検索

PyCharm には多くのスマートなアクションがあり、活用できます。 例えば、 アクション検索 Ctrl+Shift+A を使うと、アクション名の一部を入力するだけで、IDE が利用可能なオプション一覧を表示します。 次に、必要なアクションを選択してください：

どこでも検索

探したいもののおおよその内容が分かっている場合は、既存のナビゲーション機能のいずれかを使って対応する要素をいつでも見つけられます。 すべての隅々まで検索したい場合はどうすればよいでしょうか？ その答えは Search Everywhere を使うことです！

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

実行

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

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

スクリプトの実行は、 実行 ツールウィンドウで確認できます。

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

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

実行 / デバッグ構成 で実行 / デバッグ構成を調整する方法を参照してください。

デバッグ

アプリケーションで実行時エラーが発生していますか？ 原因を調べるにはデバッグが必要です。 PyCharm はすべてのプラットフォームでデバッガーに対応しています。

デバッグ は、実行を一時停止できるブレークポイントを設定し、プログラムデータを調べることから始まります。 ブレークポイントを設置したい行のガターをクリックするだけです。

アプリケーションのデバッグを開始するには、 Shift+F9 を押します。 続いて、プログラムの実行を段階的に進め（実行 メニューまたは デバッグツールウィンドウの利用可能なオプションを参照）、任意の式の評価、ウォッチの追加、変数の値の手動設定ができます。

詳細は、 デバッグを参照してください。

テスト​

アプリケーションのテストも大切であり、PyCharm はこれをできるだけ簡単に実施できるようサポートします。

PyCharm を使うと、次のことができます：

• テストを作成

• 特別な 実行 / デバッグ構成のテストを作成します。

• テストの実行 / デバッグ構成を使用して、IDE からテストを実行し、デバッグします。

• そして最後に、最も重要なこと - 実行ツールウィンドウの テストランナータブでテスト結果を確認できます：

  

番号の詳細については、「テストランナータブ 」セクションを参照してください。

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

• Unittest(英語)

• Doctest(英語)

• Nosetest(英語)

• pytest(英語)

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

詳細については、 最初の Python アプリケーションをテストする および テストの実行 を参照してください。

VCS​

ソースコードをバージョン管理下に置いている場合、PyCharm は多くの一般的な バージョン管理システム: Git（または GitHub）、Mercurial、Perforce（Pro モードのみ対応）、Subversion と連携できます。 特定の VCS に固有の認証情報や設定を指定するには、 設定 | バージョン管理 （macOS ユーザーの場合は PyCharm | 設定 | バージョン管理 ）を参照してください。

VCS メニューでは、どのようなコマンドが使用できるかがわかります。 例: ローカル変更ビュー: VCS | 変更の表示 (または単に Alt+9 を押す) から、行った変更の確認、コミット、変更リストの作成などを行うことができます。

また、メインウィンドウで基本的な VCS アクションも実行できます：

VCS ウィジェットから:

エディターの上のナビゲーションバーから:

詳細については、 バージョン管理​ を参照してください。

ローカル履歴

従来のバージョン管理に加えて、 ローカル履歴を使用できます。 ローカル履歴により、PyCharm はソースコードへの変更、リファクタリングの結果などを自動的に追跡します

ローカル履歴は常に有効です。 ファイルまたはフォルダーについて表示するには、 VCS | ローカル履歴 | 履歴の表示 を選択して ローカル履歴を表示します。 ここで、変更を確認したり、元に戻したり、パッチを作成したりできます。

外観

最初に調整したいのは全体的な外観です。 ファイル | 設定 | 外観と振る舞い | 外観 （macOS ユーザーは PyCharm | 設定 | 外観 & 振る舞い | 外観 ）で IDE テーマ を選んでください。ライトテーマや、暗い見た目が好みの場合は Darcula も選べます。

エディター

File | Settings | Editor （macOS ユーザーは PyCharm | 設定 | エディター ）配下の各ページから、エディターの動作を細かく調整できます。 ここでは一般設定（Drag'n'Drop の有効化やスクロール構成など）から、各言語やユースケースごとの色設定、タブやコードの折りたたみ、コード補完の動作、さらにはポストフィックステンプレートの設定まで、多くのオプションが利用できます。

詳細は、 PyCharm の設定を構成する を参照してください。

コードスタイル

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

詳細は コードスタイルの構成 と コード品質アシスタンスのヒントとトリック、もしくはコードをきれいに見せる方法？ をご参照ください。

キーマップ

PyCharm はキーボード重視の設計で、IDE 内のほぼすべてのアクションがキーボードショートカットに割り当てられています。

使い慣れた キーボードショートカットのセットは、手が覚える最も親しみ深い習慣のひとつです。そのため、いざ変更しようとしても簡単にはいかないものです。 PyCharm にはデフォルトのキーマップが用意されており（メインメニューから ヘルプ | キーボードショートカットの PDF書類へヘルプ | キーボードショートカット PDF を選択）、快適かつ生産的なコーディングをサポートします。 ただし、いつでも 設定変更は可能です。 File | Settings | Keymap （macOS ユーザーは PyCharm | 設定 | キーマップ ）に進んでください。

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

vi/Vim で最も生産性が高いと感じる場合は、エミュレーションモードで両方の長所を活用できます。 IDE で IdeaVim プラグインを有効にし、vim キーマップを選択します。

詳細については、 キーボードショートカットを設定する を参照してください。