Django | RemoNote

【Django】Bootstrap4を使ってリダイレクト先でメッセージを表示する

Djangoでデフォルトで用意されているmessages framework + Bootstrap4を使って、CRUD操作の際のリダイレクト先でメッセージを表示させる手順のメモです。

実行環境

環境はこちらです。

Python 3.7.1

Django 2.1.2

django-bootstrap4 0.0.7

構成はこのようになります。今回、編集／追加するファイルのみ記載しています。

mydir

├── blog

│ └── views.py

├── myproject

│ └── settings.py

├── static

│ ├── css

│ │ ├── bootstrap.min.css

│ │ └── style.css

│ └── js

│ └── jquery-3.3.1.min.js

├── templates

│ └── base.html

上記のディレクトリにダウンロードした、bootstrap.min.css と jquery-3.3.1.min.js を配置します。
https://getbootstrap.com/docs/4.1/getting-started/download/
https://jquery.com/download/

実装

次のコマンドでbootstrap4をインストールします。

1	$ pip install django-bootstrap4

Settings

settings.pyに’bootstrap4′, を追記します。’django.contrib.messages’はデフォルトで入っています。

mydir/myproject/settings.py

INSTALLED_APPS = [

'django.contrib.admin',

'django.contrib.auth',

'django.contrib.contenttypes',

'django.contrib.sessions',

'django.contrib.messages',

'django.contrib.staticfiles',

'blog.apps.BlogConfig',

'accounts.apps.AccountsConfig',

'bootstrap4', # 追加

]

一時的なメッセージを保存するための、ストレージはデフォルトで’FallbackStorage’になっています。変更する場合は、以下のように、指定します。
本家ドキュメント参照

mydir/myproject/settings.py

1	MESSAGE_STORAGE = 'django.contrib.messages.storage.cookie.CookieStorage'

Views

ビューにメソッド・メッセージを記述していきます。メッセージタグは’debug’, ‘info’, ‘success’, ‘warning’, ‘error’を指定できます。

mydir/blog/views.py

from django.contrib import messages

class CreateView(LoginRequiredMixin, generic.edit.CreateView):

model = Article

fields = ['title', 'text']

def form_valid(self, form):

form.instance.author = self.request.user

messages.success(self.request, "「{}」を作成しました!".format(form.instance)) # 追加

return super(CreateView, self).form_valid(form)

class UpdateView(LoginRequiredMixin, generic.edit.UpdateView):

model = Article

fields = ['title', 'text']

def form_valid(self, form):

messages.info(self.request, "「{}」を更新しました!".format(form.instance)) # 追加

return super(UpdateView, self).form_valid(form)

class DeleteView(LoginRequiredMixin, generic.edit.DeleteView):

model = Article

success_url = reverse_lazy('blog:index')

def delete(self, request, *args, **kwargs):

result = super().delete(request, *args, **kwargs)

messages.error(self.request, '「{}」を削除しました!'.format(self.object)) # 追加

return result

Templates

共通テンプレートで bootstrap4, css , js を読み込み、メッセージを表示する記述を加えます。

mydir/templates/base.html

{% load static %}

{% load bootstrap4 %}

<!DOCTYPE html>

<html>

<head>

<title>title</title>

</head>

<body>

</header>

{% if messages %}

{% for message in messages %}

</div>

{% endfor %}

{% endif %}

{% block content %}{% endblock %}

</body>

</html>

jQueryで自動的に非表示にする

アラート・メッセージは表示し続けるより、さりげなく、フェードアウトさせる方がいい！という方は、jQueryのsetTimeout関数を使うと実現できます。今回はオプションをfadeOut(‘slow’)、タイミングは「3000」で３秒後としてみました。

$(function(){

setTimeout("$('.alert').fadeOut('slow')", 3000)

})

</script>

CSSでスタイル調整

ブートストラップ感に飽きてきたら、CSSで上書きしましょう！大雑把ですが（汗）。

mydir/static/css/style.css

.alert-info {

text-align: center !important;

color: #f9f9f9 !important;

background-color: #0bbdde !important;

border-color: #0bbdde !important;

border-radius: 0.2rem !important;

}

button.close {

color: #ffffff !important;

opacity: 1 !important;

font-weight: 300 !important;

}

以上です！ご覧いただき、ありがとうございました！！😌

【Django】「No URL to redirect to. Either provide a url or define a get_absolute_url method on the Model.」の対処

エラー内容

Djangoの CRUD ジェネリックビューを使っていて、Createをした時に、次のようなエラーがでました！

対処法

リダイレクト先のURLがないとのこと。。。エラーメッセージそのままですが、 get_absolute_url メソッドをモデルに設定するのを忘れていました！
本家ドキュメント参照

myapp/models.py

class Article(models.Model):

title = models.CharField(max_length=255)

text = models.TextField()

# 追加

def get_absolute_url(self):

return reverse('myapp:detail', kwargs={'pk': self.pk})

これで、Createアクション後にdetailパスにリダイレクトするようになりました！
idのないindexなどに飛ばす場合は return reverse(‘blog:index’) でOKです。

その他関連ファイルです。

myapp/urls.py

app_name = 'myapp'

urlpatterns = [

path('', views.IndexView.as_view(), name='index'),

path('article/create/', views.CreateView.as_view(), name='create'),

path('article/<int:pk>/', views.DetailView.as_view(), name='detail'),

path('article/<int:pk>/update/', views.UpdateView.as_view(), name='update'),

path('article/<int:pk>/delete/', views.DeleteView.as_view(), name='delete'),

]

myapp/views.py

from django.views import generic

class CreateView(LoginRequiredMixin, generic.edit.CreateView):

model = Article

fields = ['title', 'text']

以上です！どなたかの参考になれば、幸いです！😊

【Django入門】Hello Worldの表示と、Templateでhtmlページの表示

前回の【 Django入門】venv（仮想環境）でプロジェクトを立ち上げて GitHubにpushするまでの続きとして、ビューでHello Worldの表示と、Templateを使って、htmlページを表示するまでのメモです。

バージョンはこちらです

1 2	Python 3.7.1 Django 2.1.2

前回まででは次のような構成になっています。

d-project

├── mysite

│ ├── __pycache__

│ ├── __init__.py

│ ├── settings.py

│ ├── urls.py

│ └── wsgi.py

├── myvenv

├── db.sqlite3

├── gitignore

├── manage.py

└── requirements.txt

Hellow, World!するまで

d-projectに移動して、仮想環境をアクティブにします。（ここではmyvenv）

1	$ source myvenv/bin/activate

d-project/配下に、myappという名前でアプリを作成します。

1	$ python manage.py startapp myapp

myapp/views.pyにHTTPレスポンスで”Hello, World!”を返すように記述します。

myapp/views.py

from django.http import HttpResponse

def index(request):

return HttpResponse("Hello, World!")

myapp/配下にurls.py を作成して、views.indexと紐づかせて、ルートurlで表示させます。

myapp/urls.py

from django.conf.urls import url

from . import views

urlpatterns = [

url(r'^$', views.index, name='index'),

]

mysite/urls.pyも以下のように、編集します。

mysite/urls.py

from django.contrib import admin

from django.conf.urls import include, url

urlpatterns = [

url(r'^admin/', admin.site.urls),

url(r'^$', include('myapp.urls')),

]

INSTALLED_APPSに’myapp’を追加します。

mysite/settings.py

INSTALLED_APPS = [

'django.contrib.admin',

'django.contrib.auth',

'django.contrib.contenttypes',

'django.contrib.sessions',

'django.contrib.messages',

'django.contrib.staticfiles',

'myapp', #　ここを追加

]

これで http://127.0.0.1:8000 にアクセスして、”Hello, World!”が表示されたら成功です！

テンプレートでhtmlページの表示

これまでのファイルにいくつかの記述を追加していきます。myapp/urls.pyにはviews.indexでtemplateを呼ぶようにurlに記述します。

myapp/urls.py

from django.conf.urls import url

from . import views

urlpatterns = [

url(r'^$', views.index, name='index'),

url(r'^template/$', views.index, name="index"), #ここを追加

]

mySite/settings.pyに以下の１行を追加して、templatesのpathを指定します。

mysite/settings.py

TEMPLATES = [

{

'BACKEND': 'django.template.backends.django.DjangoTemplates',

'DIRS': [os.path.join(BASE_DIR, 'templates'),], #ここを追加

'APP_DIRS': True,

'OPTIONS': {

'context_processors': [

'django.template.context_processors.debug',

'django.template.context_processors.request',

'django.contrib.auth.context_processors.auth',

'django.contrib.messages.context_processors.messages',

]

d-project/配下に、templatesディレクトリを作成して、その中に共通して使用する親テンプレートとなるmain.htmlを作成して、以下のように記述します。
「{% block ブロック名 %}」と「{% endblock %}」で囲まれた部分は子テンプレートを継承します。

templates/main.html

<!DOCTYPE html>

<html>

</head>

<body>

{% block body %}

{% endblock %}

</body>

</html>

templates/index.htmlを以下のように作成します。「{% extends “親テンプレート名” %}」で継承します。

templates/index.html

{% extends "main.html" %}

{% block body %}

<p>welcome template！</p>

{% endblock %}

myapp/views.pyの以下の箇所を追記します。

myapp/views.py

from django.http.response import HttpResponse　#ここを変更

from django.shortcuts import render　　　　　　　#ここを追加

def index(request):

return render(request, 'index.html') 　　　 #ここを変更

これで http://127.0.0.1:8000 にアクセスして、”welcome template!”が表示されたら成功です！

以上です！ご覧いただき、ありがとうございました！！☺️

【 Django入門】venv（仮想環境）でプロジェクトを立ち上げて GitHubにpushするまで

Pythonのwebフレームワークである、Djangoを Mac + venv（仮想環境）で、ローカル環境に立ち上げて、GitHubにpushするまでをメモしました。

Pythonのバージョン

MacOSの場合、デフォルトでPython2系がインストールされているかと思います。バージョンを確認する場合、ターミナルで以下のコマンドを実行します。

1	$ python --version

最新のバージョンをインストールする場合は、Python公式サイトよりダウンロードして、インストールしてください。（2018.10.24現在はPython 3.7.1）

venv（仮想環境）の作成

適当なディレクトリ（ここではd-project）を作って、そこに移動します。

$ mkdir d-project

$ cd d-project

python3のバージョンを指定して、次のコマンドで、venv(仮想環境)を作成します。（ここではmyvenv）venvはPython3.3 から標準で取り込まれています。

1	$ python3 -m venv myvenv

仮想環境をアクティブにします。

1	$ source myvenv/bin/activate

アクティブモードから抜けるときは $ deactivate です。

Djangoのインストール

Djangoのインストールには、pip（ピップ）というPythonのパッケージを管理するツールを使用します。Macはデフォルトでpipが導入されていて、 $ pip -V コマンドで確認ができます。まずはpipを最新バージョンにします。venv内ではpythonのバージョン指定は不要です。

1	$ python -m pip install --upgrade pip

次のコマンドを実行すると、最新のバージョンのDjangoがインストールされます。Django公式サイトにてlatest official versionが確認できます。

1	$ pip install django

次のコマンドはpipで管理しているパッケージの確認ができます。

1	$ pip freeze

Djangoプロジェクトを作成

それでは次のコマンドでプロジェクト（ここではmysite）を作成します。コマンドの最後にピリオド . を忘れないように。これは、現在の作業ディレクトリにDjangoをインストールするということを示しています。

1	$ django-admin startproject mysite .

プロジェクトを起動する前に、myite/settings.pyに言語とタイムゾーンを日本に設定しておきます。

mysite/settings.py

# 言語を日本語に

LANGUAGE_CODE = 'ja'

# タイムゾーンを日本に

TIME_ZONE = 'Asia/Tokyo'

次のコマンドを実行して、データベースを作成します。

1	$ python manage.py migrate

サーバーの起動

次のコマンドでローカルサーバーの起動をします。

1	$ python manage.py runserver

http://127.0.0.1:8000/ にアクセスして、次のような画面が表示されたら、成功です！ちなみに、サーバーの停止はショートカットで Control + C です。

GitHubへpush

GitHubのアカウントを取得していない場合はGitHubページから、アカウント登録をします。

ルート・ディレクトリで次のコマンドを打ち、Gitリポジトリの新規作成、または既存のGitリポジトリの再初期化を行います。

1	$ git init

Gitはすべてのファイルの変更履歴を管理しますが、管理対象に含めたくないファイルは .gitignore をルート・ディレクトリに作成して管理します。内容は以下の通りとしました。

.gitignore

*.pyc

__pycache__

myvenv

db.sqlite3

/static

.DS_Store

次のコマンドで、カレントディレクトリ（自分の今いるディレクトリ）以下の全てのファイルをステージングエリアに追加します。「.」がカレントディレクトリを示します。

1	$ git add .

「-m」フラグで、コミットメッセージをつけて変更をコミット(保存)します。

1	$ git commit -m "initialize repository"

※「git add .」と「git commit -m」を一度に行う場合は「git commit -a -m “コミットメッセージ”」です。

GitHubページで New repository を作成しておき、次のコマンドでリモートリポジトリを追加します。

1	$ git remote add origin https://github.com/<user-name>/<repository-name>.git

そして、次のコマンドで、ローカルリポジトリを、リモートリポジトリにプッシュ（同期)します。

1	$ git push -u origin master

Username と Password を聞かれるのでGitHubのアカウント設定のものを入力します。

以上です！ご覧いただき、ありがとうございました！😀

続編として、【Django入門】Hello Worldの表示と、Templateでhtmlページの表示も合わせて、ご覧ください！