3 >^:@s6dZddlZddlmZmZddlmZddlmZddl m Z ddl m Z ddl mZdd lmZdd lmZdd lmZmZmZmZmZdd lmZdd lmZddlmZddlm Z ddZ!ddZ"ddZ#dZ$GdddeZ%ddZ&ddZ'ddZ(d d!Z)ej*d"Z+Gd#d$d$e,Z-Gd%d&d&e,Z.dS)'z] generators.py # Top-down schema generation See schemas.__init__.py for package overview. N)Counter OrderedDict) import_module)settings)simplify_regex)PermissionDenied)Http404)six) exceptions) URLPattern URLResolvercoreapi coreschemaget_original_route) clone_request) api_settings)_get_pk) is_list_viewcCs`dd|D}t|}t|}|}x.t|D]"\}}|||kr,|d|}Pq,Wddj|S)NcSsg|]}|jdjdqS)/)stripsplit).0pathrP/tmp/pip-build-8app2_gc/djangorestframework/rest_framework/schemas/generators.py szcommon_path..r)minmax enumeratejoin)paths split_pathss1s2commonicrrr common_paths  r(cCs|jjj}t|jS)N)Z_metaZconcrete_modelrname)modelmetarrr get_pk_name's r,cCs*ddlm}t|dd}|dk o(t||S)zT Return `True` if the given view callback is a REST framework view/viewset. r)APIViewclsN)Zrest_framework.viewsr-getattr issubclass)callbackr-r.rrr is_api_view,s  r2a= Schema Naming Collision. coreapi.Link for URL path {value_url} cannot be inserted into schema. Position conflicts with coreapi.Link for URL path {target_url}. Attempted to insert link with keys: {keys}. Adjust URLs to avoid naming collision or override `SchemaGenerator.get_keys()` to customise schema structure. cs$eZdZfddZddZZS)LinkNodecs g|_t|_tt|jdS)N)linksrmethods_countersuperr3__init__)self) __class__rrr7DszLinkNode.__init__cCsJ||kr |Sx8|j|}|j|d7<dj||}||kr|SqWdS)Nrz{}_{})r5format)r8 preferred_keyZ current_valkeyrrrget_available_keyIs  zLinkNode.get_available_key)__name__ __module__ __qualname__r7r= __classcell__rr)r9rr3Cs r3c Cs~x.|ddD]}||kr$t||<||}qWy|jj|d|fWn0tk rxtj|j|j|d}t|YnXdS)z Nested dictionary insertion. >>> example = {} >>> insert_into(example, ['a', 'b', 'c'], 123) >>> example LinkNode({'a': LinkNode({'b': LinkNode({'c': LinkNode(links=[123])}}}))) Nr)Z value_url target_urlkeysrD)r3r4append TypeErrorINSERT_INTO_COLLISION_FMTr:url ValueError)targetrCvaluer<msgrrr insert_intoVs   rMcCsHx|jD]\}}t|q Wx$|jD]\}}|j|}|||<q&WdS)N)itemsdistribute_linksr4r=)objr<rKr;linkrrrrOos   rOcCs|dkS)Nretrievelistcreateupdatepartial_updatedestroy>rRrUrSrWrVrTr)actionrrris_custom_actionxsrYcCs*|\}}}ddddddj|d}||fS)Nrr)GETPOSTPUTPATCHDELETE)get)endpointrmethodr1Zmethod_priorityrrrendpoint_ordering~s rfz/<(?:(?P[^>:]+):)?(?P\w+)>c@s<eZdZdZdddZdddZdd Zd d Zd d ZdS)EndpointEnumeratorzR A class to determine the available API endpoints that a project exposes. NcCs@|dkr6|dkrtj}t|tjr,t|}n|}|j}||_dS)N)rZ ROOT_URLCONF isinstancer string_typesrZ urlpatternspatterns)r8rjurlconfurlsrrrr7s  zEndpointEnumerator.__init__c Cs|dkr|j}g}x|D]}|t|}t|trx|j|}|j}|j||rxL|j|D]}|||f} |j| qZWqt|t r|j |j |d} |j | qWt |td}|S)zZ Return a list of all available API endpoints by inspecting the URL conf. N)rjprefix)r<)rjrrhr get_path_from_regexr1should_include_endpointget_allowed_methodsrEr get_api_endpointsZ url_patternsextendsortedrf) r8rjrnZ api_endpointspattern path_regexrr1rerdZnested_endpointsrrrrrs&        z$EndpointEnumerator.get_api_endpointscCst|}tjtd|}|S)zG Given a URL conf regex, return a URI template string. z{\g})rresub_PATH_PARAMETER_COMPONENT_RE)r8rvrrrrrosz&EndpointEnumerator.get_path_from_regexcCsTt|s dS|jjdkrdSd|jkr8|jddkr8dS|jdsL|jdrPdSdS)zI Return `True` if the given endpoint should be included. FNschemaz .{format}z .{format}/T)r2r.rz initkwargsendswith)r8rr1rrrrps  z*EndpointEnumerator.should_include_endpointcCsLt|dr4t|j}t|jj}dd||@D}n |jj}dd|DS)zL Return a list of the valid HTTP methods for this endpoint. actionscSsg|] }|jqSr)upper)rrerrrrsz:EndpointEnumerator.get_allowed_methods..cSsg|]}|dkr|qS)OPTIONSHEAD)rrr)rrerrrrs)hasattrsetr}r.http_method_namesZallowed_methods)r8r1r}rmethodsrrrrqs     z&EndpointEnumerator.get_allowed_methods)NN)Nrm) r>r?r@__doc__r7rrrorprqrrrrrgs    rgc@speZdZddddddZeZdZdZddd Zdd d Z dd dZ ddZ dddZ ddZ ddZddZdS)SchemaGeneratorrRrTrUrVrW)rcpostputpatchdeleteNcCshts tdtstd|r0|jd r0|d7}tj|_tj|_||_ ||_ ||_ ||_ ||_ d|_dS)Nz/`coreapi` must be installed for schema support.z2`coreschema` must be installed for schema support.r)r AssertionErrorrr|rZSCHEMA_COERCE_METHOD_NAMEScoerce_method_namesZSCHEMA_COERCE_PATH_PKcoerce_path_pkrjrktitle descriptionrH endpoints)r8rrHrrjrkrrrr7s  zSchemaGenerator.__init__FcCsx|jdkr$|j|j|j}|j|_|j|r0dn|}|s>dS|j}| rZ|dk rZ|j}t|t j |j |j ||dS)zL Generate a `coreapi.Document` representing the API schema. N)rrrHcontent) rendpoint_inspector_clsrjrkrr get_linksrHZbuild_absolute_urirOr Documentrr)r8requestpublicZ inspectorr4rHrrr get_schemas  zSchemaGenerator.get_schemac Cst}g}g}xJ|jD]@\}}}|j|||}|j|||}|j||j|||fqW|sbdS|j|} x`|D]X\}}}|j|||sqr|jj|||j d} |t | d} |j | ||} t || | qrW|S)zq Return a dictionary containing all the links that should be included in the API schema. N)base_url) r3r create_view coerce_pathrEdetermine_path_prefixhas_view_permissionsrzZget_linkrHlenget_keysrM) r8rr4r!Zview_endpointsrrer1viewrnrQsubpathrCrrrr's&  zSchemaGenerator.get_linkscCs|g}xn|D]f}|jdjd}g}x |D]}d|kr6P|j|q(Wdj|dd}|s^dS|jd|dq Wt|S)a Given a list of all paths, return the common prefix which should be discounted when generating a schema structure. This will be the longest common string that does not include that last component of the URL, or the last component before a path parameter. For example: /api/v1/users/ /api/v1/users/{pk}/ The path prefix is '/api/v1/' r{NrrD)rrrEr r()r8r!prefixesr componentsZinitial_components componentrnrrrrHs  z%SchemaGenerator.determine_path_prefixcCs|jft|di}f|_i|_d|_d|_t|dd|_t|dd}|dk rn|dkr^d|_n|j|j |_|dk rt |||_|S)zC Given a callback, return an actual view instance. r{Nr}rmetadata) r.r/argskwargsZ format_kwargr action_maprXrclowerr)r8r1rerrr}rrrrgs  zSchemaGenerator.create_viewc Cs@|jdkrdSy|j|jWntjttfk r:dSXdS)zY Return `True` if the incoming request has the correct view permissions. NTF)rZcheck_permissionsr Z APIExceptionrr)r8rrerrrrr~s z$SchemaGenerator.has_view_permissionscCsJ|j sd|kr|Stt|dddd}|r6t|}nd}|jdd|S)z Coerce {pk} path arguments into the name of the model field, where possible. This is cleaner for an external representation. (Ie. "this is an identifier", not "this is a database primary key") z{pk}ZquerysetNr*idz{%s})rr/r,replace)r8rrerr* field_namerrrrs zSchemaGenerator.coerce_pathcCst|dr|j}n t|||r$d}n|j|j}dd|jdjdD}t|rt|j dkr|j|j}||j kr|j |}||gS|dd|gS||j kr|j |}||gS) a Return a list of keys that should be used to layout a link within the schema document. /users/ ("users", "list"), ("users", "create") /users/{pk}/ ("users", "read"), ("users", "update"), ("users", "delete") /users/enabled/ ("users", "enabled") # custom viewset list action /users/{pk}/star/ ("users", "star") # custom viewset detail action /users/{pk}/groups/ ("users", "groups", "list"), ("users", "groups", "create") /users/{pk}/groups/{pk}/ ("users", "groups", "read"), ("users", "groups", "update"), ("users", "groups", "delete") rXrScSsg|]}d|kr|qS)rr)rrrrrrsz,SchemaGenerator.get_keys..rrNrD) rrXrdefault_mappingrrrrYrrr)r8rrerrXZnamed_path_componentsrrrrs"       zSchemaGenerator.get_keys)NNNNN)NF)N)N)r>r?r@rrgrrrr7rrrrrrrrrrrrs    !  r)/rrw collectionsrr importlibrZ django.confrZdjango.contrib.admindocs.viewsrZdjango.core.exceptionsrZ django.httprZ django.utilsr Zrest_frameworkr Zrest_framework.compatr r r rrZrest_framework.requestrZrest_framework.settingsrZrest_framework.utils.model_metarutilsrr(r,r2rGr3rMrOrYrfcompileryobjectrgrrrrrs6              \