PyCharm でプロジェクトを構成する
PyCharm で行うことは何でも、プロジェクトのコンテキストで行います。プロジェクトは、完全なソフトウェアソリューションを表す組織単位です。これは、コーディング支援、一括リファクタリング、コーディングスタイルの一貫性などの基礎として機能します。
プロジェクトファイル
PyCharm のプロジェクトはディレクトリベースのフォーマットで表されます。プロジェクトディレクトリには アイコンが付いています。
このようなプロジェクトディレクトリには、次のファイルを含む .idea ディレクトリが含まれています。
プロジェクト構造を記述する .iml ファイル。
ワークスペース設定を含む workspace.xml ファイル。
多数の xml ファイル。各 xml ファイルは、projectCodeStyle.xml、encodings.xml、vcs.xml という名前で認識できる、独自の設定セットを担当します。
たとえば、新しい実行 / デバッグ構成を追加してエンコーディングを変更すると、2 つの異なる xml ファイルに影響します。これにより、プロジェクト設定がバージョン管理システムに格納され、異なるチームメンバーによって変更されたときのマージの競合を回避できます。
ローカル設定を保存する workspace.xml を除いて、.idea ディレクトリ内の設定ファイルはすべてバージョン管理下に置く必要があります。workspace.xml ファイルは、VCS によって無視されるものとしてマークする必要があります。
.idea ディレクトリは、プロジェクトツールウィンドウのプロジェクトビューには表示されません。
プロジェクトタイプ
各プロジェクトのディレクトリ構造には、PyCharm 固有の設定、プロジェクトファイル、およびライブラリ用の .idea ディレクトリが含まれています。
PyCharm は次のタイプのプロジェクトを提案しています:
Pure Python プロジェクトは純粋な Python プログラミングのためのものです。このようなプロジェクトのディレクトリ構造には、PyCharm 固有の設定用の .idea ディレクトリとプロジェクトファイルとライブラリが含まれています。
Python プロジェクトを作成するセクションに従って、プレーンな Python プロジェクトを作成します。
Django プロジェクト。このプロジェクトタイプは、Django(英語) アプリケーションの特定のインフラストラクチャ、およびすべての必要なファイルと設定を提供します。
Django プロジェクトを作成するセクションの説明に従って、Django アプリケーションを作成します。
Django アプリケーションを操作するには、データベースが必要です。SQLite を使用するのは、あらかじめ設定されているためです。別のデータベースエンジンを使用している場合は、それが正しくインストールされ、正しく構成されていることを確認してください。
Flask プロジェクト。このプロジェクトタイプは、Flask アプリケーションの特定のインフラストラクチャ、およびすべての必要なファイルと設定を提供します。
Flask プロジェクトの作成セクションの説明に従ってプロジェクトを作成します。
Pyramid プロジェクト。このプロジェクトタイプは、Pyramid(英語) アプリケーションの特定のインフラストラクチャ、およびすべての必要なファイルと設定を提供します。
Pyramid プロジェクトの作成セクションの説明に従ってプロジェクトを作成します。
クライアントサイドプロジェクト HTML5 ボイラープレート(英語)、Bootstrap(英語)、Foundation(英語)。
クライアントサイドアプリケーションの場合、PyCharm は必要なファイルとディレクトリを持つ特定のインフラストラクチャを作成します。
プロジェクトの作成。
PyCharm Edu プロジェクト
教育プロジェクトは Python を学びたい学生を対象としています。
教育プロジェクトは、次のエンティティで構成されています。
このようなプロジェクトを作成するプロセスは、学習者スタートガイド(英語)で説明されています。
コースは教育者を対象としています。
コースは次のエンティティで構成されています。
- コース
コースは、特別なタイプのプロジェクトにすぎません。レッスンで構成されています。
- レッスン
レッスンは、タスクファイルが格納されるディレクトリです。各レッスンには複数のタスクを含めることができます。
- タスク
タスクは、次のファイルが格納されているディレクトリです。
タスクの説明ツールウィンドウに入力する必要があるタスクの説明
エクステンション .py のファイル。これには演習コードが含まれ、解答プレースホルダーを含めることができます。
テストファイル tests.py。これは、生徒があなたの課題を正しく達成したことを確認できます。
タスクには、それを達成するために必要なファイルがさらに含まれることもあります。
- 回答プレースホルダー
回答プレースホルダーは、初期コードの一部を置き換えて非表示にする、学生に表示されるフレームです。これらのプレースホルダーには、タスクを完了するために学生が実行するアクションの説明を含める必要があります。これらのアクションの説明を自分で作成する必要があります。
回答プレースホルダ内を最初にマウスクリックすると、プレースホルダ全体が選択されます。2 回目のマウスクリックで選択が解除されます。
- ヒント
生徒が自分に自信がない場合は、ヒントを表示できます。ヒントも教育者によって作成されます。
これらのファイル群の他に、PyCharm は講師がテストを書くために使用できる便利な機能を含む特別なファイル test_helper.py を提供します。
詳細は、教育者スタートガイド(英語)を参照してください。
プロジェクト設定
プロジェクト設定は、現在のプロジェクトにのみ適用されます。それらは、他のプロジェクトファイルと一緒に .xml 形式で .idea ディレクトリに保存されます。例: プロジェクトは、VCS 設定、コードスタイルのスペルチェッカー設定、言語インジェクションのリストなどを保持します。これらの設定は、VCS に送信するときに、アプリケーションコードとともにバージョン管理下に自動的に配置されます。
プロジェクト設定を構成するには、macOS(Ctrl+Alt+S)の場合は
を、Windows および Linux の場合は を選択します。 設定ダイアログで、 アイコンが付いている設定は、現在のプロジェクトにのみ適用されます。その他の設定はグローバルであり、すべての既存のプロジェクトに適用されます。
![プロジェクト設定 Project settings](https://resources.jetbrains.com/help/img/idea/2024.1/py_project_settings.png)
既存のプロジェクト間でプロジェクト設定を共有したい場合は、設定の同期プラグインを使用できます。設定を ZIP アーカイブにエクスポートし、後で他の IDE インスタンスにインポートすることもできます。
現在のプロジェクトだけでなく、後で作成するすべてのプロジェクトのプロジェクト設定を構成できます。つまり、プロジェクトに新しいデフォルト設定を設定できます。
デフォルトのプロジェクト設定を構成する
メインメニューで、
に移動します。
関連ページ:
![](https://resources.jetbrains.com/help/img/idea/2024.1/sharing-project-notification.png)
バージョン管理統合サポート
PyCharm は 2 つのレベルでバージョン管理統合をサポートします。IDE レベルでは、VCS 統合は、デフォルトで有効になっているバンドルされたプラグインのセットを通じて提供されます。プロジェクトレベルでは、プロジェクトフォルダーを 1 つまたは複数のバージョン管理システムと関連付けることで、VCS 統合が有効になります。プロジェクトルートをバージョン管理システムに関連付ける:PyCharm を使用すると、プロジェクトとバージョン管理システムの統合を迅速に有効にし、それをプロジェクトルー...
![](https://resources.jetbrains.com/help/img/idea/2024.1/get-from-vc-git.png)
Git リポジトリのセットアップ
既存の Git リポジトリのクローンを作成するか、既存のプロジェクトを Git バージョンコントロール下に置くと、PyCharm はコンピューターに Git がインストールされているかどうかを自動的に検出します。IDE が Git 実行可能ファイルを見つけられない場合、それをダウンロードすることを提案します。PyCharm は、Windows10 バージョン 2004 で使用可能な Windows Subsystem for Linux 2(WSL2)の Git をサポートします。Git が Wi...
![](https://resources.jetbrains.com/help/img/idea/2024.1/py_projectToolWindowShowMembers.png)
プロジェクトツールウィンドウ
プロジェクトツールウィンドウでは、様々な視点からプロジェクトを見て、新しいアイテム(ディレクトリ、ファイル、クラスなど)の作成、エディターでのファイルのオープン、必要なコードフラグメントへの移動など、様々なタスクを実行することができます。このツールウィンドウのほとんどの機能には、コンテンツペインのコンテキストメニューコマンドとして、関連するショートカットを介してアクセスします。また、ビューには、作成されたスクラッチファイル、クエリコンソール、拡張スクリプトを管理できるスクラッチとコンソールフォル...
![](https://resources.jetbrains.com/help/img/idea/2024.1/py_create_python_project_community.png)
Python プロジェクトを作成する
純粋な Python プロジェクトは、Python プログラミングを対象としています。プロジェクトは、ソースコード、テスト、使用するライブラリ、個人設定を 1 つのユニットに整理できます。プロジェクトが不要な場合は、LightEdit モードでファイルを編集できます。プロジェクトを作成するには、次のいずれかを実行します。に移動します。ウェルカム画面で、新しいプロジェクトをクリックします。、新しいプロジェクトダイアログで、プロジェクト名とその場所を指定します。ダイアログは、PyCharm エディシ...
![](https://resources.jetbrains.com/help/img/idea/2024.1/py_create_django_project.png)
Django プロジェクトを作成する
Django プロジェクトは、Django を使用した生産的な Web 開発を目的としています。PyCharm は、Django アプリケーションに必要な特定のディレクトリ構造とファイルを作成し、正しい設定を提供します。Django プラグインを有効にするこの機能は、デフォルトで PyCharm にバンドルされて有効になっている Django プラグインに依存しています。関連する機能が利用できない場合は、プラグインを無効にしていないことを確認してください。を押して設定を開き、を選択します。インス...
![](https://resources.jetbrains.com/help/img/idea/2024.1/py_flask_project.png)
Flask プロジェクトの作成
Flask プロジェクトは、Flask アプリケーションの生産的な開発を目的としています。PyCharm は、特定のディレクトリ構造と設定の作成を処理します。Flask プロジェクトを作成するメインメニューでに移動するか、ウェルカム画面の新しいプロジェクトボタンをクリックします。新しいプロジェクトダイアログで、次の操作を行います。プロジェクトタイプとして Flask を選択します。プロジェクトロケーションの指定。プロジェクトを Git バージョン管理下に置くには、Git リポジトリの作成を選択します。...