>|h.dZddlZddlmZddlmZddlmZddlm Z ddl m Z dd l m Z mZmZmZmZmZmZGd d Zy) zResponse processorN)abc)deepcopy)wraps)jsonify)Response) deepupdateget_appcontextprepare_response remove_noneresolve_schema_instance"set_status_and_headers_in_responseunpack_tuple_responsec teZdZdZ d dddddddZ d dddddddddZedZed Zed Z y) ResponseMixinz)Extend Blueprint to add response handlingN) content_type descriptionexampleexamplesheadersc tj}|(tjt j }t |||||d | d< fd} | S)aDecorator generating an endpoint response :param int|str|HTTPStatus status_code: HTTP status code. Used if none is returned from the view function. :param schema schema|str|dict: :class:`Schema ` class or instance or reference or dict. If not None, will be used to serialize response data. :param str content_type: Content type of the response. :param str description: Description of the response (default: None). :param dict example: Example of response message. :param dict examples: Examples of response message. :param dict headers: Headers returned by the response. The decorated function is expected to return the same types of value than a typical flask view function, except the body part may be an object or a list of objects to serialize with the schema, rather than a ``string``. If the decorated function returns a ``Response`` object, the ``schema`` and ``status_code`` parameters are only used to document the resource. Only in this case, ``schema`` may be a reference as string or a schema definition as dict. The `example` and `examples` parameters are mutually exclusive. The latter should only be used with OpenAPI 3. The `example`, `examples` and `headers` parameters are only used to document the resource. See :doc:`Response `. schemarrrrrcXtfd}tt|di|_|jj dij dij gj |jj dgj |S)Nct|i|\}}}t|trt||||S |}n j |}t }||d<t j|}t|||| |_|S)N result_dump) r isinstancerrdumpr r_prepare_response_content status_code) argskwargs result_raw r_status_code r_headersr appcontextrespfuncrselfr s U/var/www/html/test/engine/venv/lib/python3.12/site-packages/flask_smorest/response.pywrapperz:ResponseMixin.response..decorator..wrapperUs8M$)&)84 M9 j(36"M9&%>",K"(++j"9K,- ,7 =)t==kJK24 R ('2D$ _apidocresponse responsessuccess_status_codesrrgetattrr- setdefaultappend)r(r+resp_docrr)r s` r* decoratorz)ResponseMixin.response..decoratorTs 4[  D'ww 2'FGGO**:r:K,K,! OO & &'=r B I I+ VNr,r _make_doc_response_schemahttp HTTPStatusintphraser ) r)r rrrrrr doc_schemar6r5s ``` @r*r.zResponseMixin.responsesyT)033F;  //#k*:;BBK$*"$"   $0 / br,F)rrrrrrsuccessc || n\t|}|j|} |(tjt j }t | ||||d | d<  fd} | S)aDecorator documenting an alternative response :param int|str|HTTPStatus status_code: HTTP status code. :param str response: Response reference. :param schema schema|str|dict: :class:`Schema ` class or instance or reference or dict. :param str description: Description of the response (default: None). :param dict example: Example of response message. :param dict examples: Examples of response message. :param dict headers: Headers returned by the response. :param bool success: ``True`` if this response is part of the normal flow of the function. Default: ``False``. This decorator allows the user to document an alternative response. This can be an error managed with :func:`abort ` or any response that is not the primary flow of the function documented by :meth:`Blueprint.response `. When a response reference is passed as ``response``, it is used as description and the keyword arguments are ignored. Otherwise, a description is built from the keyword arguments. See :ref:`document-alternative-responses`. rrcVtfd}tt|di|_|jj dij dij gj r+|jj dgj |S)Nc|i|SN)r!r"r(s r*r+z>ResponseMixin.alt_response..decorator..wrappersT,V,,r,r-r.r/r0r1)r(r+r5r r>s` r*r6z-ResponseMixin.alt_response..decorators 4[ - - 'ww 2'FGGO**:r:K,K,!**+A2FMMNr,r7) r)r r.rrrrrrr>r=r6r5s ` ` @r* alt_responsezResponseMixin.alt_responsesL  H-V4F77?J""ooc+.>?FF "(#.& (& H(4H^ $ .r,c|S)a Override this to modify response schema in docs This can be used to document a wrapping structure. Example: :: @staticmethod def _make_doc_response_schema(schema): if schema: return type( "Wrap" + schema.__class__.__name__, (ma.Schema,), {"data": ma.fields.Nested(schema)}, ) return None rC)rs r*r8z'ResponseMixin._make_doc_response_schemas $ r,c|S)aXOverride this to modify the data structure This allows to insert the data in a wrapping structure. Example: :: @staticmethod def _prepare_response_content(data): if data is not None: return {"data": data} return None rC)datas r*rz'ResponseMixin._prepare_response_contents  r,c H|jdi}|jr;|jdijdgj|j|rE|jj dkrt }|djD]T}|D]M}t|tjr|dxs |j} n |j} |j| OV||jhk7rt||d<|djD]x} i} t|d| D]X}t|tjs|} n:|j!dxs |j} t#||| t%| |} Z| |d| <zt%||}|S)Nr.r/defaultrproduces)getDEFAULT_ERROR_RESPONSE_NAMEr3r4openapi_versionmajorsetvaluesrrMappingDEFAULT_RESPONSE_CONTENT_TYPEaddlistkeysreversedpopr r ) docdoc_infoapispecr" operation content_typesr/r.rr r's r*_prepare_response_docz#ResponseMixin._prepare_response_docsLLR0  * *$$["5Ir*778 ##))A- # !*;!7!>!>!@ 8I$-8%h < ( 8!E#&#D#D) ,/+L+LL%)),78 8!S%F%F$GG,0,?Ij) )5::< ; !);)? )L M 6H%h <' ^4=<<!%Xt\B%dH5D 67; +&{3 ;S),C r,rB) __name__ __module__ __qualname____doc__r.rD staticmethodr8rr_rCr,r*rrs3 l lbR Rh&  33r,r)rcr9 collectionsrcopyr functoolsrflaskrwerkzeugrutilsr r r r r rrrrCr,r*rks5 ]]r,