avoid setting debug property if not needed (#18872)

* avoid setting debug property if not needed * update samples * fix compatibility with python 3.7 * always set Configuration.__debug * update samples * check `Configuration` behavior when debug parameter is / is not set * address PR requests
OpenAPITools · Jun 20, 2024 · e5ae07c · e5ae07c
1 parent 7747cc9
commit e5ae07c
Show file tree

Hide file tree

Showing 6 changed files with 39 additions and 5 deletions.
diff --git a/modules/openapi-generator/src/main/resources/python/configuration.mustache b/modules/openapi-generator/src/main/resources/python/configuration.mustache
@@ -150,6 +150,8 @@ conf = {{{packageName}}}.Configuration(
                  server_operation_index=None, server_operation_variables=None,
                  ssl_ca_cert=None,
                  retries=None,
+                 *,
+                 debug: Optional[bool] = None
                  ) -> None:
         """Constructor
         """
@@ -214,7 +216,10 @@ conf = {{{packageName}}}.Configuration(
         self.logger_file = None
         """Debug file location
         """
-        self.debug = False
+        if debug is not None:
+            self.debug = debug
+        else:
+            self.__debug = False
         """Debug switch
         """
 

diff --git a/.../echo_api/python-disallowAdditionalPropertiesIfNotPresent/openapi_client/configuration.py b/.../echo_api/python-disallowAdditionalPropertiesIfNotPresent/openapi_client/configuration.py
@@ -86,6 +86,8 @@ def __init__(self, host=None,
                  server_operation_index=None, server_operation_variables=None,
                  ssl_ca_cert=None,
                  retries=None,
+                 *,
+                 debug: Optional[bool] = None
                  ) -> None:
         """Constructor
         """
@@ -143,7 +145,10 @@ def __init__(self, host=None,
         self.logger_file = None
         """Debug file location
         """
-        self.debug = False
+        if debug is not None:
+            self.debug = debug
+        else:
+            self.__debug = False
         """Debug switch
         """
 

diff --git a/samples/client/echo_api/python/openapi_client/configuration.py b/samples/client/echo_api/python/openapi_client/configuration.py
@@ -86,6 +86,8 @@ def __init__(self, host=None,
                  server_operation_index=None, server_operation_variables=None,
                  ssl_ca_cert=None,
                  retries=None,
+                 *,
+                 debug: Optional[bool] = None
                  ) -> None:
         """Constructor
         """
@@ -143,7 +145,10 @@ def __init__(self, host=None,
         self.logger_file = None
         """Debug file location
         """
-        self.debug = False
+        if debug is not None:
+            self.debug = debug
+        else:
+            self.__debug = False
         """Debug switch
         """
 

diff --git a/samples/openapi3/client/petstore/python-aiohttp/petstore_api/configuration.py b/samples/openapi3/client/petstore/python-aiohttp/petstore_api/configuration.py
@@ -145,6 +145,8 @@ def __init__(self, host=None,
                  server_operation_index=None, server_operation_variables=None,
                  ssl_ca_cert=None,
                  retries=None,
+                 *,
+                 debug: Optional[bool] = None
                  ) -> None:
         """Constructor
         """
@@ -207,7 +209,10 @@ def __init__(self, host=None,
         self.logger_file = None
         """Debug file location
         """
-        self.debug = False
+        if debug is not None:
+            self.debug = debug
+        else:
+            self.__debug = False
         """Debug switch
         """
 

diff --git a/samples/openapi3/client/petstore/python/petstore_api/configuration.py b/samples/openapi3/client/petstore/python/petstore_api/configuration.py
@@ -146,6 +146,8 @@ def __init__(self, host=None,
                  server_operation_index=None, server_operation_variables=None,
                  ssl_ca_cert=None,
                  retries=None,
+                 *,
+                 debug: Optional[bool] = None
                  ) -> None:
         """Constructor
         """
@@ -208,7 +210,10 @@ def __init__(self, host=None,
         self.logger_file = None
         """Debug file location
         """
-        self.debug = False
+        if debug is not None:
+            self.debug = debug
+        else:
+            self.__debug = False
         """Debug switch
         """
 

diff --git a/samples/openapi3/client/petstore/python/tests/test_configuration.py b/samples/openapi3/client/petstore/python/tests/test_configuration.py
@@ -76,5 +76,14 @@ def test_get_host_from_settings(self):
         self.assertEqual("http://petstore.swagger.io:8080/v2", self.config.get_host_from_settings(0, {'port': '8080'}))
         self.assertEqual("http://dev-petstore.swagger.io:8080/v2", self.config.get_host_from_settings(0, {'server': 'dev-petstore', 'port': '8080'}))
 
+    def testConfigurationDebug(self):
+        for debug, expected in [(True, True), (False, False), (None, False)]:
+            with self.subTest('expicitly passing debug parameter', debug=debug, expected=expected):
+                c = petstore_api.Configuration(debug=debug)
+                self.assertEqual(expected, c.debug)
+        with self.subTest('not passing debug parameter'):
+            c = petstore_api.Configuration()
+            self.assertFalse(c.debug)
+
 if __name__ == '__main__':
     unittest.main()