Skip to content

feat(python): expose all config properties in constructor #23020

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

Closed
timonrieger wants to merge 4 commits into from
Closed

feat(python): expose all config properties in constructor #23020

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
63b3e27
templates
timonrieger Feb 20, 2026
7948103
samples
timonrieger Feb 20, 2026
b536ae8
scope to python generator
timonrieger Feb 20, 2026
bb0ead0
address suggestions
timonrieger Feb 21, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 17 additions & 2 deletions modules/openapi-generator/src/main/resources/python-pydantic-v1/configuration.mustache
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,8 +47,23 @@ class Configuration:
string values to replace variables in templated server configuration.
Copy link
Copy Markdown
Contributor

@cubic-dev-ai cubic-dev-ai Bot Feb 20, 2026 •
edited
Loading

Choose a reason for hiding this comment

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

P2: Constructor no longer accepts documented configuration parameters and hard-codes their defaults, so callers cannot pass options like retries/cert_file/proxy and the docstring is misleading.

Prompt for AI agents 
Check if this issue is valid — if so, understand the root cause and fix it. At modules/openapi-generator/src/main/resources/python-pydantic-v1/configuration.mustache, line 241:

<comment>Constructor no longer accepts documented configuration parameters and hard-codes their defaults, so callers cannot pass options like retries/cert_file/proxy and the docstring is misleading.</comment>

<file context>
@@ -244,28 +238,28 @@ conf = {{{packageName}}}.Configuration(
         """Set this to customize the certificate file to verify the peer.
         """
-        self.cert_file = cert_file
+        self.cert_file = None
         """client certificate file
         """
</file context>
Fix with Cubic

The validation of enums is performed for variables with defined enum
values before.
:param verify_ssl: bool - Set this to false to skip verifying SSL certificate
when calling API from https server.
:param ssl_ca_cert: str - the path to a file of concatenated CA certificates
in PEM format.
:param retries: Retry configuration (e.g. urllib3.util.retry.Retry).
:param cert_file: The path to a client certificate file, for mTLS.
:param key_file: The path to a client key file, for mTLS.
:param assert_hostname: Set this to True/False to enable/disable SSL hostname verification.
:param tls_server_name: SSL/TLS Server Name Indication (SNI). Set this to the SNI value expected by the server.
:param connection_pool_maxsize: Connection pool max size. Defaults to 100 for asyncio, cpu_count * 5 for sync.
:param proxy: Proxy URL.
:param proxy_headers: Proxy headers.
:param safe_chars_for_path_param: Safe characters for path parameter encoding.
:param client_side_validation: Enable client-side validation. Default True.
:param socket_options: Options to pass down to the underlying urllib3 socket.
:param datetime_format: Datetime format string for serialization.
:param date_format: Date format string for serialization.

{{#hasAuthMethods}}
:Example:
Expand Down Expand Up @@ -146,7 +161,7 @@ conf = {{{packageName}}}.Configuration(
{{/hasHttpSignatureMethods}}
server_index=None, server_variables=None,
server_operation_index=None, server_operation_variables=None,
ssl_ca_cert=None,
ssl_ca_cert=None, verify_ssl=True,
) -> None:
"""Constructor
"""
Expand Down Expand Up @@ -215,7 +230,7 @@ conf = {{{packageName}}}.Configuration(
"""Debug switch
"""

self.verify_ssl = True
self.verify_ssl = verify_ssl
"""SSL/TLS verification
Set this to false to skip verifying SSL certificate when calling API
from https server.
Expand Down
54 changes: 37 additions & 17 deletions modules/openapi-generator/src/main/resources/python/configuration.mustache
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -183,6 +183,8 @@ class Configuration:
string values to replace variables in templated server configuration.
The validation of enums is performed for variables with defined enum
values before.
:param verify_ssl: bool - Set this to false to skip verifying SSL certificate
when calling API from https server.
:param ssl_ca_cert: str - the path to a file of concatenated CA certificates
in PEM format.
{{#async}}
Expand All @@ -195,6 +197,16 @@ class Configuration:
in PEM (str) or DER (bytes) format.
:param cert_file: the path to a client certificate file, for mTLS.
:param key_file: the path to a client key file, for mTLS.
:param assert_hostname: Set this to True/False to enable/disable SSL hostname verification.
:param tls_server_name: SSL/TLS Server Name Indication (SNI). Set this to the SNI value expected by the server.
:param connection_pool_maxsize: Connection pool max size. None in the constructor is coerced to 100 for async and cpu_count * 5 for sync.
:param proxy: Proxy URL.
:param proxy_headers: Proxy headers.
:param safe_chars_for_path_param: Safe characters for path parameter encoding.
:param client_side_validation: Enable client-side validation. Default True.
:param socket_options: Options to pass down to the underlying urllib3 socket.
:param datetime_format: Datetime format string for serialization.
:param date_format: Date format string for serialization.

{{#hasAuthMethods}}
:Example:
Expand Down Expand Up @@ -304,6 +316,17 @@ conf = {{{packageName}}}.Configuration(
ca_cert_data: Optional[Union[str, bytes]] = None,
cert_file: Optional[str]=None,
key_file: Optional[str]=None,
verify_ssl: bool=True,
assert_hostname: Optional[bool]=None,
tls_server_name: Optional[str]=None,
connection_pool_maxsize: Optional[int]=None,
proxy: Optional[str]=None,
proxy_headers: Optional[Any]=None,
safe_chars_for_path_param: str='',
client_side_validation: bool=True,
socket_options: Optional[Any]=None,
datetime_format: str="{{{datetimeFormat}}}",
date_format: str="{{{dateFormat}}}",
*,
debug: Optional[bool] = None,
) -> None:
Expand Down Expand Up @@ -382,7 +405,7 @@ conf = {{{packageName}}}.Configuration(
"""Debug switch
"""

self.verify_ssl = True
self.verify_ssl = verify_ssl
"""SSL/TLS verification
Set this to false to skip verifying SSL certificate when calling API
from https server.
Expand All @@ -400,54 +423,51 @@ conf = {{{packageName}}}.Configuration(
self.key_file = key_file
"""client key file
"""
self.assert_hostname = None
self.assert_hostname = assert_hostname
"""Set this to True/False to enable/disable SSL hostname verification.
"""
self.tls_server_name = None
self.tls_server_name = tls_server_name
"""SSL/TLS Server Name Indication (SNI)
Set this to the SNI value expected by the server.
"""

{{#async}}
self.connection_pool_maxsize = 100
self.connection_pool_maxsize = connection_pool_maxsize if connection_pool_maxsize is not None else 100
"""This value is passed to the aiohttp to limit simultaneous connections.
Default values is 100, None means no-limit.
None in the constructor is coerced to default 100.
"""
{{/async}}
{{^async}}
self.connection_pool_maxsize = multiprocessing.cpu_count() * 5
self.connection_pool_maxsize = connection_pool_maxsize if connection_pool_maxsize is not None else multiprocessing.cpu_count() * 5
"""urllib3 connection pool's maximum number of connections saved
per pool. urllib3 uses 1 connection as default value, but this is
not the best value when you are making a lot of possibly parallel
requests to the same host, which is often the case here.
cpu_count * 5 is used as default value to increase performance.
per pool. None in the constructor is coerced to cpu_count * 5.
"""
{{/async}}

self.proxy: Optional[str] = None
self.proxy = proxy
"""Proxy URL
"""
self.proxy_headers = None
self.proxy_headers = proxy_headers
"""Proxy headers
"""
self.safe_chars_for_path_param = ''
self.safe_chars_for_path_param = safe_chars_for_path_param
"""Safe chars for path_param
"""
self.retries = retries
"""Retry configuration
"""
# Enable client side validation
self.client_side_validation = True
self.client_side_validation = client_side_validation

self.socket_options = None
self.socket_options = socket_options
"""Options to pass down to the underlying urllib3 socket
"""

self.datetime_format = "{{{datetimeFormat}}}"
self.datetime_format = datetime_format
"""datetime format
"""

self.date_format = "{{{dateFormat}}}"
self.date_format = date_format
"""date format
"""

Expand Down
50 changes: 35 additions & 15 deletions .../echo_api/python-disallowAdditionalPropertiesIfNotPresent/openapi_client/configuration.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -158,13 +158,25 @@ class Configuration:
string values to replace variables in templated server configuration.
The validation of enums is performed for variables with defined enum
values before.
:param verify_ssl: bool - Set this to false to skip verifying SSL certificate
when calling API from https server.
:param ssl_ca_cert: str - the path to a file of concatenated CA certificates
in PEM format.
:param retries: int | urllib3.util.retry.Retry - Retry configuration.
:param ca_cert_data: verify the peer using concatenated CA certificate data
in PEM (str) or DER (bytes) format.
:param cert_file: the path to a client certificate file, for mTLS.
:param key_file: the path to a client key file, for mTLS.
:param assert_hostname: Set this to True/False to enable/disable SSL hostname verification.
:param tls_server_name: SSL/TLS Server Name Indication (SNI). Set this to the SNI value expected by the server.
:param connection_pool_maxsize: Connection pool max size. None in the constructor is coerced to 100 for async and cpu_count * 5 for sync.
:param proxy: Proxy URL.
:param proxy_headers: Proxy headers.
:param safe_chars_for_path_param: Safe characters for path parameter encoding.
:param client_side_validation: Enable client-side validation. Default True.
:param socket_options: Options to pass down to the underlying urllib3 socket.
:param datetime_format: Datetime format string for serialization.
:param date_format: Date format string for serialization.

:Example:

Expand Down Expand Up @@ -205,6 +217,17 @@ def __init__(
ca_cert_data: Optional[Union[str, bytes]] = None,
cert_file: Optional[str]=None,
key_file: Optional[str]=None,
verify_ssl: bool=True,
assert_hostname: Optional[bool]=None,
tls_server_name: Optional[str]=None,
connection_pool_maxsize: Optional[int]=None,
proxy: Optional[str]=None,
proxy_headers: Optional[Any]=None,
safe_chars_for_path_param: str='',
client_side_validation: bool=True,
socket_options: Optional[Any]=None,
datetime_format: str="%Y-%m-%dT%H:%M:%S.%f%z",
date_format: str="%Y-%m-%d",
*,
debug: Optional[bool] = None,
) -> None:
Expand Down Expand Up @@ -274,7 +297,7 @@ def __init__(
"""Debug switch
"""

self.verify_ssl = True
self.verify_ssl = verify_ssl
"""SSL/TLS verification
Set this to false to skip verifying SSL certificate when calling API
from https server.
Expand All @@ -292,46 +315,43 @@ def __init__(
self.key_file = key_file
"""client key file
"""
self.assert_hostname = None
self.assert_hostname = assert_hostname
"""Set this to True/False to enable/disable SSL hostname verification.
"""
self.tls_server_name = None
self.tls_server_name = tls_server_name
"""SSL/TLS Server Name Indication (SNI)
Set this to the SNI value expected by the server.
"""

self.connection_pool_maxsize = multiprocessing.cpu_count() * 5
self.connection_pool_maxsize = connection_pool_maxsize if connection_pool_maxsize is not None else multiprocessing.cpu_count() * 5
"""urllib3 connection pool's maximum number of connections saved
per pool. urllib3 uses 1 connection as default value, but this is
not the best value when you are making a lot of possibly parallel
requests to the same host, which is often the case here.
cpu_count * 5 is used as default value to increase performance.
per pool. None in the constructor is coerced to cpu_count * 5.
"""

self.proxy: Optional[str] = None
self.proxy = proxy
"""Proxy URL
"""
self.proxy_headers = None
self.proxy_headers = proxy_headers
"""Proxy headers
"""
self.safe_chars_for_path_param = ''
self.safe_chars_for_path_param = safe_chars_for_path_param
"""Safe chars for path_param
"""
self.retries = retries
"""Retry configuration
"""
# Enable client side validation
self.client_side_validation = True
self.client_side_validation = client_side_validation

self.socket_options = None
self.socket_options = socket_options
"""Options to pass down to the underlying urllib3 socket
"""

self.datetime_format = "%Y-%m-%dT%H:%M:%S.%f%z"
self.datetime_format = datetime_format
"""datetime format
"""

self.date_format = "%Y-%m-%d"
self.date_format = date_format
"""date format
"""

Expand Down
19 changes: 17 additions & 2 deletions samples/client/echo_api/python-pydantic-v1/openapi_client/configuration.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,8 +51,23 @@ class Configuration:
string values to replace variables in templated server configuration.
Copy link
Copy Markdown
Contributor

@cubic-dev-ai cubic-dev-ai Bot Feb 20, 2026 •
edited
Loading

Choose a reason for hiding this comment

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

P2: Constructor no longer accepts documented configuration parameters and now hard-codes defaults, so passing documented kwargs (e.g., retries, proxy, formats) raises TypeError and prevents configuration at construction.

Prompt for AI agents 
Check if this issue is valid — if so, understand the root cause and fix it. At samples/client/echo_api/python-pydantic-v1/openapi_client/configuration.py, line 200:

<comment>Constructor no longer accepts documented configuration parameters and now hard-codes defaults, so passing documented kwargs (e.g., retries, proxy, formats) raises TypeError and prevents configuration at construction.</comment>

<file context>
@@ -172,52 +166,52 @@ def __init__(self, host=None,
         """Safe chars for path_param
         """
-        self.retries = retries
+        self.retries = None
         """Adding retries to override urllib3 default value 3
         """
</file context>
Fix with Cubic

The validation of enums is performed for variables with defined enum
values before.
:param verify_ssl: bool - Set this to false to skip verifying SSL certificate
when calling API from https server.
:param ssl_ca_cert: str - the path to a file of concatenated CA certificates
in PEM format.
:param retries: Retry configuration (e.g. urllib3.util.retry.Retry).
:param cert_file: The path to a client certificate file, for mTLS.
:param key_file: The path to a client key file, for mTLS.
:param assert_hostname: Set this to True/False to enable/disable SSL hostname verification.
:param tls_server_name: SSL/TLS Server Name Indication (SNI). Set this to the SNI value expected by the server.
:param connection_pool_maxsize: Connection pool max size. Defaults to 100 for asyncio, cpu_count * 5 for sync.
:param proxy: Proxy URL.
:param proxy_headers: Proxy headers.
:param safe_chars_for_path_param: Safe characters for path parameter encoding.
:param client_side_validation: Enable client-side validation. Default True.
:param socket_options: Options to pass down to the underlying urllib3 socket.
:param datetime_format: Datetime format string for serialization.
:param date_format: Date format string for serialization.

:Example:

Expand Down Expand Up @@ -81,7 +96,7 @@ def __init__(self, host=None,
access_token=None,
server_index=None, server_variables=None,
server_operation_index=None, server_operation_variables=None,
ssl_ca_cert=None,
ssl_ca_cert=None, verify_ssl=True,
Copy link
Copy Markdown
Contributor

@cubic-dev-ai cubic-dev-ai Bot Feb 21, 2026 •
edited
Loading

Choose a reason for hiding this comment

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

P2: Swapping ssl_ca_cert and verify_ssl in the constructor breaks positional-argument callers and can silently change SSL verification behavior (e.g., disabling verification no longer works). This is a backward-incompatible change to a public API.

Prompt for AI agents 
Check if this issue is valid — if so, understand the root cause and fix it. At samples/client/echo_api/python-pydantic-v1/openapi_client/configuration.py, line 99:

<comment>Swapping `ssl_ca_cert` and `verify_ssl` in the constructor breaks positional-argument callers and can silently change SSL verification behavior (e.g., disabling verification no longer works). This is a backward-incompatible change to a public API.</comment>

<file context>
@@ -96,7 +96,7 @@ def __init__(self, host=None,
                  server_index=None, server_variables=None,
                  server_operation_index=None, server_operation_variables=None,
-                 verify_ssl=True, ssl_ca_cert=None,
+                 ssl_ca_cert=None, verify_ssl=True,
                  ) -> None:
         """Constructor
</file context>
Fix with Cubic

) -> None:
"""Constructor
"""
Expand Down Expand Up @@ -143,7 +158,7 @@ def __init__(self, host=None,
"""Debug switch
"""

self.verify_ssl = True
self.verify_ssl = verify_ssl
"""SSL/TLS verification
Set this to false to skip verifying SSL certificate when calling API
from https server.
Expand Down
Loading
Loading