Skip to content
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.

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

[PYTHON] use customized default Configuration() objects if available #8500

Merged
merged 1 commit into from
Jan 30, 2021

Conversation

adpoliak
Copy link
Contributor

To be reviewed by the Python Technical Committee:
@taxpon @frol @mbohlool @cbornet @kenjones-cisco @tomplus @Jyhess @arun-nalla @spacether

For the Python variants, the generated PACKAGENAME.configuration.Configuration class allows the programmer to save the data from pre-configured instance of it as the default to be used for future instances.
However, this requires the classes to be instantiated using Configuration.get_default_copy(), rather than just Configuration().
This PR changes the templates/samples to use the Configuration.get_default_copy() wherever a naked Configuration() was found.
This has the effect of making the programmer's stored Configuration be used (such as to override the client-side verification setting), if the programmer set one, and the hard-coded defaults used otherwise.

Related Issue: #8499

PR checklist

  • Read the contribution guidelines.
  • Pull Request title clearly describes the work in the pull request and Pull Request description provides details about how to validate the work. Missing information here may result in delayed response from the community.
  • Run the following to build the project and update samples:
    ./mvnw clean package 
    ./bin/generate-samples.sh
    ./bin/utils/export_docs_generators.sh
    
    Commit all changed files.
    This is important, as CI jobs will verify all generator outputs of your HEAD commit as it would merge with master.
    These must match the expectations made by your contribution.
    You may regenerate an individual generator by passing the relevant config(s) as an argument to the script, for example ./bin/generate-samples.sh bin/configs/java*.
    For Windows users, please run the script in Git BASH.
  • File the PR against the correct branch: master, 5.1.x, 6.0.x
  • If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.

@@ -63,7 +63,7 @@ class AdditionalPropertiesClass(object):
def __init__(self, map_string=None, map_number=None, map_integer=None, map_boolean=None, map_array_integer=None, map_array_anytype=None, map_map_string=None, map_map_anytype=None, anytype_1=None, anytype_2=None, anytype_3=None, local_vars_configuration=None): # noqa: E501
"""AdditionalPropertiesClass - a model defined in OpenAPI""" # noqa: E501
if local_vars_configuration is None:
local_vars_configuration = Configuration()
local_vars_configuration = Configuration.get_default_copy()
Copy link
Contributor

Choose a reason for hiding this comment

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

Why not pass in local_vars_configuration=Configuration.get_default_copy()?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Because the generated code leaves no place to manually instantiate the classes--they are instantiated as part of data returned from API calls.
Using the example in the related issue, I only instantiate the generated ApiClient, and MembersApi classes, passing in the configuration object as designed to ApiClient, then setting options on the instantiated objects, but the only way to toggle the "client_side_validation" value was to force the use of the stored default by means of this patch.

@spacether spacether added this to the 5.0.1 milestone Jan 30, 2021
Copy link
Contributor

@spacether spacether left a comment

Choose a reason for hiding this comment

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

Looks good to me, thank you for your PR!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants