o FDiJ- @sdZddlmZddlZddlZddlZddlmZddlm Z ddl m Z ddl m Z dd lmZmZmZmZdd lmZd d d d dddddZGdddeZdS)aUtilities for generating OpenAPI Specification (fka Swagger) entities from marshmallow :class:`Schemas ` and :class:`Fields `. .. warning:: This module is treated as private API. Users should not need to use this module directly. ) annotationsN) is_collection)Version)APISpec) APISpecError) get_fieldsget_unique_schema_namemake_schema_keyresolve_schema_instance)FieldConverterMixinpathquerybodyheadercookieformData) match_infor querystringjsonheaderscookiesformfilesc@seZdZdZd/dd Zd0d d Zd0d d ZddZddddd1ddZd2d d!Z d3d$d%Z d3d&d'Z d(d)Z dd*d+d,Z d-d.ZdS)4OpenAPIConverteraAdds methods for generating OpenAPI specification from marshmallow schemas and fields. :param Version|str openapi_version: The OpenAPI version to use. Should be in the form '2.x' or '3.x.x' to comply with the OpenAPI standard. :param callable schema_name_resolver: Callable to generate the schema definition name. Receives the `Schema` class and returns the name to be used in refs within the generated spec. When working with circular referencing this function must must not return `None` for schemas in a circular reference chain. :param APISpec spec: An initialized spec. Nested schemas will be added to the spec openapi_version Version | strspecrreturnNonecCs>t|tr t|n||_||_||_||i|_dSN) isinstancestrrrschema_name_resolverrinit_attribute_functions"init_parameter_attribute_functionsrefs)selfrr#rr(X/var/www/Datamplify/venv/lib/python3.10/site-packages/apispec/ext/marshmallow/openapi.py__init__6s  zOpenAPIConverter.__init__cCs|j|jg|_dSr )field2required list2paramparameter_attribute_functions)r'r(r(r)r%Hs z3OpenAPIConverter.init_parameter_attribute_functionscCs(||}t||j||j|dS)aGMethod to add a field parameter function to the list of field parameter functions that will be called on a field to convert it to a field parameter. :param func func: the field parameter function to add The attribute function will be bound to the `OpenAPIConverter ` instance. It will be called for each field in a schema with `self ` and a `field ` instance positional arguments and `ret ` keyword argument. May mutate `ret`. User added field parameter functions will be called after all built-in field parameter functions in the order they were added. N)__get__setattr__name__r-append)r'func bound_funcr(r(r) add_parameter_attribute_functionNs z1OpenAPIConverter.add_parameter_attribute_functionc Cszt|}Wn tjjy|YSwt|}||jvr^||}|sNz||}Wnty@}z t d|d|d}~wwt |ddrLd|dS|St |j j |}|j j j||d||S) aReturn the OpenAPI representation of a marshmallow Schema. Adds the schema to the spec if it isn't already present. Typically will return a dictionary with the reference to the schema's path in the spec unless the `schema_name_resolver` returns `None`, in which case the returned dictionary will contain a JSON Schema Object representation of the schema. :param schema: schema to add to the spec z'Name resolver returned None for schema z which is part of a chain of circular referencing schemas. Please ensure that the schema_name_resolver passed to MarshmallowPlugin returns a string for all circular referencing schemas.NmanyFarraytypeitems)schema)r marshmallow exceptions RegistryErrorr r&r#schema2jsonschema RuntimeErrorrgetattrr r componentsr: get_ref_dict)r'r:schema_instance schema_keyname json_schemaexcr(r(r)resolve_nested_schemacs2       z&OpenAPIConverter.resolve_nested_schemarFN)rErequired descriptionrEr"rIboolrJ str | Nonecsrtdkr|||d}|r||d<|gSt|ddr'Jdt|dd}fd d |DS) aAReturn an array of OpenAPI parameters given a given marshmallow :class:`Schema `. If `location` is "body", then return an array of a single parameter; else return an array of a parameter for each included field in the :class:`Schema `. In OpenAPI 3, only "query", "header", "path" or "cookie" are allowed for the location of parameters. "requestBody" is used when fields are in the body. https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#parameterObject r)inrIrEr:rJr5FzNSchemas with many=True are only supported for 'json' location (aka 'in: body')T)exclude_dump_onlycs&g|]\}}j||jp |dqS))rElocation)_field2parameterdata_key).0 field_name field_objrOr'r(r) sz6OpenAPIConverter.schema2parameters..)__location_map__getrHr@rr9)r'r:rOrErIrJparamfieldsr(rUr)schema2parameterss"   z"OpenAPIConverter.schema2parametersfieldmarshmallow.fields.FieldrOdictcCs||d}||}|jjdkr||nd|vr!|d|d<d|vr,|d|d<||d<|jD] }||||dq3|S)zReturn an OpenAPI parameter as a `dict`, given a marshmallow :class:`Field `. https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#parameterObject )rMrErJ deprecatedr:)ret)field2propertyrmajorupdatepopr-)r'r\rErOrapropparam_attr_funcr(r(r)rPs     z!OpenAPIConverter._field2parameterkwargs typing.AnycKs8i}t|jdd}|jo| pt|o|j|v|d<|S)zReturn the dictionary of OpenAPI parameter attributes for a required field. :param Field field: A marshmallow field. :rtype: dict partialFrI)r@parentrIrrE)r'r\rhrarjr(r(r)r+s zOpenAPIConverter.field2requiredcKs>i}t|tjjr|jjdkrd|d<|Sd|d<d|d<|S)zReturn a dictionary of parameter properties from :class:`List |jtjkr>|jtj k|d<|S) aReturn the JSON Schema Object for a given marshmallow :class:`Schema ` instance. Schema may optionally provide the ``title`` and ``description`` class Meta options. https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#schemaObject :param Schema schema: A marshmallow Schema instance :rtype: dict, a JSON Schema Object MetaNrjrjtitlerJunknownadditionalProperties) rr@fields2jsonschemahasattrrsrJrtr;EXCLUDEINCLUDE)r'r:rZrqrj jsonschemar(r(r)r>s      z"OpenAPIConverter.schema2jsonschemarrcCsdid}|D]*\}}|jp|}||}||d|<|jr3|r*t|r3||vr3|dg|q d|vr>|d|S)aReturn the JSON Schema Object given a mapping between field names and :class:`Field ` objects. :param dict fields: A dictionary of field name field object pairs :param bool|tuple partial: Whether to override a field's required flag. If `True` no fields will be set as required. If an iterable fields in the iterable will not be marked as required. :rtype: dict, a JSON Schema Object object)r8 propertiesr|rI)r9rQrbrIr setdefaultr1sort)r'rZrjrzrSrTobserved_field_namerfr(r(r)rv s     z"OpenAPIConverter.fields2jsonschemacCs8t|}|jjd|j|}t|ddrd|dS|S)zdMethod to create a dictionary containing a JSON reference to the schema in the spec r:r5Fr6r7)r rrAget_refr&r@)r'r:rD ref_schemar(r(r)rB&s   zOpenAPIConverter.get_ref_dict)rrrrrr)rr)rEr"rIrKrJrL)r\r]rEr"rOr"rr^)r\r]rhrirr^)r0 __module__ __qualname____doc__r*r%r4rHr[rPr+r,r>rvrBr(r(r(r)r*s   , /   r)r __future__rtypingr;marshmallow.exceptionsmarshmallow.utilsrpackaging.versionrapispecrapispec.exceptionsrcommonrr r r field_converterr rWrr(r(r(r)s*