3 >^D@sdZddlZddlZddlmZddlmZddlmZddl m Z m Z ddl m ZddlmZdd lmZmZdd lmZmZmZdd lmZdd lmZd dlmZejdZ ddZ!ddZ"Gddde#Z$Gddde$Z%Gddde$Z&Gddde$Z'dS)zb inspectors.py # Per-endpoint view introspection See schemas.__init__.py for package overview. N) OrderedDict)WeakKeyDictionary)models) force_text smart_text)parse) ugettext_lazy) exceptions serializers)coreapi coreschema uritemplate) api_settings) formatting) is_list_viewz^[a-zA-Z][0-9A-Za-z_]*:cCsf|jrt|jnd}|jr$t|jnd}t|tjtjfrTt|j}t j |||dSt|tj rnt j ||dSt|tj rt j tdd|jjD||dSt|tjrt|j}t j |||dSt|tjrt j}t|jdd}|dk r |jj}t|tjr t j}|||dSt|tjr4t j||dSt|tjr`t j t jt|j d||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*r6t j ||dS|j+j,d dkrXt j||dd St j||dS)N)itemstitle description)rrcSsg|]\}}|t|fqS)field_to_schema).0keyvaluerrP/tmp/pip-build-8app2_gc/djangorestframework/rest_framework/schemas/inspectors.py .sz#field_to_schema..)Z propertiesrrmodel)enum)rrrdate)rrformatz date-timeZ base_templatez textarea.htmltextarea)-labelr help_text isinstancer ListSerializerZ ListFieldrchildr ArrayZ DictFieldZObject SerializerrfieldsrZManyRelatedFieldZchild_relationZPrimaryKeyRelatedFieldStringgetattrqueryset_metapkr AutoFieldIntegerZ RelatedFieldZMultipleChoiceFieldEnumlistchoicesZ ChoiceFieldZ BooleanFieldBooleanZ DecimalFieldZ FloatFieldNumberZ IntegerFieldZ DateFieldZ DateTimeFieldZ JSONFieldstyleget)fieldrrZ child_schemaZrelated_field_schema schema_clsr model_fieldrrrrs       rcCsJt|tjrtd}nt|tjr,td}ntd}tdj||jjdS)Nzunique integer valuez UUID stringz unique valuez'A {value_type} identifying this {name}.) value_typename)r$rr/_Z UUIDFieldr r- verbose_name)rr:r;rrrget_pk_descriptionrs    r?c@sXeZdZdZddZddZddZedd Zej d d Zej d d Zd d Z dS) ViewInspectorz[ Descriptor class on APIView. Provide subclass for per-view schema generation cCs t|_dS)N)rinstance_schemas)selfrrr__init__szViewInspector.__init__cCs||jkr|j|S||_|S)a% Enables `ViewInspector` as a Python _Descriptor_. This is how `view.schema` knows about `view`. `__get__` is called when the descriptor is accessed on the owner. (That will be when view.schema is called in our case.) `owner` is always the owner class. (An APIView, or subclass for us.) `instance` is the view instance or `None` if accessed from the class, rather than an instance. See: https://docs.python.org/3/howto/descriptor.html for info on descriptor usage. )rAview)rBinstanceownerrrr__get__s  zViewInspector.__get__cCs||j|<|dk r||_dS)N)rArD)rBrEotherrrr__set__s zViewInspector.__set__cCs|jdk std|jS)zView property.NzvSchema generation REQUIRES a view instance. (Hint: you accessed `schema` from the view class rather than an instance.))_viewAssertionError)rBrrrrDs zViewInspector.viewcCs ||_dS)N)rJ)rBrrrrrDscCs d|_dS)N)rJ)rBrrrrDscCs tddS)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 z.get_link() must be overridden.N)NotImplementedError)rBpathmethodbase_urlrrrget_links zViewInspector.get_linkN) __name__ __module__ __qualname____doc__rCrGrIpropertyrDsetterdeleterrPrrrrr@s r@cs~eZdZdZdfdd ZddZddZd d Zd d Zd dZ ddZ ddZ ddZ ddZ eddZddZZS) AutoSchemazj Default inspector for APIView Responsible for per-view introspection and schema generation. Ncs$tt|j|dkrg}||_dS)z Parameters: * `manual_fields`: list of `coreapi.Field` instances that will be added to auto-generated fields, overwriting on `Field.name` N)superrXrC_manual_fields)rB manual_fields) __class__rrrCszAutoSchema.__init__cCs|j||}||j||7}||j||7}||j||7}|j||}|j||}|rxtdd|Drx|j||}nd}|j||}|r|j dr|dd}t j t j |||j|||dS)NcSsg|]}|jdkqS)formbody)r]r^)location)rr8rrrrsz'AutoSchema.get_link../r)urlactionencodingr)r)get_path_fieldsget_serializer_fieldsget_pagination_fieldsget_filter_fieldsget_manual_fields update_fieldsany get_encodingget_description startswithr Linkurlparseurljoinlower)rBrMrNrOr)r[rcrrrrrPs$      zAutoSchema.get_linkcCsf|j}t|d|j}t||dj}|rD|j||jtjt|S|j|t|d|j|jSdS)z Determine a link description. This will be based on the method docstring if one exists, or else the class docstring. rbN) rDr+rqrT_get_description_sectionrdedentrZget_view_description)rBrMrNrD method_nameZmethod_docstringrrrrls zAutoSchema.get_descriptionc Csdd|jD}d}ddi}xH|D]@}tj|rP|jd\}}} | j||<q$||d|7<q$Wtj} ||kr||jS|| kr| ||kr|| |jS|djS)NcSsg|]}|qSrr)rlinerrrrsz7AutoSchema._get_description_section..r: ) splitlines header_regexmatch partitionstriprZSCHEMA_COERCE_METHOD_NAMES) rBrDheaderrlinesZcurrent_sectionsectionsruZ seperatorZleadZcoerce_method_namesrrrrrs    z#AutoSchema._get_description_sectionc Cs"|j}tt|dddd}g}xtj|D]}d}d}tj} i} |dk ry|jj|} Wntk rpd} YnX| dk r| j rt | j }| dk r| j rt | j }n| dk r| j rt || }t|dr|j|kr|j| d<nt| tjrtj} tj|dd| f||d | d } |j| q*W|S) zs Return a list of `coreapi.Field` instances corresponding to any templated path variables. r,Nrrlookup_value_regexpatternrMT)rr)r<r_requiredschema)rDr+r variablesr r*r- get_field Exceptionr>rr#Z primary_keyr?hasattrZ lookup_fieldrr$rr/r0r Fieldappend) rBrMrNrDrr)variablerrr9kwargsr:r8rrrrds<      zAutoSchema.get_path_fieldscCs|j}|d krgSt|ds gSy |j}Wn2tjk r^d}tjdj|jj ||YnXt |t j rt jddd tjd gSt |t jsgSg}xV|jjD]H}|jst |t jrq|jo|dk}t j|jd |t|d }|j|qW|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 {} {}.datar^T)r<r_rrr])rrr)rDrrr Z APIExceptionwarningswarnr r\rQr$r r%r rr r'r(r)valuesZ read_onlyZ HiddenFieldr field_namerr)rBrMrNrD serializerr)r8rrrrreDs>     z AutoSchema.get_serializer_fieldscCs<|j}t|||sgSt|dd}|s*gS|j}|j|S)Npagination_class)rDrr+rget_schema_fields)rBrMrNrDZ paginationZ paginatorrrrrfws  z AutoSchema.get_pagination_fieldscCs:t|jdddkrdSt|jdr.|jjdkS|jdkS)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_backendsNFrbr2retrieveupdatepartial_updatedestroyr7putpatchdelete)r2rrrr)r7rrr)r+rDrrbrq)rBrMrNrrr_allows_filterss   zAutoSchema._allows_filterscCs<|j||sgSg}x"|jjD]}||j|j7}qW|S)N)rrDrr)rBrMrNr)Zfilter_backendrrrrgs  zAutoSchema.get_filter_fieldscCs|jS)N)rZ)rBrMrNrrrrhszAutoSchema.get_manual_fieldscCsB|s|Stdd|D}x|D]}|||j<q Wt|j}|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. css|]}|j|fVqdS)N)r<)rfrrr sz+AutoSchema.update_fields..)rr<r2r)r)Z update_withZby_namerrrrris   zAutoSchema.update_fieldscCsR|j}dddh}t|dg}x0|D](}t|dd}||kr>|S|dkr"dSq"WdS) zN Return the 'encoding' parameter to use for a given endpoint. zapplication/jsonz!application/x-www-form-urlencodedzmultipart/form-dataparser_classes media_typeNz*/*zapplication/octet-stream)rDr+)rBrMrNrDZsupported_media_typesr parser_classrrrrrks   zAutoSchema.get_encoding)N)rQrRrSrTrCrPrlrrrdrerfrrgrh staticmethodrirk __classcell__rr)r\rrXs ,3   rXcs*eZdZdZdfdd ZddZZS) ManualSchemazV Allows providing a list of coreapi.Fields, plus an optional description. rNcs>tt|jtdd|Ds(td||_||_||_dS)z Parameters: * `fields`: list of `coreapi.Field` instances. * `description`: String description for view. Optional. css|]}t|tjVqdS)N)r$r r)rrrrrrsz(ManualSchema.__init__..z2`fields` must be a list of coreapi.Field instancesN)rYrrCallrK_fields _description _encoding)rBr)rrc)r\rrrCs zManualSchema.__init__cCs@|r|jdr|dd}tjtj|||j|j|j|jdS)Nr`r)rarbrcr)r) rmr rnrorprqrrr)rBrMrNrOrrrrPs  zManualSchema.get_link)rN)rQrRrSrTrCrPrrr)r\rrs rcs eZdZdZfddZZS) DefaultSchemaz?Allows overriding AutoSchema using DEFAULT_SCHEMA_CLASS settingcsHtt|j||}t|ts |Stj}t|ts8td|}||_ |S)NzTDEFAULT_SCHEMA_CLASS must be set to a ViewInspector (usually an AutoSchema) subclass) rYrrGr$rZDEFAULT_SCHEMA_CLASS issubclassr@rKrD)rBrErFresultZinspector_classZ inspector)r\rrrGs  zDefaultSchema.__get__)rQrRrSrTrGrrr)r\rrsr)(rTrer collectionsrweakrefrZ django.dbrZdjango.utils.encodingrrZdjango.utils.six.moves.urllibrroZdjango.utils.translationrr=Zrest_frameworkr r Zrest_framework.compatr r r Zrest_framework.settingsrZrest_framework.utilsrutilsrcompileryrr?objectr@rXrrrrrrs,         WE