[python] add async httpx support #22021

soapun · 2025-09-24T17:11:29Z

Add httpx (async) as library for python generator

to fix #19255

PR checklist

Read the contribution guidelines.
Pull Request title clearly describes the work in the pull request and Pull Request description provides details about how to validate the work. Missing information here may result in delayed response from the community.
Run the following to build the project and update samples:
```
./mvnw clean package || exit
./bin/generate-samples.sh ./bin/configs/*.yaml || exit
./bin/utils/export_docs_generators.sh || exit
```
(For Windows users, please run the script in WSL)
Commit all changed files.
This is important, as CI jobs will verify all generator outputs of your HEAD commit as it would merge with master.
These must match the expectations made by your contribution.
You may regenerate an individual generator by passing the relevant config(s) as an argument to the script, for example ./bin/generate-samples.sh bin/configs/java*.
IMPORTANT: Do NOT purge/delete any folders/files (e.g. tests) when regenerating the samples as manually written tests may be removed.
File the PR against the correct branch: master (upcoming 7.x.0 minor release - breaking changes with fallbacks), 8.0.x (breaking changes without fallbacks)
If your PR solves a reported issue, reference it using GitHub's linking syntax (e.g., having "fixes #123" present in the PR description)
If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.

wing328 · 2025-09-25T07:16:38Z

Thanks for the PR but your commit (as shown in the Commits tab) is not linked to your Github account, which means this PR won't count as your contribution in https://github.com/OpenAPITools/openapi-generator/graphs/contributors.

Let me know if you need help fixing it.

Ref: https://github.com/OpenAPITools/openapi-generator/wiki/FAQ#how-can-i-update-commits-that-are-not-linked-to-my-github-account

wing328 · 2025-09-25T07:17:59Z

thanks for the PR.

~~what about adding async support to the existing httpx library via an option (e.g. supportAsync) instead creating another library?~~

~~(have a single httpx library to support both async and sync requests will be easier to maintain)~~

wing328 · 2025-09-25T07:19:55Z

cc @cbornet (2017/09) @tomplus (2018/10) @krjakbrjak (2023/02) @fa0311 (2023/10) @multani (2023/10)

soapun · 2025-09-25T08:02:40Z

I've linked my commits, thanks for noticing!
Yeah I'll add sync support

wing328 · 2025-09-25T08:13:05Z

Yeah I'll add sync support

sorry please put it on hold

we can add it later if that's a demand for it (sync support)

wing328 · 2025-09-25T08:14:00Z

bin/configs/python-httpx.yaml

@@ -0,0 +1,15 @@
+generatorName: python
+outputDir: samples/openapi3/client/petstore/python-httpx


please add the new folder to the CI workflow

https://github.com/OpenAPITools/openapi-generator/blob/master/.github/workflows/samples-python-petstore.yaml

wing328 · 2025-09-25T08:36:52Z

.../openapi-generator/src/main/java/org/openapitools/codegen/languages/PythonClientCodegen.java

            additionalProperties.put("tornado", "true");
+        } else if ("httpx".equals(getLibrary())) {
+            supportingFiles.add(new SupportingFile("httpx/rest.mustache", packagePath(), "rest.py"));
+            additionalProperties.put("asyncio", "true");


can you please explain why asyncio (library option) needs to be set to true even for httpx library?

For all request methods in clients higher than RESTClientObject to be async def

like here:

api_client.mustache

api.mustache

So "asyncio" is actually not only a library option

my take is to refactor it if both asyncio and httpx need the same piece of code

for example, add the tag {{#async}} ....{{/async}} that is enabled by both asyncio and httpx libraries

btw current library name "asyncio" is a bit misleading

asyncio - part of python stdlib (coros, eventloop and so on), not a client library
aiohttp - 3rd party rest client library

please PM me via Slack if you want to further discussion this

2. hand written tests for python-httpx 3. CI workflow updated

wing328 · 2025-09-26T07:28:24Z

please review the build failure when you've time

wing328 · 2025-09-26T07:31:02Z

also I wonder if you can add a simple test to add a pet to the petstore server and get it by id similar to https://github.com/OpenAPITools/openapi-generator/blob/master/samples/openapi3/client/petstore/python/tests/test_pet_api.py#L137

this can ensure requests using httpx work with add_pet and get_pet_by_id

soapun · 2025-09-26T16:35:34Z

also I wonder if you can add a simple test to add a pet to the petstore server and get it by id similar to https://github.com/OpenAPITools/openapi-generator/blob/master/samples/openapi3/client/petstore/python/tests/test_pet_api.py#L137

this can ensure requests using httpx work with add_pet and get_pet_by_id

i've just copied hand written tests from plain python and fixed some implementation specific things. So this test is already present

https://github.com/soapun/openapi-generator/blob/python-httpx/samples/openapi3/client/petstore/python-httpx/tests/test_pet_api.py#L130

wing328 · 2025-09-26T17:01:56Z

all tests passed. i'll get it merged over the weekend before the upcoming release.

thanks for the contribution.

have a nice weekend.

thoumasd · 2025-09-27T09:16:13Z

Thanks for the contribution @soapun!

wing328 · 2025-10-01T17:46:14Z

@soapun when you've time, can you please PM me via Slack?

https://join.slack.com/t/openapi-generator/shared_invite/zt-36ucx4ybl-jYrN6euoYn6zxXNZdldoZA

* [python] fix OpenAPITools#19255 add async httpx support * update docs * 1. "async" parameter for templates 2. hand written tests for python-httpx 3. CI workflow updated * fix mypy

soapun force-pushed the python-httpx branch from 6f4a843 to 96594a8 Compare September 25, 2025 07:56

soapun added 2 commits September 25, 2025 10:59

[python] fix OpenAPITools#19255 add async httpx support

2bf2e98

update docs

9050b8b

soapun force-pushed the python-httpx branch from 96594a8 to 9050b8b Compare September 25, 2025 07:59

wing328 reviewed Sep 25, 2025

View reviewed changes

1. "async" parameter for templates

2429959

2. hand written tests for python-httpx 3. CI workflow updated

fix mypy

2e9bd8e

wing328 added Client: Python Enhancement: Feature labels Sep 27, 2025

wing328 added this to the 7.16.0 milestone Sep 27, 2025

wing328 changed the title ~~[python] fix #19255 add async httpx support~~ [python] add async httpx support Sep 27, 2025

wing328 merged commit bab5ca2 into OpenAPITools:master Sep 27, 2025
36 checks passed

wing328 added the Enhancement: New generator label Sep 28, 2025

		@@ -0,0 +1,15 @@
		generatorName: python
		outputDir: samples/openapi3/client/petstore/python-httpx

Uh oh!

[python] add async httpx support #22021

[python] add async httpx support #22021

Uh oh!

Conversation

soapun commented Sep 24, 2025 • edited by wing328 Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

PR checklist

Uh oh!

wing328 commented Sep 25, 2025

Uh oh!

wing328 commented Sep 25, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

wing328 commented Sep 25, 2025

Uh oh!

soapun commented Sep 25, 2025

Uh oh!

wing328 commented Sep 25, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

wing328 Sep 25, 2025

Choose a reason for hiding this comment

Uh oh!

wing328 Sep 25, 2025

Choose a reason for hiding this comment

Uh oh!

soapun Sep 25, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

wing328 Sep 25, 2025

Choose a reason for hiding this comment

Uh oh!

soapun Sep 25, 2025

Choose a reason for hiding this comment

Uh oh!

soapun Sep 25, 2025

Choose a reason for hiding this comment

Uh oh!

wing328 Sep 25, 2025

Choose a reason for hiding this comment

Uh oh!

wing328 commented Sep 26, 2025

Uh oh!

wing328 commented Sep 26, 2025

Uh oh!

soapun commented Sep 26, 2025

Uh oh!

wing328 commented Sep 26, 2025

Uh oh!

Uh oh!

thoumasd commented Sep 27, 2025

Uh oh!

wing328 commented Oct 1, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

soapun commented Sep 24, 2025 •

edited by wing328

Loading

wing328 commented Sep 25, 2025 •

edited

Loading

wing328 commented Sep 25, 2025 •

edited

Loading

soapun Sep 25, 2025 •

edited

Loading