[REQ] Clarifications regarding the new default python generator vs "python-legacy"

[anichari]

Is your feature request related to a problem? Please describe.

We actively use the python client codegen at our company and the recent change (probably #7965) is causing some anomalous behaviors. I tried to look in the docs to help understand the change/migration path from legacy to current python codegen but could not find much.

The behavior changes we have seen so far and would like to get a workaround/solution for.

1. model package directory has changes from being "models" in the legacy version to "model" and api package renamed to "apis"
2. The legacy client codegen's model test mustaches seem to have a make_instance that tries to create an Instance of the given model under test using example values. This code seems to be missing in the current version of the python Codegen Client.

Describe the solution you'd like

Ability to control the api and model package location so that we can continue to use what we have currently
Generate model tests that instantiate models using example values

Describe alternatives you've considered

falling back to python-legacy, although we dont know how long that will be supported

Additional context

[wing328]

python-legacy works with both python2 and python3 while the latest python (refactored) generator only works with python3.

model package directory has changes from being "models" in the legacy version to "model" and api package renamed to "apis"

The only solution I see is to introduce 2 options to customize the api and model folder names. Is that what you've in mind as well?

The legacy client codegen's model test mustaches seem to have a make_instance that tries to create an Instance of the given model under test using example values. This code seems to be missing in the current version of the python Codegen Client.

We welcome PRs to add it back to the latest python generator/templates

cc @taxpon (2017/07) @frol (2017/07) @mbohlool (2017/07) @cbornet (2017/09) @kenjones-cisco (2017/11) @tomplus (2018/10) @Jyhess (2019/01) @arun-nalla (2019/11) @spacether (2019/11)

[anichari]

The only solution I see is to introduce 2 options to customize the api and model folder names. Is that what you've in mind as well?

Yes this is what I was thinking too.

We welcome PRs to add it back to the latest python generator/templates

I will try come up with working templates and submit a PR.

Hi @anichari and @wing328,

We have some questions about this change too.
Indeed, there was a PR that allow to set auth settings per request instead of per client. (See : #6569)

This was very interesting for us as our credentials change for each call (which are executed in parallel) and we don't know how to pass this credential to ApiClient without changing the whole configuration (which is not thread safe).

Is there an other way to have these auth settings per request with this new python codegen architecture ?

Yours faithfully,
LCDP

[wing328]

Is there an other way to have these auth settings per request with this new python codegen architecture ?

Some other client generators allow the auto-generated clients to set a default header via ApiClient or Configuration Object.

Would "default header" meet your requirement?

Would "default header" meet your requirement?

Sadly if we put the one-call credential in "Configuration" it will not be thread safe because there is only one instance of "ApiClient" and "Configuration".
Thus, parallel call of configuration.auth=/ apiClient.{call} will result in "random" access token used.

A workaround would be to create one couple ApiClient / Configuration per HTTP call but it will be very inefficient as a new ThreadPool will be created for each call.

[spacether]

model package directory has changes from being "models" in the legacy version to "model" and api package renamed to "apis"

apis and models still work as imports, why not use those?

[anichari]

Hi, yes, I can confirm that the imports still work with models and api. Regards Ani

…

On Mon, Aug 16, 2021 at 8:56 AM Justin Black ***@***.***> wrote: model package directory has changes from being "models" in the legacy version to "model" and api package renamed to "apis" apis and models still work as imports, why not use those? — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#9993 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/ABILQ74VENMH35JQT5BIEL3T5EYK7ANCNFSM5AWS2O5A> . Triage notifications on the go with GitHub Mobile for iOS <https://apps.apple.com/app/apple-store/id1477376905?ct=notification-email&mt=8&pt=524675> or Android <https://play.google.com/store/apps/details?id=com.github.android&utm_campaign=notification-email> .

-- Anirudh Chari How important is anything we do? In the cosmic sense... Probably NIL!! - Calvin and Hobbes

[anichari]

w.r.t modelTests, I have the mustache template ready but I'm having some difficulty trying to get the examples to generate correctly. Can anyone help me with that? Git blame shows @wing328 (William) is the main contributor to the toExampleRecursive function in the Codegen. Will, can you please help? Regards Ani On Wed, Aug 18, 2021 at 3:45 PM Anirudh Chari ***@***.***> wrote:

…

Hi, yes, I can confirm that the imports still work with models and api. Regards Ani On Mon, Aug 16, 2021 at 8:56 AM Justin Black ***@***.***> wrote: > model package directory has changes from being "models" in the legacy > version to "model" and api package renamed to "apis" > > apis and models still work as imports, why not use those? > > — > You are receiving this because you were mentioned. > Reply to this email directly, view it on GitHub > <#9993 (comment)>, > or unsubscribe > <https://github.com/notifications/unsubscribe-auth/ABILQ74VENMH35JQT5BIEL3T5EYK7ANCNFSM5AWS2O5A> > . > Triage notifications on the go with GitHub Mobile for iOS > <https://apps.apple.com/app/apple-store/id1477376905?ct=notification-email&mt=8&pt=524675> > or Android > <https://play.google.com/store/apps/details?id=com.github.android&utm_campaign=notification-email> > . > -- Anirudh Chari How important is anything we do? In the cosmic sense... Probably NIL!! - Calvin and Hobbes

-- Anirudh Chari How important is anything we do? In the cosmic sense... Probably NIL!! - Calvin and Hobbes

[spacether]

The model tests were left out of python-experimental initially because it is unclear how to generate a sample payload when multiple composed schemas must match it. Model tests will fail because if a property is of type composed schema or a model is of type composed schema, it's unclear what the sample payload should be. How are the examples failing to generate?

[anichari]

Thanks @spacether for your response.

I see, so how do I verify that the mustache template that I modified from python-legacy works/breaks with composed schemas? The Builds and tests are passing but I do not know if that is sufficient.

Also, w.r.t the examples, I have a model that has an enum array property and this property's example generated seems to be not handled correctly in the generator code. Instead of picking the first available enum value and creating an array of len(1), it creates an array of len(1) with the element "string_example". I hope that clarifies the anomalous behavior for example generation.

I tried to follow breadcrumbs in the code for python-legacy codegen vs python-experimental (or the new python) and it seems that for python-legacy the array of enum example generation works correctly but not for the exp version. I am stuck trying to figure out why.

[spacether]

I see, so how do I verify that the mustache template that I modified from python-legacy works/breaks with composed schemas? The Builds and tests are passing but I do not know if that is sufficient.

Are you just setting example values or are you generating model tests with those values? If you are generating model tests with those values, the way to verify it is to run all the generated tests and see if the composed schema test passes, or see if tests pass for an object schema that has a property that is composed.

I am stuck trying to figure out why.

Want to pair program on this? I can be reached on our slack https://join.slack.com/t/openapi-generator/shared_invite/enQtNzAyNDMyOTU0OTE1LTY5ZDBiNDI5NzI5ZjQ1Y2E5OWVjMjZkYzY1ZGM2MWQ4YWFjMzcyNDY5MGI4NjQxNDBiMTlmZTc5NjY2ZTQ5MGM where my name is 'Justin Black'

[spacether]

@anichari what is the action that this ticket seeks?
Importing endpoints vial apis works, importing models via models works.
If you want the examples working better can you make a separate ticket or add comments to an existing ticket?
If I don't hear back in a week I will close this ticket.