U jc6@sdZddlZddlmZddlmZddlmZmZm Z ddl m Z ddl m Z ddlmZdd lmZdd lmZdd lmZdd lmZed dddddgZedddddgZddZddZGdddZGdddeZGddde jZGdddeZ 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 N) namedtuple)ImproperlyConfigured)NoReverseMatchpathre_path)views)Response)reverse)SchemaGenerator) SchemaView) api_settings)format_suffix_patternsRouteurlmappingnamedetail initkwargs DynamicRoutecCs|ddddS)zK Double brackets in regex of url_path for escape string formatting {z{{}z}})replace)url_pathr:/tmp/pip-unpacked-wheel-6231m0k6/rest_framework/routers.pyescape_curly_brackets"srcCs tj|S)zX Takes an iterable of iterables, returns a single iterable containing all items ) itertoolschain)Z list_of_listsrrrflatten)src@sBeZdZddZdddZddZdd Zd d Zed d Z dS) BaseRoutercCs g|_dSN)registryselfrrr__init__1szBaseRouter.__init__NcCsZ|dkr||}||r6d|d|d}t||j|||ft|drV|`dS)NzRouter with basename "zG" is already registered. Please provide a unique basename for viewset ""_urls)get_default_basenameis_already_registeredrr!appendhasattrr&)r#prefixviewsetbasenamemsgrrrregister4s   zBaseRouter.registercstfdd|jDS)z; Check if `basename` is already registered c3s|]\}}}|kVqdSr r).0_prefixZ_viewsetr- new_basenamerr Gsz3BaseRouter.is_already_registered..)anyr!)r#r3rr2rr(Csz BaseRouter.is_already_registeredcCs tddS)q If `basename` is not specified, attempt to automatically determine it from the viewset. z'get_default_basename must be overriddenNNotImplementedError)r#r,rrrr'IszBaseRouter.get_default_basenamecCs tddS)zO Return a list of URL patterns, given the registered viewsets. zget_urls must be overriddenNr7r"rrrget_urlsPszBaseRouter.get_urlscCst|ds||_|jS)Nr&)r*r9r&r"rrrurlsVs  zBaseRouter.urls)N) __name__ __module__ __qualname__r$r/r(r'r9propertyr:rrrrr0s rc 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}-listFsuffixListrrrrrz%^{prefix}/{url_path}{trailing_slash}$z{basename}-{url_name})rrrrz#^{prefix}/{lookup}{trailing_slash}$retrieveupdateZpartial_updatedestroy)rBputpatchdeletez{basename}-detailTZInstancez.^{prefix}/{lookup}/{url_path}{trailing_slash}$cs|rdnd|_||_|r,d|_d|_t|_npd|_d|_t|_g}|jD]L}|j}|ddkrj|d d}|d d kr|dd }| |j |d qH||_t dS) N/z5(?P<{lookup_prefix}{lookup_url_kwarg}>{lookup_value})z[^/.]+z2<{lookup_value}:{lookup_prefix}{lookup_url_kwarg}>strr^$)r) trailing_slash _use_regex _base_pattern_default_value_patternr _url_confrroutesrr)_replacesuperr$)r#rTZuse_regex_pathZ_routesrouteZ url_param __class__rrr$s&     zSimpleRouter.__init__cCs*t|dd}|dk std|jjjS)r6querysetNz`basename` argument not specified, and could not automatically determine the name from the viewset, as it does not have a `.queryset` attribute.)getattrAssertionErrormodelZ_metaZ object_namelower)r#r,r_rrrr's z!SimpleRouter.get_default_basenamecsttddjD|}fdd|D}|rLd}t|d|dd|D}dd|D}g}jD]bttrjr|fdd|D7}qrttrʈjs|fd d|D7}qr| qr|S) z Augment `self.routes` with any dynamically generated routes. Returns a list of the Route namedtuple. cSs g|]}t|tr|jqSr) isinstancerrvalues)r0r\rrr s z+SimpleRouter.get_routes..csg|]}|jkr|jqSr)r;r0action) known_actionsrrrfs zZCannot use the @action decorator on the following methods, as they are existing routes: %sz, cSsg|]}|jr|qSrrrgrrrrfscSsg|]}|js|qSrrjrgrrrrfscsg|]}|qSr_get_dynamic_routergr\r#rrrfscsg|]}|qSrrkrgrmrrrfs) r@rrYZget_extra_actionsrjoinrdrrr))r#r,Z extra_actions not_allowedr.Zdetail_actionsZ list_actionsrYr)rir\r#r get_routess$   zSimpleRouter.get_routescCsL|j}||jt|j}t|jd||j |j d|j |j |dS)Nz {url_path}z {url_name}rF) rcopyrHkwargsrrrrrrrurl_namer)r#r\rhrrrrrrls    zSimpleRouter._get_dynamic_routecCs,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_methodsmethodrhrrrget_method_maps   zSimpleRouter.get_method_maprNcCsZt|dd}t|ddp|}d}|js2t|dd}|dkrHt|d|j}|jj|||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 lookup_fieldpklookup_url_kwargNZlookup_value_converterZlookup_value_regex) lookup_prefixry lookup_value)r`rUrWrVformat)r#r,rzrwryr{rrrget_lookup_regexs  zSimpleRouter.get_lookup_regexc Csg}|jD]\}}}||}||}|D]}|||j}|sDq,|jj|||jd} |s|jt kr| ddkr| dd} n | dddkrd| dd} |j } | ||j d |j|f| } |jj|d } ||j| | | d q,q |S) zQ Use the registered viewsets to generate a list of URL patterns. )r+lookuprTrrMrQNz^/rP)r-rr-r)r!r}rprvrrr|rTrXrrrqrHras_viewrr)) r#retr+r,r-r~rYr\rregexrviewrrrrr9 s8      zSimpleRouter.get_urls)TT)rN)r;r<r=rrrYr$r'rprlrvr}r9 __classcell__rrr]rr?]sP + $ r?c@s$eZdZdZdZdZdZddZdS) APIRootViewz7 The default basic root view for DefaultRouter TNc Osri}|jj}|jD]R\}}|r.|d|}z t|||||dd||<Wqtk rfYqYqXqt|S)N:r|)argsrrrequestr|)Zresolver_match namespace api_root_dictrtr rBrr)r#rrrrrrkeyrsrrrrBBs   zAPIRootView.get)r;r<r=__doc__Z_ignore_model_permissionsZschemarrBrrrrr:s rcsReZdZdZdZdZdZdZeZe 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-rootNcs4d|kr|d|_n ttj|_tj||dS)Nroot_renderers)poprr@r ZDEFAULT_RENDERER_CLASSESr[r$)r#rrrr]rrr$es zDefaultRouter.__init__cCs@i}|jdj}|jD]\}}}|j|d||<q|jj|dS)z+ Return a basic root view. rr)r)rYrr!r|rr)r#api_urlsrZ list_namer+r,r-rrrget_api_root_viewls  zDefaultRouter.get_api_root_viewcsHt}|jr6|j|d}td||jd}|||jrDt|}|S)z Generate the list of URL patterns, including a default root view for the API, and appending `.json` style format suffixes. )rrNr) r[r9include_root_viewrrroot_view_namer)include_format_suffixesr )r#r:rZroot_urlr]rrr9ws   zDefaultRouter.get_urls)N)r;r<r=rrrrZdefault_schema_renderersrr Z APISchemaViewr r$rr9rrrr]rrXs  r)!rr collectionsrZdjango.core.exceptionsrZ django.urlsrrrZrest_frameworkrZrest_framework.responserZrest_framework.reverser Zrest_framework.schemasr Zrest_framework.schemas.viewsr Zrest_framework.settingsr Zrest_framework.urlpatternsr rrrrrr?ZAPIViewrrrrrrs(         -^