Why Gemfury?
Push, build, and install
RubyGems
npm packages
Python packages
Maven artifacts
PHP packages
Go Modules
Debian packages
RPM packages
NuGet packages
doctorondemand / djangorestframework python
Repository URL to install this package:
|
Version:
3.6.4 ▾
|
£OY×F ã @ sv d Z d d l m Z d d l m Z d d l m Z d d l m Z d d l m
Z
d d l m Z d d l
m Z d d l m Z m Z d d
l m Z d d l m Z d d l m Z d d
l m Z d d l m Z m Z d d l m Z d d l m! Z! d d l" m# Z# d d l$ m% Z% d d l& m' Z' d d d Z( d d d Z) d d Z* Gd d d e Z+ d S) zL
Provides an APIView class that is the base of all views in REST framework.
é )Úunicode_literals)Úsettings)ÚPermissionDenied)Úmodels)ÚHttp404)ÚHttpResponseBase)Úsix)Ú cc_delim_reÚpatch_vary_headers)Ú
smart_text)Ú
ugettext_lazy)Ú csrf_exempt)ÚView)Ú
exceptionsÚstatus)Ú set_rollback)ÚRequest)ÚResponse)Ú api_settings)Ú
formattingNc C sT | j } t j | d } t j | d } t j | } | rP | d | 7} | S)zØ
Given a view class, return a textual name to represent the view.
This name is used in the browsable API, and in OPTIONS responses.
This function is the default for the `VIEW_NAME_FUNCTION` setting.
r ZViewSetú )Ú__name__r Zremove_trailing_stringZcamelcase_to_spaces)Úview_clsÚsuffixÚname© r úS/Users/carlton/Documents/Django-Stack/django-rest-framework/rest_framework/views.pyÚ
get_view_name s r Fc C s; | j p d } t j t | } | r7 t j | S| S)zæ
Given a view class, return a textual description to represent the view.
This name is used in the browsable API, and in OPTIONS responses.
This function is the default for the `VIEW_DESCRIPTION_FUNCTION` setting.
Ú )Ú__doc__r Údedentr Zmarkup_description)r ÚhtmlÚ descriptionr r r Úget_view_description+ s
r# c C sE t | t j r i } t | d d r7 | j | d <t | d d rZ d | j | d <t | j t t f r~ | j } n d | j i } t t
| d | j d | St | t r÷ t
d
} d t j | i } t t
| d t j St | t rAt
d } d t j | i } t t
| d t j Sd S) a4
Returns the response that should be used for any given exception.
By default we handle the REST framework `APIException`, and also
Django's built-in `Http404` and `PermissionDenied` exceptions.
Any unhandled exceptions may return `None`, which will cause a 500 error
to be raised.
Ú auth_headerNzWWW-AuthenticateÚwaitz%dz Retry-AfterÚdetailr Úheadersz
Not found.zPermission denied.)Ú
isinstancer Ú APIExceptionÚgetattrr$ r% r& ÚlistÚdictr r Ú status_coder Ú_r Ú text_typer ÚHTTP_404_NOT_FOUNDr ÚHTTP_403_FORBIDDEN)ÚexcÚcontextr' ÚdataÚmsgr r r Úexception_handler9 s,
r6 c s e Z d Z e j Z e j Z e j Z e j
Z e j Z
e j Z e j Z e j Z e Z d Z e f d d Z e d d Z e d d Z d d Z d
d d Z d
d Z d d Z d d Z d d Z d d Z! d d Z" d d d Z# d d Z$ d d Z% d d Z& d! d" Z' d# d$ Z( d% d& Z) d' d( Z* d) d* Z+ d d+ d, Z, d- d. Z- d/ d0 Z. d1 d2 Z/ d3 d4 Z0 d5 d6 Z1 d7 d8 Z2 d9 d: Z3 d; d< Z4 d= d> Z5 d? d@ Z6 dA dB Z7 dC dD Z8 S)EÚAPIViewFc sm t t | d d t j j r9 d d } | | j _ t t | j | } | | _
| | _ t | S)zÈ
Store the original class on the view function.
This allows us to discover information about the view when we do URL
reverse lookups. Used for breadcrumb generation.
ÚquerysetNc S s t d d S)NzDo not evaluate the `.queryset` attribute directly, as the result will be cached and reused between requests. Use `.all()` or call `.get_queryset()` instead.)Ú RuntimeErrorr r r r Úforce_evaluation~ s z)APIView.as_view.<locals>.force_evaluation)
r( r* r ÚqueryÚQuerySetr8 Ú
_fetch_allÚsuperr7 Úas_viewÚclsÚ
initkwargsr
)r@ rA r: Úview)Ú __class__r r r? u s ! zAPIView.as_viewc C s
| j S)zZ
Wrap Django's private `_allowed_methods` interface in a public property.
)Ú_allowed_methods)Úselfr r r Úallowed_methods s zAPIView.allowed_methodsc C s; d d j | j i } t | j d k r7 d | d <| S)NÚAllowz, é ÚAcceptÚVary)ÚjoinrF ÚlenÚrenderer_classes)rE r' r r r Údefault_response_headers s
z APIView.default_response_headersc O s t j | j d S)z
If `request.method` does not correspond to a handler method,
determine what kind of exception to raise.
N)r ÚMethodNotAllowedÚmethod)rE ÚrequestÚargsÚkwargsr r r Úhttp_method_not_allowed s z APIView.http_method_not_allowedNc C s5 | j r | j r t j t j d | d S)zY
If request is not permitted, determine what kind of exception to raise.
r& N)ÚauthenticatorsÚsuccessful_authenticatorr ÚNotAuthenticatedr )rE rQ Úmessager r r Úpermission_denied¥ s zAPIView.permission_deniedc C s t j | d S)zU
If request is throttled, determine what kind of exception to raise.
N)r Ú Throttled)rE rQ r% r r r Ú throttled s zAPIView.throttledc C s' | j } | r# | d j | Sd S)z
If a request is unauthenticated, determine the WWW-Authenticate
header to use for 401 responses, if any.
r N)Úget_authenticatorsZauthenticate_header)rE rQ rU r r r Úget_authenticate_header³ s z APIView.get_authenticate_headerc C s. d | d t | d f d t | d i i S)z|
Returns a dict that is passed through to Parser.parse(),
as the `parser_context` keyword argument.
rB rR rS )r* )rE Ú http_requestr r r Úget_parser_context¼ s zAPIView.get_parser_contextc C s@ d | d t | d f d t | d i d t | d d i S)z
Returns a dict that is passed through to Renderer.render(),
as the `renderer_context` keyword argument.
rB rR rS rQ N)r* )rE r r r Úget_renderer_contextÉ s z APIView.get_renderer_contextc C s@ d | d t | d f d t | d i d t | d d i S)zp
Returns a dict that is passed through to EXCEPTION_HANDLER,
as the `context` argument.
rB rR rS rQ N)r* )rE r r r Ú get_exception_handler_context× s z%APIView.get_exception_handler_contextc C s( | j j } | | j t | d d S)zf
Return the view name, as used in OPTIONS responses and in the
browsable API.
r N)r ÚVIEW_NAME_FUNCTIONrC r* )rE Úfuncr r r r ã s zAPIView.get_view_namec C s | j j } | | j | S)z{
Return some descriptive text for the view, as used in OPTIONS responses
and in the browsable API.
)r ÚVIEW_DESCRIPTION_FUNCTIONrC )rE r! rc r r r r# ë s z APIView.get_view_descriptionc K s# | j j r | j | j j Sd S)zQ
Determine if the request includes a '.json' style format suffix
N)r ÚFORMAT_SUFFIX_KWARGÚget)rE rS r r r Úget_format_suffixõ s zAPIView.get_format_suffixc C s d d | j D S)zX
Instantiates and returns the list of renderers that this view can use.
c S s g | ] } | q Sr r )Ú.0Úrendererr r r ú
<listcomp> s z)APIView.get_renderers.<locals>.<listcomp>)rM )rE r r r Ú
get_renderersü s zAPIView.get_renderersc C s d d | j D S)zV
Instantiates and returns the list of parsers that this view can use.
c S s g | ] } | q Sr r )rh Úparserr r r rj s z'APIView.get_parsers.<locals>.<listcomp>)Úparser_classes)rE r r r Ú get_parsers s zAPIView.get_parsersc C s d d | j D S)z]
Instantiates and returns the list of authenticators that this view can use.
c S s g | ] } | q Sr r )rh Úauthr r r rj s z.APIView.get_authenticators.<locals>.<listcomp>)Úauthentication_classes)rE r r r r\ s zAPIView.get_authenticatorsc C s d d | j D S)z[
Instantiates and returns the list of permissions that this view requires.
c S s g | ] } | q Sr r )rh Ú
permissionr r r rj s z+APIView.get_permissions.<locals>.<listcomp>)Úpermission_classes)rE r r r Úget_permissions s zAPIView.get_permissionsc C s d d | j D S)zU
Instantiates and returns the list of throttles that this view uses.
c S s g | ] } | q Sr r )rh Úthrottler r r rj s z)APIView.get_throttles.<locals>.<listcomp>)Úthrottle_classes)rE r r r Ú
get_throttles s zAPIView.get_throttlesc C s( t | d d s! | j | _ | j S)zN
Instantiate and return the content negotiation class to use.
Ú _negotiatorN)r* Úcontent_negotiation_classrw )rE r r r Úget_content_negotiator s z APIView.get_content_negotiatorc C s
| j j S)zD
Returns the exception handler that this view uses.
)r ÚEXCEPTION_HANDLER)rE r r r Úget_exception_handler" s z APIView.get_exception_handlerc C si | j } | j } y | j | | | j SWn0 t k
rd | r] | d | d j f S Yn Xd S)zU
Determine which renderer and media type to use render the response.
r N)rk ry Zselect_rendererÚ format_kwargÚ ExceptionÚ
media_type)rE rQ ÚforceÚ renderersZconnegr r r Úperform_content_negotiation* s
z#APIView.perform_content_negotiationc C s | j d S)a
Perform authentication on the incoming request.
Note that if you override this and simply 'pass', then authentication
will instead be performed lazily, the first time either
`request.user` or `request.auth` is accessed.
N)Úuser)rE rQ r r r Úperform_authentication8 s z APIView.perform_authenticationc C sL xE | j D]7 } | j | | s
| j | d t | d d q
Wd S)z
Check if the request should be permitted.
Raises an appropriate exception if the request is not permitted.
rX N)rs Zhas_permissionrY r* )rE rQ rq r r r Úcheck_permissionsB s zAPIView.check_permissionsc C sO xH | j D]: } | j | | | s
| j | d t | d d q
Wd S)z
Check if the request should be permitted for a given object.
Raises an appropriate exception if the request is not permitted.
rX N)rs Zhas_object_permissionrY r* )rE rQ Úobjrq r r r Úcheck_object_permissionsM s z APIView.check_object_permissionsc C sC x< | j D]. } | j | | s
| j | | j q
Wd S)z|
Check if request should be throttled.
Raises an appropriate exception if the request is throttled.
N)rv Z
allow_requestr[ r% )rE rQ rt r r r Úcheck_throttlesX s zAPIView.check_throttlesc O s8 | j d k r d S| j } | j | | | | f S)z£
If versioning is being used, then determine any API version for the
incoming request. Returns a two-tuple of (version, versioning_scheme)
N)NN)Úversioning_classÚdetermine_version)rE rQ rR rS Úschemer r r r a s zAPIView.determine_versionc
O sC | j | } t | d | j d | j d | j d | S)z5
Returns the initial request object.
ÚparsersrU Ú
negotiatorÚparser_context)r_ r rn r\ ry )rE rQ rR rS r r r r Úinitialize_requestm s zAPIView.initialize_requestc O s | j | | _ | j | } | \ | _ | _ | j | | | \ } } | | | _ | _ | j | | j | | j
| d S)zX
Runs anything that needs to occur prior to calling the method handler.
N) rg r| r Úaccepted_rendererÚaccepted_media_typer ÚversionÚversioning_schemer r r )rE rQ rR rS Únegr r r r r Úinitial{ s
zAPIView.initialc O sù t | t s% t d t | t | t r t | d d sm | j | d d } | \ | _ | _ | j | _ | j | _ | j | _
| j j d d } | d k rË t
| t j | x' | j j D] \ } } | | | <qÛ W| S)z4
Returns the final response object.
zrExpected a `Response`, `HttpResponse` or `HttpStreamingResponse` to be returned from the view, but received a `%s`r Nr TrJ )r( r ÚAssertionErrorÚtyper r* r r r r` Úrenderer_contextr' Úpopr
r ÚsplitÚitems) rE rQ ÚresponserR rS r Ú vary_headersÚkeyÚvaluer r r Úfinalize_response s zAPIView.finalize_responsec C s t | t j t j f rK | j | j } | r? | | _ n t j | _ | j
} | j } | | | } | d k r | j | d | _
| S)zz
Handle any exception that occurs, by returning an appropriate response,
or re-raising the error.
NT)r( r rW ÚAuthenticationFailedr] rQ r$ r r1 r- r{ ra Úraise_uncaught_exceptionÚ exception)rE r2 r$ r6 r3 r r r r Úhandle_exception¬ s
zAPIView.handle_exceptionc C sD t j r= | j } t | j d } | d k } | j | d S)NÚformatr! ÚapiÚadmin)zhtmlzapizadmin)r ÚDEBUGrQ r* r Úforce_plaintext_errors)rE r2 rQ Zrenderer_formatZuse_plaintext_tracebackr r r r¡ Æ s
z APIView.raise_uncaught_exceptionc O s | | _ | | _ | j | | | } | | _ | j | _ yk | j | | | | j j | j k r t
| | j j | j } n | j } | | | | } Wn4 t k
rÝ } z | j
| } WYd d } ~ Xn X| j | | | | | _ | j S)z¡
`.dispatch()` is pretty much the same as Django's regular dispatch,
but with extra hooks for startup, finalize, and exception handling.
N)rR rS r rQ rN r' r rP ÚlowerÚhttp_method_namesr* rT r} r£ r r )rE rQ rR rS Úhandlerr r2 r r r ÚdispatchÑ s "zAPIView.dispatchc O sM | j d k r" | j | | | S| j j | | } t | d t j S)z<
Handler method for HTTP 'OPTIONS' request.
Nr )Úmetadata_classrT Zdetermine_metadatar r Ú HTTP_200_OK)rE rQ rR rS r4 r r r Úoptionsî s zAPIView.options)9r Ú
__module__Ú __qualname__r ÚDEFAULT_RENDERER_CLASSESrM ÚDEFAULT_PARSER_CLASSESrm Ú DEFAULT_AUTHENTICATION_CLASSESrp ÚDEFAULT_THROTTLE_CLASSESru ÚDEFAULT_PERMISSION_CLASSESrr Ú!DEFAULT_CONTENT_NEGOTIATION_CLASSrx ÚDEFAULT_METADATA_CLASSr ÚDEFAULT_VERSIONING_CLASSr r Zexclude_from_schemaÚ classmethodr? ÚpropertyrF rN rT rY r[ r] r_ r` ra r r# rg rk rn r\ rs rv ry r{ r r r r r r r r r r£ r¡ r¬ r¯ r r )rC r r7 c sV
r7 ),r Ú
__future__r Ú django.confr Údjango.core.exceptionsr Ú django.dbr Ú django.httpr Údjango.http.responser Ú django.utilsr Údjango.utils.cacher r
Údjango.utils.encodingr Údjango.utils.translationr r. Z django.views.decorators.csrfr
Zdjango.views.genericr Úrest_frameworkr r Úrest_framework.compatr Úrest_framework.requestr Úrest_framework.responser Úrest_framework.settingsr Zrest_framework.utilsr r r# r6 r7 r r r r Ú<module> s, *