PyCharm for Productive Python Development（ガイド）

この記事ではPyCharm Community Edition 2019.1を使用します。これはすべての主要プラットフォームで無料で利用できます。 プロフェッショナル機能に関するセクションのみがPyCharm Professional Edition 2019.1を使用します。

PyCharmの推奨インストール方法は、https://www.jetbrains.com/toolbox/app/[JetBrains Toolbox App]を使用することです。 その助けを借りて、異なるJetBrains製品または同じ製品の複数のバージョンをインストールし、更新、ロールバックし、必要に応じてツールを簡単に削除できます。 また、適切なIDEおよびバージョンでプロジェクトをすばやく開くこともできます。

ツールボックスアプリをインストールするには、JetBrainsのhttps://www.jetbrains.com/help/pycharm/installation-guide.html#toolbox[documentation]を参照してください。 OSに応じて、自動的に正しい指示が表示されます。 OSが正しく認識されなかった場合、右上のドロップダウンリストからいつでも見つけることができます。

https://files.realpython.com/media/pycharm-jetbrains-os-list.231740335aaa.png []

インストール後、アプリを起動し、ユーザー契約に同意します。 [ツール]タブの下に、使用可能な製品のリストが表示されます。 そこでPyCharmコミュニティを見つけて、[インストール]をクリックします。

https://files.realpython.com/media/pycharm-toolbox-installed-pycharm.cdcf1b52bc02.png []

ほら！ マシンでPyCharmを使用できます。 Toolboxアプリを使用したくない場合は、https://www.jetbrains.com/help/pycharm/installation-guide.html#standalone [PyCharmのスタンドアロンインストール]を実行することもできます。

PyCharmを起動すると、インポート設定のポップアップが表示されます。

https://files.realpython.com/media/pycharm-import-settings-popup.4e360260c697.png []

PyCharmは、これが新規インストールであることを自動的に検出し、[設定をインポートしない]を選択します。 _OK_をクリックすると、PyCharmがキーマップスキームの選択を求めます。 デフォルトのままにして、右下の[次へ：UIテーマ]をクリックします。

その後、PyCharmはDarculaと呼ばれるダークテーマまたはライトテーマを選択するように求めます。 好きなものを選択して、[次：ランチャースクリプト]をクリックします。

https://files.realpython.com/media/pycharm-set-ui-theme.c48aac8e3fe0.png []

このチュートリアルでは、ダークテーマDarculaを使用します。 link：＃using-plugins-and-external-tools-in-pycharm [plugins]として他のテーマを見つけてインストールするか、https://blog.codota.com/5-best-intellij-themes/を使用することもできます。 [インポートする]。

次のページで、デフォルトのままにして[Next：Featured plugins]をクリックします。 そこで、PyCharmはほとんどのユーザーがプラグインを使用したいので、インストールしたいプラグインのリストを表示します。 [_PyCharmの使用を開始する]をクリックすると、コードを作成する準備が整いました。

PyCharmでは、*プロジェクト*のコンテキストですべてを行います。 したがって、最初に行う必要があるのは、作成です。

PyCharmをインストールして開くと、ようこそ画面が表示されます。 _Create New Project_をクリックすると、_New Project_ポップアップが表示されます。

、width = 664、height = 480]

プロジェクトの場所を指定し、Project Interpreter_ドロップダウンを展開します。 ここでは、新しいプロジェクトインタープリターを作成するか、既存のプロジェクトインタープリターを再利用するかを選択できます。 _New environment using_を選択します。 そのすぐ横に、_Virtualenv _、 Pipenv_、または_Conda_のいずれかを選択するためのドロップダウンリストがあります。これらは、異なるプロジェクトに必要な依存関係を別々のPython環境を作成することで維持するのに役立つツールです。

好きなものを自由に選択できますが、このチュートリアルでは_Virtualenv_を使用します。 必要に応じて、環境の場所を指定し、システムからインストールされているPythonインタープリター（Python2.7やPython3.6など）のリストであるリストからベースインタープリターを選択できます。 通常、デフォルトで問題ありません。 次に、グローバルサイトパッケージを新しい環境に継承し、他のすべてのプロジェクトで使用できるようにするために、ボックスを選択する必要があります。 未選択のままにします。

右下の[作成]をクリックすると、新しいプロジェクトが作成されます：

また、PyCharmが各スタートアップで学ぶための1つのトリックを提供する小さな_Tip of the Day_ポップアップが表示されます。 このポップアップを閉じてください。

ここで、新しいPythonプログラムを開始します。 Macの場合は[.keys]＃Cmd + N＃、WindowsまたはLinuxの場合は[.keys]＃Alt + Ins＃と入力します。 次に、_Python File_を選択します。 メニューから[ファイル]→[新規]を選択することもできます。 新しいファイルに「+ guess_game.py +」という名前を付け、_OK_をクリックします。 次のようなPyCharmウィンドウが表示されます。

テストコードでは、ユーザーが推測する必要のある数字をプログラムが選択する単純な推測ゲームをすばやくコーディングしましょう。 推測ごとに、プログラムはユーザーの推測が秘密の数値よりも小さいか大きいかを判断します。 ユーザーが数字を推測すると、ゲームは終了します。 ゲームのコードは次のとおりです。

コピーして貼り付けるのではなく、このコードを直接入力します。 次のようなものが表示されます。

ご覧のとおり、PyCharmはhttps://www.jetbrains.com/pycharm/features/coding_assistance.html[Intelligent Coding Assistance]にコード補完、コード検査、オンザフライエラー強調表示、クイック修正提案を提供します。 特に、 `+ main `を入力してTabキーを押すと、PyCharmが ` main +`句全体を自動補完する方法に注意してください。

また、条件の前に「+ if 」を入力するのを忘れて「 .if 」を追加し、[。keys]＃Tab＃を押すと、PyCharmが「 if 」句を修正することに注意してください。 ` True.while +`でも同じことが言えます。 これはhttps://www.jetbrains.com/help/pycharm/settings-postfix-completion.html[PyCharmのPostfixの完了]であり、後方へのキャレットジャンプを減らすのに役立ちます。

ゲームのコーディングが完了したので、今度はゲームを実行します。

このプログラムを実行するには、次の3つの方法があります。

上記のオプションのいずれかを使用してプログラムを実行すると、ウィンドウの下部に[ツールの実行]ペインが表示され、コード出力に以下が表示されます。

https://files.realpython.com/media/pycharm-running-script.33fb830f45b4.gif []

推測された数字を見つけることができるかどうかを確認するために、少しゲームをプレイします。 プロのヒント：50から始めます。

番号を見つけましたか？ もしそうなら、番号を見つけた後に何か変なものを見たかもしれません。 お祝いのメッセージを出力して終了する代わりに、プログラムは最初からやり直しているようです。 これはバグです。 プログラムが最初からやり直される理由を見つけるために、プログラムをデバッグします。

最初に、行番号8の左側の空白スペースをクリックしてブレークポイントを配置します。

これは、プログラムが中断されるポイントになり、そこから何が悪かったのかを探り始めることができます。 次に、次の3つの方法のいずれかを選択してデバッグを開始します。

その後、下部に_Debug_ウィンドウが開きます：

https://files.realpython.com/media/pycharm-debugging-start.04246b743469.png []

以下の手順に従って、プログラムをデバッグします。

、width = 1092、height = 720]

おめでとうございます。 バグを修正しました。

単体テストなしでは信頼できるアプリケーションはありません。 PyCharmは、それらを非常に迅速かつ快適に作成および実行するのに役立ちます。 デフォルトでは、https://docs.python.org/3/library/unittest.html [+ unittest +]がテストランナーとして使用されますが、PyCharmはhttp：//www.pytestなどの他のテストフレームワークもサポートしています。 org/en/latest/[+ pytest +]、https://nose.readthedocs.io/en/latest/[+ nose +]、https://docs.python.org/3/library/doctest。 html [+ doctest +]、https://www.jetbrains.com/help/pycharm/tox-support.html [+ tox +]、およびhttps://twistedmatrix.com/trac/wiki/TwistedTrial [` トライアル `]。 たとえば、次のようにプロジェクトで `+ pytest +`を有効にできます。

この例では、デフォルトのテストランナー `+ unittest +`を使用します。

同じプロジェクトで、 `+ calculator.py `というファイルを作成し、次の ` Calculator +`クラスをその中に配置します。

PyCharmを使用すると、既存のコードのテストを非常に簡単に作成できます。 `+ calculator.py +`ファイルを開いた状態で、次のいずれかを実行します：

_Create New Test…_を選択すると、次のウィンドウが表示されます。

Target directory _、 Test file name_、および_Test class name_のデフォルトのままにします。 両方の方法を選択して、[_ OK_]をクリックします。 ほら！ PyCharmは自動的に `+ test_calculator.py +`というファイルを作成し、その中に次のスタブテストを作成しました：

以下のいずれかの方法を使用してテストを実行します。

すべてのテストが失敗したテストウィンドウが下部に表示されます。

左側にテスト結果の階層があり、右側に端末の出力があることに注意してください。

次に、コードを次のように変更して、 `+ test_add +`を実装します。

テストを再度実行すると、1つのテストが成功し、もう1つのテストが失敗したことがわかります。 合格したテストを表示するオプション、無視されたテストを表示するオプション、テストをアルファベット順にソートするオプション、およびテストを期間別にソートするオプションを調べます。

上記のGIFに表示される `+ sleep（0.1）+`メソッドは、テストの1つをより遅くするために意図的に使用されているため、期間によるソートが機能することに注意してください。

これらの単一ファイルプロジェクトは、例としては優れていますが、多くの場合、より大きなプロジェクトを長期間にわたって作業します。 このセクションでは、より大きなプロジェクトでPyCharmがどのように機能するかを見ていきます。

PyCharmのプロジェクト中心の機能を調べるには、学習用に構築されたAlcazar Webフレームワークを使用します。 追跡を続けるには、レポジトリをローカルでクローンします：

レポジトリのクローン： 使用するレポジトリのクローンを作成するにはここをクリックして、このチュートリアルでPyCharmのプロジェクト中心の機能を調べます。

プロジェクトをローカルに作成したら、次のいずれかの方法を使用してPyCharmでプロジェクトを開きます。

これらの手順のいずれかの後、コンピューター上でプロジェクトを含むフォルダーを見つけて開きます。

このプロジェクトにhttps://realpython.com/python-virtual-environments-a-primer/[仮想環境]が含まれている場合、PyCharmはこの仮想環境を自動的に使用し、プロジェクトインタープリターにします。

別の `+ virtualenv +`を設定する必要がある場合は、[。keys]＃Ctrl + Alt + S＃を押してWindowsまたはLinuxで[.keys] #Cmd +、＃または_Settings_を押して_Preferences_を開き、_Projectを見つけます。 ：ProjectName_セクション。 ドロップダウンを開き、_Project Interpreter_を選択します。

ドロップダウンリストから[+ virtualenv +]を選択します。 そこにない場合は、ドロップダウンリストの右側にある設定ボタンをクリックして、[追加…]を選択します。 残りの手順は、link：＃writing-code-in-pycharm [新しいプロジェクトの作成]と同じである必要があります。

一人ですべての場所を覚えるのが難しい大規模プロジェクトでは、探しているものをすばやく見つけて見つけることができることが非常に重要です。 PyCharmでもここで説明しています。 上記のセクションで開いたプロジェクトを使用して、これらのショートカットを練習します。

ナビゲーションについては、次のショートカットを使用すると時間を大幅に節約できます。

詳細については、https://www.jetbrains.com/help/pycharm/tutorial-exploring-navigation-and-search.html [公式ドキュメント]を参照してください。

Gitやhttps://www.mercurial-scm.org/[Mercurial]などのバージョン管理システムは、現代のソフトウェア開発の世界で最も重要なツールの一部です。 したがって、IDEがそれらをサポートすることは不可欠です。 PyCharmは、Git（およびhttps://github.com/[Github]）、Mercurial、https://www.perforce.com/solutions/version-control [ Perforce]、およびhttps://subversion.apache.org/[Subversion]。

注：https://realpython.com/python-git-github-intro/[Git]は次の例で使用されます。

PyCharmで開発に必要なほぼすべてのものを見つけることができます。 できない場合は、ほとんどの場合、PyCharmに必要な機能を追加するhttps://plugins.jetbrains.com/[plugin]があります。 たとえば、次のことができます。

たとえば、https://plugins.jetbrains.com/plugin/164-ideavim [IdeaVim]はVimエミュレーションをPyCharmに追加します。 Vimが好きなら、これはかなり良い組み合わせになります。

Material Theme UIは、PyCharmの外観をMaterial Designのルックアンドフィールに変更します。

Vue.jsは、https://vuejs.org/[Vue.js]プロジェクトのサポートを追加します。 Markdownは、IDE内でMarkdownファイルを編集し、レンダリングされたHTMLをライブプレビューで表示する機能を提供します。 _Marketplace_タブで、Macの_Preferences→Plugins_またはWindowsまたはLinuxの_Settings→Plugins_に移動して、使用可能なすべてのプラグインを検索してインストールできます。

、width = 1047、height = 687]

必要なものが見つからない場合は、http：//www.jetbrains.org/intellij/sdk/docs/basics.html [独自のプラグインを開発]を使用することもできます。

適切なプラグインが見つからず、既にPyPIにパッケージがあるために独自のプラグインを開発したくない場合は、外部ツールとしてPyCharmに追加できます。 例として、コードアナライザーであるhttp://flake8.pycqa.org/en/latest/[+ Flake8 +]を取り上げます。

まず、選択したターミナルアプリで `+ pip install flake8 `を使用してvirtualenvに ` flake8 +`をインストールします。 PyCharmに統合されたものを使用することもできます：

次に、Preferences→Tools to Macまたは_Settings→Tools_ to Windows/Linuxに移動し、External Tools_を選択します。 次に、下部の小さな + _ボタンをクリックします（1）。 新しいポップアップウィンドウで、以下に示すように詳細を挿入し、両方のウィンドウで[OK]をクリックします。

ここで、Program（2）は、仮想環境の_/bin_フォルダーにあるFlake8実行可能ファイルを指します。 Arguments（3）は、Flake8を使用して分析するファイルを指します。 _作業ディレクトリ_は、プロジェクトのディレクトリです。

ここではすべての絶対パスをハードコーディングできますが、他のプロジェクトではこの外部ツールを使用できないことを意味します。 1つのファイルの1つのプロジェクト内でのみ使用できます。

したがって、_Macros_と呼ばれるものを使用する必要があります。 マクロは基本的に、 `+ $ name $ `の形式の変数であり、コンテキストに応じて変化します。 たとえば、「 first.py 」を編集しているときは「 $ FileName $ 」は「 first.py 」であり、「 second.py 」を編集しているときは「 second.py +」です。 _Insert Macro…_ボタンをクリックして、リストを表示し、それらのいずれかを挿入できます。 ここでマクロを使用したため、現在作業中のプロジェクトに応じて値が変更され、Flake8は引き続き適切に機能します。

それを使用するには、ファイル `+ example.py +`を作成し、次のコードをその中に入れます：

これは、いくつかのFlake8ルールを意図的に破ります。 このファイルの背景を右クリックします。 _External Tools_を選択してから、_Flake8_を選択します。 ほら！ Flake8分析の出力は下部に表示されます。

、width = 997、height = 634]

さらに改善するために、ショートカットを追加できます。 Macでは_Preferences_に、WindowsまたはLinuxでは_Settings_に移動します。 次に、_キーマップ→外部ツール→外部ツール_に移動します。 _Flake8_をダブルクリックし、_キーボードショートカットの追加_を選択します。 次のウィンドウが表示されます。

上の画像では、このツールのショートカットは[.keys]＃Ctrl + Alt + A＃です。 希望するショートカットをテキストボックスに追加し、両方のウィンドウで[OK]をクリックします。 これで、そのショートカットを使用して、現在Flake8で作業しているファイルを分析できます。

PyCharm Professionalは、すぐに使える機能と統合を備えたPyCharmの有料版です。 このセクションでは、主にその主な機能の概要と、各機能の詳細について説明している公式ドキュメントへのリンクを紹介します。 Communityエディションでは、次の機能は使用できないことに注意してください。