3 Ah`/@sdZddlZddlmZmZddlmZddlmZm 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) OrderedDict namedtuple)ImproperlyConfigured)NoReverseMatchre_path)views)Response)reverse)SchemaGenerator) SchemaView) api_settings)format_suffix_patternsRouteurlmappingnamedetail initkwargs DynamicRoutecCs|jddjddS)zK Double brackets in regex of url_path for escape string formatting {z{{}z}})replace)url_pathrE/tmp/pip-build-9m32_hle/djangorestframework/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@s:eZdZddZd ddZddZdd Zed d ZdS) BaseRoutercCs g|_dS)N)registry)selfrrr__init__1szBaseRouter.__init__NcCs6|dkr|j|}|jj|||ft|dr2|`dS)N_urls)get_default_basenamer appendhasattrr#)r!prefixviewsetbasenamerrrregister4s   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)r!r(rrrr$=szBaseRouter.get_default_basenamecCs tddS)zO Return a list of URL patterns, given the registered viewsets. zget_urls must be overriddenN)r+)r!rrrget_urlsDszBaseRouter.get_urlscCst|ds|j|_|jS)Nr#)r&r,r#)r!rrrurlsJs  zBaseRouter.urls)N) __name__ __module__ __qualname__r"r*r$r,propertyr-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}-listFsuffixZList)rrrrrz%^{prefix}/{url_path}{trailing_slash}$z{basename}-{url_name})rrrrz#^{prefix}/{lookup}{trailing_slash}$retrieveupdateZpartial_updatedestroy)r5putpatchdeletez{basename}-detailTZInstancez.^{prefix}/{lookup}/{url_path}{trailing_slash}$cs|rdnd|_tjdS)N/)trailing_slashsuperr")r!r@) __class__rrr"~szSimpleRouter.__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.)getattrAssertionErrormodelZ_metaZ object_namelower)r!r(rCrrrr$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.)rJaction) known_actionsrrrLszZCannot use the @action decorator on the following methods, as they are existing routes: %sz, cSsg|]}|jr|qSr)r)rJrMrrrrLscSsg|]}|js|qSr)r)rJrMrrrrLscsg|]}j|qSr)_get_dynamic_route)rJrM)rKr!rrrLscsg|]}j|qSr)rO)rJrM)rKr!rrrLs) r3rroutesZget_extra_actionsrjoinrHrrr%)r!r(Z extra_actions not_allowedmsgZdetail_actionsZ list_actionsrPr)rNrKr!r get_routess  zSimpleRouter.get_routescCsL|jj}|j|jt|j}t|jjd||j |j jd|j |j |dS)Nz {url_path}z {url_name})rrrrr) rcopyr9kwargsrrrrrrrurl_namer)r!rKrMrrrrrrOs    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. )itemsr&)r!r(Z method_mapZ bound_methodsmethodrMrrrget_method_maps   zSimpleRouter.get_method_mapr?cCs<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_prefixr] lookup_value)rDformat)r!r(r^Z base_regexr[r]r_rrrget_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. )r'lookupr@Nz^/^)r)r)r))r)r rarTrZrrr`r@rrUr9ras_viewrr%r) r!retr'r(r)rbrPrKrregexrviewrrrrr,s,      zSimpleRouter.get_urls)T)r?)r.r/r0rrrPr"r$rTrOrZrar, __classcell__rr)rBrr2QsB    $ r2c@s$eZdZdZdZdZdZddZdS) APIRootViewz7 The default basic root view for DefaultRouter TNcOsxt}|jj}x`|jjD]R\}}|r2|d|}y"t|||||jddd||<Wqtk rjwYqXqWt|S)N:r`)argsrVrequestr`) rZresolver_match namespace api_root_dictrXr r5rr)r!rmrlrVrfrnkeyrWrrrr5s  zAPIRootView.get)r.r/r0__doc__Z_ignore_model_permissionsZschemaror5rrrrrjs rjcsReZdZdZdZdZdZdZeZe 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|jd|_n ttj|_tj||dS)Nroot_renderers)poprsr3r ZDEFAULT_RENDERER_CLASSESrAr")r!rlrV)rBrrr";s zDefaultRouter.__init__cCsFt}|jdj}x$|jD]\}}}|j|d||<qW|jj|dS)z+ Return a basic root view. r)r))ro)rrPrr r`rjre)r!api_urlsroZ list_namer'r(r)rrrget_api_root_viewBs  zDefaultRouter.get_api_root_viewcsHtj}|jr6|j|d}td||jd}|j||jrDt|}|S)z Generate the list of URL patterns, including a default root view for the API, and appending `.json` style format suffixes. )ruz^$)r) rAr,include_root_viewrvrroot_view_namer%include_format_suffixesr )r!r-rhZroot_url)rBrrr,Ms   zDefaultRouter.get_urls)N)r.r/r0rqrwryrxZdefault_schema_renderersrjr Z APISchemaViewr r"rvr,rirr)rBrrr.s  rr)!rqr collectionsrrZdjango.core.exceptionsrZ django.urlsrrZrest_frameworkrZrest_framework.responserZrest_framework.reverser Zrest_framework.schemasr Zrest_framework.schemas.viewsr Zrest_framework.settingsr Zrest_framework.urlpatternsr rrrrrr2ZAPIViewrjrrrrrrs(        !@