Djangoクラスベースビュー(TemplateView)のURLパラメータとロジック


94

Django 1.5のclass-based-viewsでURLパラメータにアクセスするのがどのように最適であるかは、私にはわかりません。

以下を検討してください。

見る:

from django.views.generic.base import TemplateView


class Yearly(TemplateView):
    template_name = "calendars/yearly.html"

    current_year = datetime.datetime.now().year
    current_month = datetime.datetime.now().month

    def get_context_data(self, **kwargs):
        context = super(Yearly, self).get_context_data(**kwargs)
        context['current_year'] = self.current_year
        context['current_month'] = self.current_month
        return context

URLCONF:

from .views import Yearly


urlpatterns = patterns('',
    url(
        regex=r'^(?P<year>\d+)/$',
        view=Yearly.as_view(),
        name='yearly-view'
    ),
)

yearビューでパラメーターにアクセスしたいので、次のようなロジックを実行できます。

month_names = [
    "January", "February", "March", "April", 
    "May", "June", "July", "August", 
    "September", "October", "November", "December"
]

for month, month_name in enumerate(month_names, start=1):
    is_current = False
    if year == current_year and month == current_month:
        is_current = True
        months.append({
            'month': month,
            'name': month_name,
            'is_current': is_current
        })

サブクラス化された上記のようなCBVのurlパラメータにどのようにアクセスするのが最適でTemplateViewあり、このようなロジックを理想的にどこに配置する必要がありますか。メソッドで?


にはシンプルなextra_context辞書のオプションがありdjango2ます。ここを
Timo

回答:


113

クラスベースのビュー、使用中のURLパラメータにアクセスするself.argsか、self.kwargsあなたがやってそれをアクセスしますself.kwargs['year']


1
上記のようにビューで直接変数を作成することは想定されていないことは正しく理解されていますか?(それらについての何かが持続的です)。また、上記のようなロジックをどこに配置すればよいかわかりません。どの方法で?また、私がyear = self.kwargs['year']ビューで行うとき、私は得NameError: self not definedます。

2
それらはクラスレベルにあり、クラス変数であるため、技術的にはすべきではありません。に関してはNameError、どこでやろうとしているのyear = self.kwargs['year']ですか?メソッドで行う必要があります。クラスレベルではできません。したがって、たとえば、あなたはTemplateViewあなたがget_context_dataオーバーライドでロジックを実行することを意味するを使用しています。
Ngenator 2013

4
参考までに:self.request、self.argsなどのドキュメントは、docs.djangoproject.com / en / 1.10
topics /

またdef __init__(self):、他の関数の外部からアクセスしたい場合は、クラスの関数で実行できます。
Rahat Zaman

60

次のようなURLパラメータを渡す場合:

http://<my_url>/?order_by=created

self.request.GET(にself.argsもにも表示されていないself.kwargs)を使用して、クラスベースのビューでアクセスできます。

class MyClassBasedView(ObjectList):
    ...
    def get_queryset(self):
        order_by = self.request.GET.get('order_by') or '-created'
        qs = super(MyClassBasedView, self).get_queryset()
        return qs.order_by(order_by)

4
ありがとう!これは私を混乱させてきました...私はHTTPパラメータがkwargsにあることを暗示するものを読み続けます。
foob​​arbecue 2014年

MyClassBasedViewのスーパークラスのget_queryset()を表示できますか?私はただそうします qs=<Object>.objects.<method>
Timo

24

ここで指摘しように、私はこのエレガントな解決策を見つけました、そしてdjango 1.5以上のために:

Djangoのジェネリッククラスベースのビューは、自動的にビュー変数をコンテキストに含めます。この変数は、ビューオブジェクトを指します。

あなたのviews.pyで:

from django.views.generic.base import TemplateView    

class Yearly(TemplateView):
    template_name = "calendars/yearly.html"
    # Not here 
    current_year = datetime.datetime.now().year
    current_month = datetime.datetime.now().month

    # dispatch is called when the class instance loads
    def dispatch(self, request, *args, **kwargs):
        self.year = kwargs.get('year', "any_default")

    # other code

    # needed to have an HttpResponse
    return super(Yearly, self).dispatch(request, *args, **kwargs)

この質問で見つかったディスパッチソリューション。ビューがすでにテンプレートコンテキスト内で渡され、あなたが本当にそれを心配する必要はありません。テンプレートファイルyearly.htmlでは、次の方法でこれらのビュー属性にアクセスできます。

{{ view.year }}
{{ view.current_year }}
{{ view.current_month }}

urlconfはそのままにしておくことができます

テンプレートのコンテキストに情報を取得するとget_context_data()が上書きされるため、djangoのアクションBeanフローが何らかの形で破壊されることに言及する価値があります。


8

これまでのところ、get_querysetメソッド内からのみこれらのurlパラメータにアクセスできましたが、TemplateViewではなくListViewでのみ試しました。urlパラメータを使用してオブジェクトインスタンスに属性を作成し、次にその属性をget_context_dataで使用してコンテキストを設定します。

class Yearly(TemplateView):
    template_name = "calendars/yearly.html"

    current_year = datetime.datetime.now().year
    current_month = datetime.datetime.now().month

    def get_queryset(self):
        self.year = self.kwargs['year']
        queryset = super(Yearly, self).get_queryset()
        return queryset

    def get_context_data(self, **kwargs):
        context = super(Yearly, self).get_context_data(**kwargs)
        context['current_year'] = self.current_year
        context['current_month'] = self.current_month
        context['year'] = self.year
        return context

私は奇妙だと思いcontext['year'] = self.kwargs['year']ます、あなたがやろうとしたときにエラーや何かがありますか?クラスのどこからでもアクセスできる必要があります。
Ngenator 2013年

@Ngenator:クリーンなdjangoプロジェクトをセットアップして再確認したところ、あなたが正しいことがわかりました。元のコードでこれを妨げていた理由はわかりませんが、わかります:)。ヘッドアップをありがとう
hellsgate 2013年

7

Pythonデコレータを使用してこれをわかりやすくするのはどうでしょうか。

class Yearly(TemplateView):

    @property
    def year(self):
       return self.kwargs['year']

私はこれが好きです。プロパティは再利用可能です。
セザール、
弊社のサイトを使用することにより、あなたは弊社のクッキーポリシーおよびプライバシーポリシーを読み、理解したものとみなされます。
Licensed under cc by-sa 3.0 with attribution required.