rest_framework.schemas.inspectors.ViewInspector

class documentation

class ViewInspector: (source)

Known subclasses: rest_framework.schemas.coreapi.AutoSchema, rest_framework.schemas.coreapi.ManualSchema, rest_framework.schemas.inspectors.DefaultSchema, rest_framework.schemas.openapi.AutoSchema

View In Hierarchy

Descriptor class on APIView. Provide subclass for per-view schema generation

Method	`__get__`	Enables `ViewInspector` as a Python _Descriptor_.
Method	`__init__`	Undocumented
Method	`__set__`	Undocumented
Method	`get_description`	Determine a path description.
Method	`view.deleter`	Undocumented
Method	`view.setter`	Undocumented
Class Variable	`header_regex`	Undocumented
Instance Variable	`instance_schemas`	Undocumented
Property	`view`	View property.
Method	`_get_description_section`	Undocumented
Instance Variable	`_view`	Undocumented

def __get__(self, instance, owner): (source) ¶

overridden in rest_framework.schemas.inspectors.DefaultSchema

Enables `ViewInspector` as a Python _Descriptor_. This is how `view.schema` knows about `view`. `__get__` is called when the descriptor is accessed on the owner. (That will be when view.schema is called in our case.) `owner` is always the owner class. (An APIView, or subclass for us.) `instance` is the view instance or `None` if accessed from the class, rather than an instance. See: https://docs.python.org/3/howto/descriptor.html for info on descriptor usage.

def __init__(self): (source) ¶

overridden in rest_framework.schemas.coreapi.AutoSchema, rest_framework.schemas.coreapi.ManualSchema, rest_framework.schemas.openapi.AutoSchema

Undocumented

def __set__(self, instance, other): (source) ¶

Undocumented

def get_description(self, path, method): (source) ¶

Determine a path description. This will be based on the method docstring if one exists, or else the class docstring.

@view.deleter
def view(self): (source) ¶

Undocumented

@view.setter
def view(self, value): (source) ¶

Undocumented

header_regex = (source) ¶