U
    æ‘«jbj  ã                   @   s  d dl Z d dlZd dlmZ d dlmZ d dlmZ d dlm	Z	m
Z
mZmZmZmZmZmZ d dlmZ d dlmZ d dlmZmZmZmZ d d	lmZmZ d d
lmZmZ d dl m!Z! ddl"m#Z# ddl$m%Z% ddl&m'Z'm(Z( G dd„ de#ƒZ)G dd„ de%ƒZ*dS )é    N)ÚDecimal)Ú
attrgetter)Úurljoin)ÚDecimalValidatorÚEmailValidatorÚMaxLengthValidatorÚMaxValueValidatorÚMinLengthValidatorÚMinValueValidatorÚRegexValidatorÚURLValidator)Úmodels)Ú	force_str)ÚRemovedInDRF316WarningÚ
exceptionsÚ	renderersÚserializers)Ú
inflectionÚuritemplate)Ú_UnvalidatedFieldÚempty)Úapi_settingsé   )ÚBaseSchemaGenerator)ÚViewInspector)Úget_pk_descriptionÚis_list_viewc                   @   s&   e Zd Zdd„ Zdd„ Zd	dd„ZdS )
ÚSchemaGeneratorc                 C   s.   | j pd| jpddœ}| jd k	r*| j|d< |S )NÚ )ÚtitleÚversionÚdescription)r   r    r!   )ÚselfÚinfo© r$   úB/tmp/pip-unpacked-wheel-znb74khk/rest_framework/schemas/openapi.pyÚget_info   s    þ

zSchemaGenerator.get_infoc                 C   s‚   i }|D ]t}|| D ]f}d|| | kr*q|| | d }||krlt  dj|| d || d |||d�¡ ||dœ||< qqd S )NÚoperationIdzîYou have a duplicated operationId in your OpenAPI schema: {operation_id}
	Route: {route1}, Method: {method1}
	Route: {route2}, Method: {method2}
	An operationId has to be unique across your schema. Your schema may not work in other tools.ÚrouteÚmethod)Zroute1Zmethod1Zroute2Zmethod2Úoperation_id)r(   r)   )ÚwarningsÚwarnÚformat)r"   ÚpathsÚidsr(   r)   r*   r$   r$   r%   Úcheck_duplicate_operation_id(   s&    

÷ÿþz,SchemaGenerator.check_duplicate_operation_idNFc                 C   s   |   ¡  i }i }|  |rdn|¡\}}|D ]¼\}}}	|  |||	¡sDq*|	j ||¡}
|	j ||¡}| ¡ D ]0}||krvqh|| || krˆqht d 	|¡¡ qh| 
|¡ | d¡rº|dd… }t| jpÄd|ƒ}| |i ¡ |
|| | ¡ < q*|  |¡ d|  ¡ |dœ}t|ƒdk�rd|i|d	< |S )
z,
        Generate a OpenAPI schema.
        NzASchema component "{}" has been overridden with a different value.ú/r   z3.0.2)Zopenapir#   r.   r   ZschemasÚ
components)Z_initialise_endpointsZ_get_paths_and_endpointsZhas_view_permissionsÚschemaÚget_operationÚget_componentsÚkeysr+   r,   r-   ÚupdateÚ
startswithr   ÚurlÚ
setdefaultÚlowerr0   r&   Úlen)r"   ÚrequestÚpublicZcomponents_schemasr.   Ú_Zview_endpointsÚpathr)   ÚviewÚ	operationr2   Úkr3   r$   r$   r%   Ú
get_schemaB   s>    


ý ÿzSchemaGenerator.get_schema)NF)Ú__name__Ú
__module__Ú__qualname__r&   r0   rD   r$   r$   r$   r%   r      s   r   c                       s  e Zd Zd@‡ fdd„	Zg Zg Zdddddd	œZd
d„ Zdd„ Zdd„ Z	dd„ Z
dd„ Zdd„ Zdd„ Zdd„ Zdd„ Zdd„ Zdd„ Zd d!„ Zd"d#„ Zd$d%„ Zd&d'„ Zd(d)„ Zd*d+„ Zd,d-„ Zd.d/„ Zd0d1„ Zd2d3„ Zd4d5„ Zd6d7„ Zd8d9„ Zd:d;„ Zd<d=„ Z d>d?„ Z!‡  Z"S )AÚ
AutoSchemaNc                    s>   |rt dd„ |D ƒƒstdƒ‚|| _|| _|| _tƒ  ¡  dS )a  
        :param operation_id_base: user-defined name in operationId. If empty, it will be deducted from the Model/Serializer/View name.
        :param component_name: user-defined component's name. If empty, it will be deducted from the Serializer's class name.
        c                 s   s   | ]}t |tƒV  qd S ©N©Ú
isinstanceÚstr)Ú.0Útagr$   r$   r%   Ú	<genexpr>}   s     z&AutoSchema.__init__.<locals>.<genexpr>z'tags must be a list or tuple of string.N)ÚallÚ
ValueErrorÚ_tagsÚoperation_id_baseÚcomponent_nameÚsuperÚ__init__)r"   ÚtagsrS   rT   ©Ú	__class__r$   r%   rV   x   s    zAutoSchema.__init__ÚretrieveÚcreater7   ZpartialUpdateÚdestroy)ÚgetÚpostÚputÚpatchÚdeletec                 C   sœ   i }|   ||¡|d< |  ||¡|d< g }||  ||¡7 }||  ||¡7 }||  ||¡7 }||d< |  ||¡}|rx||d< |  ||¡|d< |  ||¡|d< |S )Nr'   r!   Ú
parametersZrequestBodyÚ	responsesrW   )Úget_operation_idÚget_descriptionÚget_path_parametersÚget_pagination_parametersÚget_filter_parametersÚget_request_bodyÚget_responsesÚget_tags)r"   r@   r)   rB   rb   Úrequest_bodyr$   r$   r%   r4   �   s    zAutoSchema.get_operationc                 C   sP   | j dk	r| j S |jj}t dtj¡}| d|¡}|dkrLtd |jj¡ƒ‚|S )z¡
        Compute the component's name from the serializer.
        Raise an exception if the serializer's class name is "Serializer" (case-insensitive).
        NÚ
serializerr   z�"{}" is an invalid class name for schema generation. Serializer's class name should be unique and explicit. e.g. "ItemSerializer")	rT   rY   rE   ÚreÚcompileÚ
IGNORECASEÚsubÚ	Exceptionr-   )r"   rm   rT   Úpatternr$   r$   r%   Úget_component_name£   s    
þÿzAutoSchema.get_component_namec                 C   sˆ   |  ¡ dkri S |  ||¡}|  ||¡}i }t|tjƒrX|  |¡}|  |¡}| ||¡ t|tjƒr„|  |¡}|  |¡}| ||¡ |S )zN
        Return components with their properties from the serializer.
        ra   )	r;   Úget_request_serializerÚget_response_serializerrK   r   Ú
Serializerrt   Úmap_serializerr:   )r"   r@   r)   Zrequest_serializerZresponse_serializerr2   rT   Úcontentr$   r$   r%   r5   º   s    



zAutoSchema.get_componentsc                 C   s.   |  d¡}|d d dd„ |dd … D ƒ¡ S )Nr?   r   r   c                 s   s   | ]}|  ¡ V  qd S rI   )r   )rM   Úxr$   r$   r%   rO   ×   s     z,AutoSchema._to_camel_case.<locals>.<genexpr>r   )ÚsplitÚjoin)r"   Z	snake_strr2   r$   r$   r%   Ú_to_camel_caseÓ   s    
zAutoSchema._to_camel_casec                 C   sê   t t | jddƒddƒ}| jdk	r(| j}n |dk	r8|j}n�|  ||¡dk	rp|  ||¡jj}| d¡rÈ|dd… }nX| jjj}| d¡r’|dd… }n| d¡r¨|dd	… }| | ¡ ¡rÈ|dt|ƒ … }|d
kræt	sÜt
dƒ‚t	 |¡}|S )za
        Compute the base part for operation ID from the model, serializer or view name.
        ÚquerysetNÚmodelrw   iöÿÿÿZAPIViewiùÿÿÿZViewéüÿÿÿÚlistz:`inflection` must be installed for OpenAPI schema support.)ÚgetattrrA   rS   rE   Úget_serializerrY   Úendswithr   r<   r   ÚAssertionErrorZ	pluralize)r"   r@   r)   Úactionr   Únamer$   r$   r%   Úget_operation_id_baseÙ   s(    





z AutoSchema.get_operation_id_basec                 C   s`   t | jd| ¡ ƒ}t||| jƒr&d}n$|| jkr<|  |¡}n| j| ¡  }|  |||¡}|| S )z^
        Compute an operation ID from the view type and get_operation_id_base method.
        r†   r�   )r‚   rA   r;   r   Úmethod_mappingr}   rˆ   )r"   r@   r)   Úmethod_namer†   r‡   r$   r$   r%   rd   ÿ   s    
zAutoSchema.get_operation_idc           	   	   C   sÀ   t stdƒ‚tt| jddƒddƒ}g }t  |¡D ]Š}d}|dk	rœz|j |¡}W n tk
rh   d}Y nX |dk	r„|jr„t	|jƒ}n|dk	rœ|j
rœt||ƒ}|dd|dd	id
œ}| |¡ q0|S )zL
        Return a list of parameters from templated path variables.
        z;`uritemplate` must be installed for OpenAPI schema support.r~   Nr   r   r@   TÚtypeÚstring)r‡   ÚinÚrequiredr!   r3   )r   r…   r‚   rA   Ú	variablesÚ_metaÚ	get_fieldrr   Ú	help_textr   Zprimary_keyr   Úappend)	r"   r@   r)   r   rb   Úvariabler!   Úmodel_fieldZ	parameterr$   r$   r%   rf     s0    

 ÿû	zAutoSchema.get_path_parametersc                 C   s8   |   ||¡sg S g }| jjD ]}||ƒ  | j¡7 }q|S rI   )Úallows_filtersrA   Úfilter_backendsÚget_schema_operation_parameters)r"   r@   r)   rb   Zfilter_backendr$   r$   r%   rh   3  s    z AutoSchema.get_filter_parametersc                 C   s:   t | jddƒdkrdS t| jdƒr.| jjdkS | ¡ dkS )zÜ
        Determine whether to include filter Fields in schema.

        Default implementation looks for ModelViewSet or GenericAPIView
        actions/methods that cause filtering on the default implementation.
        r—   NFr†   )r�   rZ   r7   Zpartial_updater\   )r]   r_   r`   ra   )r‚   rA   Úhasattrr†   r;   ©r"   r@   r)   r$   r$   r%   r–   ;  s
    zAutoSchema.allows_filtersc                 C   s0   | j }t|||ƒsg S |  ¡ }|s&g S | |¡S rI   )rA   r   Úget_paginatorr˜   )r"   r@   r)   rA   Ú	paginatorr$   r$   r%   rg   H  s    z$AutoSchema.get_pagination_parametersc                 C   sŒ   t t |j¡ƒ}tdd„ |D ƒƒr(d}nLtdd„ |D ƒƒr@d}n4tdd„ |D ƒƒrXd}ntdd„ |D ƒƒrpd	}nd }d
|i}|rˆ||d< |S )Nc                 s   s   | ]}t |tƒV  qd S rI   )rK   Úbool©rM   Úchoicer$   r$   r%   rO   V  s     z-AutoSchema.map_choicefield.<locals>.<genexpr>Úbooleanc                 s   s   | ]}t |tƒV  qd S rI   )rK   Úintrž   r$   r$   r%   rO   X  s     Úintegerc                 s   s   | ]}t |tttfƒV  qd S rI   )rK   r¡   Úfloatr   rž   r$   r$   r%   rO   Z  s     Únumberc                 s   s   | ]}t |tƒV  qd S rI   rJ   rž   r$   r$   r%   rO   ]  s     rŒ   Úenumr‹   )r�   ÚdictÚfromkeysÚchoicesrP   )r"   Úfieldr¨   r‹   Úmappingr$   r$   r%   Úmap_choicefieldT  s      ý
zAutoSchema.map_choicefieldc                 C   s$  t |tjƒrd|  |j¡dœS t |tjƒr@|  |¡}d|d< |S t |tjƒr^d|  |j¡dœS t |tj	ƒr¶t
|ddƒr„| j|jd�S t
|jdd ƒ}|d k	r¶|jj}t |tjƒr¶dd	iS t |tjƒrÒd|  |¡dœS t |tjƒrè|  |¡S t |tjƒ�r"di dœ}t |jtƒ�s|  |j¡|d
< |S t |tjƒ�r:dddœS t |tjƒ�rRdddœS t |tjƒ�rjdddœS t |tjƒ�r‚dddœS t |tjƒ�ršdddœS t |tjƒ�rÊddi}|jdk�rÆ|j|d< |S t |tjƒ�r^t
|dtjƒ�rôdddœ}nddi}|j �r"t!d|j d d  d ƒ|d< |j"�rNt#|j"d ƒd |d< |d  |d< |  $||¡ |S t |tj%ƒ�r„ddi}|  $||¡ |S t |tj&ƒ�rÞdd	i}|  $||¡ t#| 'dd¡ƒd k�sÒt#| 'dd¡ƒd k�rÚd!|d< |S t |tj(ƒ�rödd"dœS tj)d#tj*dtj+dtj,di}d| '|j-d¡iS )$NÚarray©r‹   ÚitemsÚobjectr‹   Úpk_fieldF)r©   r   r¢   r®   rŒ   Údate)r‹   r-   z	date-timeÚemailÚuriÚuuidZbothr-   Úcoerce_to_stringÚdecimalr¤   Ú.r   Ú0Ú1Ú
multipleOfÚ9ÚmaximumÚminimumr   iÿÿÿZint64Úbinaryr    ).rK   r   ZListSerializerrx   Úchildrw   ZManyRelatedFieldÚ	map_fieldZchild_relationZPrimaryKeyRelatedFieldr‚   r°   r~   r�   Úpkr   Z	AutoFieldZMultipleChoiceFieldr«   ZChoiceFieldÚ	ListFieldr   Z	DateFieldZDateTimeFieldZ
EmailFieldZURLFieldZ	UUIDFieldZIPAddressFieldÚprotocolZDecimalFieldr   ÚCOERCE_DECIMAL_TO_STRINGÚdecimal_placesr£   Zmax_whole_digitsr¡   Ú_map_min_maxZ
FloatFieldZIntegerFieldr]   Z	FileFieldZBooleanFieldZ	JSONFieldZ	DictFieldZHStoreFieldrY   )r"   r©   Údatar   r•   rª   ry   ZFIELD_CLASS_SCHEMA_TYPEr$   r$   r%   rÀ   p  sÎ    
þ

þþ
þþþþþþ ÿ
þ ÿ ÿ ÿ,þ    üzAutoSchema.map_fieldc                 C   s$   |j r|j |d< |jr |j|d< d S )Nr¼   r½   )Z	max_valueZ	min_value)r"   r©   ry   r$   r$   r%   rÆ      s    
zAutoSchema._map_min_maxc                 C   sæ   g }i }|j  ¡ D ]¸}t|tjƒr$q|jr@|js@| |  |¡¡ |  	|¡}|j
rXd|d< |jrfd|d< |jrtd|d< |jd k	rœ|jtkrœt|jƒsœ|j|d< |jr°t|jƒ|d< |  ||¡ |||  |¡< qd|dœ}|râ||d	< |S )
NTZreadOnlyZ	writeOnlyZnullableÚdefaultr!   r¯   )r‹   Ú
propertiesrŽ   )ÚfieldsÚvaluesrK   r   ZHiddenFieldrŽ   Úpartialr“   Úget_field_namerÀ   Z	read_onlyZ
write_onlyZ
allow_nullrÈ   r   Úcallabler’   rL   Úmap_field_validators)r"   rm   rŽ   rÉ   r©   r3   Úresultr$   r$   r%   rx     s4    

þzAutoSchema.map_serializerc                 C   sd  |j D �]V}t|tƒrd|d< t|tƒr0d|d< t|tƒrP|jj dd¡|d< qt|tƒrzd}t|t	j
ƒrnd}|j||< qt|tƒr¤d	}t|t	j
ƒr˜d
}|j||< qt|tƒrº|j|d< qt|tƒrÐ|j|d< qt|tƒrt|dtjƒs|j�rtd|jd d  d ƒ|d< |jr|j}|jdk	�r<|jdk�r<||j8 }t|d ƒd |d< |d  |d< qdS )z&
        map field validators
        r²   r-   r³   z\Zz\zrs   Z	maxLengthZmaxItemsZ	minLengthZminItemsr¼   r½   rµ   r·   r   r¸   r¹   rº   Nr   r»   )Z
validatorsrK   r   r   r   Úregexrs   Úreplacer   r   rÂ   Zlimit_valuer	   r   r
   r   r‚   r   rÄ   rÅ   r£   Z
max_digitsr¡   )r"   r©   r3   ÚvÚ	attr_nameÚdigitsr$   r$   r%   rÏ   *  s@    







ÿ
zAutoSchema.map_field_validatorsc                 C   s   |j S )z�
        Override this method if you want to change schema field name.
        For example, convert snake_case field name to camelCase.
        )Ú
field_name)r"   r©   r$   r$   r%   rÍ   R  s    zAutoSchema.get_field_namec                 C   s   t | jdd ƒ}|r|ƒ S d S )NÚpagination_class)r‚   rA   )r"   r×   r$   r$   r%   r›   Y  s    zAutoSchema.get_paginatorc                 C   s   t ttdƒ| jjƒƒS )NÚ
media_type)r�   Úmapr   rA   Zparser_classesrš   r$   r$   r%   Úmap_parsers_  s    zAutoSchema.map_parsersc                 C   s0   g }| j jD ]}t|tjƒrq| |j¡ q|S rI   )rA   Zrenderer_classesÚ
issubclassr   ZBrowsableAPIRendererr“   rØ   )r"   r@   r)   Zmedia_typesZrendererr$   r$   r%   Úmap_renderersb  s    zAutoSchema.map_renderersc              
   C   sT   | j }t|dƒsd S z
| ¡ W S  tjk
rN   t d |jj	||¡¡ Y d S X d S )Nrƒ   zt{}.get_serializer() raised an exception during schema generation. Serializer fields will not be generated for {} {}.)
rA   r™   rƒ   r   ZAPIExceptionr+   r,   r-   rY   rE   )r"   r@   r)   rA   r$   r$   r%   rƒ   k  s    

  ýzAutoSchema.get_serializerc                 C   s   |   ||¡S )zr
        Override this method if your view uses a different serializer for
        handling request body.
        ©rƒ   rš   r$   r$   r%   ru   z  s    z!AutoSchema.get_request_serializerc                 C   s   |   ||¡S )zu
        Override this method if your view uses a different serializer for
        populating response data.
        rÝ   rš   r$   r$   r%   rv   �  s    z"AutoSchema.get_response_serializerc                 C   s   dd  |  |¡¡iS )Nz$refz#/components/schemas/{})r-   rt   ©r"   rm   r$   r$   r%   Úget_referenceˆ  s    zAutoSchema.get_referencec                    sZ   |dkri S |   ||¡| _|  ||¡}t|tjƒs8i ‰ n
|  |¡‰ d‡ fdd„| jD ƒiS )N)ÚPUTÚPATCHÚPOSTry   c                    s   i | ]}|d ˆ i“qS ©r3   r$   ©rM   Úct©Úitem_schemar$   r%   Ú
<dictcomp>™  s   ÿ z/AutoSchema.get_request_body.<locals>.<dictcomp>)rÚ   Úrequest_media_typesru   rK   r   rw   rß   )r"   r@   r)   rm   r$   ræ   r%   ri   ‹  s    
 
þÿzAutoSchema.get_request_bodyc                    s¬   |dkrdddiiS |   ||¡| _|  ||¡}t|tjƒs@i }n
|  |¡}t||| jƒrzd|dœ‰ |  	¡ }|r~| 
ˆ ¡‰ n|‰ |dkrŠdnd	}|‡ fd
d„| jD ƒddœiS )NÚDELETEZ204r!   r   r¬   r­   râ   Z201Z200c                    s   i | ]}|d ˆ i“qS rã   r$   rä   ©Zresponse_schemar$   r%   rè   ½  s   ÿ z,AutoSchema.get_responses.<locals>.<dictcomp>)ry   r!   )rÜ   Úresponse_media_typesrv   rK   r   rw   rß   r   rA   r›   Zget_paginated_response_schema)r"   r@   r)   rm   rç   rœ   Ústatus_coder$   rë   r%   rj   Ÿ  s6     ÿÿ
þ
þøÿzAutoSchema.get_responsesc                 C   s:   | j r| j S | d¡r"|dd … }| d¡d  dd¡gS )Nr1   r   r   r?   ú-)rR   r8   r{   rÒ   rš   r$   r$   r%   rk   È  s
    
zAutoSchema.get_tagsc                 C   s   t jdtdd� |  |¡S )NzkMethod `_get_reference()` has been renamed to `get_reference()`. The old name will be removed in DRF v3.16.é   )Ú
stacklevel)r+   r,   r   rß   rÞ   r$   r$   r%   Ú_get_referenceÕ  s     ýzAutoSchema._get_reference)NNN)#rE   rF   rG   rV   ré   rì   r‰   r4   rt   r5   r}   rˆ   rd   rf   rh   r–   rg   r«   rÀ   rÆ   rx   rÏ   rÍ   r›   rÚ   rÜ   rƒ   ru   rv   rß   ri   rj   rk   rñ   Ú__classcell__r$   r$   rX   r%   rH   v   sJ   û&$ $(	)rH   )+rn   r+   r¶   r   Úoperatorr   Úurllib.parser   Zdjango.core.validatorsr   r   r   r   r	   r
   r   r   Z	django.dbr   Zdjango.utils.encodingr   Zrest_frameworkr   r   r   r   Zrest_framework.compatr   r   Zrest_framework.fieldsr   r   Zrest_framework.settingsr   Ú
generatorsr   Z
inspectorsr   Úutilsr   r   r   rH   r$   r$   r$   r%   Ú<module>   s    (\