3 =^6@szdZddlmZddlZddlZddlmZmZddlm Z ddl m Z ddl m Z ddlmZdd lmZdd lmZmZmZdd lmZdd lmZdd lmZddlmZddlmZddl m!Z!eddddddgZ"edddddgZ#Gddde$Z%Gddde$Z&ddZ'ddZ(Gd d!d!eZ)Gd"d#d#ej*e)Z+Gd$d%d%e+Z,Gd&d'd'ej-Z.Gd(d)d)e,Z/dS)*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 )unicode_literalsN) OrderedDict namedtuple)url)ImproperlyConfigured)NoReverseMatch)six)RenameMethodsBase)RemovedInDRF310WarningRemovedInDRF311Warningviews)Response)reverse)SchemaGenerator) SchemaView) api_settings)format_suffix_patternsRoutermappingnamedetail initkwargs DynamicRoutec@seZdZddZdS)DynamicDetailRoutecCstjdtddt||d|S)Nz`DynamicDetailRoute` is deprecated and will be removed in 3.10 in favor of `DynamicRoute`, which accepts a `detail` boolean. Use `DynamicRoute(url, name, True, initkwargs)` instead.) stacklevelT)warningswarnr r)clsrrrrE/tmp/pip-build-8app2_gc/djangorestframework/rest_framework/routers.py__new__+s zDynamicDetailRoute.__new__N)__name__ __module__ __qualname__r!rrrr r*src@seZdZddZdS)DynamicListRoutecCstjdtddt||d|S)Nz`DynamicListRoute` is deprecated and will be removed in 3.10 in favor of `DynamicRoute`, which accepts a `detail` boolean. Use `DynamicRoute(url, name, False, initkwargs)` instead.r)rF)rrr r)rrrrrrr r!6s zDynamicListRoute.__new__N)r"r#r$r!rrrr r%5sr%cCs$dod|kr |jddjdd}|S)zK Double brackets in regex of url_path for escape string formatting {}z{{z}})replace)url_pathrrr escape_curly_brackets@s r*cCs tj|S)zX Takes an iterable of iterables, returns a single iterable containing all items ) itertoolschain)Z list_of_listsrrr flattenIsr-c@seZdZddeffZdS)RenameRouterMethodsZget_default_base_nameget_default_basenameN)r"r#r$r Zrenamed_methodsrrrr r.Psr.c@s:eZdZddZd ddZddZdd Zed d ZdS) BaseRoutercCs g|_dS)N)registry)selfrrr __init__WszBaseRouter.__init__NcCsn|dk rd}tj|td|o | s,td|dkr8|}|dkrJ|j|}|jj|||ft|drj|`dS)NzGThe `base_name` argument is pending deprecation in favor of `basename`.rz=Do not provide both the `basename` and `base_name` arguments._urls) rrr AssertionErrorr/r1appendhasattrr4)r2prefixviewsetbasename base_namemsgrrr registerZs   zBaseRouter.registercCs tddS)zq If `basename` is not specified, attempt to automatically determine it from the viewset. z'get_default_basename must be overriddenN)NotImplementedError)r2r9rrr r/mszBaseRouter.get_default_basenamecCs tddS)zO Return a list of URL patterns, given the registered viewsets. zget_urls must be overriddenN)r>)r2rrr get_urlstszBaseRouter.get_urlscCst|ds|j|_|jS)Nr4)r7r?r4)r2rrr urlszs  zBaseRouter.urls)NN) r"r#r$r3r=r/r?propertyr@rrrr r0Vs  r0c seZdZeddddddddid ed d did ed dddddddddid edd did gZd&fdd ZddZddZddZ dd Z d'd"d#Z d$d%Z Z S)( SimpleRouterz^{prefix}{trailing_slash}$listcreate)getpostz{basename}-listFsuffixList)rrrrrz%^{prefix}/{url_path}{trailing_slash}$z{basename}-{url_name})rrrrz#^{prefix}/{lookup}{trailing_slash}$retrieveupdateZpartial_updatedestroy)rEputpatchdeletez{basename}-detailTZInstancez.^{prefix}/{lookup}/{url_path}{trailing_slash}$cs |rdnd|_tt|jdS)N/)trailing_slashsuperrBr3)r2rQ) __class__rr r3szSimpleRouter.__init__cCs*t|dd}|dk std|jjjjS)zq If `basename` is not specified, attempt to automatically determine it from the viewset. querysetNz`basename` argument not specified, and could not automatically determine the name from the viewset, as it does not have a `.queryset` attribute.)getattrr5modelZ_metaZ object_namelower)r2r9rTrrr r/s z!SimpleRouter.get_default_basenamecsttddjD|j}fdd|D}|rLd}t|dj|dd|D}dd|D}g}xnjD]dttrjr|fdd|D7}qtttrΈj r|fd d|D7}qt|j qtW|S) z Augment `self.routes` with any dynamically generated routes. Returns a list of the Route namedtuple. cSs g|]}t|tr|jjqSr) isinstancerrvalues).0routerrr sz+SimpleRouter.get_routes..csg|]}|jkr|jqSr)r")rZaction) known_actionsrr r\szZCannot use the @action decorator on the following methods, as they are existing routes: %sz, cSsg|]}|jr|qSr)r)rZr]rrr r\scSsg|]}|js|qSr)r)rZr]rrr r\scsg|]}j|qSr)_get_dynamic_route)rZr])r[r2rr r\scsg|]}j|qSr)r_)rZr])r[r2rr r\s) rCr-routesZget_extra_actionsrjoinrXrrr6)r2r9Z extra_actions not_allowedr<Zdetail_actionsZ list_actionsr`r)r^r[r2r get_routess  zSimpleRouter.get_routescCsL|jj}|j|jt|j}t|jjd||j |j jd|j |j |dS)Nz {url_path}z {url_name})rrrrr) rcopyrJkwargsr*r)rrr(rrurl_namer)r2r[r]rr)rrr r_s    zSimpleRouter._get_dynamic_routecCs0i}x&|jD]\}}t||r|||<qW|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. )itemsr7)r2r9Z method_mapZ bound_methodsmethodr]rrr get_method_maps   zSimpleRouter.get_method_maprPcCs<d}t|dd}t|ddp|}t|dd}|j|||dS) 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_fieldpklookup_url_kwargNZlookup_value_regexz[^/.]+) lookup_prefixrl lookup_value)rUformat)r2r9rmZ base_regexrjrlrnrrr get_lookup_regexs   zSimpleRouter.get_lookup_regexc Csg}x|jD]\}}}|j|}|j|}x|D]}|j||j}|sHq0|jj|||jd} | r| dddkrd| dd} |jj } | j ||j d|j |f| } |j j|d} |jt| | | dq0Wq W|S) zQ Use the registered viewsets to generate a list of URL patterns. )r8lookuprQNrz^/^)r:r)r:)r)r1rprcrirrrorQrrdrJras_viewrr6) r2retr8r9r:rqr`r[rregexrviewrrrr r?s,      zSimpleRouter.get_urls)T)rP)r"r#r$rrr`r3r/rcr_rirpr? __classcell__rr)rSr rBsB    $ rBc@s$eZdZdZdZdZdZddZdS) APIRootViewz7 The default basic root view for DefaultRouter TNcOsxt}|jj}x`|jjD]R\}}|r2|d|}y"t|||||jddd||<Wqtk rjwYqXqWt|S)N:ro)argsrerequestro) rZresolver_match namespace api_root_dictrgrrErr )r2r{rzrertr|keyrfrrr rEHs  zAPIRootView.get)r"r#r$__doc__Z_ignore_model_permissionsZschemar}rErrrr rx@s rxcsReZdZdZdZdZdZdZeZe Z e Z fddZ d ddZ fd d ZZS) DefaultRouterz The default router extends the SimpleRouter, but also adds in a default API root view, and adds format suffix patterns to the URLs. Tzapi-rootNcs8d|kr|jd|_n ttj|_tt|j||dS)Nroot_renderers)poprrCrZDEFAULT_RENDERER_CLASSESrRrr3)r2rzre)rSrr r3ks zDefaultRouter.__init__cCsFt}|jdj}x$|jD]\}}}|j|d||<qW|jj|dS)z+ Return a basic root view. r)r:)r})rr`rr1rorxrs)r2api_urlsr}Z list_namer8r9r:rrr get_api_root_viewrs  zDefaultRouter.get_api_root_viewcsLtt|j}|jr:|j|d}td||jd}|j||jrHt |}|S)z Generate the list of URL patterns, including a default root view for the API, and appending `.json` style format suffixes. )rz^$)r) rRrr?include_root_viewrrroot_view_namer6include_format_suffixesr)r2r@rvZroot_url)rSrr r?}s  zDefaultRouter.get_urls)N)r"r#r$rrrrZdefault_schema_renderersrxrZ APISchemaViewrr3rr?rwrr)rSr r^s  r)0r __future__rr+r collectionsrrZdjango.conf.urlsrZdjango.core.exceptionsrZ django.urlsrZ django.utilsrZdjango.utils.deprecationr Zrest_frameworkr r r Zrest_framework.responser Zrest_framework.reverserZrest_framework.schemasrZrest_framework.schemas.viewsrZrest_framework.settingsrZrest_framework.urlpatternsrrrobjectrr%r*r-r.with_metaclassr0rBZAPIViewrxrrrrr s8               +@