o FD©iœã@sBdZddlmZddlZddlmZddlmZGdd„dƒZdS) zBase class for Plugin classes.é)Ú annotationsNé)ÚAPISpec©ÚPluginMethodNotImplementedErrorc@sdeZdZdZd$dd„Zd%dd„Zd&dd„Zd'dd„Zd(dd„Z   d)d*d d!„Z  d+d,d"d#„Z dS)-Ú BasePluginz&Base class for APISpec plugin classes.ÚspecrÚreturnÚNonecCsdS)zInitialize plugin with APISpec object :param APISpec spec: APISpec object this plugin instance is attached to N©)Úselfrr r úG/var/www/Datamplify/venv/lib/python3.10/site-packages/apispec/plugin.pyÚ init_specszBasePlugin.init_specÚnameÚstrÚ definitionÚdictÚkwargsú typing.Anyú dict | NonecKót‚)zöMay return definition as a dict. :param str name: Identifier by which schema may be referenced :param dict definition: Schema definition :param kwargs: All additional keywords arguments sent to `APISpec.schema()` r)r rrrr r r Ú schema_helpers zBasePlugin.schema_helperÚresponsecKr)zÂMay return response component description as a dict. :param dict response: Response fields :param kwargs: All additional keywords arguments sent to `APISpec.response()` r)r rrr r r Úresponse_helperózBasePlugin.response_helperÚ parametercKr)zÆMay return parameter component description as a dict. :param dict parameter: Parameter fields :param kwargs: All additional keywords arguments sent to `APISpec.parameter()` r)r rrr r r Úparameter_helper'rzBasePlugin.parameter_helperÚheadercKr)zºMay return header component description as a dict. :param dict header: Header fields :param kwargs: All additional keywords arguments sent to `APISpec.header()` r)r rrr r r Ú header_helper/rzBasePlugin.header_helperNÚpathú str | NoneÚ operationsÚ parametersúlist[dict] | NonecKr)aMay return a path as string and mutate operations dict and parameters list. :param str path: Path to the resource :param dict operations: A `dict` mapping HTTP methods to operation object. See https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#operationObject :param list parameters: A `list` of parameters objects or references for the path. See https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md#parameterObject and https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md#referenceObject :param kwargs: All additional keywords arguments sent to `APISpec.path()` Return value should be a string or None. If a string is returned, it is set as the path. The last path helper returning a string sets the path value. Therefore, the order of plugin registration matters. However, generally, registering several plugins that return a path does not make sense. r)r rr!r"rr r r Ú path_helper7szBasePlugin.path_helpercKr)a^May mutate operations. :param str path: Path to the resource :param dict operations: A `dict` mapping HTTP methods to operation object. See https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md#operationObject :param kwargs: All additional keywords arguments sent to `APISpec.path()` r)r rr!rr r r Úoperation_helperQs zBasePlugin.operation_helper)rrr r )rrrrrrr r)rrrrr r)rrrrr r)rrrrr r)NNN) rr r!rr"r#rrr r )NN)rr r!rrrr r ) Ú__name__Ú __module__Ú __qualname__Ú__doc__rrrrrr$r%r r r r r s      üýr) r)Ú __future__rÚtypingÚcorerÚ exceptionsrrr r r r Ús