class documentation

The base ViewSet class does not provide any actions by default.

Inherited from ViewSetMixin:

Class Method get_extra_actions Get the methods that are marked as an extra ViewSet `@action`.
Method as_view Because of the way class based views create a closure around the instantiated view, we need to totally reimplement `.as_view`, and slightly modify the view function that is created and returned.
Method get_extra_action_url_map Build a map of {names: urls} for the extra actions.
Method initialize_request Set the `.action` attribute on the view, depending on the request method.
Method reverse_action Reverse the action for the given `url_name`.
Instance Variable action Undocumented

Inherited from APIView (via ViewSetMixin):

Method check_object_permissions Check if the request should be permitted for a given object. Raises an appropriate exception if the request is not permitted.
Method check_permissions Check if the request should be permitted. Raises an appropriate exception if the request is not permitted.
Method check_throttles Check if request should be throttled. Raises an appropriate exception if the request is throttled.
Method determine_version If versioning is being used, then determine any API version for the incoming request. Returns a two-tuple of (version, versioning_scheme)
Method dispatch `.dispatch()` is pretty much the same as Django's regular dispatch, but with extra hooks for startup, finalize, and exception handling.
Method finalize_response Returns the final response object.
Method get_authenticate_header If a request is unauthenticated, determine the WWW-Authenticate header to use for 401 responses, if any.
Method get_authenticators Instantiates and returns the list of authenticators that this view can use.
Method get_content_negotiator Instantiate and return the content negotiation class to use.
Method get_exception_handler Returns the exception handler that this view uses.
Method get_exception_handler_context Returns a dict that is passed through to EXCEPTION_HANDLER, as the `context` argument.
Method get_format_suffix Determine if the request includes a '.json' style format suffix
Method get_parser_context Returns a dict that is passed through to Parser.parse(), as the `parser_context` keyword argument.
Method get_parsers Instantiates and returns the list of parsers that this view can use.
Method get_permissions Instantiates and returns the list of permissions that this view requires.
Method get_renderer_context Returns a dict that is passed through to Renderer.render(), as the `renderer_context` keyword argument.
Method get_renderers Instantiates and returns the list of renderers that this view can use.
Method get_throttles Instantiates and returns the list of throttles that this view uses.
Method get_view_description Return some descriptive text for the view, as used in OPTIONS responses and in the browsable API.
Method get_view_name Return the view name, as used in OPTIONS responses and in the browsable API.
Method handle_exception Handle any exception that occurs, by returning an appropriate response, or re-raising the error.
Method http_method_not_allowed If `request.method` does not correspond to a handler method, determine what kind of exception to raise.
Method initial Runs anything that needs to occur prior to calling the method handler.
Method options Handler method for HTTP 'OPTIONS' request.
Method perform_authentication Perform authentication on the incoming request.
Method perform_content_negotiation Determine which renderer and media type to use render the response.
Method permission_denied If request is not permitted, determine what kind of exception to raise.
Method raise_uncaught_exception Undocumented
Method throttled If request is throttled, determine what kind of exception to raise.
Class Variable schema Undocumented
Instance Variable args Undocumented
Instance Variable format_kwarg Undocumented
Instance Variable headers Undocumented
Instance Variable kwargs Undocumented
Instance Variable request Undocumented
Instance Variable response Undocumented
Property allowed_methods Wrap Django's private `_allowed_methods` interface in a public property.
Property default_response_headers Undocumented
Instance Variable _negotiator Undocumented