Skip to content

Python: Fix client generation #2797

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

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Python: Fix client generation #2797

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
1d2c9e5
Fix client generation
singhpk234 Oct 12, 2025
c2c2b28
Address feedback
singhpk234 Oct 13, 2025
c46ab2c
fix typo and address review feedback
singhpk234 Oct 13, 2025
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
16 changes: 11 additions & 5 deletions regtests/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -189,17 +189,23 @@ The client can be generated using two commands:
```shell
# generate the management api client
docker run --rm \
-v ${PWD}:/local openapitools/openapi-generator-cli generate \
-v ${PWD}:/local openapitools/openapi-generator-cli:v7.9.0 generate \
Copy link
Contributor

Choose a reason for hiding this comment

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

I think we could delete this part, now the python client will auto-generate all the client using the latest spec file upon build, so we do not need to run these manually anymore : )

Copy link
Contributor

@MonkeyCanCode MonkeyCanCode Oct 13, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

Yes. this happened with 7.13 (first breaking version as it needs 3.1.1). In this PR #2800, I bumped it to the latest working version. When running regtests via make, this will be done automatically (as part of polaris package install/build)

-i /local/spec/polaris-management-service.yml \
-g python \
-o /local/client/python --additional-properties=packageName=polaris.management --additional-properties=apiNamePrefix=polaris
-o /local/client/python \
--additional-properties=packageName=polaris.management \
--additional-properties=apiNamePrefix=polaris

# generate the iceberg rest client
# generate the Polaris catalog api client
docker run --rm \
-v ${PWD}:/local openapitools/openapi-generator-cli generate \
-v ${PWD}:/local openapitools/openapi-generator-cli:v7.9.0 generate \
-i /local/spec/polaris-catalog-service.yaml \
-g python \
-o /local/client/python --additional-properties=packageName=polaris.catalog --additional-properties=apiNameSuffix="" --additional-properties=apiNamePrefix=Iceberg
-o /local/client/python \
--additional-properties=packageName=polaris.catalog \
--additional-properties=apiNameSuffix="" \
--additional-properties=apiNamePrefix=Iceberg

```

Tests rely on Python 3.9 or higher. `pyenv` can be used to install a current version and mapped to the local directory
Expand Down