Parâmetros de URL e lógica em visualizações baseadas em classe do Django (TemplateView)

94

Não está claro para mim como é melhor acessar parâmetros de URL em visualizações baseadas em classe no Django 1.5.

Considere o seguinte:

Visão:

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'
    ),
)

Quero acessar o yearparâmetro em minha visão, para poder fazer lógicas como:

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
        })

Qual seria a melhor forma de acessar o parâmetro url em CBVs como o acima, que é uma subclasse de TemplateViewe onde se deve colocar idealmente a lógica como esta, por exemplo. em um método?

Nayan
fonte
Existe a opção do extra_contextditado simples django2, veja aqui
Timo

Respostas:

113

Para acessar os parâmetros de url em visualizações baseadas em classe, use self.argsou self.kwargsentão você acessaria fazendoself.kwargs['year']

Ngenator
fonte
1
É bem entendido que não devo criar variáveis ​​diretamente na visualização como fiz acima? (algo sobre eles serem persistentes). Também não entendo onde devo colocar a lógica como a acima, por exemplo. em qual método? Também quando eu faço year = self.kwargs['year']na vista eu recebo NameError: self not defined.
2
Tecnicamente, você não deveria, pois eles estão no nível de classe e são variáveis ​​de classe. Quanto ao NameError, onde você está tentando fazer year = self.kwargs['year']? Você deveria fazer isso em um método, você não pode fazer isso no nível da classe. Então, por exemplo, você está usando umTemplateView que significa que você faria a lógica em sua get_context_datasubstituição.
Ngenator
4
Apenas para referência: A documentação sobre self.request, self.args etc. pode ser encontrada em docs.djangoproject.com/en/1.10/topics/class-based-views/…
LShi
Além disso, você pode fazer isso em def __init__(self):função da classe se quiser acessá-lo fora de outras funções.
Rahat Zaman
60

Caso você passe um parâmetro de URL como este:

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

Você pode acessá-lo na visualização baseada em classe usando self.request.GET(não é apresentado em self.argsnem em 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)
niekas
fonte
4
Obrigado! Isso tem me confundido ... Eu continuo lendo coisas que indicam que os parâmetros HTTP estarão nos kwargs.
foobarbecue de
Você pode mostrar o get_queryset () da superclasse de MyClassBasedView? Eu apenas faria qs=<Object>.objects.<method>
Timo
24

Eu encontrei esta solução elegante, e para Django 1.5 ou superior, como apontado aqui :

As visualizações genéricas baseadas em classes do Django agora incluem automaticamente uma variável de visualização no contexto. Esta variável aponta para o seu objeto de visualização.

Em suas 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)

A solução de despacho encontrada nesta questão .
Como a visão já é passada dentro do contexto do Template, você realmente não precisa se preocupar com isso. Em seu arquivo de modelo anual.html, é possível acessar esses atributos de visualização simplesmente:

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

Você pode manter seu urlconf como está.

Vale a pena mencionar que obter informações no contexto do seu modelo sobrescreve o get_context_data (), então de alguma forma está quebrando o fluxo do bean de ação do django .

Evhz
fonte
8

Até agora, só consegui acessar esses parâmetros de url de dentro do método get_queryset, embora eu só tenha tentado com um ListView, não um TemplateView. Usarei o parâmetro url para criar um atributo na instância do objeto e, em seguida, usarei esse atributo em get_context_data para preencher o contexto:

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
portão do Inferno
fonte
Acho estranho, ocorreu um erro ou algo assim quando você tentou fazer context['year'] = self.kwargs['year']? Deve ser acessível em qualquer lugar da classe.
Ngenator
@Ngenator: Acabei de configurar um projeto django limpo para verificar novamente e descobri que você está correto. Não tenho certeza do que estava impedindo isso no meu código original, mas vou descobrir :). Obrigado pelo heads-up
hellsgate
7

Que tal usar decoradores Python para tornar isso inteligível:

class Yearly(TemplateView):

    @property
    def year(self):
       return self.kwargs['year']
danizen
fonte
Eu gosto deste. A propriedade é reutilizável.
cezar