2021/08/05

PyCharm: Djangoアプリケーションの新規作成

前回の記事では、PyCharm Community EditionでDjangoプロジェクトを作成・実行しました。今回は、このプロジェクトに新規アプリケーションを追加してみます。


目次[非表示]

新規アプリケーションの作成

Djangoのコマンドを使ってアプリケーションを作成します。作成したアプリケーションをDjangoに認識させるため、Django設定ファイルにアプリケーション名を登録します。

  1. PyCharm下部のTerminalタブをクリックします。
  2. Djangoプロジェクトのルート（前回の記事ではプロジェクトルートとDjangoプロジェクトのルートを同じ階層に合わせています）にカレントディレクトリを移動します。manage.pyが存在するパスです。
  3. python manage.py startappコマンドを実行し、testapp1という名前のアプリケーションを作成します。実行後は、testapp1フォルダ以下にいくつかのpyファイルが作成されます。
    (venv) C:\Dev\PyCharm\DjangoTest>python manage.py startapp testapp1

(venv) C:\Dev\PyCharm\DjangoTest>cd testapp1

(venv) C:\Dev\PyCharm\DjangoTest\testapp1>tree /f /a
C:.
|   admin.py
|   apps.py
|   models.py
|   tests.py
|   views.py
|   __init__.py
|
\---migrations
        __init__.py

  4. testapp1アプリケーションをDjangoプロジェクトに登録します。mysite内のsettings.pyファイルを開き、INSTALLED_APPS変数にtestapp1を追加します。


Webページの作成

DjangoアプリケーションにWebページを追加します。Viewを追加し、そのViewにアクセスできるようにURLを関連付けます。

  1. PyCharm上でtestapp1内にあるview.pyを開きます。
  2. 以下のコードを貼り付けて保存します。
    1. # testapp1/views.py
    2. from django.http import HttpResponse
    3.  
    4.  
    5. def index(request):
    6.     return HttpResponse("Hello, world. It's Django Test page.")

  3. testapp1アプリケーションの直下にurls.pyという名前のPythonファイルを追加します。
  4. urls.pyを開きます。
  5. 以下のコードを貼り付けて保存します。
    1. # testapp1/urls.py
    2. from django.urls import path
    3.  
    4. from . import views
    5.  
    6. urlpatterns = [
    7.     path('', views.index, name='index'),
    8. ]


  6. アプリケーションの設定は完了しました。次に、Djangoプロジェクトにtestapp1アプリケーションへのベースURLを設定します。mysiteフォルダ内のurls.pyファイルを開きます。このファイルはDjangoプロジェクト全体のURLを管理（主にルートURLを管理）するファイルです。
  7. 以下のコードを貼り付けて保存します。ここでは、urlpattenrs変数にtestapp1用のベースURLを追加し、またInclude関数をインポートしています。
    1. from django.contrib import admin
    2. from django.urls import path, include   # include関数をインポート
    3.  
    4. urlpatterns = [
    5.     path('admin/', admin.site.urls),
    6.     path('testapp1/', include('testapp1.urls')),
    7. ]


動作確認

開発Webサーバを起動して動作確認を行います。

  1. PyCharm下部のTerminalタブをクリックします。
  2. python manage.py runserverを実行して、開発用Webサーバを起動します。
  3. ブラウザを起動し、アドレスバーに http://127.0.0.1:8000/testapp1/ を入力後、Webページを開きます。以下のようなWebページが表示されれば成功です。


  4. PyCharmのターミナルウィンドウで、Ctrl + Cキーを押下し、Webサーバを停止します。


おわりに

本記事では、新規にDjangoアプリケーションを作成し、Djangoの作法にならって、Viewを作成したり、URLを追加したりして、PyCharm上で開発を行いました。また開発したアプリケーションに開発用Webサーバからアクセスし、新規に作成したDjangoアプリケーションが問題なく動作することを確認しました。


動作確認の際、わざわざTerminalでサーバを起動するのは手間ですよね。次回は、PyCharmを活用して、より簡単にDjangoアプリケーションを実行する方法、およびデバッグする方法を説明したいと思います。


Labels: