django.urls verktygsfunktionerLink to this heading#reverse()Link to this heading#Funktionen reverse() kan användas för att returnera en absolut sökvägsreferens för en given vy och valfria parametrar, på liknande sätt som taggen url:
viewname kan vara ett URL-mönsternamn eller det anropsbara vyobjekt som används i URLconf. Till exempel:, med följande url:
from news import views\n\npath("archive/", views.archive, name="news-archive")\nkan du använda något av följande för att vända URL:en:
\n# using the named URL\nreverse("news-archive")\n\n# passing a callable object\n# (This is discouraged because you can't reverse namespaced views this way.)\nfrom news import views\n\nreverse(views.archive)\nOm URL:en accepterar argument kan du skicka dem i args. Till exempel:
from django.urls import reverse\n\n\ndef myview(request):\n return HttpResponseRedirect(reverse("arch-summary", args=[1945]))\nDu kan också skicka kwargs i stället för args. Till exempel:
>>> reverse("admin:app_list", kwargs={"app_label": "auth"})\n'/admin/auth/'\nargs och kwargs kan inte skickas till reverse() samtidigt.
Om ingen matchning kan göras, ger reverse() upphov till ett NoReverseMatch undantag.
Funktionen reverse() kan vända ett stort antal reguljära uttrycksmönster för webbadresser, men inte alla möjliga. Den största begränsningen för närvarande är att mönstret inte kan innehålla alternativa val med hjälp av det vertikala strecket ("|"). Du kan mycket väl använda sådana mönster för att matcha mot inkommande webbadresser och skicka dem till visningar, men du kan inte vända sådana mönster.
Med argumentet current_app kan du ge en ledtråd till resolvern som anger vilken applikation den vy som körs för tillfället tillhör. Detta current_app-argument används som en ledtråd för att lösa upp applikationsnamnrymder till URL:er på specifika applikationsinstanser, enligt namespaced URL resolution strategy.
Argumentet urlconf är URLconf-modulen som innehåller de URL-mönster som ska användas för reversering. Som standard används rot-URLconf för den aktuella tråden.
Nyckelordsargumentet query anger parametrar som ska läggas till i den returnerade URL:en. Det kan acceptera en instans av QueryDict (t.ex. request.GET) eller ett värde som är kompatibelt med urllib.parse.urlencode(). Den kodade frågesträngen läggs till den upplösta URL:en, med en ? som prefix.
Nyckelordsargumentet fragment anger en fragmentidentifierare som ska läggas till i den returnerade URL:en (dvs. efter sökvägen och frågesträngen, föregånget av #).
Till exempel:
\n>>> from django.urls import reverse\n>>> reverse("admin:index", query={"q": "biscuits", "page": 2}, fragment="results")\n'/admin/?q=biscuits&page=2#results'\n>>> reverse("admin:index", query=[("color", "blue"), ("color", 1), ("none", None)])\n'/admin/?color=blue&color=1&none=None'\n>>> reverse("admin:index", query={"has empty spaces": "also has empty spaces!"})\n'/admin/?has+empty+spaces=also+has+empty+spaces%21'\n>>> reverse("admin:index", fragment="no encoding is done")\n'/admin/#no encoding is done'\nomvänd_lazy()Link to this heading#En lättsamt utvärderad version av reverse().
\nDen är användbar när du behöver använda en URL-reversering innan projektets URLConf har laddats. Några vanliga fall där denna funktion är nödvändig är:
\ntillhandahålla en omvänd URL som url-attribut för en generisk klassbaserad vy.
tillhandahålla en omvänd URL till en dekorator (t.ex. argumentet login_url för dekoratorn django.contrib.auth.decorators.permission_required()).
tillhandahålla en omvänd URL som standardvärde för en parameter i en funktions signatur.
resolve()Link to this heading#Funktionen resolve() kan användas för att lösa upp URL-sökvägar till motsvarande vyfunktioner. Den har följande signatur:
path är den URL-sökväg du vill lösa. Precis som med reverse() behöver du inte oroa dig för parametern urlconf. Funktionen returnerar ett ResolverMatch-objekt som gör att du kan komma åt olika metadata om den upplösta URL:en.
Om URL:en inte kan lösas, ger funktionen upphov till ett Resolver404-undantag (en underklass till Http404) .
Den vyfunktion som ska användas för att betjäna URL:en
\nDe argument som ska skickas till view-funktionen, som de tolkats från URL:en.
\nAlla nyckelordsargument som ska skickas till vyfunktionen, dvs captured_kwargs och extra_kwargs.
De fångade nyckelordsargument som skulle skickas till visningsfunktionen, som de tolkats från URL:en.
\nDe ytterligare nyckelordsargument som ska skickas till view-funktionen.
\nNamnet på det URL-mönster som matchar URL:en.
\nRutten för det matchande URL-mönstret.
\nOm till exempel path('users/<id>/', ...) är det matchande mönstret kommer route att innehålla 'users/<id>/'.
Listan över URL-mönster som provades innan URL:en antingen matchade ett eller uttömde tillgängliga mönster.
\nApplikationens namnrymd för det URL-mönster som matchar URL:en.
\nListan över enskilda namnrymdskomponenter i hela applikationens namnrymd för det URL-mönster som matchar URL:en. Om t.ex. app_name är 'foo:bar, kommer app_names att vara ['foo', 'bar'].
Instansnamnrymden för det URL-mönster som matchar URL:en.
\nListan över enskilda namnrymdskomponenter i den fullständiga instansens namnrymd för det URL-mönster som matchar URL:en. dvs. om namnrymden är foo:bar kommer namnrymderna att vara ['foo', 'bar'].
Namnet på den vy som matchar URL:en, inklusive namnrymden om det finns en sådan.
\nEtt ResolverMatch-objekt kan sedan förfrågas för att ge information om det URL-mönster som matchar en URL:
# Resolve a URL\nmatch = resolve("/some/path/")\n# Print the URL pattern that matches the URL\nprint(match.url_name)\nEtt ResolverMatch-objekt kan också tilldelas en trippel:
func, args, kwargs = resolve("/some/path/")\nEn möjlig användning av resolve() skulle vara att testa om en vy skulle ge upphov till ett Http404-fel innan den omdirigeras till den:
from urllib.parse import urlsplit\nfrom django.urls import resolve\nfrom django.http import Http404, HttpResponseRedirect\n\n\ndef myview(request):\n next = request.META.get("HTTP_REFERER", None) or "/"\n response = HttpResponseRedirect(next)\n\n # modify the request and response as required, e.g. change locale\n # and set corresponding locale cookie\n\n view, args, kwargs = resolve(urlsplit(next).path)\n kwargs["request"] = request\n try:\n view(*args, **kwargs)\n except Http404:\n return HttpResponseRedirect("/")\n return response\nget_script_prefix()Link to this heading#Normalt bör du alltid använda reverse() för att definiera webbadresser i din applikation. Men om din applikation konstruerar en del av URL-hierarkin själv, kan du ibland behöva generera webbadresser. I så fall måste du kunna hitta bas-URL:en för Django-projektet i dess webbserver (normalt tar reverse() hand om detta åt dig). I så fall kan du anropa get_script_prefix(), som returnerar skriptprefixdelen av URL:en för ditt Django-projekt. Om ditt Django-projekt ligger i roten på webbservern är detta alltid "/".