Python – ページ 2 – igreks開発日記

Django FilterViewを使って作成した検索フォームのラベル名変更

FilterView（filters.py）を使うと、検索フォームに表示される検索項目の名前(ラベル名)は、モデルで定義した名前になります。

例えば、モデルに、

class Attendance(models.Model):
       :
    # 出勤日時
    attendance_at = models.DateTimeField(
        verbose_name='出勤日時',
        default=timezone.now,
    )
       :

class Attendance(models.Model):

# 出勤日時

attendance_at = models.DateTimeField(

verbose_name='出勤日時',

default=timezone.now,

)

と書いてあれば、verbose_nameの値(出勤日時)になります。verbose_nameが無い場合はモデル名(attendance_at)になります。

このラベル名を変更する場合は、filters.pyに以下のように追記します。

class AttendanceStatsFilter(FilterSet):

    order_by = MyOrderingFilter(
        # tuple-mapping retains order
        fields=(
            ('attendance_at', 'attendance_at'),
        ),
        field_labels={
            'attendance_at': '出勤日時',
        },
        label='並び順'
    )

    class Meta:

        model = Attendance
        # 検索ボックスに出すフィールド
        fields = (
            'attendance_at',
        )

    """ 追記部分 """
    def __init__(self, *args, **kwargs):
        super(AttendanceStatsFilter, self).__init__(*args, **kwargs)
        self.filters['attendance_at'].label="表示したいラベル名"

class AttendanceStatsFilter(FilterSet):

order_by = MyOrderingFilter(

# tuple-mapping retains order

fields=(

('attendance_at', 'attendance_at'),

field_labels={

'attendance_at': '出勤日時',

label='並び順'

)

class Meta:

model = Attendance

# 検索ボックスに出すフィールド

fields = (

'attendance_at',

)

""" 追記部分 """

def __init__(self, *args, **kwargs):

super(AttendanceStatsFilter, self).__init__(*args, **kwargs)

self.filters['attendance_at'].label="表示したいラベル名"

参考サイト）

https://stackoverflow.com/questions/31686157/django-set-filter-field-label-or-verbose-name

Django Migrate時に「The row in table ‘app_fuga’ with primary key ‘’ has an invalid foreign key: app_fuga.hoge_id contains a value ‘’ that does not have a corresponding value in app_hoge.id.」の解消

エラーの内容

makemigrationsまでは通るのですが、その後migrateしようとすると、以下のようなエラーに遭遇するときがあります。

The row in table 'app_fuga' with primary key '*' has an invalid foreign key: app_fuga.hoge_id contains a value '*' that does not have a corresponding value in app_hoge.id.

1	The row in table 'app_fuga' with primary key '' has an invalid foreign key: app_fuga.hoge_id contains a value '' that does not have a corresponding value in app_hoge.id.

このエラーは、開発環境でモデルを追加したり変更したりmigrateしたりを繰り返していると出ます。

直訳すると、

主キー「*」を持つテーブル「app_fuga」の行に無効な外部キーがあります：app_fuga.hoge_idには、app_hoge.idに対応する値がない値「*」が含まれています。

1	主キー「」を持つテーブル「app_fuga」の行に無効な外部キーがあります：app_fuga.hoge_idには、app_hoge.idに対応する値がない値「」が含まれています。

となり、つまり「子テーブル(app_fuga)の中に、親テーブル(app_hoge)の外部キーらしきIDの値があるけど、そんなIDを持つレコードはapp_hogeにはねーよ！」ということらしいです。

ここでは、app_hoge が親テーブル、app_fuga が子テーブルなので、app_fuga の hoge_id というカラムが、親テーブルのIDを参照する外部キーです。

このカラムに例えば「1」という値が入っていたとすると、app_hogeの中に、IDが「1」のレコードは存在しないと言っていることになります。

DBの中身を見てみる

一応確認します。

sqlite> SELECT * FROM app_fuga WHERE hoge_id = 1
sqlite>

1 2	sqlite> SELECT * FROM app_fuga WHERE hoge_id = 1 sqlite>

？結果がありません。どゆこと？

つまり、hoge_idが「1」となっているレコードが無いのにもかかわらず、「あるし！」と言われているので、訳が分かりません。

結論から言うと、おそらく「app/migrations」に、過去のモデル修正の繰り返しで作成されたマイグレーションファイル（000*_auto_YYYYMMDD_TT.pyとか）が蓄積されている状況で、これらが悪さをしているようです。

新しいマイグレーションファイルは、さらに過去のマイグレーションファイルを参照し、変更の履歴を見てコンフリクトを解消しようとします。

つまりその流れの中で、過去のマイグレーションで行ってきた操作ができなかった時、例えば前提とされているテーブル構造が実際には変わっていたり、あるはずのレコードが削除されてたりすると、途中経過でエラーとなる場合があるみたいです。

今回はおそらく、モデルに新しくデフォルト値などを張った都合で整合性が取れなくなったのかと思います。

解決方法

開発環境なので、手順なんていちいち記録していないことも多いでしょうから、どこで狂ったのかなんてわかりません。

そういう時はマイグレーションファイルを削除するのが手っ取り早いのですが、この場合、全てのアプリのマイグレーションファイルを削除してはいけません。全て削除すると、また同じ結果になります。

おそらくmakemigrationsの順番が関係しているのでしょう。

ポイントは、エラーが出ているテーブルのモデルを定義しているマイグレーションファイルをだけを削除します。

今回は「app_fuga」でエラーが出ているので、「app/migrations」の中の、__init__.py以外を全て削除します。

こうすることで、再度makemigrationsしたときに、どうやら変更履歴を無視して、現在のモデル構造だけを反映したマイグレーションファイルを作ってくれるようです。

無事にmigrateが通りました。

Django テンプレートでDurationフィールドの値の割り算と丸め

簡単な掛け算割り算で出るような値は、いちいちDBに結果を保持するのは冗長です。

views.pyで計算してレンダリングしても良いですが、テンプレートでサクッとやれちゃえば楽です。

しかし、DurationフィールドはTimeフィールドやDatetimeフィールドと違い、データ型が実際は浮動小数点型なので、日付け操作用の組み込みフィルタで小数点以下切り捨てなどがきません。

それになぜか、{{ value|flortformat:0 }} も効きません。

仕方が無いのでフィルタを自作します。

フィルタ自作の方法自体は、こちらが詳しいです。

ここでは、上記サイトの中の「utils.py」の内容だけ説明します。（別に名前は何でもよいです）

from django import template
register = template.Library()


""" 自作テンプレートフィルタ """

# durationフィールドの割り算用 (1秒未満切り捨て)
@register.filter(name="division_duration")
def division_duration(value, args):
    ret = value / args
    total_time = ret.total_seconds()
    hours = int(total_time / 3600) # 時間
    minutes = int(total_time % 3600 / 60) # 分
    seconds = int(total_time % 3600 % 60) # 秒
    return '{:02}:{:02}:{:02}'.format(hours, minutes, seconds)

from django import template

""" 自作テンプレートフィルタ """

# durationフィールドの割り算用 (1秒未満切り捨て)

@register.filter(name="division_duration")

def division_duration(value, args):

ret = value / args

total_time = ret.total_seconds()

hours = int(total_time / 3600) # 時間

minutes = int(total_time % 3600 / 60) # 分

seconds = int(total_time % 3600 % 60) # 秒

return '{:02}:{:02}:{:02}'.format(hours, minutes, seconds)

テンプレートで以下のように書けば、Durationフィールドの割り算と丸めが、できるようになります。

{% load utils %}

作業時間は、1ダースあたり
{{ duration_value|division_duration:12 }}
です。

{% load utils %}

作業時間は、1ダースあたり

です。

参考サイト）

https://ja.coder.work/so/python/577761

Django テンプレートでchoicesの名前の方を出す

{{ ’クラス名’.get_’モデル名’_display }} で取得できます。

models.py

class Attendance(models.Model):
      :
    STATUS_CHOICES = (
        (0, "退勤中"),
        (1, "出勤中"),
    )
    status = models.IntegerField(
        verbose_name='状態',
        default=1,
        choices=STATUS_CHOICES,
    )
      :

class Attendance(models.Model):

STATUS_CHOICES = (

(0, "退勤中"),

(1, "出勤中"),

)

status = models.IntegerField(

verbose_name='状態',

default=1,

choices=STATUS_CHOICES,

)

template

あなたは現在、{{ attendance.get_status_display }} です。

1	あなたは現在、{{ attendance.get_status_display }} です。

Django データ保存後に遷移先ページで簡単なメッセージを出す

messagesクラスを使い、遷移先またはbase.htmlでメッセージを表示させます。

views.py

from django.contrib.auth.mixins import LoginRequiredMixin
from django.views.generic.edit import CreateView
from django.shortcuts import redirect
from .models import Hoge
from .forms import HogeForm
from django.contrib import messages

class HogeCreateView(LoginRequiredMixin, CreateView):
    model =  Hoge
    form_class =  HogeForm
           :
    def form_valid(self, form):
        post = form.save(commit=False)
           :
        post.save()
        messages.info(self.request, f'保存しました！')
        return redirect('hoge:top')

from django.contrib.auth.mixins import LoginRequiredMixin

from django.views.generic.edit import CreateView

from django.shortcuts import redirect

from .models import Hoge

from .forms import HogeForm

from django.contrib import messages

class HogeCreateView(LoginRequiredMixin, CreateView):

model = Hoge

form_class = HogeForm

def form_valid(self, form):

post = form.save(commit=False)

post.save()

messages.info(self.request, f'保存しました！')

return redirect('hoge:top')

base.html

{% load static %}<!doctype html>
<html lang="ja">
<head>
  :
</head>
<body>

    <!-- メッセージ表示 -->
    {% if messages %}
      {% for message in messages %}
      <p> {{ message }}</p>
      {% endfor %}
    {% endif %}

    <!-- メインコンテンツ -->
    <div class="container">
        {% block content %}{% endblock %}
    </div>


</body>
</html>

{% load static %}<!doctype html>

<head>

</head>

<body>

{% if messages %}

{% for message in messages %}

<p> {{ message }}</p>

{% endfor %}

{% endif %}

{% block content %}{% endblock %}

</div>

</body>

</html>

Django CreateViewやUpdateView利用時、任意のデータを裏側で保存する

CreateViewやUpdateViewを使うけど、ボタンを押すだけのパターン（保存する値がすでに決まっているパターン）にしたい時とか、一部だけ選択させてそれ以外は決まった値を保存したい時。

たとえば、出退勤を記録するための出勤ボタン/退勤ボタン。

そういうケースでは、そもそもクラスビューを使う必要もなさそうだか、改修時に固定値を1個だけ追加したいとかあるかもしれない。

form_validメソッドをオーバーライドします。

views.py

from django.contrib.auth.mixins import LoginRequiredMixin
from django.views.generic.edit import CreateView, UpdateView
from django.utils import timezone
from .models import Hoge
from .forms import HogeForm

""" 登録画面 """
class HogeCreateView(LoginRequiredMixin, CreateView):
    model =  Hoge
    form_class =  HogeForm

    # form_valid関数をオーバーライドすることで、更新するフィールドと値を指定できる
    def form_valid(self, form):
        post = form.save(commit=False)
        # employeeフィールドはログインしているユーザ名とする
        post.employee = self.request.user
        # statusフィールドには1(出勤)を指定する
        post.status = 1
        # 出勤日時。念のためmodelの初期値もtimezone.now()にしといたほうが良いかも
        post.attendance_at = timezone.now()
        post.save()
        return redirect('hoge:top')

from django.contrib.auth.mixins import LoginRequiredMixin

from django.views.generic.edit import CreateView, UpdateView

from django.utils import timezone

from .models import Hoge

from .forms import HogeForm

""" 登録画面 """

class HogeCreateView(LoginRequiredMixin, CreateView):

model = Hoge

form_class = HogeForm

# form_valid関数をオーバーライドすることで、更新するフィールドと値を指定できる

def form_valid(self, form):

post = form.save(commit=False)

# employeeフィールドはログインしているユーザ名とする

post.employee = self.request.user

# statusフィールドには1(出勤)を指定する

post.status = 1

# 出勤日時。念のためmodelの初期値もtimezone.now()にしといたほうが良いかも

post.attendance_at = timezone.now()

post.save()

return redirect('hoge:top')

forms.py

from django import forms
from .models import Hoge

# 出勤用
class HogeForm(forms.ModelForm):

    class Meta:
        model = Hoge
        # 今回は保存値がすでに決まっているのでfield,widgetsは不要
        # 必要ならばここに追加
        fields = (
        )
        widgets = {
        }

from django import forms

from .models import Hoge

# 出勤用

class HogeForm(forms.ModelForm):

class Meta:

model = Hoge

# 今回は保存値がすでに決まっているのでfield,widgetsは不要

# 必要ならばここに追加

fields = (

)

widgets = {

}

hoge_form.html

{{ form.certifications.errors }}
<div class="container">

    <form method="post" id="attendance_form">
         {%crispy form%}
    </form>

    <a id="attendance" class="save" href="#">出勤する</a>

</div>

<script type="text/javascript">
    $(function(){
        "use strict";
        $('.save').on('click', function (e) {
            if(!confirm("出勤します。よろしいですか？")){
                return false;
            };
            $('.save').addClass('disabled');
            $('#attendance_form').submit();
        })
    });
</script>

{%crispy form%}

</form>

</div>

$(function(){

"use strict";

$('.save').on('click', function (e) {

if(!confirm("出勤します。よろしいですか？")){

return false;

};

$('.save').addClass('disabled');

$('#attendance_form').submit();

})

});

</script>

参考サイト）

Django UpdateViewなどで、データを作成したユーザ以外更新できないようにする

要するに、手書きでのpkのURLを書き換えられた時の対策。get_querysetメソッドをオーバーライドする。

views.py

from django.contrib.auth.mixins import LoginRequiredMixin
from django.views.generic.edit import UpdateView
from django.shortcuts import redirect

""" 更新画面 """ 
class HogeUpdateView(LoginRequiredMixin, UpdateView):
    template_name = 'hoge_update.html'
    model = Hoge
      :
    # ログインしているユーザが作ったもでなければアクセス不可
    def get_queryset(self):
    	# このビューで生成されるベースとなるクエリセットを取得
        base_qs = super(HogeUpdateView, self).get_queryset()
        # さらにユーザIDで絞った結果を返す。(存在しないので404が返る)
        # 条件分岐してエラーページを出しても可
        return base_qs.filter(created_by=self.request.user)

from django.contrib.auth.mixins import LoginRequiredMixin

from django.views.generic.edit import UpdateView

from django.shortcuts import redirect

""" 更新画面 """

class HogeUpdateView(LoginRequiredMixin, UpdateView):

template_name = 'hoge_update.html'

model = Hoge

# ログインしているユーザが作ったもでなければアクセス不可

def get_queryset(self):

# このビューで生成されるベースとなるクエリセットを取得

base_qs = super(HogeUpdateView, self).get_queryset()

# さらにユーザIDで絞った結果を返す。(存在しないので404が返る)

# 条件分岐してエラーページを出しても可

return base_qs.filter(created_by=self.request.user)

参考サイト）

https://ja.coder.work/so/django/1026438

Django 特定のフィールドでGROUP BYして集計する

※model, urlsの定義は割愛します。

DBオブジェクト操作時、values(‘カラム名’).annotate(…)の順で書くと、カラム名でGROUP BYされた動きになります。

またvaluesするときでもannotateするときでも、’ラベル=カラム名’とすると、別名(ラベル名)で受け取れます。

#例）社員のタスク時間を集計して降順にソート
model = Task
groupby_employee = Task.objects.values('employee').annotate(
        	    total=Sum('task_time'),
            ).order_by('total').reverse()

#例）社員のタスク時間を集計して降順にソート

model = Task

groupby_employee = Task.objects.values('employee').annotate(

total=Sum('task_time'),

).order_by('total').reverse()

select_related を加えるとで外部キー参照している親テーブルをJOINできます。

#例）社員のタスク時間を集計して降順にソート（社員名が定義されている親テーブルをJOIN）
model = Task
groupby_employee = Task.objects.select_related().values('employee').annotate(
        	    total=Sum('task_time'),
            ).order_by('total').reverse()

#例）社員のタスク時間を集計して降順にソート（社員名が定義されている親テーブルをJOIN）

model = Task

groupby_employee = Task.objects.select_related().values('employee').annotate(

total=Sum('task_time'),

).order_by('total').reverse()

親テーブルをJOINした時、values に ‘キー_親テーブルのカラム名’を指定すると、親テーブルの値を取得できます。

#例）社員のタスク時間を集計して降順にソート（社員名が定義されている親テーブルをJOIN）
#　  さらに社員名も取得
model = Task
groupby_employee = Task.objects.select_related().values(
                'employee',
                'employee__full_name'
            ).annotate(
        	    total=Sum('task_time'),
            ).order_by('total').reverse()

#例）社員のタスク時間を集計して降順にソート（社員名が定義されている親テーブルをJOIN）

#　さらに社員名も取得

model = Task

groupby_employee = Task.objects.select_related().values(

'employee',

'employee__full_name'

).annotate(

total=Sum('task_time'),

).order_by('total').reverse()

具体的なview.py、templateの内容は以下のようになります。

views.py

from django.contrib.auth.mixins import LoginRequiredMixin
from django.views.generic import TemplateView
from django.db.models import Sum
class TaskStatsView(LoginRequiredMixin, TemplateView):

    model = Task
    template_name = 'template.html'

    # getメソッドをオーバーライドするパターン
    def get(self, request, **kwargs):
        # 社員のタスク時間を集計して降順にソート(社員名が定義されている親テーブルをJOIN。さらに社員名も取得)
        groupby_employee = Task.objects.select_related().values(
                'employee',
                'employee__full_name'
            ).annotate(
        	total=Sum('task_time'),
            ).order_by('total').reverse()

        context = {
            'groupby_employee' : groupby_employee,
        }

        return self.render_to_response(context)

from django.contrib.auth.mixins import LoginRequiredMixin

from django.views.generic import TemplateView

from django.db.models import Sum

class TaskStatsView(LoginRequiredMixin, TemplateView):

model = Task

template_name = 'template.html'

# getメソッドをオーバーライドするパターン

def get(self, request, **kwargs):

# 社員のタスク時間を集計して降順にソート(社員名が定義されている親テーブルをJOIN。さらに社員名も取得)

groupby_employee = Task.objects.select_related().values(

'employee',

'employee__full_name'

).annotate(

total=Sum('task_time'),

).order_by('total').reverse()

context = {

'groupby_employee' : groupby_employee,

}

return self.render_to_response(context)

template.html

別名を付けたものは辞書型で取り出せます。別名付けなかった場合は、Sumしたものであれば ‘カラム名__sum’ の形で取り出せます。

<table>
    {% for e in groupby_employee %}
    <tr>
      <!-- 親テーブルから参照した社員名 -->
      <td>社員名：{{ e.employee__full_name|default:"(社員名未設定)" }}</td>
      <!-- totalという名前を付けた値 = Sum('task_time') -->
      <td>総タスク時間：{{ e.total }}</td>
      <!-- Sum('task_time')に名前を付けなかった場合 -->
      <td>総タスク時間：{{ e.task_time__sum }}</td>
    </tr>
    {% endfor %}
</table>

<table>

{% for e in groupby_employee %}

<tr>

<td>社員名：{{ e.employee__full_name|default:"(社員名未設定)" }}</td>

<td>総タスク時間：{{ e.total }}</td>

<td>総タスク時間：{{ e.task_time__sum }}</td>

</tr>

{% endfor %}

</table>

Django 前回のフォーム入力値を保持・出力する

入力値データをsessionに保存して行いますが、多少複雑なので、クラスビューではなく関数ビューを使うのが良いかと思います。

views.py

from .forms import HogeForm
from django.shortcuts import redirect

def HogeCreateView(request):
    # 一覧表示からの遷移や、確認画面から戻った時
    if request.method == 'GET':
        # セッションにデータがあればそれを使う
        form = HogeForm(request.session.get('form_data'))
    # 送信ボタンが押された時(POSTされた時)
    else:
        # POST
        form = HogeForm(request.POST)
        # 送信された値が正しかった時の処理
        if form.is_valid():
            # 保存
            form.save()
            # セッションにデータを格納
            request.session['form_data'] = request.POST
            # 遷移させるページ
            return redirect('hoge:top')
    # コンテキストにフォームのオブジェクトを指定してレンダリング
    context = {
        'form': form,
    }
    return render(request, 'hoge_form.html', context)

from .forms import HogeForm

from django.shortcuts import redirect

def HogeCreateView(request):

# 一覧表示からの遷移や、確認画面から戻った時

if request.method == 'GET':

# セッションにデータがあればそれを使う

form = HogeForm(request.session.get('form_data'))

# 送信ボタンが押された時(POSTされた時)

else:

# POST

form = HogeForm(request.POST)

# 送信された値が正しかった時の処理

if form.is_valid():

# 保存

form.save()

# セッションにデータを格納

request.session['form_data'] = request.POST

# 遷移させるページ

return redirect('hoge:top')

# コンテキストにフォームのオブジェクトを指定してレンダリング

context = {

'form': form,

}

return render(request, 'hoge_form.html', context)

テンプレートの、テンプレートタグ{{ form }}に、フォームと値がセットされます。

以上、備忘録。

djangoのCreateViewでフォームの初期値を設定する方法

get_initial関数をオーバーライドします。

class HogeCreateView(CreateView):
        :
     def get_initial(self):
          initial = super().get_initial()
          initial["name"] = "山田太郎"
          initial["age"] = 22
          return initial

class HogeCreateView(CreateView):

def get_initial(self):

initial = super().get_initial()

initial["name"] = "山田太郎"

initial["age"] = 22

return initial

以上、備忘録。