feat: update python sdk generator (#169)

* fix: not working renovate

* remove not customized python templates

* remove python version 3.8

* add readme for python templates

* upgrade generator and templates to v7.14.0 of the openapi-generator

* review finding

Co-authored-by: Alexander Dahmen <[email protected]>

Author: marceljk

.github/renovate.json

@@ -14,20 +14,20 @@
     "customManagers": [
         {
             "customType": "regex",
-            "fileMatch": [
-                "(^|\\/)generate-sdk\\.sh$"
+            "managerFilePatterns": [
+                "/(^|\\/)generate-sdk\\.sh$/"
             ],
             "matchStrings": [
-                "# Renovate: datasource=(?<datasource>.*?) depName=(?<depName>.*?) versioning=(?<versioning>.*?)?\\sGENERATOR_VERSION=\\\"?(?<currentValue>.*?)\\\"\\s"
+                "# Renovate: datasource=(?<datasource>.*?) depName=(?<depName>.*?) versioning=(?<versioning>.*?)?\\s+GENERATOR_VERSION=\"?(?<currentValue>.*?)\""
             ]
         },
         {
             "customType": "regex",
-            "fileMatch": [
-                "(^|\\/)go\\.mod\\.mustache$"
+            "managerFilePatterns": [
+                "/(^|\\/)go\\.mod\\.mustache$/"
             ],
             "matchStrings": [
-                "{{gitHost}}\\/{{gitUserId}}\\/{{gitRepoId}}\\/core ?(?<currentValue>.*?)\\s"
+                "github.com\/stackitcloud\/stackit-sdk-go\/core (?<currentValue>.*?)\\s"
             ],
             "datasourceTemplate": "go",
             "depNameTemplate": "github.com/stackitcloud/stackit-sdk-go",

.github/workflows/ci.yaml

@@ -79,7 +79,7 @@ jobs:
     strategy:
       matrix:
         os: [ubuntu-latest, macos-latest]
-        python-version: ["3.8", "3.9", "3.10", "3.11", "3.12", "3.13"]
+        python-version: ["3.9", "3.10", "3.11", "3.12", "3.13"]
     runs-on: ${{ matrix.os }}
     steps:
       - name: Install SSH Key

scripts/generate-sdk/generate-sdk.sh

@@ -57,7 +57,8 @@ go)
     GENERATOR_VERSION="v6.6.0" # There are issues with GO SDK generation in version v7
     ;;
 python)
-    GENERATOR_VERSION="v7.9.0"
+# Renovate: datasource=github-tags depName=OpenAPITools/openapi-generator versioning=semver
+    GENERATOR_VERSION="v7.14.0"
     ;;
 *)
     echo "SDK language not supported."
@@ -90,8 +91,8 @@ python)
     echo -e "\n>> Generating the Python SDK..."
 
     source ${LANGUAGE_GENERATORS_FOLDER_PATH}/${LANGUAGE}.sh
-    # Usage: generate_python_sdk GENERATOR_PATH GIT_HOST GIT_USER_ID [GIT_REPO_ID] [SDK_REPO_URL]
-    generate_python_sdk ${jar_path} ${GIT_HOST} ${GIT_USER_ID} ${GIT_REPO_ID} ${SDK_REPO_URL}
+    # Usage: generate_python_sdk GENERATOR_PATH GIT_HOST GIT_USER_ID [GIT_REPO_ID] [SDK_REPO_URL] [SDK_BRANCH]
+    generate_python_sdk "${jar_path}" "${GIT_HOST}" "${GIT_USER_ID}" "${GIT_REPO_ID}" "${SDK_REPO_URL}" "${SDK_BRANCH}"
     ;;
 *)
     echo "! SDK language not supported."

scripts/generate-sdk/languages/python.sh

@@ -21,6 +21,7 @@ generate_python_sdk() {
     # Optional parameters
     local GIT_REPO_ID=$4
     local SDK_REPO_URL=$5
+    local SDK_BRANCH=$6
 
     # Check required parameters
     if [[ -z ${GIT_HOST} ]]; then
@@ -54,7 +55,7 @@ generate_python_sdk() {
         echo "Old SDK repo clone was found, it will be removed."
         rm -rf ${SDK_REPO_LOCAL_PATH}
     fi
-    git clone --quiet ${SDK_REPO_URL} ${SDK_REPO_LOCAL_PATH}
+    git clone --quiet -b ${SDK_BRANCH} ${SDK_REPO_URL} ${SDK_REPO_LOCAL_PATH}
 
     # Install SDK project tools
     cd ${ROOT_DIR}

templates/python/README.md

@@ -0,0 +1,14 @@
+# Python templates
+
+This folder contains only our customized python templates. Beside these customized templates,
+the original templates of openapi-generator for python are used. These can be found in the 
+official GitHub repo of the [openapi-generator](https://github.com/OpenAPITools/openapi-generator/tree/v7.14.0/modules/openapi-generator/src/main/resources/python).
+
+If you need to change something in the Python Generator, try always first to add
+[user-defined templates](https://openapi-generator.tech/docs/customization#user-defined-templates),
+instead of overwriting existing templates. These ensure an easier upgrade process, to newer
+versions of the openapi-generator.
+
+If it's required to customize the original templates, you can copy them into this directory.  
+Try to minimize the customization as much as possible, to ensure, that we can easily upgrade
+to newer versions in the future.  

templates/python/README_onlypackage.mustache

@@ -6,27 +6,44 @@
 
 __version__ = "{{packageVersion}}"
 
+# Define package exports
+__all__ = [
+    {{#apiInfo}}{{#apis}}"{{classname}}",
+    {{/apis}}{{/apiInfo}}"ApiResponse",
+    "ApiClient",
+    "HostConfiguration",
+    "OpenApiException",
+    "ApiTypeError",
+    "ApiValueError",
+    "ApiKeyError",
+    "ApiAttributeError",
+    "ApiException",
+    {{#hasHttpSignatureMethods}}"HttpSigningConfiguration",
+    {{/hasHttpSignatureMethods}}{{#models}}{{#model}}"{{classname}}"{{^-last}},
+    {{/-last}}{{#-last}},{{/-last}}{{/model}}{{/models}}
+]
+
 # import apis into sdk package
-{{#apiInfo}}{{#apis}}from {{apiPackage}}.{{classFilename}} import {{classname}}
+{{#apiInfo}}{{#apis}}from {{apiPackage}}.{{classFilename}} import {{classname}} as {{classname}}
 {{/apis}}{{/apiInfo}}
 # import ApiClient
-from {{packageName}}.api_response import ApiResponse
-from {{packageName}}.api_client import ApiClient
-from {{packageName}}.configuration import HostConfiguration
-from {{packageName}}.exceptions import OpenApiException
-from {{packageName}}.exceptions import ApiTypeError
-from {{packageName}}.exceptions import ApiValueError
-from {{packageName}}.exceptions import ApiKeyError
-from {{packageName}}.exceptions import ApiAttributeError
-from {{packageName}}.exceptions import ApiException
+from {{packageName}}.api_response import ApiResponse as ApiResponse
+from {{packageName}}.api_client import ApiClient as ApiClient
+from {{packageName}}.configuration import HostConfiguration as HostConfiguration
+from {{packageName}}.exceptions import OpenApiException as OpenApiException
+from {{packageName}}.exceptions import ApiTypeError as ApiTypeError
+from {{packageName}}.exceptions import ApiValueError as ApiValueError
+from {{packageName}}.exceptions import ApiKeyError as ApiKeyError
+from {{packageName}}.exceptions import ApiAttributeError as ApiAttributeError
+from {{packageName}}.exceptions import ApiException as ApiException
 {{#hasHttpSignatureMethods}}
-from {{packageName}}.signing import HttpSigningConfiguration
+from {{packageName}}.signing import HttpSigningConfiguration as HttpSigningConfiguration
 {{/hasHttpSignatureMethods}}
 
 # import models into sdk package
 {{#models}}
 {{#model}}
-from {{modelPackage}}.{{classFilename}} import {{classname}}
+from {{modelPackage}}.{{classFilename}} import {{classname}} as {{classname}}
 {{/model}}
 {{/models}}
 {{#recursionLimit}}