mirror of
https://github.com/django/django.git
synced 2024-12-22 17:16:24 +00:00
Fixed #28999 -- Documented how to reverse a class-based view by instance.
Co-authored-by: Sarah Boyce <42296566+sarahboyce@users.noreply.github.com>
This commit is contained in:
parent
be138f32ed
commit
4d11ea1ef0
@ -13,7 +13,8 @@ your code, Django provides the following function:
|
||||
.. function:: reverse(viewname, urlconf=None, args=None, kwargs=None, current_app=None)
|
||||
|
||||
``viewname`` can be a :ref:`URL pattern name <naming-url-patterns>` or the
|
||||
callable view object. For example, given the following ``url``::
|
||||
callable view object used in the URLconf. For example, given the following
|
||||
``url``::
|
||||
|
||||
from news import views
|
||||
|
||||
@ -79,6 +80,26 @@ use for reversing. By default, the root URLconf for the current thread is used.
|
||||
Applying further encoding (such as :func:`urllib.parse.quote`) to the output
|
||||
of ``reverse()`` may produce undesirable results.
|
||||
|
||||
.. admonition:: Reversing class-based views by view object
|
||||
|
||||
The view object can also be the result of calling
|
||||
:meth:`~django.views.generic.base.View.as_view` if the same view object is
|
||||
used in the URLConf. Following the original example, the view object could
|
||||
be defined as:
|
||||
|
||||
.. code-block:: python
|
||||
:caption: ``news/views.py``
|
||||
|
||||
from django.views import View
|
||||
|
||||
|
||||
class ArchiveView(View): ...
|
||||
|
||||
|
||||
archive = ArchiveView.as_view()
|
||||
|
||||
However, remember that namespaced views cannot be reversed by view object.
|
||||
|
||||
``reverse_lazy()``
|
||||
==================
|
||||
|
||||
|
@ -522,12 +522,12 @@ class URLPatternReverse(SimpleTestCase):
|
||||
with self.assertRaisesMessage(NoReverseMatch, msg):
|
||||
reverse("places", kwargs={"arg1": 2})
|
||||
|
||||
def test_func_view_from_cbv(self):
|
||||
def test_view_func_from_cbv(self):
|
||||
expected = "/hello/world/"
|
||||
url = reverse(views.view_func_from_cbv, kwargs={"name": "world"})
|
||||
self.assertEqual(url, expected)
|
||||
|
||||
def test_func_view_from_cbv_no_expected_kwarg(self):
|
||||
def test_view_func_from_cbv_no_expected_kwarg(self):
|
||||
with self.assertRaises(NoReverseMatch):
|
||||
reverse(views.view_func_from_cbv)
|
||||
|
||||
|
@ -137,6 +137,6 @@ urlpatterns = [
|
||||
path("includes/", include(other_patterns)),
|
||||
# Security tests
|
||||
re_path("(.+)/security/$", empty_view, name="security"),
|
||||
# View function from cbv
|
||||
# View function from cbv.
|
||||
path("hello/<slug:name>/", view_func_from_cbv),
|
||||
]
|
||||
|
@ -58,12 +58,12 @@ def bad_view(request, *args, **kwargs):
|
||||
raise ValueError("I don't think I'm getting good value for this view")
|
||||
|
||||
|
||||
class _HelloView(View):
|
||||
class HelloView(View):
|
||||
def get(self, request, *args, **kwargs):
|
||||
return HttpResponse(f"Hello {self.kwargs['name']}")
|
||||
|
||||
|
||||
view_func_from_cbv = _HelloView.as_view()
|
||||
view_func_from_cbv = HelloView.as_view()
|
||||
|
||||
empty_view_partial = partial(empty_view, template_name="template.html")
|
||||
empty_view_nested_partial = partial(
|
||||
|
Loading…
Reference in New Issue
Block a user