>|h. dZddlmZddlmZddlmZddlm Z ddl m Z ddl m Z dd lmZdd lmZdd lmZmZGd d ee eee Zy)aAPI Blueprint This is a subclass of Flask's Blueprint It provides added features: - Decorators to specify Marshmallow schema for view functions I/O - API documentation registration Documentation process works in several steps: - At import time - When a MethodView or a view function is decorated, relevant information is automatically added to the object's ``_apidoc`` attribute. - The ``Blueprint.doc`` decorator stores additional information in there that flask-smorest can not - or does not yet - infer from the code. - The ``Blueprint.route`` decorator registers the endpoint in the Blueprint and gathers all documentation information about the endpoint in ``Blueprint._docs[endpoint]``. - At initialization time - Schema instances are replaced by their reference in the `schemas` section of the spec components. - The ``Blueprint.register_blueprint`` method merges nested blueprint documentation into the parent blueprint documentation. - Documentation is finalized using the information stored in ``Blueprint._docs``, with adaptations to parameters only known at init time, such as OAS version. - Manual documentation is deep-merged with automatic documentation. - Endpoints documentation is registered in the APISpec object. )deepcopy)wraps) Blueprint) MethodView)ArgumentsMixin) EtagMixin)PaginationMixin) ResponseMixin) deepupdateload_info_from_docstringceZdZdZgdZddddZdZfdZ dd d d fd Zd d d d Z fd Z dZ dZ e dZdZxZS)rz2Blueprint that registers info in API documentation)OPTIONSHEADGETPOSTPUTPATCHDELETEzapplication/jsonz!application/x-www-form-urlencodedzmultipart/form-data)jsonformfilesz---c|jdd|_t| |i|i|_g|_|j |j|j|jg|_ y)N description) poprsuper__init___docs _endpoints_prepare_arguments_doc_prepare_response_doc_prepare_pagination_doc_prepare_etag_doc_prepare_doc_cbks)selfargskwargs __class__s V/var/www/html/test/engine/venv/lib/python3.12/site-packages/flask_smorest/blueprint.pyrzBlueprint.__init__Gsf!::mR8 $)&)$   ' '  & &  ( (  " " " N parameterstagsc l| td| |j}||jvr|dt|j}|jj |t |t tr|j|}n|}t |(|||fi||j||||fi|y)a2Register url rule in application Also stores doc info for later registration Use this to register a :class:`MethodView ` or a resource function. :param str rule: URL rule as string. :param str endpoint: Endpoint for the registered URL rule (defaults to function name). :param callable|MethodView view_func: View function or MethodView class :param list parameters: List of parameter descriptions relevant to all operations in this path. Only used to document the resource. :param list tags: List of tags for the resource. If None, ``Blueprint`` name is used. :param options: Options to be forwarded to the underlying :class:`werkzeug.routing.Rule ` object. Nzview_func must be provided_) TypeError__name__r lenappend isinstancetyperas_viewr add_url_rule_store_endpoint_docs) r&ruleendpoint view_funcprovide_automatic_optionsr-r.optionsfuncr)s r*r8zBlueprint.add_url_rulees:  89 9   ))H t &"1S%9$:;H x( ij!1 2$$X.DD T8T=W=!!!(Iz4S7Sr+c "fd}|S)zDecorator to register view function in application and documentation Calls :meth:`add_url_rule `. c\jdd}j||fd|S)Nr;r,)rr8)r?r;r>r-r:r&r.s r* decoratorz"Blueprint.route..decoratorsC{{:t4H D  h 1;$ JQ Kr+)r&r:r-r.r>rBs````` r*routezBlueprint.routes   r+c |jd|j}|jj|jj Dcic]\}}dj ||f|c}}t ||fi|Scc}}w)aRegister a nested blueprint in application Also stores doc info from the nested bluepint for later registration. Use this to register a nested :class:`Blueprint `. :param Blueprint blueprint: Blueprint to register under this blueprint. :param options: Options to be forwarded to the underlying :meth:`flask.Blueprint.register_blueprint` method. See :ref:`register-nested-blueprints`. name.)getrFrupdateitemsjoinrregister_blueprint)r& blueprintr>blp_name endpoint_namedocr)s r*rLzBlueprint.register_blueprints;;vy~~6 +4//*?*?*A &M3(M23S8  w))?w??  sB c  jj|i fd}t|ttrPj D]@}||j vsd|vs||dvst||j}|||Bn/j D] }||jddvs|||"| d<y)zStore view or function doc infoctt|di}t|jj|d<|d<||j <y)z7Add auto and manual doc to table for later registration_apidoc) delimiter docstringr.N)rgetattrr __doc__DOCSTRING_INFO_DELIMITERlower)methodfunctionrPendpoint_doc_infor&r.s r*store_method_docsz9Blueprint._store_endpoint_docs..store_method_docssT 78Y;r]rZr?r\s ` ` @r*r9zBlueprint._store_endpoint_docss!JJ11(B? 4 c4 + ,++ 8S[[( /6WY=O3O&sFLLN;)&$7  8++ 3W[[H==%fc2 3 +5,'r+c F|xsg}t|jjD]\}}|jdxsg} || z} i} |jD]v\} } | jd}i}|jD]}||| |||| }|j | d||n|g|d<| j di}t||| | <xdj||f}t|jj|}|j|| | y) a#Register views information in documentation If a schema in a parameter or a response appears in the spec `schemas` section, it is replaced by a reference in the parameter or response documentation: "schema":{"$ref": "#/components/schemas/MySchema"} r-r.)apiappspecrZrUN manual_docrG)r: operationsr-) rrrJrr%rIrHr rKnexturl_map iter_rulespath)r&rcrdrerFr-url_prefix_parametersr;r\endpoint_route_parametersendpoint_parametersrPmethod_loperation_doc_infor. operation_docr?rf full_endpointr:s r*register_views_in_doczBlueprint.register_views_in_docsd!+ 0b,4DJJ+?+E+E+G! Q 'H'(9(=(=l(K(Qr %"7:S"S C0A0G0G0I F,,)--f5 "  22D$(%*!' %M$$%7 %DE'f%033L"E *=* EH / F4 HHdH%56M ..}=>D II4C.decorator..wrapper'sV0x00r+rSrf)rrrVrSr rH)r?ryr(s` r*rBz Blueprint.doc..decorator&se 4[ 1 1'ww 2'FGGO,6,,\2>?-GOOL )Nr+rC)r(rBs` r*rPz Blueprint.docs r+ct|ttrQ|jD]@}||jvs|j }t ||}t||||B|S||S)z7Apply decorator to view func or MethodView HTTP methods)r5r6rr`r^rYrVsetattr)r&rBrarZror?s r*"_decorate_view_func_or_method_viewz,Blueprint._decorate_view_func_or_method_view4sl c4 + ,++ <S[[(%||~H"31DC9T?;  < J~r+)NNN)r2 __module__ __qualname__rWr`%DEFAULT_LOCATION_CONTENT_TYPE_MAPPINGrXrr8rDrLr9rs staticmethodrPr| __classcell__)r)s@r*rr7s=PL#3&-) % B"& 1T 1Tf)-4 @2"5H1Qf8 r+rN)rWcopyr functoolsrflaskrFlaskBlueprint flask.viewsr argumentsretagr paginationr responser utilsr r rCr+r*rs?'R-"%'#7INM?IIr+