class RedirectView

from django.views.generic import RedirectView
Provide a redirect on any GET request.

Ancestors (MRO)

  1. RedirectView
  2. View

Attributes

  Defined in
http_method_names = ['get', 'post', 'put', 'patch', 'delete', 'head', 'options', 'trace'] View
pattern_name = None RedirectView
permanent = False RedirectView
query_string = False RedirectView
url = None RedirectView
Expand Collapse

Methods

def _allowed_methods(self): View

105
106
def _allowed_methods(self):
    return [m.upper() for m in self.http_method_names if hasattr(self, m)]

def as_view(cls, **initkwargs): View

Main entry point for a request-response process.
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
@classonlymethod
def as_view(cls, **initkwargs):
    """Main entry point for a request-response process."""
    for key in initkwargs:
        if key in cls.http_method_names:
            raise TypeError("You tried to pass in the %s method name as a "
                            "keyword argument to %s(). Don't do that."
                            % (key, cls.__name__))
        if not hasattr(cls, key):
            raise TypeError("%s() received an invalid keyword %r. as_view "
                            "only accepts arguments that are already "
                            "attributes of the class." % (cls.__name__, key))
    def view(request, *args, **kwargs):
        self = cls(**initkwargs)
        if hasattr(self, 'get') and not hasattr(self, 'head'):
            self.head = self.get
        self.request = request
        self.args = args
        self.kwargs = kwargs
        return self.dispatch(request, *args, **kwargs)
    view.view_class = cls
    view.view_initkwargs = initkwargs
    # take name and docstring from class
    update_wrapper(view, cls, updated=())
    # and possible attributes set by decorators
    # like csrf_exempt from dispatch
    update_wrapper(view, cls.dispatch, assigned=())
    return view

def delete(self, request, *args, **kwargs): RedirectView

202
203
def delete(self, request, *args, **kwargs):
    return self.get(request, *args, **kwargs)

def dispatch(self, request, *args, **kwargs): View

81
82
83
84
85
86
87
88
89
def dispatch(self, request, *args, **kwargs):
    # Try to dispatch to the right method; if a method doesn't exist,
    # defer to the error handler. Also defer to the error handler if the
    # request method isn't on the approved list.
    if request.method.lower() in self.http_method_names:
        handler = getattr(self, request.method.lower(), self.http_method_not_allowed)
    else:
        handler = self.http_method_not_allowed
    return handler(request, *args, **kwargs)

def get(self, request, *args, **kwargs): RedirectView

179
180
181
182
183
184
185
186
187
188
189
190
191
def get(self, request, *args, **kwargs):
    url = self.get_redirect_url(*args, **kwargs)
    if url:
        if self.permanent:
            return HttpResponsePermanentRedirect(url)
        else:
            return HttpResponseRedirect(url)
    else:
        logger.warning(
            'Gone: %s', request.path,
            extra={'status_code': 410, 'request': request}
        )
        return HttpResponseGone()

def get_redirect_url(self, *args, **kwargs): RedirectView

Return the URL redirect to. Keyword arguments from the URL pattern
match generating the redirect request are provided as kwargs to this
method.
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
def get_redirect_url(self, *args, **kwargs):
    """
    Return the URL redirect to. Keyword arguments from the URL pattern
    match generating the redirect request are provided as kwargs to this
    method.
    """
    if self.url:
        url = self.url % kwargs
    elif self.pattern_name:
        url = reverse(self.pattern_name, args=args, kwargs=kwargs)
    else:
        return None
    args = self.request.META.get('QUERY_STRING', '')
    if args and self.query_string:
        url = "%s?%s" % (url, args)
    return url

def head(self, request, *args, **kwargs): RedirectView

def http_method_not_allowed(self, request, *args, **kwargs): View

91
92
93
94
95
96
def http_method_not_allowed(self, request, *args, **kwargs):
    logger.warning(
        'Method Not Allowed (%s): %s', request.method, request.path,
        extra={'status_code': 405, 'request': request}
    )
    return HttpResponseNotAllowed(self._allowed_methods())

def __init__(self, **kwargs): View

Constructor. Called in the URLconf; can contain helpful extra
keyword arguments, and other things.
39
40
41
42
43
44
45
46
47
def __init__(self, **kwargs):
    """
    Constructor. Called in the URLconf; can contain helpful extra
    keyword arguments, and other things.
    """
    # Go through keyword arguments, and either save their values to our
    # instance, or raise an error.
    for key, value in kwargs.items():
        setattr(self, key, value)

def options(self, request, *args, **kwargs):

RedirectView

Handle responding to requests for the OPTIONS HTTP verb.
199
200
def options(self, request, *args, **kwargs):
    return self.get(request, *args, **kwargs)

View

Handle responding to requests for the OPTIONS HTTP verb.
 98
 99
100
101
102
103
def options(self, request, *args, **kwargs):
    """Handle responding to requests for the OPTIONS HTTP verb."""
    response = HttpResponse()
    response['Allow'] = ', '.join(self._allowed_methods())
    response['Content-Length'] = '0'
    return response

def patch(self, request, *args, **kwargs): RedirectView

208
209
def patch(self, request, *args, **kwargs):
    return self.get(request, *args, **kwargs)

def post(self, request, *args, **kwargs): RedirectView

196
197
def post(self, request, *args, **kwargs):
    return self.get(request, *args, **kwargs)

def put(self, request, *args, **kwargs): RedirectView

205
206
def put(self, request, *args, **kwargs):
    return self.get(request, *args, **kwargs)