U
    ڲgoI                     @   s   d 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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 Z"dddZ#dd Z$dd Z%G dd deZ&dS )zL
Provides an APIView class that is the base of all views in REST framework.
    )settings)PermissionDenied)connectionsmodels)Http404)HttpResponseBase)cc_delim_repatch_vary_headers)	smart_str)csrf_exempt)View)
exceptionsstatus)Request)Response)DefaultSchema)api_settings)
formattingc                 C   sb   t | dd}|dk	r|S | jj}t|d}t|d}t|}t | dd}|r^|d| 7 }|S )z
    Given a view instance, 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.
    nameNr   ZViewSetsuffix )getattr	__class____name__r   Zremove_trailing_stringZcamelcase_to_spaces)viewr   r    r   8/tmp/pip-unpacked-wheel-11h17kvo/rest_framework/views.pyget_view_name   s    
r   Fc                 C   s@   t | dd}|dkr | jjpd}tt|}|r<t|S |S )z
    Given a view instance, 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.
    descriptionN )r   r   __doc__r   dedentr
   Zmarkup_description)r   htmlr   r   r   r   get_view_description/   s    
r#   c                  C   s,   t  D ]} | jd r| jr| d qd S )NZATOMIC_REQUESTST)r   allZsettings_dictZin_atomic_blockset_rollback)dbr   r   r   r%   A   s    r%   c                 C   s   t | trtj| j } nt | tr.tj| j } t | tjri }t| ddrT| j|d< t| ddrnd| j	 |d< t | j
ttfr| j
}n
d| j
i}t  t|| j|dS d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_headerNzWWW-Authenticatewaitz%dzRetry-Afterdetail)r   headers)
isinstancer   r   ZNotFoundargsr   ZAPIExceptionr   r'   r(   r)   listdictr%   r   status_code)exccontextr*   datar   r   r   exception_handlerG   s     




r3   c                       sh  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e Ze fddZedd Zedd Zdd ZdEd
dZdd Zdd Zdd Z dd Z!dd Z"dd Z#dFd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,dGd+d,Z-d-d. Z.d/d0 Z/d1d2 Z0d3d4 Z1d5d6 Z2d7d8 Z3d9d: Z4d;d< Z5d=d> Z6d?d@ Z7dAdB Z8dCdD Z9  Z:S )HAPIViewc                    sH   t t| ddtjjr&dd }|| j_t jf |}| |_	||_
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   queryZQuerySetr5   Z
_fetch_allsuperas_viewcls
initkwargsr   )r;   r<   r7   r   r   r   r   r:   y   s    zAPIView.as_viewc                 C   s   |   S )zZ
        Wrap Django's private `_allowed_methods` interface in a public property.
        )Z_allowed_methodsselfr   r   r   allowed_methods   s    zAPIView.allowed_methodsc                 C   s*   dd | ji}t| jdkr&d|d< |S )NZAllowz,    AcceptVary)joinr@   lenrenderer_classes)r?   r*   r   r   r   default_response_headers   s     
z APIView.default_response_headersc                 O   s   t |jdS )z
        If `request.method` does not correspond to a handler method,
        determine what kind of exception to raise.
        N)r   ZMethodNotAllowedmethod)r?   requestr,   kwargsr   r   r   http_method_not_allowed   s    zAPIView.http_method_not_allowedNc                 C   s&   |j r|jst tj||ddS )zY
        If request is not permitted, determine what kind of exception to raise.
        )r)   codeN)authenticatorsZsuccessful_authenticatorr   NotAuthenticatedr   )r?   rI   messagerL   r   r   r   permission_denied   s    zAPIView.permission_deniedc                 C   s   t |dS )zU
        If request is throttled, determine what kind of exception to raise.
        N)r   Z	Throttled)r?   rI   r(   r   r   r   	throttled   s    zAPIView.throttledc                 C   s   |   }|r|d |S dS )z
        If a request is unauthenticated, determine the WWW-Authenticate
        header to use for 401 responses, if any.
        r   N)get_authenticatorsZauthenticate_header)r?   rI   rM   r   r   r   get_authenticate_header   s    zAPIView.get_authenticate_headerc                 C   s   | t | ddt | di dS )z|
        Returns a dict that is passed through to Parser.parse(),
        as the `parser_context` keyword argument.
        r,   r   rJ   )r   r,   rJ   r   )r?   http_requestr   r   r   get_parser_context   s    

zAPIView.get_parser_contextc                 C   s&   | t | ddt | di t | dddS )z
        Returns a dict that is passed through to Renderer.render(),
        as the `renderer_context` keyword argument.
        r,   r   rJ   rI   Nr   r,   rJ   rI   rT   r>   r   r   r   get_renderer_context   s
    


zAPIView.get_renderer_contextc                 C   s&   | t | ddt | di t | dddS )zp
        Returns a dict that is passed through to EXCEPTION_HANDLER,
        as the `context` argument.
        r,   r   rJ   rI   NrW   rT   r>   r   r   r   get_exception_handler_context   s
    


z%APIView.get_exception_handler_contextc                 C   s   | j j}|| S )zf
        Return the view name, as used in OPTIONS responses and in the
        browsable API.
        )r   ZVIEW_NAME_FUNCTION)r?   funcr   r   r   r      s    zAPIView.get_view_nameFc                 C   s   | j j}|| |S )z{
        Return some descriptive text for the view, as used in OPTIONS responses
        and in the browsable API.
        )r   ZVIEW_DESCRIPTION_FUNCTION)r?   r"   rZ   r   r   r   r#      s    zAPIView.get_view_descriptionc                 K   s   | j jr|| j jS dS )zQ
        Determine if the request includes a '.json' style format suffix
        N)r   ZFORMAT_SUFFIX_KWARGget)r?   rJ   r   r   r   get_format_suffix   s    zAPIView.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S r   r   ).0Zrendererr   r   r   
<listcomp>  s     z)APIView.get_renderers.<locals>.<listcomp>)rF   r>   r   r   r   get_renderers   s    zAPIView.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S r   r   )r]   parserr   r   r   r^   
  s     z'APIView.get_parsers.<locals>.<listcomp>)parser_classesr>   r   r   r   get_parsers  s    zAPIView.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S r   r   )r]   authr   r   r   r^     s     z.APIView.get_authenticators.<locals>.<listcomp>)authentication_classesr>   r   r   r   rR     s    zAPIView.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S r   r   )r]   
permissionr   r   r   r^     s     z+APIView.get_permissions.<locals>.<listcomp>)permission_classesr>   r   r   r   get_permissions  s    zAPIView.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S r   r   )r]   throttler   r   r   r^     s     z)APIView.get_throttles.<locals>.<listcomp>)throttle_classesr>   r   r   r   get_throttles  s    zAPIView.get_throttlesc                 C   s   t | dds|  | _| jS )zN
        Instantiate and return the content negotiation class to use.
        _negotiatorN)r   content_negotiation_classrk   r>   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   ZEXCEPTION_HANDLERr>   r   r   r   get_exception_handler&  s    zAPIView.get_exception_handlerc                 C   sX   |   }|  }z|||| jW S  tk
rR   |rL|d |d jf Y S  Y nX dS )zU
        Determine which renderer and media type to use render the response.
        r   N)r_   rm   Zselect_rendererformat_kwarg	Exception
media_type)r?   rI   forceZ	renderersZconnegr   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)r?   rI   r   r   r   perform_authentication<  s    zAPIView.perform_authenticationc                 C   s>   |   D ]0}||| s| j|t|ddt|ddd qdS )z
        Check if the request should be permitted.
        Raises an appropriate exception if the request is not permitted.
        rO   NrL   rO   rL   )rg   Zhas_permissionrP   r   )r?   rI   re   r   r   r   check_permissionsF  s    

zAPIView.check_permissionsc                 C   s@   |   D ]2}||| |s| j|t|ddt|ddd qdS )z
        Check if the request should be permitted for a given object.
        Raises an appropriate exception if the request is not permitted.
        rO   NrL   rv   )rg   Zhas_object_permissionrP   r   )r?   rI   objre   r   r   r   check_object_permissionsS  s    

z APIView.check_object_permissionsc                 C   sZ   g }|   D ]}||| s||  q|rVdd |D }t|dd}| || dS )z|
        Check if request should be throttled.
        Raises an appropriate exception if the request is throttled.
        c                 S   s   g | ]}|d k	r|qS )Nr   )r]   durationr   r   r   r^   m  s   z+APIView.check_throttles.<locals>.<listcomp>N)default)rj   Zallow_requestappendr(   maxrQ   )r?   rI   Zthrottle_durationsrh   Z	durationsrz   r   r   r   check_throttles`  s    zAPIView.check_throttlesc                 O   s,   | j dkrdS |   }|j|f|||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)r?   rI   r,   rJ   schemer   r   r   r   u  s    
zAPIView.determine_versionc                 O   s(   |  |}t||  |  |  |dS )z5
        Returns the initial request object.
        )parsersrM   Z
negotiatorparser_context)rV   r   rb   rR   rm   )r?   rI   r,   rJ   r   r   r   r   initialize_request  s    
zAPIView.initialize_requestc                 O   sj   | j f || _| |}|\|_|_| j|f||\}}|| |_|_| | | 	| | 
| dS )zX
        Runs anything that needs to occur prior to calling the method handler.
        N)r\   ro   rs   accepted_rendereraccepted_media_typer   versionZversioning_schemeru   rw   r~   )r?   rI   r,   rJ   negr   r   r   r   r   initial  s    


zAPIView.initialc           	      O   s   t |tstdt| t |trdt|ddsJ| j|dd}|\|_|_|j|_|j|_| 	 |_
| jdd}|dk	rt|t| | j D ]\}}|||< q|S )z4
        Returns the final response object.
        zrExpected a `Response`, `HttpResponse` or `StreamingHttpResponse` to be returned from the view, but received a `%s`r   NT)rr   rC   )r+   r   AssertionErrortyper   r   rs   r   r   rX   Zrenderer_contextr*   popr	   r   splititems)	r?   rI   responser,   rJ   r   Zvary_headerskeyvaluer   r   r   finalize_response  s$    


zAPIView.finalize_responsec                 C   sh   t |tjtjfr2| | j}|r*||_ntj|_	| 
 }|  }|||}|dkr^| | d|_|S )zz
        Handle any exception that occurs, by returning an appropriate response,
        or re-raising the error.
        NT)r+   r   rN   ZAuthenticationFailedrS   rI   r'   r   ZHTTP_403_FORBIDDENr/   rn   rY   raise_uncaught_exception	exception)r?   r0   r'   r3   r1   r   r   r   r   handle_exception  s    

zAPIView.handle_exceptionc                 C   s2   t jr*| j}t|jd}|dk}|| |d S )Nformat)r"   apiZadmin)r   DEBUGrI   r   r   Zforce_plaintext_errors)r?   r0   rI   Zrenderer_formatZuse_plaintext_tracebackr   r   r   r     s    
z APIView.raise_uncaught_exceptionc              
   O   s   || _ || _| j|f||}|| _| j| _zR| j|f|| |j | j	krft
| |j | j}n| j}||f||}W n, tk
r } z| |}W 5 d}~X Y nX | j||f||| _| 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)r,   rJ   r   rI   rG   r*   r   rH   lowerZhttp_method_namesr   rK   rp   r   r   r   )r?   rI   r,   rJ   handlerr   r0   r   r   r   dispatch  s"    zAPIView.dispatchc                 O   s:   | j dkr| j|f||S |   || }t|tjdS )z<
        Handler method for HTTP 'OPTIONS' request.
        N)r   )metadata_classrK   Zdetermine_metadatar   r   ZHTTP_200_OK)r?   rI   r,   rJ   r2   r   r   r   options  s    
zAPIView.options)NN)F)F);r   
__module____qualname__r   ZDEFAULT_RENDERER_CLASSESrF   ZDEFAULT_PARSER_CLASSESra   ZDEFAULT_AUTHENTICATION_CLASSESrd   ZDEFAULT_THROTTLE_CLASSESri   ZDEFAULT_PERMISSION_CLASSESrf   Z!DEFAULT_CONTENT_NEGOTIATION_CLASSrl   ZDEFAULT_METADATA_CLASSr   ZDEFAULT_VERSIONING_CLASSr   r   r   Zschemaclassmethodr:   propertyr@   rG   rK   rP   rQ   rS   rV   rX   rY   r   r#   r\   r_   rb   rR   rg   rj   rm   rn   rs   ru   rw   ry   r~   r   r   r   r   r   r   r   r   __classcell__r   r   r=   r   r4   h   s\   


	



r4   N)F)'r    Zdjango.confr   Zdjango.core.exceptionsr   Z	django.dbr   r   Zdjango.httpr   Zdjango.http.responser   Zdjango.utils.cacher   r	   Zdjango.utils.encodingr
   Zdjango.views.decorators.csrfr   Zdjango.views.genericr   Zrest_frameworkr   r   Zrest_framework.requestr   Zrest_framework.responser   Zrest_framework.schemasr   Zrest_framework.settingsr   Zrest_framework.utilsr   r   r#   r%   r3   r4   r   r   r   r   <module>   s(   
!