class RedirectView

from django.views.generic import RedirectView
A view that provides a redirect on any GET request.

Ancestors (MRO)

  1. RedirectView
  2. View

Attributes

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

Methods

def as_view(cls, **initkwargs): View

Main entry point for a request-response process.
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
@classonlymethod
def as_view(cls, **initkwargs):
    """
    Main entry point for a request-response process.
    """
    # sanitize keyword arguments
    for key in initkwargs:
        if key in cls.http_method_names:
            raise TypeError(u"You tried to pass in the %s method name as a "
                            u"keyword argument to %s(). Don't do that."
                            % (key, cls.__name__))
        if not hasattr(cls, key):
            raise TypeError(u"%s() received an invalid keyword %r" % (
                cls.__name__, key))
    def view(request, *args, **kwargs):
        self = cls(**initkwargs)
        return self.dispatch(request, *args, **kwargs)
    # 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

174
175
def delete(self, request, *args, **kwargs):
    return self.get(request, *args, **kwargs)

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

57
58
59
60
61
62
63
64
65
66
67
68
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
    self.request = request
    self.args = args
    self.kwargs = kwargs
    return handler(request, *args, **kwargs)

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

150
151
152
153
154
155
156
157
158
159
160
161
162
163
def get(self, request, *args, **kwargs):
    url = self.get_redirect_url(**kwargs)
    if url:
        if self.permanent:
            return http.HttpResponsePermanentRedirect(url)
        else:
            return http.HttpResponseRedirect(url)
    else:
        logger.warning('Gone: %s' % self.request.path,
                    extra={
                        'status_code': 410,
                        'request': self.request
                    })
        return http.HttpResponseGone()

def get_redirect_url(self, **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.
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
def get_redirect_url(self, **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:
        args = self.request.META["QUERY_STRING"]
        if args and self.query_string:
            url = "%s?%s" % (self.url, args)
        else:
            url = self.url
        return url % kwargs
    else:
        return None

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

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

70
71
72
73
74
75
76
77
78
def http_method_not_allowed(self, request, *args, **kwargs):
    allowed_methods = [m for m in self.http_method_names if hasattr(self, m)]
    logger.warning('Method Not Allowed (%s): %s' % (request.method, request.path),
        extra={
            'status_code': 405,
            'request': self.request
        }
    )
    return http.HttpResponseNotAllowed(allowed_methods)

def __init__(self, **kwargs): View

Constructor. Called in the URLconf; can contain helpful extra
keyword arguments, and other things.
20
21
22
23
24
25
26
27
28
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.iteritems():
        setattr(self, key, value)

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

171
172
def options(self, request, *args, **kwargs):
    return self.get(request, *args, **kwargs)

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

168
169
def post(self, request, *args, **kwargs):
    return self.get(request, *args, **kwargs)

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

177
178
def put(self, request, *args, **kwargs):
    return self.get(request, *args, **kwargs)