Parametry adresu URL i logika w widokach opartych na klasach Django (TemplateView)

97

Nie jest dla mnie jasne, jak najlepiej uzyskać dostęp do parametrów URL w widokach opartych na klasach w Django 1.5.

Rozważ następujące:

Widok:

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

Chcę uzyskać dostęp do yearparametru w moim widoku, więc mogę wykonać logikę, taką jak:

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

Jak najlepiej uzyskać dostęp do parametru url w CBV, takim jak powyższy, który jest podklasą TemplateViewi gdzie najlepiej umieścić taką logikę, np. w metodzie?

Nayan
źródło
Jest opcja prostego extra_contextdyktowania django2, patrz tutaj
Timo

Odpowiedzi:

117

Aby uzyskać dostęp do parametrów adresu URL w widokach opartych na klasach, użyj self.argslub self.kwargstak, aby uzyskać do niego dostęp, wykonującself.kwargs['year']

Ngenator
źródło
1
Czy dobrze rozumiem, że nie powinienem tworzyć zmiennych bezpośrednio w widoku, tak jak powyżej? (coś o tym, że są wytrwali). Nie rozumiem też, gdzie mam umieścić taką logikę jak powyżej, np. w jakiej metodzie? Również kiedy robię year = self.kwargs['year']w widoku, który dostaję NameError: self not defined.
2
Technicznie nie powinieneś, ponieważ są one na poziomie klasy i są zmiennymi klasowymi. A jeśli chodzi o to NameError, gdzie próbujesz zrobić year = self.kwargs['year']? Powinieneś to robić metodą, nie możesz tego robić na poziomie klasy. Na przykład używasz a, TemplateViewco oznacza, że ​​wykonasz logikę w swoim get_context_datazastąpieniu.
Ngenator
4
Tylko w celach informacyjnych: dokumentację dotyczącą self.request, self.args itp. Można znaleźć w docs.djangoproject.com/en/1.10/topics/class-based-views/ ...
LShi
Możesz to również zrobić w def __init__(self):funkcji w klasie, jeśli chcesz uzyskać do niej dostęp poza innymi funkcjami.
Rahat Zaman
61

W przypadku przekazania parametru adresu URL w ten sposób:

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

Możesz uzyskać do niego dostęp w widoku opartym na klasach, używając self.request.GET(nie jest wyświetlany w self.argsani w 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
źródło
5
Dzięki! To mnie wprawiło w zakłopotanie ... Wciąż czytam rzeczy, które sugerują, że parametry HTTP będą w kwargach.
foobarbecue
Czy możesz pokazać get_queryset () z nadklasy MyClassBasedView? Zrobiłbym po prostu qs=<Object>.objects.<method>
Timo
24

Znalazłem to eleganckie rozwiązanie i dla django 1.5 lub nowszego, jak wskazano tutaj :

Ogólne widoki oparte na klasach w Django teraz automatycznie uwzględniają zmienną widoku w kontekście. Ta zmienna wskazuje na obiekt widoku.

W Twoim 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)

Rozwiązanie wysyłki znalezione w tym pytaniu .
Ponieważ widok jest już przekazany w kontekście szablonu, nie musisz się o to martwić. W pliku szablonu yearly.html można uzyskać dostęp do tych atrybutów widoku w prosty sposób:

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

Możesz zachować swój adres urlconf bez zmian .

Warto wspomnieć, że pobranie informacji do kontekstu szablonu nadpisuje metodę get_context_data (), więc w jakiś sposób przerywa przepływ fasoli akcji django .

Evhz
źródło
8

Do tej pory mogłem uzyskać dostęp do tych parametrów adresu URL tylko z metody get_queryset, chociaż próbowałem tego tylko z ListView, a nie TemplateView. Użyję parametru url do utworzenia atrybutu w instancji obiektu, a następnie użyję tego atrybutu w get_context_data, aby wypełnić kontekst:

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
Brama piekła
źródło
Wydaje mi się to dziwne, czy jest jakiś błąd lub coś, kiedy próbujesz to zrobić context['year'] = self.kwargs['year']? Powinien być dostępny w każdym miejscu w klasie.
Ngenator,
@Ngenator: Właśnie stworzyłem czysty projekt django, aby dokładnie sprawdzić i okazuje się, że masz rację. Nie jestem pewien, co temu zapobiegało w moim oryginalnym kodzie, ale się dowiem :). Dzięki za
ostrzeżenie
7

Co powiesz na użycie dekoratorów Pythona, aby uczynić to zrozumiałym:

class Yearly(TemplateView):

    @property
    def year(self):
       return self.kwargs['year']
danizen
źródło
Podoba mi się ten. Nieruchomość jest wielokrotnego użytku.
cezar