Django – ルーティング – urls.py

2022-03-14 / tau / コメントする

概要

リクエストされたURLから、Django内部で必要なview関数を呼ぶためのルーティングは、urls.pyで設定する。

urls.pyはプロジェクト設定ディレクトリーの下か、各アプリケーションディレクトリーの下
アプリケーションディレクトリー下のurls.pyは新規に作成し、設定ディレクトリーのurls.pyでincludeする
ルーティングはurls.pyのurlpatterns配列にpath関数で登録する
path関数の引数に、URLパターンとビュー関数を与える

設定ディレクトリー下のurls.py

プロジェクト構成

djangobasicsプロジェクトを作成。設定ディレクトリーをconfとし、アプリケーションurlincludeを作成・登録した場合のツリーは以下の通り。

/djangobasics/
├── conf
│     ├── __init__.py
│     ├── asgi.py
│     ├── settings.py
│     ├── urls.py
│     └── wsgi.py
├── manage.py
└── urlinclude
       ├── __init__.py
       ├── admin.py
       ├── apps.py
       ├── migrations
       │     └── __init__.py
       ├── models.py
       ├── tests.py
       ├── urls.py
       └── views.py

/djangobasics/

├── conf

│ ├── __init__.py

│ ├── asgi.py

│ ├── settings.py

│ ├── urls.py

│ └── wsgi.py

├── manage.py

└── urlinclude

├── __init__.py

├── admin.py

├── apps.py

├── migrations

│ └── __init__.py

├── models.py

├── tests.py

├── urls.py

└── views.py

ビューとテンプレート

urlinclude/views.pyを以下のように編集する。

from django.shortcuts import render

def index(request):
    return render(request, 'urlinclude/index.html')

from django.shortcuts import render

def index(request):

return render(request, 'urlinclude/index.html')

urlinclude/templates/urlincludeディレクトリーを作成し、その下にindex.htmlを以下の内容で作成。

<!DOCTYPE html>
<html lang="ja">
  <head>
    <meta charset="utf-8">
    <title>Index</title>
  </head>
  <body>
    <h1>Index</h1>
  </body>
</html>

<!DOCTYPE html>

<head>

<title>Index</title>

</head>

<body>

<h1>Index</h1>

</body>

</html>

pathの登録

設定ディレクトリーconfの下のurls.pyに以下のように追記。以下、このurls.pyを「グローバルなurls.py」と呼ぶ。

from django.contrib import admin
from django.urls import path
from urlinclude import views

urlpatterns = [
    path('admin/', admin.site.urls),
    path('urlinclude', views.index),
]

from django.contrib import admin

from django.urls import path

from urlinclude import views

urlpatterns = [

path('admin/', admin.site.urls),

path('urlinclude', views.index),

]

まずアプリケーションのviewsモジュールをインポートしている。

from アプリケーション名 import views

1	from アプリケーション名 import views

そしてホスト名/アプリケーション名でindexビュー関数が呼ばれるようルーティング。

path('アプリケーション名', views.ビュー関数)

1	path('アプリケーション名', views.ビュー関数)

ここでhttp://localhost:8000/urlincludeでブラウザーからアクセスすると、index.htmlの内容が表示される。

アプリケーション下のurls.py

グローバルなurls.pyの問題点

設定ファイル直下のurls.pyでのpath登録は、

デフォルトで作成されたurls.pyを編集すればよい
任意のアプリケーションのルーティング登録ができる

ただし以下のような問題点がある。

登録するビューのアプリケーションをインポートする必要がある
全てのビューを登録するため見通しが悪くなる
アプリケーション間でビューの名前の衝突が起こり得る

このため一般にはアプリケーションごとにurls.pyを作成し、そのモジュールを設定ディレクトリー下のグローバルなurls.pyでincludeする。

ビューとテンプレート

ビューとテンプレートは先の例と同じものを使う。

アプリケーションのurls.pyの準備

アプリケーションディレクトリー下に、以下の内容でurls.pyファイルを作成する。conf/urls.pyのように自動作成されないので、新たに作成する必要がある。

from django.urls import path
from urlinclude import views

urlpatterns = [
    path('index', views.index),
]

from django.urls import path

from urlinclude import views

urlpatterns = [

path('index', views.index),

]

ツリーは以下の通り。

/djangobasics/
├── conf
│     ├── __init__.py
│     ├── asgi.py
│     ├── settings.py
│     ├── urls.py
│     └── wsgi.py
├── manage.py
├── startserver.sh
└── urlinclude
       ├── __init__.py
       ├── admin.py
       ├── apps.py
       ├── migrations
       │     ├── __init__.py
       │     └── __pycache__
       │     └── __init__.cpython-36.pyc
       ├── models.py
       ├── templates
       │     └── urlinclude
       │            └── index.html
       ├── tests.py
       ├── urls.py
       └── views.py

/djangobasics/

├── conf

│ ├── __init__.py

│ ├── asgi.py

│ ├── settings.py

│ ├── urls.py

│ └── wsgi.py

├── manage.py

├── startserver.sh

└── urlinclude

├── __init__.py

├── admin.py

├── apps.py

├── migrations

│ ├── __init__.py

│ └── __pycache__

│ └── __init__.cpython-36.pyc

├── models.py

├── templates

│ └── urlinclude

│ └── index.html

├── tests.py

├── urls.py

└── views.py

グローバルなurls.pyの編集

conf/urls.pyを以下のように編集する。

django.urlsパッケージのpathモジュールに加えて、includeモジュールもインポートする
urlpatterns配列にpath関数を追加し、アプリケーションのurls.pyをincludeする

from django.contrib import admin
from django.urls import path, include
#from urlinclude import views

urlpatterns = [
    path('admin/', admin.site.urls),
#    path('urlinclude/', views.index),
    path('urlinclude/', include('urlinclude.urls')),
]

from django.contrib import admin

from django.urls import path, include

#from urlinclude import views

urlpatterns = [

path('admin/', admin.site.urls),

# path('urlinclude/', views.index),

path('urlinclude/', include('urlinclude.urls')),

]

ここでhttp://localhost:8000/urlinclude/indexにアクセスすると、index.htmlがブラウザーに表示される。

アプリケーションの登録

新たにアプリケーションを作成した場合には、プロジェクト共通ディレクトリーのsettings.pyでINSTALLED_APPSに作成したアプリケーションを登録しておく必要がある。

INSTALLED_APPS = [
    ....,
    'urlinclude.apps.UrlincludeConfig',
]

INSTALLED_APPS = [

....,

'urlinclude.apps.UrlincludeConfig',

]

留意点

グローバルなurls.pyでは、個々のアプリケーションのviewsモジュールをインポートする必要はない。

include関数の第1引数はアプリケーション名を使ったディレクトリーで、その後にアプリケーション内で定義したパスが続く。

今回の例では'urlinclude/' + 'index'→'urlinclude/index'
末尾に'/'がないとエラーになる

include関数の引数は、'アプリケーション.urls'の文字列。

文字列にしていないと”名前が見つからない”、とエラーになる

直接テンプレートを表示する

path関数で直接テンプレートを表示させることもできるが、少し手間が必要。

urls.pyでTemplateVierwクラスをインポート
path関数の第2引数にTemplateView.as_view()メソッドを与えてテンプレートを指定

たとえば以下は、index.htmlと同じディレクトリーにexample.htmlを作成し、これを直接path関数から呼び出す例。

from django.urls import path
from urlinclude import views
from django.views.generic.base import TemplateView

urlpatterns = [
    path('index', views.index),
    path('example', TemplateView.as_view(template_name='urlinclude/example.html')),
]

from django.urls import path

from urlinclude import views

from django.views.generic.base import TemplateView

urlpatterns = [

path('index', views.index),

path('example', TemplateView.as_view(template_name='urlinclude/example.html')),

]

Django – Troubleshooting

2022-03-14 / tau / コメントする

テンプレートがない

症状

ブラウザーで以下のエラー表示

TemplateDoesNotExist at /

原因

テンプレートはアプリケーション下なので探索範囲にある、アプリケーションのrender関数でもテンプレートのパスは間違っていない・・・。ほとんどの場合、settings.pyへのアプリケーションの登録漏れ。

名前が定義されていない

サーバーコンソールに以下のエラー表示

name *** is not defined

原因

引数のパスなどが文字列になっていないとこのエラーが出る。

render(request, app/index.html)
↓
render(request, 'app/index.html')

path(app/, include(app.urls)
↓
path(app/, include('app.urls')

render(request, app/index.html)

↓

render(request, 'app/index.html')

path(app/, include(app.urls)

↓

path(app/, include('app.urls')

Django – DTL – include

2022-03-14 / tau / コメントする

テンプレートの継承では、個別ページが共有するテンプレートを継承元の親テンプレートとした。一方、HTMLの一部を部品化して任意のページに埋め込むにはincludeタグを使う。

たとえば検索フォームを作成して、これを複数のページで使い回したいとする。例として以下のようなダミーのHTMLを準備する。

div>
    <p>検索用のフォーム</p>
</div>

div>

<p>検索用のフォーム</p>

</div>

テンプレートの継承で使った以下のテンプレートを考える。includeタグで挿入するHTMLのパスを指定している。パスの指定の仕方は他のタグと同じ相対パス。

{% extends 'inheritance/authenticated.html' %}

{% block title %}ようこそ{% endblock %}

{% block content %}
  <h1>ユーザーホームページ</h1>

  <p>ログイン済みユーザー用の内容</p>

  {% include 'inheritance/search.html' %}
  
{% endblock %}

{% extends 'inheritance/authenticated.html' %}

{% block title %}ようこそ{% endblock %}

{% block content %}

<h1>ユーザーホームページ</h1>

<p>ログイン済みユーザー用の内容</p>

{% include 'inheritance/search.html' %}

{% endblock %}

このページを呼び出すと、以下のようにincludeタグの部分に検索フォームのHTMLが埋め込まれる。

<!DOCTYPE html>
<html lang="ja">
  <head>
    <meta charset="utf-8">
    <title>ようこそ</title>
  </head>
  <body>
    
<p>ユーザー用メニュー</p>
<ul>
  <li>ユーザーホーム</li>
  <li>ログアウト</li>
</ul>


    
  <p>ユーザーホームページ</p>

  <p>ログイン済みユーザー用の内容</p>

  <div>
    <p>検索用のフォーム</p>
</div>



  </body>
</html>

<!DOCTYPE html>

<head>

</head>

<body>

<p>ユーザー用メニュー</p>

<ul>

<li>ユーザーホーム</li>

<li>ログアウト</li>

</ul>

<p>ユーザーホームページ</p>

<p>ログイン済みユーザー用の内容</p>

<div>

<p>検索用のフォーム</p>

</div>

</body>

</html>

表示は以下の通りで、検索フォームの部分が表示されている。

ユーザー用メニュー

ユーザーホーム
ログアウト

ユーザーホームページ

ログイン済みユーザー用の内容

検索用のフォーム

Django – DTL – 継承

2022-03-14 / tau / コメントする

概要

個別ページで共通するHTMLの枠組みがある場合、それらを親テンプレートとして一つにまとめて、個別ページは親テンプレートを継承するようにできる。たとえばHTML全体の枠組みやサイトに共通するデザインなどをまとめるケース。テンプレートの継承の要点は以下のとおり。

継承元の親テンプレートを準備
- blockタグ→子テンプレートで具体内容を埋め込むブロック
継承先の子テンプレートを準備
- extends→継承元の親テンプレートを指定
- blockタグ→親テンプレートのblockタグの部分に埋め込む内容
blockタグには識別名を書き、親・子でブロックを対応させる

子テンプレートを呼び出したとき、親テンプレートのblockタグの部分に子テンプレートのblockタグの内容が埋め込まれたHTMLとなる。

なお継承ではないが、includeタグによって別に準備したHTMLの一部分を取り込むことができる。

基本形

まず、子テンプレートで単に親テンプレートをextendsで読み込むだけの例を確認する。

継承元の親テンプレート

子テンプレートが継承する元の親テンプレート(layout.html)を以下のように準備する。要点は以下のとおり。

HTMLの完全な枠組みを持たせている
title要素、header要素、body要素にblockタグのブロックを書いている
- title要素のblockには'Placeholder'という文字列を書いている
- header要素のblockにはp要素とリストを書いている
- body要素のblockには何も書いていない

<!DOCTYPE html>
<html lang="ja">
  <head>
    <meta charset="utf-8">
    <title>{% block title %}Placeholeder{% endblock %}</title>
  </head>
  <body>
    <header>
      {% block header %}
      <p>Default Header Menu</p>
        <ul>
          <li>Login</li>
          <li>Signup</li>
        </ul>
      {% endblock %}
    </header>
    {% block content %}
    {% endblock %}
  </body>
</html>

<!DOCTYPE html>

<head>

<title>{% block title %}Placeholeder{% endblock %}</title>

</head>

<body>

{% block header %}

<p>Default Header Menu</p>

<ul>

<li>Login</li>

<li>Signup</li>

</ul>

{% endblock %}

</header>

{% block content %}

{% endblock %}

</body>

</html>

子テンプレート

子テンプレート(index.html)ではextendsタグによって親テンプレートを継承する。この場合のタグの引数は、view関数で呼ぶrender文の第2引数と同じで、テンプレートディレクトリーからの相対パス。

{% extends 'inheritance/layout.html' %}

1	{% extends 'inheritance/layout.html' %}

子テンプレートはこの1行だけなので、単にこのテンプレートの内容が親テンプレートの内容で埋められる。

ただし親テンプレートのblockタグに対する子テンプレートのblockがないので、以下のように解釈される。

親のblockに内容が定義されていれば、その内容が展開される
親のblockがタグだけで内容がなければ、何も引き継がれない。

子テンプレートが引き継いだ親テンプレートの内容が解釈された結果、最終的なindex.htmlは以下のようになる。

title要素には'Placeholder'の文字が充てられる
header要素には、親で記述されたp要素とリストが埋められる
親の{% block content %}のブロックには内容がないので、子要素にも何も引き継がれない

<!DOCTYPE html>
<html lang="ja">
  <head>
    <meta charset="utf-8">
    <title>Placeholeder</title>
  </head>
  <body>
    <header>
      
      <p>Default Header Menu</p>
        <ul>
          <li>Login</li>
          <li>Signup</li>
        </ul>
      
    </header>

    
    
  </body>
</html>

<!DOCTYPE html>

<head>

<title>Placeholeder</title>

</head>

<body>

<p>Default Header Menu</p>

<ul>

<li>Login</li>

<li>Signup</li>

</ul>

</header>

</body>

</html>

この結果、ブラウザーの表示は以下のようになる（ブラウザーのタブには'Placeholder'の文字が表示される。

Default Header Menu

Login
Signup

標準形

次に、子テンプレートindex.htmlで親テンプレートの各blockの具体の内容を実装する。

{% extends 'inheritance/layout.html' %}

{% block title %}タイトル{% endblock %}

{% block header %}
<p>メニュー</p>
<ul>
  <li>ログイン</li>
  <li>サインアップ</li>
</ul>
{% endblock %}

{% block content %}
<p>サイト内容</p>
<ul>
  <li>サイト紹介</li>
  <li>内容一覧</li>
</ul>
{% endblock %}

{% extends 'inheritance/layout.html' %}

{% block title %}タイトル{% endblock %}

{% block header %}

<ul>

<li>サインアップ</li>

</ul>

{% endblock %}

{% block content %}

<p>サイト内容</p>

<ul>

<li>サイト紹介</li>

</ul>

{% endblock %}

この結果、親テンプレートのblock部分に子テンプレートの対応するblockの内容が埋め込まれる。親テンプレートのblockに書かれた内容がある場合は、子テンプレートの内容で置き換えられる。

HTMLソースを確認すると、子テンプレートの内容が反映されていることがわかる。

<!DOCTYPE html>
<html lang="ja">
  <head>
    <meta charset="utf-8">
    <title>タイトル</title>
  </head>
  <body>
    <header>
      
<p>メニュー</p>
<ul>
  <li>ログイン</li>
  <li>サインアップ</li>
</ul>

    </header>

    
<p>サイト内容</p>
<ul>
  <li>サイト紹介</li>
  <li>内容一覧</li>
</ul>

  </body>
</html>

<!DOCTYPE html>

<head>

</head>

<body>

<ul>

<li>サインアップ</li>

</ul>

</header>

<p>サイト内容</p>

<ul>

<li>サイト紹介</li>

</ul>

</body>

</html>

ブラウザーでの表示結果は以下のとおり（ブラウザーのタブには’タイトル'と表示される）。

メニュー

ログイン
サインアップ

サイト内容

サイト紹介
内容一覧

継承のチェーン

これまでは親～子の継承だったが、さらに親～子～孫の継承を見てみる。

たとえばページの種類が、認証済みユーザー用と非認証のゲスト用の2通りに区分され、それぞれでメニューの内容を変えたいとする。このような場合は、以下のようにテンプレートを分けて継承させる。

親：全てのページに共通するテンプレート
子：認証用／非認証用それぞれに応じたテンプレート
孫：個々のページ～ページ内容によって認証用／非認証用あり

認証済みユーザー用のページ

まず、認証済みユーザー用のメニューを共通化し、これをユーザーホーム(index)で継承する例。先の例ではindex.htmlがlayout.htmlを継承したが、ここでは以下のように構成を変更する。

前：layout.html←index.html
後：layout.html←authenticated.html←index.html

サイト共通の基本的な枠組みはlayout.htmlで記述し、ユーザー認証中のHTML部分はauthenticated.htmlで、認証中の具体のページ内容をindex.htmlで実装している。

親テンプレートlayout.htmlはそのままとし、新たにauthenticated.htmlを以下の内容で準備する。ここでは{% block header %}のみを実装し、認証済みユーザー用のヘッダーメニューを表示させる。

{% extends 'inheritance/layout.html' %}

{% block header %}
<p>ユーザー用メニュー</p>
<ul>
  <li>ユーザーホーム</li>
  <li>ログアウト</li>
</ul>
{% endblock %}

{% extends 'inheritance/layout.html' %}

{% block header %}

<p>ユーザー用メニュー</p>

<ul>

<li>ユーザーホーム</li>

<li>ログアウト</li>

</ul>

{% endblock %}

index.htmlはauthenticated.htmlを継承し、孫テンプレートとなる。未実装の{% block title %}と{% block content %}を実装して「ログイン済みユーザー用の内容」とだけ表示させている。

{% extends 'inheritance/authenticated.html' %}

{% block title %}ようこそ{% endblock %}

{% block content %}
  <h1>ユーザーホームページ</h1>

  <p>ログイン済みユーザー用の内容</p>
{% endblock %}

{% extends 'inheritance/authenticated.html' %}

{% block title %}ようこそ{% endblock %}

{% block content %}

<h1>ユーザーホームページ</h1>

<p>ログイン済みユーザー用の内容</p>

{% endblock %}

index.htmlを呼び出すと、index.htmlでcontentとtitleが、authenticated.htmlでheaderが実装され、以下のように表示される。

ユーザー用メニュー

ユーザーホーム
ログアウト

ユーザーホームページ

ログイン済みユーザー用の内容

非認証時のページ

次に非認証時のページとして、以下のような構成を追加する。

layout.html←unauthenticated.html←login.html

全体共通の基本的な枠組みlayout.htmlは同じで、非認証時のHTML部分をuauthenticated.htmlにまとめ、非認証時の具体ページの例としてlogin.htmlを追加。

unauthenticated.htmlはauthenticated.htmlと同じように{% block header %}のみを実装し、ゲスト用のメニューを記述。

{% extends 'inheritance/layout.html' %}

{% block header %}
<p>ゲスト用メニュー</p>
<ul>
  <li>ログイン</li>
  <li>サインアップ</li>
</ul>
{% endblock %}

{% extends 'inheritance/layout.html' %}

{% block header %}

<p>ゲスト用メニュー</p>

<ul>

<li>サインアップ</li>

</ul>

{% endblock %}

ログインページでは非認証時のunauthenticated.htmlを継承し、具体のタイトルと内容を記述。

{% extends 'inheritance/unauthenticated.html' %}

{% block title %}ログイン{% endblock %}

{% block content %}
  <h1>ログインページ</h1>

  <p>ユーザーログイン用の内容</p>
{% endblock %}

{% extends 'inheritance/unauthenticated.html' %}

{% block title %}ログイン{% endblock %}

{% block content %}

<h1>ログインページ</h1>

<p>ユーザーログイン用の内容</p>

{% endblock %}

表示結果は以下のようになる。

ゲスト用メニュー

ログイン
サインアップ

ログインページ

ユーザーログイン用の内容

重複記述の禁止

blockタグの識別子が同じ名前で複数存在することはできない。たとえばtitle要素とページのh1要素が同じ内容なので以下のように2度使いしようとするとエラーになる。

<!DOCTYPE html>
<html lang="ja">
  <head>
    <meta charset="utf-8">
    <title>{% block title %}Placeholeder{% endblock %}</title>
  </head>
  <body>
{% comment %}
    <h1>{% block title %}Title Here{% endblock %}</h1>

    同じブロック名のブロックは重複して書けない
    TemplateSyntaxError at /inheritance
    'block' tag with name 'title' appears more than once
{% endcomment %}
  </body>
</html>

<!DOCTYPE html>

<head>

<title>{% block title %}Placeholeder{% endblock %}</title>

</head>

<body>

{% comment %}

<h1>{% block title %}Title Here{% endblock %}</h1>

同じブロック名のブロックは重複して書けない

TemplateSyntaxError at /inheritance

'block' tag with name 'title' appears more than once

{% endcomment %}

</body>

</html>

Django – DTL – if

2022-03-10 / tau / コメントする

基本形

文法

基本はPythonのif ... elif ... elseと同じで、終了タグ{% endif %}で終える。

{% if .... %}
  ....
{% elif %}
  ....
{% else %}
  ....
{% endif %}

{% if .... %}

....

{% elif %}

....

{% else %}

....

{% endif %}

テンプレートの実例は以下の通り。

    <p>
      {{ var }} is
      {% if var > 0 %}
        Poisive.
      {% elif var < 0 %}
        Negative.
      {% else %}
        Zero.
      {% endif %}
    </p>

<p>

{{ var }} is

{% if var > 0 %}

Poisive.

{% elif var < 0 %}

Negative.

{% else %}

Zero.

{% endif %}

</p>

Pythonとの違い

以下はPythonのif文との違いで、外すとTemplateSyntaxErrorになる。

条件部に()は使えない
- {% if (he == gentle or she == tender) and they == love_each_other %} はエラー
- こういう場合はifのネストにする
条件部に算術演算子は使えないがフィルターは使える
- {% if d % 2 == 2 %}はエラー
- {% if d|divisable:2 %}はok

その他

ifequal/ifnotequal

if a == b/if a != bと同じ。

ifchanged

割愛。

Django – DTL – フィルターとスペースとエラー

2022-03-10 / tau / コメントする

概要

DjangoのDTLにおけるフィルターの一般形式は以下のようになっている。

変数|フィルター:引数|フィルター:引数|・・・

フィルターは変数展開{{ .... }}でもタグ{% .... %}でも使えるが、それぞれで'|'や':'の前後にスペースを入れた時の挙動が異なるので整理する。

結論すると、DTLでフィルターを使う場合は'|'と':'の前後にはスペースを入れないと決めておくのが紛れがなくてよい。

変数展開の場合

'|'の前後のスペースは許されるが、':'の前後にスペースを入れるとTemplateSyntaxErrorになる。

`{{ var\|add:2 }}`	Ok
`{{ var \|add:2 }}`	Ok
`{{ var\| add:2 }}`	Ok
`{{ var\|add :2 }}`	Error
`{{ var\|add: 2 }}`	Error

タグの場合

'|'の前後も':'の前後もスペースを入れるとTemplateSyntaxErrorになる。

`{% if var\|divisibleby:2 %}`	Ok
`{% if var \|divisibleby:2 %}`	Error
`{% if var\| divisibleby:2 %}`	Error
`{% if var\|divisibleby :2 %}`	Error
`{% if var\|divisibleby: 2 %}`	Error

Django – DTL – テンプレート言語

2022-03-10 / tau / コメントする

概要

Djangoのテンプレート言語(DTL: Django Template Language)について整理する。

テンプレートの基礎についてはこちら。

一行コメント{#...#}と複数行コメント{% comment %}...{% endcomment %}がある。

DTLのコメントの詳細についてはこちら。

変数展開

変数の内容を展開するには{{ 変数 }}と記述する。

変数の内容は、数値・文字列のほか、コレクションの要素や一般のオブジェクトの属性やメソッドの結果も展開可能。

変数展開の詳細についてはこちら。

Django – DTL – for

2022-03-10 / tau / コメントする

基本形

文法

forタグで始め、endforタグで終える。forタグの書き方はPythonのfor文と同じ。

{% for  in .... %}
    ....
{% endfor %}

{% for in .... %}

....

{% endfor %}

コレクションに対する操作の殆どはPythonと同じ。

アンパック

def for_tag(request):
    context = {
        'dices': [[1, 3], [3, 3], [4, 2]],
    }
    return render(request, 'dtldemo/for_tag.html', context)

def for_tag(request):

context = {

'dices': [[1, 3], [3, 3], [4, 2]],

}

return render(request, 'dtldemo/for_tag.html', context)

    <p>
      サイコロ：
      {% for dice1, dice2 in dices %}
        ({{ dice1 }}, {{ dice2 }})
      {% endfor %}
    </p>

<p>

サイコロ：

{% for dice1, dice2 in dices %}

({{ dice1 }}, {{ dice2 }})

{% endfor %}

</p>

サイコロ： (1, 3) (3, 3) (4, 2)

辞書

辞書のキーと値を取り出す例。Pythonと同じで.itemsを付ける。

def for_tag(request):
    context = {
        'capitals': {'Japan': 'Tokyo', 'France': 'Paris', 'US': 'WDC'}
    }
    return render(request, 'dtldemo/for_tag.html', context)

def for_tag(request):

context = {

'capitals': {'Japan': 'Tokyo', 'France': 'Paris', 'US': 'WDC'}

}

return render(request, 'dtldemo/for_tag.html', context)

    <p>首都</p>
    <ul>
      {% for key, value in capitals.items %}
        <li>Country: {{ key }} - Capital: {{ value }}</li>
      {% endfor %}
    </ul>

<ul>

{% for key, value in capitals.items %}

<li>Country: {{ key }} - Capital: {{ value }}</li>

{% endfor %}

</ul>

首都

Country: Japan – Capital: Tokyo
Country: France – Capital: Paris
Country: US – Capital: WDC

注意点

for ... inの後には関数やリテラルは書けず、rangeやzip、enumerateはエラーになる。ただしリテラルは書けないが、view関数内で変数に代入しておけば実行可能。以下はrangeの例。

    context = {
        'var_range': range(5),
    }
    return render(request, 'dtldemo/for_tag.html', context)

context = {

'var_range': range(5),

}

return render(request, 'dtldemo/for_tag.html', context)

      {% for i in var_range %}
        <p>{{ i }}</p>
      {% endfor %}

{% for i in var_range %}

{% endfor %}

zipやenumerateについても、view関数側で変数に代入しておけば使える。なおenumerateについては、forloop変数にカウンターが用意されている。

empty～変数が空の場合

{% empty %}タグは{% for %}～{% endfor %}の間に入れる。forで使う変数が空の場合にループを実行せず、empty以下が実行されてループを終わる。

{% for .... in var $}
    ループ処理
{% empty %}
    空の場合の処理
{% endfor %}

{% for .... in var $}

ループ処理

{% empty %}

空の場合の処理

{% endfor %}

変数の内容が以下の場合にemptyブロックが実行される。

未定義
None
[]
()
''

reversed～逆順

forタグにreversedを付すと、cの内容が逆順でeに取り出される。

{% for e in c reversed %}
    ....
{% endfor %}

{% for e in c reversed %}

....

{% endfor %}

forloop変数

一覧

forloop変数によって、ループ中でカウンター値やループの先頭・末尾データなどを得ることができる。

`forloop.counter`	ループカウンター値(初期値：1)
`forloop.counter0`	ループカウンター値(初期値：0)
`forloop.revcounter`	逆順カウンター値(終了値：1)
`forloop.revcounter0`	逆順カウンター値(終了置：0)
`forloop.first`	最初のループなら`True`
`forloop.last`	最後のループならTrue
`forloop.parentloop`	多重ループの外側の値

カウンター

以下はrevcounter0の例。

def for_tag(request):
    context = {
        'countdown': ['three', 'two', 'one', 'zero!'],
    }
    return render(request, 'dtldemo/for_tag.html', context)

def for_tag(request):

context = {

'countdown': ['three', 'two', 'one', 'zero!'],

}

return render(request, 'dtldemo/for_tag.html', context)

    <p>countdown</p>
    <ul>
      {% for c in countdown %}
        <li>{{ forloop.revcounter0 }}-{{ c }}</li>
      {% endfor %}
    </ul>

<p>countdown</p>

<ul>

{% for c in countdown %}

<li>{{ forloop.revcounter0 }}-{{ c }}</li>

{% endfor %}

</ul>

countdown

3-three
2-two
1-one
0-zero!

first/last～最初／最後のループ判定

forloop.first、forloop.lastは最初や末尾のループだけ別の処理をさせたいときに便利。

def for_tag(request):
    context = {
        'firstlast': [1, 2, 3, 4],
    }
    return render(request, 'dtldemo/for_tag.html', context)

def for_tag(request):

context = {

'firstlast': [1, 2, 3, 4],

}

return render(request, 'dtldemo/for_tag.html', context)

    <p>first and last</p>
    <p>
      {% for i in firstlast %}
        {% if forloop.first %}
          &lt;{{ i }},
        {% elif forloop.last %}
          {{ i }}&gt;
        {% else %}
          {{ i }},
        {% endif %}
      {% endfor %}
    </p>

<p>first and last</p>

<p>

{% for i in firstlast %}

{% if forloop.first %}

<{{ i }},

{% elif forloop.last %}

{{ i }}>

{% else %}

{{ i }},

{% endif %}

{% endfor %}

</p>

first and last

<1, 2, 3, 4>

この例では、最初の要素の前に'<'を出力し、最後の要素の後ろにカンマを付けずに'>'を出力する。

parentloop～親ループ

foroop.parentloopは言わば「親ループの～」という意味で、この後にcounterやfirstなどを付けて親ループの値を参照する。たとえば、

forloop.parentloop.counter：親ループの現在のカウンター値
forloop.parentloop.first：親ループが現在最初のループ中ならTrue

たとえば以下の例では、二重ループを回しながら、一番最初の行の先頭要素の前と一番最後の行の末尾要素の後に別の文字を出力させている。

def for_tag(request):
    context = {
        'digits': [1, 2, 3],
    }
    return render(request, 'dtldemo/for_tag.html', context)

def for_tag(request):

context = {

'digits': [1, 2, 3],

}

return render(request, 'dtldemo/for_tag.html', context)

    <p>parentloop</p>
    <code>
      {% for i in digits %}
        {% for j in digits %}
          {% if forloop.parentloop.first and forloop.first %}
            &lt;
          {% endif %}
          {{ i }}-{{ j }}
          {% if forloop.parentloop.last and forloop.last %}
            &gt;
          {% endif %}
        {% endfor %}
        <br>
      {% endfor %}
    </code>

<p>parentloop</p>

<code>

{% for i in digits %}

{% for j in digits %}

{% if forloop.parentloop.first and forloop.first %}

{% endif %}

{{ i }}-{{ j }}

{% if forloop.parentloop.last and forloop.last %}

{% endif %}

{% endfor %}

<br>

{% endfor %}

</code>

parentloop

< 1-1 1-2 1-3 2-1 2-2 2-3 3-1 3-2 3-3 >

Django – DTL – コメント

2022-03-09 / tau / コメントする

一行コメントは{#...#}。コメント内で改行はできない。

{# コメント文 #}

1	{# コメント文 #}

複数行コメントは{% comment %} ... {% endcomment %}。

{% comment %}
  コメント文
  ・・・・・
  コメント文
{% endcomment %}

{% comment %}

コメント文

・・・・・

コメント文

{% endcomment %}

コメント自体の注釈を書くこともできる。

{% comment "コメントの注釈" %}
  コメント文
  ・・・・・
  コメント文
{% endcomment %}

{% comment "コメントの注釈" %}

コメント文

・・・・・

コメント文

{% endcomment %}

Django – DTL – 変数展開

2022-03-09 / tau / コメントする

概要

Djangoのテンプレート内での変数展開は{{ 変数 }}と記述。

単純変数はそのまま内容が展開される
コレクションはリスト、タプル、辞書に応じた表現になる
コレクションの要素は[]ではなくドット(.)で添字やキーを指定
オブジェクトの属性やメソッドもドット(.)で指定

単純変数

単純変数の展開の例を以下に示す。まずview関数。

from django.shortcuts import render

def variable(request):
    context = {
        'var_float': 3.1415,
        'var_string': 'ABCDいろはに',
    }

    return render(request, 'dtldemo/variable.html', context)

from django.shortcuts import render

def variable(request):

context = {

'var_float': 3.1415,

'var_string': 'ABCDいろはに',

}

return render(request, 'dtldemo/variable.html', context)

テンプレートの変数展開部分。

    <p>単純変数</p>
    <ul>
      <li>実数値：{{ var_float }}</li>
      <li>文字列：{{ var_string }}</li>
    </ul>

<ul>

<li>実数値：{{ var_float }}</li>

<li>文字列：{{ var_string }}</li>

</ul>

ブラウザーの表示。

単純変数

実数値：3.1415
文字列：ABCDいろはに

コレクション

コレクションを参照する変数を展開すると、変数をprint文でコンソール出力した時の形式で展開される。

from django.shortcuts import render

def variable(request):
    context = {
        'var_list': ['one', 2, [3, 'three']],
        'var_tuple': ('one', 2, (3, 'three')),
        'var_dict': {'one': 1, 'two': 2, 'three': 3},
    }

    return render(request, 'dtldemo/variable.html', context)

from django.shortcuts import render

def variable(request):

context = {

'var_list': ['one', 2, [3, 'three']],

'var_tuple': ('one', 2, (3, 'three')),

'var_dict': {'one': 1, 'two': 2, 'three': 3},

}

return render(request, 'dtldemo/variable.html', context)

テンプレートの変数展開部分。

    <p>コレクション</p>
    <ul>
      <li>リスト：{{ var_list }}</li>
      <li>タプル：{{ var_tuple }}</li>
      <li>辞　書：{{ var_dict }}</li>
    </ul>

<p>コレクション</p>

<ul>

<li>タプル：{{ var_tuple }}</li>

</ul>

ブラウザーの表示。

コレクション

リスト：[‘one’, 2, [3, ‘three’]]
タプル：(‘one’, 2, (3, ‘three’))
辞　書：{‘one’: 1, ‘two’: 2, ‘three’: 3}

コレクションの要素を展開する場合、Pythonの[]と違ってドット(.)に続けて添字の数値やキーの文字列をそのまま書く。

{{ 変数.添字 }}  または  {{ 変数.キー }}

1	{{ 変数.添字 }} または {{ 変数.キー }}

多次元の場合には、次数に対応して連ねていく。

{{ 変数.1次元目.2次元目 }}

1	{{ 変数.1次元目.2次元目 }}

コレクション全体と同じ例で要素を表示したいときのテンプレートの例。

    <p>コレクションの要素</p>
    <ul>
      <li>
        リストの要素：{{ var_list.0 }}, {{ var_list.1 }},
        {{ var_list.2.0 }}, {{ var_list.2.1 }}
      </li>
      <li>
        タプルの要素：{{ var_tuple.0 }}, {{ var_tuple.1 }},
        {{ var_tuple.2.0 }}, {{ var_tuple.2.1 }}
      </li>
      <li>
        辞書の要素　：{{ var_dict.one }}, {{ var_dict.two }}, {{ var_dict.three }}
      </li>
    </ul>

<p>コレクションの要素</p>

<ul>

<li>

リストの要素：{{ var_list.0 }}, {{ var_list.1 }},

{{ var_list.2.0 }}, {{ var_list.2.1 }}

</li>

<li>

タプルの要素：{{ var_tuple.0 }}, {{ var_tuple.1 }},

{{ var_tuple.2.0 }}, {{ var_tuple.2.1 }}

</li>

<li>

辞書の要素　：{{ var_dict.one }}, {{ var_dict.two }}, {{ var_dict.three }}

</li>

</ul>

ブラウザーの表示。

コレクションの要素

リストの要素：one, 2, 3, three
タプルの要素：one, 2, 3, three
辞書の要素　：1, 2, 3

オブジェクト

クラスのインスタンスを参照する変数も展開できる。以下はviews.pyで単純なクラスを定義して、そのインスタンスをテンプレートに渡している。

from django.shortcuts import render

class BinaryOperation:
    def __init__(self, a, b):
        self.a = a
        self.b = b

    def add(self):
        return self.a + self.b

def variable(request):
    var_obj = BinaryOperation(2, 3)

    context = {
        'var_obj': var_obj,
    }

    return render(request, 'dtldemo/variable.html', context)

from django.shortcuts import render

class BinaryOperation:

def __init__(self, a, b):

self.a = a

self.b = b

def add(self):

return self.a + self.b

def variable(request):

var_obj = BinaryOperation(2, 3)

context = {

'var_obj': var_obj,

}

return render(request, 'dtldemo/variable.html', context)

テンプレートでのオブジェクトの展開は、以下の3種類となる。

オブジェクト全体を展開すると、オブジェクトが文字列にキャストされた表現となる
オブジェクトの属性は、変数と属性名をドット(.)で繋いで得られる
オブジェクトとメソッド名をドット(.)で繋ぐと、メソッドの実行結果が得られる

    <p>オブジェクト</p>
    <ul>
      <li>オブジェクト全体：{{ var_obj }}</li>
      <li>オブジェクトの属性：{{ var_obj.a }}, {{ var_obj.b }}</li>
      <li>オブジェクトのメソッド：{{ var_obj.add }}</li>
    </ul>

<p>オブジェクト</p>

<ul>

<li>オブジェクト全体：{{ var_obj }}</li>

<li>オブジェクトの属性：{{ var_obj.a }}, {{ var_obj.b }}</li>

<li>オブジェクトのメソッド：{{ var_obj.add }}</li>

</ul>

ブラウザーでの表示。

オブジェクト

オブジェクト全体：<dtldemo.views.BinaryOperation object at 0x7fdf2835ec50>
オブジェクトの属性：2, 3
オブジェクトのメソッド：5

フィルター

基本形

フィルターはテンプレート中の変数を加工するもので、Djangoによる組み込みフィルターが多数用意されている。フィルターの基本形は以下のとおり。

{{ 変数|フィルター }}

わかりやすい例としては、変数の文字列の文字数を返すlengthがある。以下のテンプレートでは、var_stringに格納されている文字列とその文字数を表示している。

文字列{{ var_string }}の文字数は{{ var_string|length }}です

1	文字列{{ var_string }}の文字数は{{ var_string\|length }}です

変数の内容が'abcd'の場合、表示は以下のようになる。

文字列abcdeの文字数は5です

1	文字列abcdeの文字数は5です

引数

フィルターには引数を持つものもある。引数はリテラルとする必要がある。

{{ 変数|フィルター:引数 }}

以下の例はaddフィルターで、元の変数の内容に引数の内容を加える。

    <p>{{ var_two|add:3 }}</p>
    <p>{{ var_string|add:'XYZ'}}</p>

1 2	<p>{{ var_two\|add:3 }}</p> <p>{{ var_string\|add:'XYZ'}}</p>

var_two=2、var_string='abcde'の場合、表示は以下のようになる。

5
abcdeXYZ

1 2	5 abcdeXYZ

チェーン

フィルターのチェーンによって、複数のフィルターを作用させることができる。

{{ 変数|フィルター[:引数]|フィルター[:引数] ... }}

以下の例では変数の文字列に文字列定数を連結した上で文字数を得ている。

{{ var_string|add:'efg'|length }}

1	{{ var_string\|add:'efg'\|length }}

var_string='abcde'の場合、結果は’8'となる。

スペースとエラー

'|'や':'の前後にスペースを入れても問題ないが、タグ({% ... %})でフィルターを使う場合にはエラーとなる場合がある。

紛らわしいので、「フィルターを使うときは間のスペースなし」と決めておく方がよい。