U
    d/                     @   s  d Z ddlZddlmZ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lmZ ddlmZ eddddddgZedddddgZdd Zdd ZG dd dZG dd deZG dd dejZG dd deZ dS ) a  
Routers provide a convenient and consistent way of automatically
determining the URL conf for your API.

They are used by simply instantiating a Router class, and then registering
all the required ViewSets with that router.

For example, you might have a `urls.py` that looks something like this:

    router = routers.DefaultRouter()
    router.register('users', UserViewSet, 'user')
    router.register('accounts', AccountViewSet, 'account')

    urlpatterns = router.urls
    N)OrderedDict
namedtuple)ImproperlyConfigured)NoReverseMatchre_path)views)Response)reverse)SchemaGenerator)
SchemaView)api_settings)format_suffix_patternsRouteurlmappingnamedetail
initkwargsDynamicRoutec                 C   s   |  dd ddS )zK
    Double brackets in regex of url_path for escape string formatting
    {z{{}z}})replace)url_path r   :/tmp/pip-unpacked-wheel-quko9yh2/rest_framework/routers.pyescape_curly_brackets"   s    r   c                 C   s
   t j|  S )zX
    Takes an iterable of iterables, returns a single iterable containing all items
    )	itertoolschain)Zlist_of_listsr   r   r   flatten)   s    r   c                   @   s:   e Zd Zdd ZdddZdd Zdd	 Zed
d ZdS )
BaseRouterc                 C   s
   g | _ d S )N)registryselfr   r   r   __init__1   s    zBaseRouter.__init__Nc                 C   s6   |d kr|  |}| j|||f t| dr2| `d S N_urls)get_default_basenamer    appendhasattrr%   )r"   prefixviewsetbasenamer   r   r   register4   s
    

zBaseRouter.registerc                 C   s   t ddS )q
        If `basename` is not specified, attempt to automatically determine
        it from the viewset.
        z'get_default_basename must be overriddenNNotImplementedError)r"   r*   r   r   r   r&   =   s    zBaseRouter.get_default_basenamec                 C   s   t ddS )zO
        Return a list of URL patterns, given the registered viewsets.
        zget_urls must be overriddenNr.   r!   r   r   r   get_urlsD   s    zBaseRouter.get_urlsc                 C   s   t | ds|  | _| jS r$   )r(   r0   r%   r!   r   r   r   urlsJ   s    

zBaseRouter.urls)N)	__name__
__module____qualname__r#   r,   r&   r0   propertyr1   r   r   r   r   r   0   s   
	r   c                	       s   e Zd Zeddddddddid	ed
ddi deddddddddddid	edddi dgZd& fdd	Zdd Zdd Zdd Z	dd  Z
d'd"d#Zd$d% Z  ZS )(SimpleRouterz^{prefix}{trailing_slash}$listcreate)getpostz{basename}-listFsuffixListr   r   r   r   r   z%^{prefix}/{url_path}{trailing_slash}$z{basename}-{url_name})r   r   r   r   z#^{prefix}/{lookup}{trailing_slash}$retrieveupdateZpartial_updatedestroy)r9   putpatchdeletez{basename}-detailTZInstancez.^{prefix}/{lookup}/{url_path}{trailing_slash}$c                    s   |rdnd| _ t   d S )N/ )trailing_slashsuperr#   )r"   rF   	__class__r   r   r#   ~   s    zSimpleRouter.__init__c                 C   s*   t |dd}|dk	std|jjj S )r-   querysetNz`basename` argument not specified, and could not automatically determine the name from the viewset, as it does not have a `.queryset` attribute.)getattrAssertionErrormodelZ_metaZobject_namelower)r"   r*   rJ   r   r   r   r&      s    z!SimpleRouter.get_default_basenamec                    s   t tdd jD  | } fdd|D }|rLd}t|d| dd |D }dd |D }g }jD ]bttrjr|fdd|D 7 }qrttrʈjs|fd	d|D 7 }qr|	 qr|S )
z
        Augment `self.routes` with any dynamically generated routes.

        Returns a list of the Route namedtuple.
        c                 S   s    g | ]}t |tr|j qS r   )
isinstancer   r   values).0router   r   r   
<listcomp>   s     
 z+SimpleRouter.get_routes.<locals>.<listcomp>c                    s   g | ]}|j  kr|j qS r   )r2   rQ   action)known_actionsr   r   rS      s   
zZCannot use the @action decorator on the following methods, as they are existing routes: %sz, c                 S   s   g | ]}|j r|qS r   r   rT   r   r   r   rS      s      c                 S   s   g | ]}|j s|qS r   rW   rT   r   r   r   rS      s      c                    s   g | ]}  |qS r   _get_dynamic_routerT   rR   r"   r   r   rS      s     c                    s   g | ]}  |qS r   rX   rT   rZ   r   r   rS      s     )
r7   r   routesZget_extra_actionsr   joinrO   r   r   r'   )r"   r*   Zextra_actionsnot_allowedmsgZdetail_actionsZlist_actionsr[   r   )rV   rR   r"   r   
get_routes   s$    

zSimpleRouter.get_routesc                 C   sL   |j  }||j t|j}t|jd||j	|j
d|j|j|dS )Nz
{url_path}z
{url_name}r=   )r   copyr?   kwargsr   r   r   r   r   r   r   url_namer   )r"   rR   rU   r   r   r   r   r   rY      s    

zSimpleRouter._get_dynamic_routec                 C   s,   i }|  D ]\}}t||r|||< q|S )z
        Given a viewset, and a mapping of http methods to actions,
        return a new mapping which only includes any mappings that
        are actually implemented by the viewset.
        )itemsr(   )r"   r*   Z
method_mapZbound_methodsmethodrU   r   r   r   get_method_map   s
    

zSimpleRouter.get_method_maprE   c                 C   s<   d}t |dd}t |ddp|}t |dd}|j|||dS )	a  
        Given a viewset, return the portion of URL regex that is used
        to match against a single instance.

        Note that lookup_prefix is not used directly inside REST rest_framework
        itself, but is required in order to nicely support nested router
        implementations, such as drf-nested-routers.

        https://github.com/alanjds/drf-nested-routers
        z5(?P<{lookup_prefix}{lookup_url_kwarg}>{lookup_value})lookup_fieldpklookup_url_kwargNZlookup_value_regexz[^/.]+)lookup_prefixrh   lookup_value)rK   format)r"   r*   ri   Z
base_regexrf   rh   rj   r   r   r   get_lookup_regex   s    zSimpleRouter.get_lookup_regexc              	   C   s   g }| j D ]\}}}| |}| |}|D ]}| ||j}|sDq,|jj||| jd}	|s||	dd dkr|d|	dd  }	|j	 }
|

||jd |j|f|
}|jj|d}|t|	||d q,q
|S )	zQ
        Use the registered viewsets to generate a list of URL patterns.
        )r)   lookuprF   N   z^/^)r+   r   r+   r   )r    rl   r_   re   r   r   rk   rF   r   r`   r?   r   as_viewr   r'   r   )r"   retr)   r*   r+   rm   r[   rR   r   regexr   viewr   r   r   r   r0      s0    



zSimpleRouter.get_urls)T)rE   )r2   r3   r4   r   r   r[   r#   r&   r_   rY   re   rl   r0   __classcell__r   r   rH   r   r6   Q   sP   +$
r6   c                   @   s$   e Zd ZdZdZdZdZdd ZdS )APIRootViewz7
    The default basic root view for DefaultRouter
    TNc              	   O   st   t  }|jj}| j D ]R\}}|r0|d | }z t|||||dd||< W q tk
rh   Y qY qX qt|S )N:rk   )argsra   requestrk   )	r   Zresolver_match	namespaceapi_root_dictrc   r	   r9   r   r   )r"   rz   ry   ra   rs   r{   keyrb   r   r   r   r9     s     zAPIRootView.get)r2   r3   r4   __doc__Z_ignore_model_permissionsZschemar|   r9   r   r   r   r   rw     s
   rw   c                       sR   e Zd ZdZdZdZdZdZeZe	Z
eZ fddZdddZ fd	d
Z  ZS )DefaultRouterz
    The default router extends the SimpleRouter, but also adds in a default
    API root view, and adds format suffix patterns to the URLs.
    Tzapi-rootNc                    s4   d|kr| d| _nttj| _t j|| d S )Nroot_renderers)popr   r7   r   ZDEFAULT_RENDERER_CLASSESrG   r#   )r"   ry   ra   rH   r   r   r#   ;  s    zDefaultRouter.__init__c                 C   sB   t  }| jd j}| jD ]\}}}|j|d||< q| jj|dS )z+
        Return a basic root view.
        r   rp   )r|   )r   r[   r   r    rk   rw   rr   )r"   api_urlsr|   Z	list_namer)   r*   r+   r   r   r   get_api_root_viewB  s
    zDefaultRouter.get_api_root_viewc                    sH   t   }| jr6| j|d}td|| jd}|| | jrDt|}|S )z
        Generate the list of URL patterns, including a default root view
        for the API, and appending `.json` style format suffixes.
        )r   z^$rq   )	rG   r0   include_root_viewr   r   root_view_namer'   include_format_suffixesr   )r"   r1   ru   Zroot_urlrH   r   r   r0   M  s    

zDefaultRouter.get_urls)N)r2   r3   r4   r~   r   r   r   Zdefault_schema_renderersrw   r   ZAPISchemaViewr
   r#   r   r0   rv   r   r   rH   r   r   .  s   
r   )!r~   r   collectionsr   r   Zdjango.core.exceptionsr   Zdjango.urlsr   r   Zrest_frameworkr   Zrest_framework.responser   Zrest_framework.reverser	   Zrest_framework.schemasr
   Zrest_framework.schemas.viewsr   Zrest_framework.settingsr   Zrest_framework.urlpatternsr   r   r   r   r   r   r6   ZAPIViewrw   r   r   r   r   r   <module>   s(   ! @