views.generic.base.View.options() documentation doesn't match code

[Marcel Moreaux]

The documentation for views.generic.base.View.options() says:

options(request, *args, kwargs)

Handles responding to requests for the OPTIONS HTTP verb. Returns a list of the allowed HTTP method names for the view.

However,

class Some(View):
    def options(self, request, **kwargs):
        return ['GET', 'OPTIONS']

Results in

Traceback (most recent call last):
  File "/.../django/core/handlers/base.py", line 235, in get_response
    response = middleware_method(request, response)
  File "/.../django/middleware/clickjacking.py", line 31, in process_response
    if response.get('X-Frame-Options') is not None:
AttributeError: 'list' object has no attribute 'get'

The relevant Django code is:

def dispatch(self, request, *args, **kwargs):
    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 options(self, request, *args, **kwargs):
    response = http.HttpResponse()
    response['Allow'] = ', '.join(self._allowed_methods())
    response['Content-Length'] = '0'
    return response

So, from the looks of it, Django expects options() to return a HttpResponse object, in line with e.g. get() and post(), in direct contradiction of the documentation.

[1] ​https://docs.djangoproject.com/en/1.9/ref/class-based-views/base/#django.views.generic.base.View.options

[Tim Graham]

If we change the sentence to "Returns a response with the list of the allowed HTTP method names for the view." does the clarify it for you?

[Dheerendra Rathor]

I will suggest a bit more verbose doc "Returns a response with the list of the allowed HTTP method names in Allow header for the view"

[Tim Graham <timograham@…>]

In db2a6b6b:

Fixed #26695 -- Clarified return value of View.options().

Thanks mmoreaux and DheerendraRathor.

[Tim Graham <timograham@…>]

In bad894d:

[1.10.x] Fixed #26695 -- Clarified return value of View.options().

Thanks mmoreaux and DheerendraRathor.

Backport of db2a6b6bfa9881725e70ca579a17e942a97a4df8 from master

[Tim Graham <timograham@…>]

In 84698b89:

[1.9.x] Fixed #26695 -- Clarified return value of View.options().

Thanks mmoreaux and DheerendraRathor.

Backport of db2a6b6bfa9881725e70ca579a17e942a97a4df8 from master