ccbv.co.uk

class RedirectView

from django.views.generic import RedirectView
Hierarchy diagram Documentation Source code 
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', 'patch', 'delete', 'head', 'options', 'trace'] View
pattern_name = None RedirectView
permanent = <object object at 0x7f82a187d750> RedirectView
query_string = False RedirectView
url = None RedirectView
Expand Collapse

Methods

def __init__(self, *args, **kwargs):

RedirectView

 
Constructor. Called in the URLconf; can contain helpful extra
keyword arguments, and other things.
171
172
173
174
175
176
177
178
179
180
181
def __init__(self, *args, **kwargs):
    if 'permanent' not in kwargs and self.permanent is _sentinel:
        warnings.warn(
            "Default value of 'RedirectView.permanent' will change "
            "from True to False in Django 1.9. Set an explicit value "
            "to silence this warning.",
            RemovedInDjango19Warning,
            stacklevel=2
        )
        self.permanent = True
    super(RedirectView, self).__init__(*args, **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 six.iteritems(kwargs):
        setattr(self, key, value)

def _allowed_methods(self): View 

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

def as_view(cls, **initkwargs):

RedirectView

 
Main entry point for a request-response process.
183
184
185
186
187
188
189
190
191
192
193
194
@classonlymethod
def as_view(cls, **initkwargs):
    if 'permanent' not in initkwargs and cls.permanent is _sentinel:
        warnings.warn(
            "Default value of 'RedirectView.permanent' will change "
            "from True to False in Django 1.9. Set an explicit value "
            "to silence this warning.",
            RemovedInDjango19Warning,
            stacklevel=2
        )
        initkwargs['permanent'] = True
    return super(RedirectView, cls).as_view(**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)
    # 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 

241
242
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 

217
218
219
220
221
222
223
224
225
226
227
228
229
230
def get(self, request, *args, **kwargs):
    url = self.get_redirect_url(*args, **kwargs)
    if url:
        if self.permanent:
            return http.HttpResponsePermanentRedirect(url)
        else:
            return http.HttpResponseRedirect(url)
    else:
        logger.warning('Gone: %s', request.path,
                    extra={
                        'status_code': 410,
                        'request': request
                    })
        return http.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.
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
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:
        try:
            url = reverse(self.pattern_name, args=args, kwargs=kwargs)
        except NoReverseMatch:
            return None
    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 

232
233
def head(self, request, *args, **kwargs):
    return self.get(request, *args, **kwargs)

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

91
92
93
94
95
96
97
98
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 http.HttpResponseNotAllowed(self._allowed_methods())

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

RedirectView

 
Handles responding to requests for the OPTIONS HTTP verb.
238
239
def options(self, request, *args, **kwargs):
    return self.get(request, *args, **kwargs)

View

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

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

247
248
def patch(self, request, *args, **kwargs):
    return self.get(request, *args, **kwargs)

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

235
236
def post(self, request, *args, **kwargs):
    return self.get(request, *args, **kwargs)

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

244
245
def put(self, request, *args, **kwargs):
    return self.get(request, *args, **kwargs)