fix(python): exclude unset API values on model dump (#3777)

Author: shortcuts

config/generation.config.mjs

@@ -119,7 +119,6 @@ export const patterns = [
   'clients/algoliasearch-client-python/requirements.txt',
   'clients/algoliasearch-client-python/.gitignore',
 
-  'tests/output/python/requirements.txt',
   'tests/output/python/poetry.lock',
   '!tests/output/python/**/__init__.py',
 

playground/python/app/search.py

@@ -1,7 +1,12 @@
 from asyncio import run
 from os import environ
+from base64 import b64decode
 
 from algoliasearch.search.client import SearchClient
+from algoliasearch.search.models.search_params_object import SearchParamsObject
+from algoliasearch.search.models.secured_api_key_restrictions import (
+    SecuredApiKeyRestrictions,
+)
 from algoliasearch.search import __version__
 from dotenv import load_dotenv
 
@@ -17,9 +22,19 @@ async def main():
     print("client initialized", client)
 
     try:
-        await client.browse_objects(
-            index_name="api-clients-automation",
-            aggregator=lambda _resp: print("baaaaaaaaaaaaaaar", _resp.to_json()),
+        # resp = await client.search(search_method_params={
+        #   "requests": [{"indexName": "api-clients-automation"}]
+        # })
+        # print(resp.to_dict())
+        print(
+            b64decode(await client.generate_secured_api_key(
+                "foo",
+                SecuredApiKeyRestrictions(
+                    restrictIndices=["foo"],
+                    filters="bar",
+                    searchParams=SearchParamsObject(attributesToRetrieve=["baz"]),
+                ),
+            ))
         )
     finally:
         await client.close()

playground/python/poetry.lock

@@ -9,7 +9,7 @@ homepage = "https://www.algolia.com"
 repository = "https://github.com/algolia/api-clients-automation"
 
 [tool.poetry.dependencies]
-python = "^3.8.1"
+python = ">= 3.8.1"
 algoliasearch = { path = "../../clients/algoliasearch-client-python", develop = true }
 ruff = "== 0.6.4"
 python-dotenv = "== 1.0.1"

playground/python/pyproject.toml

@@ -2,5 +2,5 @@ argcomplete==3.5.0
 click==8.1.7
 packaging==24.1
 pipx==1.7.1
-platformdirs==4.3.3
+platformdirs==4.2.2
 userpath==1.9.2

playground/python/requirements.txt

@@ -51,7 +51,7 @@ export async function formatter(language: string, cwd: string): Promise<void> {
       break;
     case 'python':
       await run(
-        'poetry lock --no-update && poetry install --sync && pip freeze > requirements.txt && poetry run ruff check --fix && poetry run ruff format',
+        'poetry lock --no-update && poetry install --sync && pip freeze > requirements.txt && poetry run ruff check --fix --unsafe-fixes && poetry run ruff format',
         { cwd, language },
       );
       break;

scripts/formatter.ts

@@ -124,6 +124,7 @@ class {{classname}}({{#parent}}{{{.}}}{{/parent}}{{^parent}}BaseModel{{/parent}}
                 {{/isAdditionalPropertiesTrue}}
             },
             exclude_none=True,
+            exclude_unset=True,
         )
         {{#allVars}}
         {{#isContainer}}
@@ -329,4 +330,4 @@ class {{classname}}({{#parent}}{{{.}}}{{/parent}}{{^parent}}BaseModel{{/parent}}
 
         {{/isAdditionalPropertiesTrue}}
         return _obj
-        {{/hasChildren}}
+        {{/hasChildren}}