Merge branch 'main' into openapi-3.1

# Conflicts:
#	openapi_python_client/parser/openapi.py

Author: dbanty

.changeset/remove_useless_pass_statements_from_generated_code.md

@@ -17,7 +17,7 @@ jobs:
     steps:
       - uses: actions/checkout@v4.1.1
       - name: Set up Python
-        uses: actions/setup-python@v4
+        uses: actions/setup-python@v5.0.0
         with:
           python-version: ${{ matrix.python }}
 
@@ -101,7 +101,7 @@ jobs:
     steps:
       - uses: actions/checkout@v4.1.1
       - name: Set up Python
-        uses: actions/setup-python@v4
+        uses: actions/setup-python@v5.0.0
         with:
           python-version: "3.8"
       - name: Get Python Version

.changeset/switch_from_black_to_ruff_for_formatting.md

@@ -13,6 +13,40 @@ 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.16.0 (2023-12-07)
+
+### Breaking Changes
+
+#### Switch from Black to Ruff for formatting
+
+`black` is no longer a runtime dependency, so if you have them set in custom `post_hooks` in a config file, you'll need to make sure they're being installed manually. [`ruff`](https://docs.astral.sh/ruff) is now installed and used by default instead.
+
+#### Use Ruff instead of isort + autoflake at runtime
+
+`isort` and `autoflake` are no longer runtime dependencies, so if you have them set in custom `post_hooks` in a config file, you'll need to make sure they're being installed manually. [`ruff`](https://docs.astral.sh/ruff) is now installed and used by default instead.
+
+### Features
+
+#### Support all `text/*` content types in responses
+
+Within an API response, any content type which starts with `text/` will now be treated the same as `text/html` already was—they will return the `response.text` attribute from the [httpx Response](https://www.python-httpx.org/api/#response).
+
+Thanks to @fdintino for the initial implementation, and thanks for the discussions from @kairntech, @rubenfiszel, and @antoneladestito.
+
+Closes #797 and #821.
+
+#### Support `application/octet-stream` request bodies
+
+Endpoints that accept `application/octet-stream` request bodies are now supported using the same `File` type as octet-stream responses.
+
+Thanks to @kgutwin for the implementation and @rtaycher for the discussion!
+
+PR #899 closes #588
+
+### Fixes
+
+#### Remove useless `pass` statements from generated code
+
 ## 0.15.2 (2023-09-16)
 
 ### Features

.changeset/use_ruff_instead_of_isort_autoflake_at_runtime.md

@@ -625,6 +625,46 @@
             }
           }
         }
+      },
+      "post": {
+        "tags": [
+          "tests"
+        ],
+        "summary": "Binary (octet stream) request body",
+        "operationId": "octet_stream_tests_octet_stream_post",
+        "requestBody": {
+          "content": {
+            "application/octet-stream": {
+              "schema": {
+                "description": "A file to upload",
+                "type": "string",
+                "format": "binary"
+              }
+            }
+          }
+        },
+        "responses": {
+          "200": {
+            "description": "success",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "string"
+                }
+              }
+            }
+          },
+          "422": {
+            "description": "Validation Error",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/HTTPValidationError"
+                }
+              }
+            }
+          }
+        }
       }
     },
     "/tests/no_response": {
@@ -781,6 +821,27 @@
         }
       }
     },
+    "/responses/text": {
+      "post": {
+        "tags": [
+          "responses"
+        ],
+        "summary": "Text Response",
+        "operationId": "text_response",
+        "responses": {
+          "200": {
+            "description": "Text response",
+            "content": {
+              "text/plain": {
+                "schema": {
+                  "type": "string"
+                }
+              }
+            }
+          }
+        }
+      }
+    },
     "/auth/token_with_cookie": {
       "get": {
         "tags": [

.github/workflows/checks.yml

@@ -623,6 +623,46 @@ info:
           }
         }
       }
+    },
+    "post": {
+      "tags": [
+        "tests"
+      ],
+      "summary": "Binary (octet stream) request body",
+      "operationId": "octet_stream_tests_octet_stream_post",
+      "requestBody": {
+        "content": {
+          "application/octet-stream": {
+            "schema": {
+              "description": "A file to upload",
+              "type": "string",
+              "format": "binary"
+            }
+          }
+        }
+      },
+      "responses": {
+        "200": {
+          "description": "success",
+          "content": {
+            "application/json": {
+              "schema": {
+                "type": "string"
+              }
+            }
+          }
+        },
+        "422": {
+          "description": "Validation Error",
+          "content": {
+            "application/json": {
+              "schema": {
+                "$ref": "#/components/schemas/HTTPValidationError"
+              }
+            }
+          }
+        }
+      }
     }
   },
   "/tests/no_response": {
@@ -787,6 +827,27 @@ info:
       }
     }
   },
+  "/responses/text": {
+    "post": {
+      "tags": [
+        "responses"
+      ],
+      "summary": "Text Response",
+      "operationId": "text_response",
+      "responses": {
+        "200": {
+          "description": "Text response",
+          "content": {
+            "text/plain": {
+              "schema": {
+                "type": "string"
+              }
+            }
+          }
+        }
+      }
+    }
+  },
   "/auth/token_with_cookie": {
     "get": {
       "tags": [

CHANGELOG.md

@@ -2,7 +2,7 @@
 
 import types
 
-from . import post_responses_unions_simple_before_complex
+from . import post_responses_unions_simple_before_complex, text_response
 
 
 class ResponsesEndpoints:
@@ -12,3 +12,10 @@ def post_responses_unions_simple_before_complex(cls) -> types.ModuleType:
         Regression test for #603
         """
         return post_responses_unions_simple_before_complex
+
+    @classmethod
+    def text_response(cls) -> types.ModuleType:
+        """
+        Text Response
+        """
+        return text_response

end_to_end_tests/baseline_openapi_3.0.json

@@ -15,6 +15,7 @@
     json_body_tests_json_body_post,
     no_response_tests_no_response_get,
     octet_stream_tests_octet_stream_get,
+    octet_stream_tests_octet_stream_post,
     post_form_data,
     post_form_data_inline,
     post_tests_json_body_string,
@@ -118,6 +119,13 @@ def octet_stream_tests_octet_stream_get(cls) -> types.ModuleType:
         """
         return octet_stream_tests_octet_stream_get
 
+    @classmethod
+    def octet_stream_tests_octet_stream_post(cls) -> types.ModuleType:
+        """
+        Binary (octet stream) request body
+        """
+        return octet_stream_tests_octet_stream_post
+
     @classmethod
     def no_response_tests_no_response_get(cls) -> types.ModuleType:
         """

end_to_end_tests/baseline_openapi_3.1.yaml

@@ -0,0 +1,118 @@
+from http import HTTPStatus
+from typing import Any, Dict, Optional, Union
+
+import httpx
+
+from ... import errors
+from ...client import AuthenticatedClient, Client
+from ...types import Response
+
+
+def _get_kwargs() -> Dict[str, Any]:
+    return {
+        "method": "post",
+        "url": "/responses/text",
+    }
+
+
+def _parse_response(*, client: Union[AuthenticatedClient, Client], response: httpx.Response) -> Optional[str]:
+    if response.status_code == HTTPStatus.OK:
+        response_200 = response.text
+        return response_200
+    if client.raise_on_unexpected_status:
+        raise errors.UnexpectedStatus(response.status_code, response.content)
+    else:
+        return None
+
+
+def _build_response(*, client: Union[AuthenticatedClient, Client], response: httpx.Response) -> Response[str]:
+    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: Union[AuthenticatedClient, Client],
+) -> Response[str]:
+    """Text Response
+
+    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[str]
+    """
+
+    kwargs = _get_kwargs()
+
+    response = client.get_httpx_client().request(
+        **kwargs,
+    )
+
+    return _build_response(client=client, response=response)
+
+
+def sync(
+    *,
+    client: Union[AuthenticatedClient, Client],
+) -> Optional[str]:
+    """Text Response
+
+    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:
+        str
+    """
+
+    return sync_detailed(
+        client=client,
+    ).parsed
+
+
+async def asyncio_detailed(
+    *,
+    client: Union[AuthenticatedClient, Client],
+) -> Response[str]:
+    """Text Response
+
+    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[str]
+    """
+
+    kwargs = _get_kwargs()
+
+    response = await client.get_async_httpx_client().request(**kwargs)
+
+    return _build_response(client=client, response=response)
+
+
+async def asyncio(
+    *,
+    client: Union[AuthenticatedClient, Client],
+) -> Optional[str]:
+    """Text Response
+
+    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:
+        str
+    """
+
+    return (
+        await asyncio_detailed(
+            client=client,
+        )
+    ).parsed