feat: Add support for cookie parameters

Author: dongfangtianyu

openapi_python_client/parser/openapi.py

@@ -19,6 +19,7 @@ class ParameterLocation(str, Enum):
     QUERY = "query"
     PATH = "path"
     HEADER = "header"
+    COOKIE = "cookie"
 
 
 def import_string_from_reference(reference: Reference, prefix: str = "") -> str:
@@ -93,6 +94,7 @@ class Endpoint:
     query_parameters: List[Property] = field(default_factory=list)
     path_parameters: List[Property] = field(default_factory=list)
     header_parameters: List[Property] = field(default_factory=list)
+    cookie_parameters: List[Property] = field(default_factory=list)
     responses: List[Response] = field(default_factory=list)
     form_body_reference: Optional[Reference] = None
     json_body: Optional[Property] = None
@@ -214,6 +216,8 @@ def _add_parameters(
                 endpoint.path_parameters.append(prop)
             elif param.param_in == ParameterLocation.HEADER:
                 endpoint.header_parameters.append(prop)
+            elif param.param_in == ParameterLocation.COOKIE:
+                endpoint.cookie_parameters.append(prop)
             else:
                 return ParseError(data=param, detail="Parameter must be declared in path or query"), schemas
         return endpoint, schemas

openapi_python_client/templates/endpoint_macros.py.jinja

@@ -11,6 +11,20 @@ if {{ parameter.python_name }} is not UNSET:
 {% endif %}
 {% endmacro %}
 
+{% macro cookie_params(endpoint) %}
+{% if endpoint.cookie_parameters %}
+    {% for parameter in endpoint.cookie_parameters %}
+        {% if parameter.required %}
+cookies["{{ parameter.python_name | kebabcase}}"] = {{ parameter.python_name }}
+        {% else %}
+if {{ parameter.python_name }} is not UNSET:
+    cookies["{{ parameter.python_name | kebabcase}}"] = {{ parameter.python_name }}
+        {% endif %}
+    {% endfor %}
+{% endif %}
+{% endmacro %}
+
+
 {% macro query_params(endpoint) %}
 {% if endpoint.query_parameters %}
     {% for property in endpoint.query_parameters %}
@@ -101,6 +115,10 @@ json_body: {{ endpoint.json_body.get_type_string() }},
 {% for parameter in endpoint.header_parameters %}
 {{ parameter.to_string() }},
 {% endfor %}
+{# cookie parameters #}
+{% for parameter in endpoint.cookie_parameters %}
+{{ parameter.to_string() }},
+{% endfor %}
 {% endmacro %}
 
 {# Just lists all kwargs to endpoints as name=name for passing to other functions #}

openapi_python_client/templates/endpoint_module.py.jinja

@@ -10,7 +10,7 @@ from ...types import Response
 {{ relative }}
 {% endfor %}
 
-{% from "endpoint_macros.py.jinja" import header_params, query_params, json_body, return_type, arguments, client, kwargs, parse_response %}
+{% from "endpoint_macros.py.jinja" import header_params, cookie_params, query_params, json_body, return_type, arguments, client, kwargs, parse_response %}
 
 {% set return_string = return_type(endpoint) %}
 {% set parsed_responses = (endpoint.responses | length > 0) and return_string != "None" %}
@@ -26,17 +26,20 @@ def _get_kwargs(
     )
 
     headers: Dict[str, Any] = client.get_headers()
+    cookies: Dict[str, Any] = client.get_cookies()
 
     {{ header_params(endpoint) | indent(4) }}
 
+    {{ cookie_params(endpoint) | indent(4) }}
+
     {{ query_params(endpoint) | indent(4) }}
 
     {{ json_body(endpoint) | indent(4) }}
 
     return {
         "url": url,
         "headers": headers,
-        "cookies": client.get_cookies(),
+        "cookies": cookies,
         "timeout": client.get_timeout(),
         {% if endpoint.form_body_reference %}
         "data": asdict(form_data),

tests/test_parser/test_openapi.py

@@ -444,7 +444,9 @@ def test__add_parameters_fail_loudly_when_location_not_supported(self, mocker):
         )
         parsed_schemas = mocker.MagicMock()
         mocker.patch(f"{MODULE_NAME}.property_from_data", return_value=(mocker.MagicMock(), parsed_schemas))
-        param = oai.Parameter.construct(name="test", required=True, param_schema=mocker.MagicMock(), param_in="cookie")
+        param = oai.Parameter.construct(
+            name="test", required=True, param_schema=mocker.MagicMock(), param_in="error_location"
+        )
         schemas = Schemas()
 
         result = Endpoint._add_parameters(

tests/test_templates/endpoint_module.py

@@ -20,11 +20,12 @@ def _get_kwargs(
     url = "{}/post/".format(client.base_url)
 
     headers: Dict[str, Any] = client.get_headers()
+    cookies: Dict[str, Any] = client.get_cookies()
 
     return {
         "url": url,
         "headers": headers,
-        "cookies": client.get_cookies(),
+        "cookies": cookies,
         "timeout": client.get_timeout(),
         "data": asdict(form_data),
         "files": multipart_data.to_dict(),