fix(python): template cleanup and playgrounds (#2286)

Author: shortcuts

.github/actions/restore-artifacts/action.yml

@@ -27,6 +27,9 @@ inputs:
   dart:
     description: Whether this job ran or not
     required: false     
+  python:
+    description: Whether this job ran or not
+    required: false     
 
 runs:
   using: composite

.gitignore

@@ -37,3 +37,6 @@ generators/bin
 .dart_tool/
 .packages
 pubspec.lock
+
+# Python
+**/__pycache__

clients/algoliasearch-client-python/algoliasearch/.gitignore

@@ -0,0 +1,44 @@
+[metadata]
+name = algoliasearch
+version = attr: algoliasearch.__version__
+url = https://github.com/algolia/algoliasearch-client-python
+project_urls =
+  CI: GitHub Actions = https://github.com/algolia/api-clients-automation/actions
+  Docs = https://algolia.com/docs
+  GitHub: issues = https://github.com/algolia/algoliasearch-client-python/issues
+  GitHub: repo = https://github.com/algolia/algoliasearch-client-python/issues
+description = ⚡️ A fully-featured and blazing-fast Python API client to interact with Algolia.
+long_description = file: README.md
+long_description_content_type = textmarkdown
+maintainer = support team <[email protected]>
+maintainer_email = [email protected]
+license = MIT
+license_files = LICENSE
+keywords = algolia, py, search, backend, hosted, cloud, full-text search, faceted search
+platform = any
+classifiers =
+    Intended Audience :: Developers
+    License :: OSI Approved :: MIT License
+    Operating System :: OS Independent
+    Programming Language :: Python
+    Programming Language :: Python :: 3.8
+    Programming Language :: Python :: 3.9
+    Programming Language :: Python :: 3.10
+    Programming Language :: Python :: 3.11
+    Programming Language :: Python :: 3.12
+    Topic :: Internet
+    Topic :: Internet :: WWW/HTTP
+    Topic :: Internet :: WWW/HTTP :: Indexing/Search
+    Development Status :: 5 - Production/Stable
+
+[options]
+zip_safe = True
+include_package_data = True
+packages = find:
+install_requires =
+    urllib3>=1.25.3,<2.0
+    aiohttp>=3.9.0,<4.0
+    python-dateutil>=2.8.2,<3.0
+    pydantic>=2,3.0
+    typing-extensions>=4.7.1,<5.0
+python_requires = >= 3.8

clients/algoliasearch-client-python/setup.cfg

@@ -0,0 +1,4 @@
+import sys
+
+if sys.version_info < (3, 8):
+    raise RuntimeError("algoliasearch 4.x requires Python 3.8+")

clients/algoliasearch-client-python/setup.py

@@ -1 +1 @@
-3.12.0
+3.11.6

config/.python-version

@@ -80,5 +80,8 @@ export const patterns = [
   // Python
   'clients/algoliasearch-client-python/**',
   '!clients/algoliasearch-client-python/*',
-  '!clients/algoliasearch-client-python/algoliasearch/*/__init__.py',
+  'clients/algoliasearch-client-python/pyproject.toml',
+  'clients/algoliasearch-client-python/poetry.lock',
+  'clients/algoliasearch-client-python/requirements.txt',
+  'clients/algoliasearch-client-python/.gitignore',
 ];

config/generation.config.mjs

@@ -5,26 +5,31 @@
 import org.openapitools.codegen.*;
 import org.openapitools.codegen.CodegenConstants;
 import org.openapitools.codegen.languages.PythonClientCodegen;
+import org.openapitools.codegen.model.ModelMap;
+import org.openapitools.codegen.model.OperationsMap;
 
 public class AlgoliaPythonGenerator extends PythonClientCodegen {
 
+  private String CLIENT;
+
   @Override
   public String getName() {
     return "algolia-python";
   }
 
   @Override
   public void processOpts() {
-    String client = (String) additionalProperties.get("client");
+    CLIENT = (String) additionalProperties.get("client");
 
-    additionalProperties.put("isSearchClient", client.equals("search"));
+    additionalProperties.put("isSearchClient", CLIENT.equals("search"));
     additionalProperties.put("packageVersion", Utils.getClientConfigField("python", "packageVersion"));
     additionalProperties.put(CodegenConstants.EXCLUDE_TESTS, true);
 
     setApiNameSuffix(Utils.API_SUFFIX);
 
-    setPackageName(Utils.toSnakeCase(client));
-    setApiPackage("api");
+    String packageName = Utils.toSnakeCase(CLIENT);
+    setPackageName(packageName);
+    setApiPackage("");
     setModelPackage("models");
 
     super.processOpts();
@@ -48,23 +53,57 @@ public void processOpts() {
       file.getTemplateFile().equals("setup.mustache") ||
       file.getTemplateFile().equals("pyproject.mustache") ||
       file.getTemplateFile().equals("py.typed.mustache") ||
-      file.getTemplateFile().equals("rest.mustache") ||
       file.getTemplateFile().equals("README.mustache") ||
       file.getTemplateFile().equals("api_test.mustache") ||
       file.getTemplateFile().equals("model_test.mustache") ||
       file.getTemplateFile().equals("github-workflow.mustache") ||
       file.getTemplateFile().equals("travis.mustache") ||
+      file.getTemplateFile().equals("__init__api.mustache") ||
       file.getTemplateFile().equals("gitlab-ci.mustache")
     );
 
     // repository
     supportingFiles.add(new SupportingFile("pyproject.mustache", "../", "pyproject.toml"));
+    supportingFiles.add(new SupportingFile("gitignore.mustache", "../", ".gitignore"));
+    supportingFiles.add(new SupportingFile("__init__.mustache", "", "__init__.py"));
 
     try {
-      Utils.generateServer(client, additionalProperties);
+      Utils.generateServer(CLIENT, additionalProperties);
     } catch (GeneratorException e) {
       e.printStackTrace();
       System.exit(1);
     }
   }
+
+  @Override
+  public String toApiFilename(String name) {
+    return "client";
+  }
+
+  @Override
+  public String toApiImport(String name) {
+    return super.toApiImport(name).replace("from ", "from algoliasearch.");
+  }
+
+  @Override
+  public String toModelImport(String name) {
+    return super.toModelImport(name).replace("from ", "from algoliasearch.");
+  }
+
+  // we need to override imports of all operations because somehow the methods `toModelImport` and
+  // `toApiImport` does not override the imports used in the API client file (client.py).
+  @Override
+  public OperationsMap postProcessOperationsWithModels(OperationsMap objs, List<ModelMap> models) {
+    OperationsMap operations = super.postProcessOperationsWithModels(objs, models);
+
+    List<Map<String, String>> imports = operations.getImports();
+
+    for (Map<String, String> imp : imports) {
+      imp.put("import", imp.get("import").replace("from " + CLIENT + ".", "from algoliasearch." + CLIENT + "."));
+    }
+
+    operations.setImports(imports);
+
+    return operations;
+  }
 }

generators/src/main/java/com/algolia/codegen/AlgoliaPythonGenerator.java

@@ -0,0 +1 @@
+The python playground