-
-
Notifications
You must be signed in to change notification settings - Fork 6.4k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Python client - fixes boolean enum use case (#9926)
* Adds boolean enum component and object property and tests of it * Regenerates samples * Passes needed locale argument to toUpperCase * Regenerates samples
- Loading branch information
Showing
13 changed files
with
416 additions
and
5 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
12 changes: 12 additions & 0 deletions
12
samples/openapi3/client/petstore/python/docs/BooleanEnum.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
# BooleanEnum | ||
|
||
|
||
## Properties | ||
Name | Type | Description | Notes | ||
------------ | ------------- | ------------- | ------------- | ||
**value** | **bool** | | defaults to True, must be one of [True, ] | ||
**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] | ||
|
||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
279 changes: 279 additions & 0 deletions
279
samples/openapi3/client/petstore/python/petstore_api/model/boolean_enum.py
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,279 @@ | ||
""" | ||
OpenAPI Petstore | ||
This spec is mainly for testing Petstore server and contains fake endpoints, models. Please do not use this for any other purpose. Special characters: \" \\ # noqa: E501 | ||
The version of the OpenAPI document: 1.0.0 | ||
Generated by: https://openapi-generator.tech | ||
""" | ||
|
||
|
||
import re # noqa: F401 | ||
import sys # noqa: F401 | ||
|
||
from petstore_api.model_utils import ( # noqa: F401 | ||
ApiTypeError, | ||
ModelComposed, | ||
ModelNormal, | ||
ModelSimple, | ||
cached_property, | ||
change_keys_js_to_python, | ||
convert_js_args_to_python_args, | ||
date, | ||
datetime, | ||
file_type, | ||
none_type, | ||
validate_get_composed_info, | ||
) | ||
from ..model_utils import OpenApiModel | ||
from petstore_api.exceptions import ApiAttributeError | ||
|
||
|
||
|
||
class BooleanEnum(ModelSimple): | ||
"""NOTE: This class is auto generated by OpenAPI Generator. | ||
Ref: https://openapi-generator.tech | ||
Do not edit the class manually. | ||
Attributes: | ||
allowed_values (dict): The key is the tuple path to the attribute | ||
and the for var_name this is (var_name,). The value is a dict | ||
with a capitalized key describing the allowed value and an allowed | ||
value. These dicts store the allowed enum values. | ||
validations (dict): The key is the tuple path to the attribute | ||
and the for var_name this is (var_name,). The value is a dict | ||
that stores validations for max_length, min_length, max_items, | ||
min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, | ||
inclusive_minimum, and regex. | ||
additional_properties_type (tuple): A tuple of classes accepted | ||
as additional properties values. | ||
""" | ||
|
||
allowed_values = { | ||
('value',): { | ||
'TRUE': True, | ||
}, | ||
} | ||
|
||
validations = { | ||
} | ||
|
||
@cached_property | ||
def additional_properties_type(): | ||
""" | ||
This must be a method because a model may have properties that are | ||
of type self, this must run after the class is loaded | ||
""" | ||
return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 | ||
|
||
_nullable = False | ||
|
||
@cached_property | ||
def openapi_types(): | ||
""" | ||
This must be a method because a model may have properties that are | ||
of type self, this must run after the class is loaded | ||
Returns | ||
openapi_types (dict): The key is attribute name | ||
and the value is attribute type. | ||
""" | ||
return { | ||
'value': (bool,), | ||
} | ||
|
||
@cached_property | ||
def discriminator(): | ||
return None | ||
|
||
|
||
attribute_map = {} | ||
|
||
read_only_vars = set() | ||
|
||
_composed_schemas = None | ||
|
||
required_properties = set([ | ||
'_data_store', | ||
'_check_type', | ||
'_spec_property_naming', | ||
'_path_to_item', | ||
'_configuration', | ||
'_visited_composed_classes', | ||
]) | ||
|
||
@convert_js_args_to_python_args | ||
def __init__(self, *args, **kwargs): | ||
"""BooleanEnum - a model defined in OpenAPI | ||
Note that value can be passed either in args or in kwargs, but not in both. | ||
Args: | ||
args[0] (bool): if omitted defaults to True, must be one of [True, ] # noqa: E501 | ||
Keyword Args: | ||
value (bool): if omitted defaults to True, must be one of [True, ] # noqa: E501 | ||
_check_type (bool): if True, values for parameters in openapi_types | ||
will be type checked and a TypeError will be | ||
raised if the wrong type is input. | ||
Defaults to True | ||
_path_to_item (tuple/list): This is a list of keys or values to | ||
drill down to the model in received_data | ||
when deserializing a response | ||
_spec_property_naming (bool): True if the variable names in the input data | ||
are serialized names, as specified in the OpenAPI document. | ||
False if the variable names in the input data | ||
are pythonic names, e.g. snake case (default) | ||
_configuration (Configuration): the instance to use when | ||
deserializing a file_type parameter. | ||
If passed, type conversion is attempted | ||
If omitted no type conversion is done. | ||
_visited_composed_classes (tuple): This stores a tuple of | ||
classes that we have traveled through so that | ||
if we see that class again we will not use its | ||
discriminator again. | ||
When traveling through a discriminator, the | ||
composed schema that is | ||
is traveled through is added to this set. | ||
For example if Animal has a discriminator | ||
petType and we pass in "Dog", and the class Dog | ||
allOf includes Animal, we move through Animal | ||
once using the discriminator, and pick Dog. | ||
Then in Dog, we will make an instance of the | ||
Animal class but this time we won't travel | ||
through its discriminator because we passed in | ||
_visited_composed_classes = (Animal,) | ||
""" | ||
# required up here when default value is not given | ||
_path_to_item = kwargs.pop('_path_to_item', ()) | ||
|
||
if 'value' in kwargs: | ||
value = kwargs.pop('value') | ||
elif args: | ||
args = list(args) | ||
value = args.pop(0) | ||
else: | ||
value = True | ||
|
||
_check_type = kwargs.pop('_check_type', True) | ||
_spec_property_naming = kwargs.pop('_spec_property_naming', False) | ||
_configuration = kwargs.pop('_configuration', None) | ||
_visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) | ||
|
||
if args: | ||
raise ApiTypeError( | ||
"Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( | ||
args, | ||
self.__class__.__name__, | ||
), | ||
path_to_item=_path_to_item, | ||
valid_classes=(self.__class__,), | ||
) | ||
|
||
self._data_store = {} | ||
self._check_type = _check_type | ||
self._spec_property_naming = _spec_property_naming | ||
self._path_to_item = _path_to_item | ||
self._configuration = _configuration | ||
self._visited_composed_classes = _visited_composed_classes + (self.__class__,) | ||
self.value = value | ||
if kwargs: | ||
raise ApiTypeError( | ||
"Invalid named arguments=%s passed to %s. Remove those invalid named arguments." % ( | ||
kwargs, | ||
self.__class__.__name__, | ||
), | ||
path_to_item=_path_to_item, | ||
valid_classes=(self.__class__,), | ||
) | ||
|
||
@classmethod | ||
@convert_js_args_to_python_args | ||
def _from_openapi_data(cls, *args, **kwargs): | ||
"""BooleanEnum - a model defined in OpenAPI | ||
Note that value can be passed either in args or in kwargs, but not in both. | ||
Args: | ||
args[0] (bool): if omitted defaults to True, must be one of [True, ] # noqa: E501 | ||
Keyword Args: | ||
value (bool): if omitted defaults to True, must be one of [True, ] # noqa: E501 | ||
_check_type (bool): if True, values for parameters in openapi_types | ||
will be type checked and a TypeError will be | ||
raised if the wrong type is input. | ||
Defaults to True | ||
_path_to_item (tuple/list): This is a list of keys or values to | ||
drill down to the model in received_data | ||
when deserializing a response | ||
_spec_property_naming (bool): True if the variable names in the input data | ||
are serialized names, as specified in the OpenAPI document. | ||
False if the variable names in the input data | ||
are pythonic names, e.g. snake case (default) | ||
_configuration (Configuration): the instance to use when | ||
deserializing a file_type parameter. | ||
If passed, type conversion is attempted | ||
If omitted no type conversion is done. | ||
_visited_composed_classes (tuple): This stores a tuple of | ||
classes that we have traveled through so that | ||
if we see that class again we will not use its | ||
discriminator again. | ||
When traveling through a discriminator, the | ||
composed schema that is | ||
is traveled through is added to this set. | ||
For example if Animal has a discriminator | ||
petType and we pass in "Dog", and the class Dog | ||
allOf includes Animal, we move through Animal | ||
once using the discriminator, and pick Dog. | ||
Then in Dog, we will make an instance of the | ||
Animal class but this time we won't travel | ||
through its discriminator because we passed in | ||
_visited_composed_classes = (Animal,) | ||
""" | ||
# required up here when default value is not given | ||
_path_to_item = kwargs.pop('_path_to_item', ()) | ||
|
||
self = super(OpenApiModel, cls).__new__(cls) | ||
|
||
if 'value' in kwargs: | ||
value = kwargs.pop('value') | ||
elif args: | ||
args = list(args) | ||
value = args.pop(0) | ||
else: | ||
value = True | ||
|
||
_check_type = kwargs.pop('_check_type', True) | ||
_spec_property_naming = kwargs.pop('_spec_property_naming', False) | ||
_configuration = kwargs.pop('_configuration', None) | ||
_visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) | ||
|
||
if args: | ||
raise ApiTypeError( | ||
"Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( | ||
args, | ||
self.__class__.__name__, | ||
), | ||
path_to_item=_path_to_item, | ||
valid_classes=(self.__class__,), | ||
) | ||
|
||
self._data_store = {} | ||
self._check_type = _check_type | ||
self._spec_property_naming = _spec_property_naming | ||
self._path_to_item = _path_to_item | ||
self._configuration = _configuration | ||
self._visited_composed_classes = _visited_composed_classes + (self.__class__,) | ||
self.value = value | ||
if kwargs: | ||
raise ApiTypeError( | ||
"Invalid named arguments=%s passed to %s. Remove those invalid named arguments." % ( | ||
kwargs, | ||
self.__class__.__name__, | ||
), | ||
path_to_item=_path_to_item, | ||
valid_classes=(self.__class__,), | ||
) | ||
|
||
return self |
Oops, something went wrong.