Skip to content

[python] fix #23032 add sync httpx support #23044

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
soapun wants to merge 7 commits into
base: master
Choose a base branch
from
+47,416 −13
Open

[python] fix #23032 add sync httpx support #23044

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
146db3a
[python] fix OpenAPITools#23032 add sync httpx support
soapun Feb 24, 2026
656de6a
fix tests
soapun Feb 24, 2026
f243adf
fix test_proxy
soapun Feb 24, 2026
ea0fddd
fix test_proxy platform specific exc message
soapun Feb 25, 2026
fd1099c
Merge branch 'master' into python-httpx-sync
soapun Feb 26, 2026
672973a
separate template for httpx api_client
soapun Feb 26, 2026
7d352a9
upd FILES
soapun Feb 26, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
1 change: 1 addition & 0 deletions .github/workflows/samples-python-petstore.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@ jobs:
sample:
- samples/openapi3/client/petstore/python-aiohttp
- samples/openapi3/client/petstore/python-httpx
- samples/openapi3/client/petstore/python-httpx-sync
Copy link
Contributor

@cubic-dev-ai cubic-dev-ai bot Feb 24, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2: The new python-httpx-sync sample is included in the test matrix but missing from the pull_request path filters, so changes limited to that directory won’t trigger CI for this workflow.

Prompt for AI agents 
Check if this issue is valid — if so, understand the root cause and fix it. At .github/workflows/samples-python-petstore.yaml, line 38:

<comment>The new python-httpx-sync sample is included in the test matrix but missing from the pull_request path filters, so changes limited to that directory won’t trigger CI for this workflow.</comment>

<file context>
@@ -35,6 +35,7 @@ jobs:
         sample:
           - samples/openapi3/client/petstore/python-aiohttp
           - samples/openapi3/client/petstore/python-httpx
+          - samples/openapi3/client/petstore/python-httpx-sync
           - samples/openapi3/client/petstore/python
           - samples/openapi3/client/petstore/python-lazyImports
</file context>

Copy link
Contributor

@cubic-dev-ai cubic-dev-ai bot Feb 24, 2026 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2: The new python-httpx-sync sample is included in the test matrix but missing from the pull_request path filters, so changes limited to that directory won’t trigger CI for this workflow.

Prompt for AI agents 
Check if this issue is valid — if so, understand the root cause and fix it. At .github/workflows/samples-python-petstore.yaml, line 38:

<comment>The new python-httpx-sync sample is included in the test matrix but missing from the pull_request path filters, so changes limited to that directory won’t trigger CI for this workflow.</comment>

<file context>
@@ -35,6 +35,7 @@ jobs:
         sample:
           - samples/openapi3/client/petstore/python-aiohttp
           - samples/openapi3/client/petstore/python-httpx
+          - samples/openapi3/client/petstore/python-httpx-sync
           - samples/openapi3/client/petstore/python
           - samples/openapi3/client/petstore/python-lazyImports
</file context>
Fix with Cubic

- samples/openapi3/client/petstore/python
- samples/openapi3/client/petstore/python-lazyImports
services:
Expand Down
15 changes: 15 additions & 0 deletions bin/configs/python-httpx-sync.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
generatorName: python
outputDir: samples/openapi3/client/petstore/python-httpx-sync
inputSpec: modules/openapi-generator/src/test/resources/3_0/python/petstore-with-fake-endpoints-models-for-testing.yaml
templateDir: modules/openapi-generator/src/main/resources/python
library: httpx-sync
Copy link
Member

@wing328 wing328 Mar 3, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

instead of creating another library, what about an option called supportHttpxSync to generate an additional API method suffix with _sync (e.g. get_pet_by_id_sync) while this method simply called the async API method and wait for the completion of the operation?

Copy link
Contributor Author

@soapun soapun Mar 3, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It would be very impractical for mutiple threads to utilize same sync client if we make some kind of async to sync here. Each thread would need its own event loop. This leads to more issues if httpx.AsyncClient client utilizes any global synchronization primitives under the hood.

Copy link
Member

@wing328 wing328 Mar 4, 2026 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

what if a client needs to call both sync and async methods in the same setting? they need to use 2 different Python SDKs?

Copy link
Contributor Author

@soapun soapun Mar 4, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i agree, it would be nice to have both sync and async clients in the same SDK to share models. But as separate classes

Copy link
Member

@wing328 wing328 Mar 4, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

for some other clients in different programming languages, we already have both sync and async methods in the same API class with different method suffix.

async method:

openapi-generator/samples/client/petstore/php/psr-18/lib/Api/PetApi.php

Line 1283 in 3972c65

public function getPetByIdAsync($pet_id)

sync method:

openapi-generator/samples/client/petstore/php/psr-18/lib/Api/PetApi.php

Line 1180 in 3972c65

public function getPetById($pet_id)

Copy link
Contributor Author

@soapun soapun Mar 4, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ok. Shall i also create sync methods in rest.py and api_client.py ?

Copy link
Member

@wing328 wing328 Mar 6, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i don't think so

i think all you need is to create a sync version for each api method, which calls the corresponding async api method and wait for completion

additionalProperties:
packageName: petstore_api
mapNumberTo: float
poetry1: false
nameMappings:
_type: underscore_type
type_: type_with_underscore
modelNameMappings:
# The OpenAPI spec ApiResponse conflicts with the internal ApiResponse
ApiResponse: ModelApiResponse
2 changes: 1 addition & 1 deletion docs/generators/python.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl
|generateSourceCodeOnly|Specifies that only a library source code is to be generated.| |false|
|hideGenerationTimestamp|Hides the generation timestamp when files are generated.| |true|
|lazyImports|Enable lazy imports.| |false|
|library|library template (sub-template) to use: asyncio, tornado (deprecated), urllib3, httpx| |urllib3|
|library|library template (sub-template) to use: asyncio, tornado (deprecated), urllib3, httpx, httpx-sync| |urllib3|
|mapNumberTo|Map number to Union[StrictFloat, StrictInt], StrictStr or float.| |Union[StrictFloat, StrictInt]|
|packageName|python package name (convention: snake_case).| |openapi_client|
|packageUrl|python package URL.| |null|
Expand Down
9 changes: 7 additions & 2 deletions ...enapi-generator/src/main/java/org/openapitools/codegen/languages/PythonClientCodegen.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -158,7 +158,8 @@ public PythonClientCodegen() {
supportedLibraries.put("asyncio", "asyncio-based client");
supportedLibraries.put("tornado", "tornado-based client (deprecated)");
supportedLibraries.put("httpx", "httpx-based client");
CliOption libraryOption = new CliOption(CodegenConstants.LIBRARY, "library template (sub-template) to use: asyncio, tornado (deprecated), urllib3, httpx");
supportedLibraries.put("httpx-sync", "httpx-based sync client");
CliOption libraryOption = new CliOption(CodegenConstants.LIBRARY, "library template (sub-template) to use: asyncio, tornado (deprecated), urllib3, httpx, httpx-sync");
libraryOption.setDefault(DEFAULT_LIBRARY);
cliOptions.add(libraryOption);
setLibrary(DEFAULT_LIBRARY);
Expand Down Expand Up @@ -326,7 +327,6 @@ public void processOpts() {
supportingFiles.add(new SupportingFile("__init__.mustache", testFolder, "__init__.py"));
}

supportingFiles.add(new SupportingFile("api_client.mustache", packagePath(), "api_client.py"));
supportingFiles.add(new SupportingFile("api_response.mustache", packagePath(), "api_response.py"));

if ("asyncio".equals(getLibrary())) {
Expand All @@ -338,10 +338,15 @@ public void processOpts() {
additionalProperties.put("tornado", "true");
} else if ("httpx".equals(getLibrary())) {
supportingFiles.add(new SupportingFile("httpx/rest.mustache", packagePath(), "rest.py"));
supportingFiles.add(new SupportingFile("httpx/api_client.mustache", packagePath(), "api_client.py"));
additionalProperties.put("async", "true");
additionalProperties.put("httpx", "true");
} else if ("httpx-sync".equals(getLibrary())) {
supportingFiles.add(new SupportingFile("httpx/rest.mustache", packagePath(), "rest.py"));
additionalProperties.put("httpx", "true");
} else {
supportingFiles.add(new SupportingFile("rest.mustache", packagePath(), "rest.py"));
supportingFiles.add(new SupportingFile("api_client.mustache", packagePath(), "api_client.py"));
}

modelPackage = this.packageName + "." + modelPackage;
Expand Down
Loading
Loading