a cfS@s ddlZddlmZddlmZddlmZddlmZddl m Z m Z m Z ddl mZmZmZddlmZd d lmZd d lmZd d lmZmZd dZddZddZdZGdddeZddZ GdddeZ!ddZ"GdddeZ#GdddeZ$d d!Z%dS)"N)Counter)parse)models) force_str)RemovedInDRF317Warning exceptions serializers)coreapi coreschema uritemplate) api_settings)BaseSchemaGenerator) ViewInspector)get_pk_description is_list_viewcCs^dd|D}t|}t|}|}t|D]$\}}|||kr*|d|}qPq*dd|S)NcSsg|]}|ddqS)/)stripsplit).0pathr[/home/httpd/docs/test/DocsMgr/lib/python3.9/site-packages/rest_framework/schemas/coreapi.py zcommon_path..r)minmax enumeratejoin)paths split_pathss1s2commonicrrr common_paths  r&cCs|dvS)N>retrievedestroycreatepartial_updateupdatelistr)actionrrris_custom_actionsr.cCs@|D]\}}t|q|jD]\}}||}|||<q dSN)itemsdistribute_linkslinksget_available_key)objkeyvalue preferred_keylinkrrrr1#s   r1a= 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)LinkNodecsg|_t|_tdSr/)r2rmethods_countersuper__init__)self __class__rrr<:szLinkNode.__init__cCsF||vr |S|j|}|j|d7<d||}||vr |Sq dS)Nr z{}_{})r:format)r=r7Z current_valr5rrrr3?s  zLinkNode.get_available_key)__name__ __module__ __qualname__r<r3 __classcell__rrr>rr99s r9cCsx|ddD]}||vr"t||<||}q z|j|d|fWn.tyrtj|j|j|d}t|Yn0dS)z Nested dictionary insertion. >>> example = {} >>> insert_into(example, ['a', 'b', 'c'], 123) >>> example LinkNode({'a': LinkNode({'b': LinkNode({'c': LinkNode(links=[123])}}}))) N)Z value_url target_urlkeys)r9r2append TypeErrorINSERT_INTO_COLLISION_FMTr@url ValueError)targetrGr6r5msgrrr insert_intoLs    rOcsZeZdZdZddddddZdZdfd d Zdd d ZdddZddZ ddZ Z S)SchemaGeneratorz# Original CoreAPI version. r'r)r+r*r()getpostputpatchdeleteNcsLts Jdtdur tdtts,Jdt|||||tj|_ dS)Nz/`coreapi` must be installed for schema support.CCoreAPI compatibility is deprecated and will be removed in DRF 3.17z2`coreschema` must be installed for schema support.) r warningswarnrr r;r<r ZSCHEMA_COERCE_METHOD_NAMEScoerce_method_names)r=titlerK descriptionpatternsZurlconfversionr>rrr<ws    zSchemaGenerator.__init__c Cst}||\}}|sdS||}|D]X\}}}||||sDq*|jj|||jd} |t|d} || ||} t || | q*|S)zq Return a dictionary containing all the links that should be included in the API schema. N)base_url) r9Z_get_paths_and_endpointsdetermine_path_prefixZhas_view_permissionsschemaget_linkrKlenget_keysrO) r=requestr2rZview_endpointsprefixrmethodviewr8subpathrGrrr get_linkss zSchemaGenerator.get_linksFcCsZ|||rdn|}|s"dS|j}|s<|dur<|}t|tj|j|j||dS)zL Generate a `coreapi.Document` representing the API schema. N)rZr[rKcontent) Z_initialise_endpointsrirKZbuild_absolute_urir1r ZDocumentrZr[)r=rdpublicr2rKrrr get_schemas zSchemaGenerator.get_schemacCst|dr|j}n t|||r$d}n|j|}dd|ddD}t|rdd|jD}t |dkr|j|}||j vr|j |}||gS|d d |gS||j vr|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") r-r,cSsg|]}d|vr|qS){r)r componentrrrrsz,SchemaGenerator.get_keys..rcSsh|]}|dkr|qS)headr)rrfrrr sz+SchemaGenerator.get_keys..r NrE) hasattrr-rdefault_mappinglowerrrr.Z action_maprbrY)r=rhrfrgr-Znamed_path_componentsZmapped_methodsrrrrcs*        zSchemaGenerator.get_keyscCsxg}|D]f}|dd}g}|D]}d|vr4q@||q$d|dd}|s\dS|d|dqt|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' rrmNrE)rrrHrr&)r=rprefixesr componentsZinitial_componentsrnrerrrr_s z%SchemaGenerator.determine_path_prefix)NNNNNN)N)NF) rArBrC__doc__rrrYr<rirlrcr_rDrrr>rrPes   0rPcCsb|jrt|jnd}|jr$t|jnd}t|tjtjfrTt|j}t j |||dSt|tj rnt j ||dSt|tj rt j dd|jD||dSt|tjrt|j}t j |||dSt|tjrt j}t|jdd}|dur|jj}t|tjrt j}|||dSt|tjr0t j||dSt|tjr\t j t jt|jd||dSt|tj rt jt|j||d St|tj!rt j"||dSt|tj#tj$frt j%||dSt|tj&rt j||dSt|tj'rt j||d d St|tj(rt j||d d St|tj)r2t j ||dS|j*+d dkrTt j||dd St j||dS)N)r0rZr[rZr[cSsi|]\}}|t|qSr)field_to_schema)rr5r6rrr sz#field_to_schema..) propertiesrZr[model)enum)r}rZr[date)rZr[r@z date-timeZ base_templatez textarea.htmltextarea),labelr help_text isinstancerListSerializerZ ListFieldrychildr ArrayZ DictFieldZObject Serializerfieldsr0ZManyRelatedFieldZchild_relationZPrimaryKeyRelatedFieldStringgetattrqueryset_metapkr AutoFieldIntegerZ RelatedFieldZMultipleChoiceFieldEnumr,choicesZ ChoiceFieldZ BooleanFieldBooleanZ DecimalFieldZ FloatFieldNumberZ IntegerFieldZ DateFieldZ DateTimeFieldZ JSONFieldstylerQ)fieldrZr[Z child_schemaZrelated_field_schema schema_clsr| model_fieldrrrrys       rycsneZdZdZdfdd ZddZddZd d Zd d Zd dZ ddZ ddZ e ddZ ddZZS) AutoSchemazj Default inspector for APIView Responsible for per-view introspection and schema generation. Ncs4ttdurtdt|dur*g}||_dS)z Parameters: * `manual_fields`: list of `coreapi.Field` instances that will be added to auto-generated fields, overwriting on `Field.name` NrV)r;r<r rWrXr_manual_fields)r= manual_fieldsr>rrr<\s   zAutoSchema.__init__cCs|||}||||7}||||7}||||7}|||}|||}|rxtdd|Drx|||}nd}|||}|r| dr|dd}t j t ||||||dS)a7 Generate `coreapi.Link` for self.view, path and method. This is the main _public_ access point. Parameters: * path: Route path for view from URLConf. * method: The HTTP request method. * base_url: The project "mount point" as given to SchemaGenerator cSsg|]}|jdvqS))formbody)location)rrrrrrrz'AutoSchema.get_link..Nrr rKr-encodingrr[)get_path_fieldsget_serializer_fieldsget_pagination_fieldsget_filter_fieldsget_manual_fields update_fieldsany get_encodingget_description startswithr Linkrurljoinrs)r=rrfr^rrrr[rrrraks&      zAutoSchema.get_linkc Cs|j}tt|dddd}g}t|D]}d}d}tj} i} |durz|j|} Wntyld} Yn0| dur| j rt | j }| dur| j rt | j }n| dur| j rt || }t|dr|j|kr|j| d<nt| tjrtj} tj|dd| f||d | d } || q(|S) zs Return a list of `coreapi.Field` instances corresponding to any templated path variables. rNr|rwlookup_value_regexpatternrTrxnamerrequiredr`)rgrr variablesr rr get_field ExceptionZ verbose_namerrZ primary_keyrrqZ lookup_fieldrrrrrr FieldrH) r=rrfrgr|rvariablerZr[rkwargsrrrrrrs>        zAutoSchema.get_path_fieldsc Cs|j}|dvrgSt|ds gSz |}Wn0tjy\d}td|jj ||Yn0t |t j rt jdddtdgSt |t jsgSg}|jD]H}|jst |t jrq|jo|d k}t j|jd |t|d}||q|S) z Return a list of `coreapi.Field` instances corresponding to any request body input, as determined by the serializer class. )PUTPATCHPOSTget_serializerNzt{}.get_serializer() raised an exception during schema generation. Serializer fields will not be generated for {} {}.datarTrrr)rgrqrrZ APIExceptionrWrXr@r?rArrrr rr rrrvaluesZ read_onlyZ HiddenFieldr field_nameryrH)r=rrfrg serializerrrrrrrrsF      z AutoSchema.get_serializer_fieldscCs<|j}t|||sgSt|dd}|s*gS|}||S)Npagination_class)rgrrrget_schema_fields)r=rrfrgZ paginationZ paginatorrrrrs  z AutoSchema.get_pagination_fieldscCs:t|jdddurdSt|jdr.|jjdvS|dvS)a Determine whether to include filter Fields in schema. Default implementation looks for ModelViewSet or GenericAPIView actions/methods that cause filtering on the default implementation. Override to adjust behaviour for your view. Note: Introduced in v3.7: Initially "private" (i.e. with leading underscore) to allow changes based on user experience. filter_backendsNFr-)r,r'r+r*r()rQrSrTrU)rrgrqr-rsr=rrfrrr_allows_filterss   zAutoSchema._allows_filterscCs8|||sgSg}|jjD]}|||j7}q|Sr/)rrgrr)r=rrfrZfilter_backendrrrrs   zAutoSchema.get_filter_fieldscCs|jSr/)rrrrrrszAutoSchema.get_manual_fieldscCs:|s|Sdd|D}|D]}|||j<qt|}|S)ay Update list of coreapi.Field instances, overwriting on `Field.name`. Utility function to handle replacing coreapi.Field fields from a list by name. Used to handle `manual_fields`. Parameters: * `fields`: list of `coreapi.Field` instances to update * `update_with: list of `coreapi.Field` instances to add or replace. cSsi|] }|j|qSr)rrfrrrrz-rz,AutoSchema.update_fields..)rr,r)rZ update_withZby_namerrrrrs   zAutoSchema.update_fieldscCsR|j}hd}t|dg}|D].}t|dd}||vr>|S|dkrdSqdS)zN Return the 'encoding' parameter to use for a given endpoint. >zmultipart/form-datazapplication/jsonz!application/x-www-form-urlencodedparser_classes media_typeNz*/*zapplication/octet-stream)rgr)r=rrfrgZsupported_media_typesr parser_classrrrrr3s  zAutoSchema.get_encoding)N)rArBrCrvr<rarrrrrr staticmethodrrrDrrr>rrVs&,3   rcs*eZdZdZdfdd ZddZZS) ManualSchemazV Allows providing a list of coreapi.Fields, plus an optional description. rwNcsNttdurtdttdd|Ds8Jd||_||_||_ dS)z Parameters: * `fields`: list of `coreapi.Field` instances. * `description`: String description for view. Optional. NrVcss|]}t|tjVqdSr/)rr rrrrr [rz(ManualSchema.__init__..z2`fields` must be a list of coreapi.Field instances) r;r<r rWrXrall_fields _description _encoding)r=rr[rr>rrr<Ps  zManualSchema.__init__cCs@|r|dr|dd}tjt||||j|j|jdS)Nrr r) rr rrrrsrrr)r=rrfr^rrrra`s  zManualSchema.get_link)rwN)rArBrCrvr<rarDrrr>rrKsrcCs tdurtdtttjtS)zIs CoreAPI Mode enabled?NrV)r rWrXr issubclassr ZDEFAULT_SCHEMA_CLASSrrrrr is_enabledns r)&rW collectionsrurllibrZ django.dbrZdjango.utils.encodingrZrest_frameworkrrrZrest_framework.compatr r r Zrest_framework.settingsr generatorsrZ inspectorsrutilsrrr&r.r1rJdictr9rOrPryrrrrrrrs.          Wv#