Merge branch 'main' into follow_redirect

Author: emann

.github/renovate.json

@@ -3,5 +3,27 @@
     "config:base",
     ":semanticCommitTypeAll(chore)"
   ],
-  "rangeStrategy": "widen"
+  "rangeStrategy": "widen",
+  "regexManagers": [
+    {
+      "fileMatch": [
+        "release.*\\.yml"
+      ],
+      "matchStrings": [
+        "version:\\s*(?<currentValue>.*)"
+      ],
+      "depNameTemplate": "knope",
+      "datasourceTemplate": "crate",
+      "versioningTemplate": "semver"
+    }
+  ],
+  "packageRules": [
+    {
+      "packagePatterns": [
+        "^knope$"
+      ],
+      "groupName": "knope",
+      "rangeStrategy": "pin"
+    }
+  ]
 }

.github/workflows/release-dry-run.yml

@@ -12,9 +12,9 @@ jobs:
       - uses: actions/checkout@v3
         with:
           fetch-depth: 0
-          token: ${{ secrets.PAT }}
+          token: ${{ secrets.GITHUB_TOKEN }}
       - name: Install Knope
         uses: knope-dev/action@v1
         with:
-          version: 0.6.2
+          version: 0.7.2
       - run: knope release --dry-run

.github/workflows/release.yml

@@ -20,7 +20,7 @@ jobs:
       - name: Install Knope
         uses: knope-dev/action@v1
         with:
-          version: 0.6.2
+          version: 0.7.2
       - name: Bump Version & Create GitHub Release
         run: knope release
         env:

CHANGELOG.md

@@ -13,6 +13,17 @@ Programmatic usage of this project (e.g., importing it as a Python module) and t
 
 The 0.x prefix used in versions for this project is to indicate that breaking changes are expected frequently (several times a year). Breaking changes will increment the minor number, all other changes will increment the patch number. You can track the progress toward 1.0 [here](https://github.com/openapi-generators/openapi-python-client/projects/2).
 
+## 0.13.2
+
+### Features
+
+- Always generate enums with sorted members (#728)
+
+### Fixes
+
+- Prevent backslashes in descriptions from breaking docstrings [#735]. Thanks @robertschweizer & @bryan-hunt! (#735)
+- Respect `required` field in parameters included with `$ref` (#737)
+
 ## 0.13.1
 
 ### Features

end_to_end_tests/custom-templates-golden-record/my_test_api_client/api/tests/__init__.py

@@ -5,6 +5,7 @@
 from . import (
     callback_test,
     defaults_tests_defaults_post,
+    description_with_backslash,
     get_basic_list_of_booleans,
     get_basic_list_of_floats,
     get_basic_list_of_integers,
@@ -158,3 +159,10 @@ def callback_test(cls) -> types.ModuleType:
         Try sending a request related to a callback
         """
         return callback_test
+
+    @classmethod
+    def description_with_backslash(cls) -> types.ModuleType:
+        """
+            Test description with \
+        """
+        return description_with_backslash

end_to_end_tests/golden-record/my_test_api_client/api/parameter_references/get_parameter_references_path_param.py

@@ -1,30 +1,32 @@
 from http import HTTPStatus
-from typing import Any, Dict, Optional
+from typing import Any, Dict, Optional, Union
 
 import httpx
 
 from ... import errors
 from ...client import Client
-from ...types import UNSET, Response
+from ...types import UNSET, Response, Unset
 
 
 def _get_kwargs(
     path_param: str,
     *,
     client: Client,
-    string_param: str,
-    integer_param: int = 0,
-    header_param: str,
-    cookie_param: str,
+    string_param: Union[Unset, None, str] = UNSET,
+    integer_param: Union[Unset, None, int] = 0,
+    header_param: Union[Unset, str] = UNSET,
+    cookie_param: Union[Unset, str] = UNSET,
 ) -> Dict[str, Any]:
     url = "{}/parameter-references/{path_param}".format(client.base_url, path_param=path_param)
 
     headers: Dict[str, str] = client.get_headers()
     cookies: Dict[str, Any] = client.get_cookies()
 
-    headers["header param"] = header_param
+    if not isinstance(header_param, Unset):
+        headers["header param"] = header_param
 
-    cookies["cookie param"] = cookie_param
+    if cookie_param is not UNSET:
+        cookies["cookie param"] = cookie_param
 
     params: Dict[str, Any] = {}
     params["string param"] = string_param
@@ -66,19 +68,19 @@ def sync_detailed(
     path_param: str,
     *,
     client: Client,
-    string_param: str,
-    integer_param: int = 0,
-    header_param: str,
-    cookie_param: str,
+    string_param: Union[Unset, None, str] = UNSET,
+    integer_param: Union[Unset, None, int] = 0,
+    header_param: Union[Unset, str] = UNSET,
+    cookie_param: Union[Unset, str] = UNSET,
 ) -> Response[Any]:
     """Test different types of parameter references
 
     Args:
         path_param (str):
-        string_param (str):
-        integer_param (int):
-        header_param (str):
-        cookie_param (str):
+        string_param (Union[Unset, None, str]):
+        integer_param (Union[Unset, None, int]):
+        header_param (Union[Unset, str]):
+        cookie_param (Union[Unset, str]):
 
     Raises:
         errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
@@ -109,19 +111,19 @@ async def asyncio_detailed(
     path_param: str,
     *,
     client: Client,
-    string_param: str,
-    integer_param: int = 0,
-    header_param: str,
-    cookie_param: str,
+    string_param: Union[Unset, None, str] = UNSET,
+    integer_param: Union[Unset, None, int] = 0,
+    header_param: Union[Unset, str] = UNSET,
+    cookie_param: Union[Unset, str] = UNSET,
 ) -> Response[Any]:
     """Test different types of parameter references
 
     Args:
         path_param (str):
-        string_param (str):
-        integer_param (int):
-        header_param (str):
-        cookie_param (str):
+        string_param (Union[Unset, None, str]):
+        integer_param (Union[Unset, None, int]):
+        header_param (Union[Unset, str]):
+        cookie_param (Union[Unset, str]):
 
     Raises:
         errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.

end_to_end_tests/golden-record/my_test_api_client/api/tests/description_with_backslash.py

@@ -0,0 +1,98 @@
+from http import HTTPStatus
+from typing import Any, Dict, Optional
+
+import httpx
+
+from ... import errors
+from ...client import Client
+from ...types import Response
+
+
+def _get_kwargs(
+    *,
+    client: Client,
+) -> Dict[str, Any]:
+    url = "{}/tests/description-with-backslash".format(client.base_url)
+
+    headers: Dict[str, str] = client.get_headers()
+    cookies: Dict[str, Any] = client.get_cookies()
+
+    return {
+        "method": "get",
+        "url": url,
+        "headers": headers,
+        "cookies": cookies,
+        "timeout": client.get_timeout(),
+    }
+
+
+def _parse_response(*, client: Client, response: httpx.Response) -> Optional[Any]:
+    if response.status_code == HTTPStatus.OK:
+        return None
+    if client.raise_on_unexpected_status:
+        raise errors.UnexpectedStatus(f"Unexpected status code: {response.status_code}")
+    else:
+        return None
+
+
+def _build_response(*, client: Client, response: httpx.Response) -> Response[Any]:
+    return Response(
+        status_code=HTTPStatus(response.status_code),
+        content=response.content,
+        headers=response.headers,
+        parsed=_parse_response(client=client, response=response),
+    )
+
+
+def sync_detailed(
+    *,
+    client: Client,
+) -> Response[Any]:
+    r""" Test description with \
+
+     Test description with \
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Response[Any]
+     """
+
+    kwargs = _get_kwargs(
+        client=client,
+    )
+
+    response = httpx.request(
+        verify=client.verify_ssl,
+        **kwargs,
+    )
+
+    return _build_response(client=client, response=response)
+
+
+async def asyncio_detailed(
+    *,
+    client: Client,
+) -> Response[Any]:
+    r""" Test description with \
+
+     Test description with \
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Response[Any]
+     """
+
+    kwargs = _get_kwargs(
+        client=client,
+    )
+
+    async with httpx.AsyncClient(verify=client.verify_ssl) as _client:
+        response = await _client.request(**kwargs)
+
+    return _build_response(client=client, response=response)

end_to_end_tests/golden-record/my_test_api_client/models/__init__.py

@@ -47,6 +47,7 @@
 from .model_with_additional_properties_refed import ModelWithAdditionalPropertiesRefed
 from .model_with_any_json_properties import ModelWithAnyJsonProperties
 from .model_with_any_json_properties_additional_property_type_0 import ModelWithAnyJsonPropertiesAdditionalPropertyType0
+from .model_with_backslash_in_description import ModelWithBackslashInDescription
 from .model_with_circular_ref_a import ModelWithCircularRefA
 from .model_with_circular_ref_b import ModelWithCircularRefB
 from .model_with_circular_ref_in_additional_properties_a import ModelWithCircularRefInAdditionalPropertiesA
@@ -111,6 +112,7 @@
     "ModelWithAdditionalPropertiesRefed",
     "ModelWithAnyJsonProperties",
     "ModelWithAnyJsonPropertiesAdditionalPropertyType0",
+    "ModelWithBackslashInDescription",
     "ModelWithCircularRefA",
     "ModelWithCircularRefB",
     "ModelWithCircularRefInAdditionalPropertiesA",

end_to_end_tests/golden-record/my_test_api_client/models/an_all_of_enum.py

@@ -2,9 +2,9 @@
 
 
 class AnAllOfEnum(str, Enum):
-    FOO = "foo"
-    BAR = "bar"
     A_DEFAULT = "a_default"
+    BAR = "bar"
+    FOO = "foo"
     OVERRIDDEN_DEFAULT = "overridden_default"
 
     def __str__(self) -> str:

end_to_end_tests/golden-record/my_test_api_client/models/get_location_header_types_string_enum_header.py

@@ -3,8 +3,8 @@
 
 class GetLocationHeaderTypesStringEnumHeader(str, Enum):
     ONE = "one"
-    TWO = "two"
     THREE = "three"
+    TWO = "two"
 
     def __str__(self) -> str:
         return str(self.value)

end_to_end_tests/golden-record/my_test_api_client/models/model_with_backslash_in_description.py

@@ -0,0 +1,46 @@
+from typing import Any, Dict, List, Type, TypeVar
+
+import attr
+
+T = TypeVar("T", bound="ModelWithBackslashInDescription")
+
+
+@attr.s(auto_attribs=True)
+class ModelWithBackslashInDescription:
+    r""" Description with special character: \
+
+     """
+
+    additional_properties: Dict[str, Any] = attr.ib(init=False, factory=dict)
+
+    def to_dict(self) -> Dict[str, Any]:
+
+        field_dict: Dict[str, Any] = {}
+        field_dict.update(self.additional_properties)
+        field_dict.update({})
+
+        return field_dict
+
+    @classmethod
+    def from_dict(cls: Type[T], src_dict: Dict[str, Any]) -> T:
+        d = src_dict.copy()
+        model_with_backslash_in_description = cls()
+
+        model_with_backslash_in_description.additional_properties = d
+        return model_with_backslash_in_description
+
+    @property
+    def additional_keys(self) -> List[str]:
+        return list(self.additional_properties.keys())
+
+    def __getitem__(self, key: str) -> Any:
+        return self.additional_properties[key]
+
+    def __setitem__(self, key: str, value: Any) -> None:
+        self.additional_properties[key] = value
+
+    def __delitem__(self, key: str) -> None:
+        del self.additional_properties[key]
+
+    def __contains__(self, key: str) -> bool:
+        return key in self.additional_properties