[python-nextgen] add support for StrictBytes (#15365)

* add strictbyte support in python-nextgen client

* update samples

* use union of strictbytes, strictstr for backward compatibility
This commit is contained in:
William Cheng
2023-05-01 10:51:22 +08:00
committed by GitHub
parent c7c5dd2673
commit 961980f284
42 changed files with 1028 additions and 55 deletions

View File

@@ -86,6 +86,7 @@ All URIs are relative to *http://localhost:3000*
Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*BodyApi* | [**test_binary_gif**](docs/BodyApi.md#test_binary_gif) | **POST** /binary/gif | Test binary (gif) response body
*BodyApi* | [**test_body_application_octetstream_binary**](docs/BodyApi.md#test_body_application_octetstream_binary) | **POST** /body/application/octetstream/binary | Test body parameter(s)
*BodyApi* | [**test_echo_body_free_form_object_response_string**](docs/BodyApi.md#test_echo_body_free_form_object_response_string) | **POST** /echo/body/FreeFormObject/response_string | Test free form object
*BodyApi* | [**test_echo_body_pet**](docs/BodyApi.md#test_echo_body_pet) | **POST** /echo/body/Pet | Test body parameter(s)
*BodyApi* | [**test_echo_body_pet_response_string**](docs/BodyApi.md#test_echo_body_pet_response_string) | **POST** /echo/body/Pet/response_string | Test empty response body

View File

@@ -5,6 +5,7 @@ All URIs are relative to *http://localhost:3000*
Method | HTTP request | Description
------------- | ------------- | -------------
[**test_binary_gif**](BodyApi.md#test_binary_gif) | **POST** /binary/gif | Test binary (gif) response body
[**test_body_application_octetstream_binary**](BodyApi.md#test_body_application_octetstream_binary) | **POST** /body/application/octetstream/binary | Test body parameter(s)
[**test_echo_body_free_form_object_response_string**](BodyApi.md#test_echo_body_free_form_object_response_string) | **POST** /echo/body/FreeFormObject/response_string | Test free form object
[**test_echo_body_pet**](BodyApi.md#test_echo_body_pet) | **POST** /echo/body/Pet | Test body parameter(s)
[**test_echo_body_pet_response_string**](BodyApi.md#test_echo_body_pet_response_string) | **POST** /echo/body/Pet/response_string | Test empty response body
@@ -72,6 +73,71 @@ No authorization required
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# **test_body_application_octetstream_binary**
> str test_body_application_octetstream_binary(body=body)
Test body parameter(s)
Test body parameter(s)
### Example
```python
import time
import os
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost:3000
# See configuration.py for a list of all supported configuration parameters.
configuration = openapi_client.Configuration(
host = "http://localhost:3000"
)
# Enter a context with an instance of the API client
with openapi_client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = openapi_client.BodyApi(api_client)
body = None # bytearray | (optional)
try:
# Test body parameter(s)
api_response = api_instance.test_body_application_octetstream_binary(body=body)
print("The response of BodyApi->test_body_application_octetstream_binary:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling BodyApi->test_body_application_octetstream_binary: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**body** | **bytearray**| | [optional]
### Return type
**str**
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: application/octet-stream
- **Accept**: text/plain
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Successful operation | - |
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# **test_echo_body_free_form_object_response_string**
> str test_echo_body_free_form_object_response_string(body=body)

View File

@@ -14,13 +14,14 @@
import re # noqa: F401
import io
from pydantic import validate_arguments, ValidationError
from typing_extensions import Annotated
from pydantic import Field
from pydantic import Field, StrictBytes, StrictStr
from typing import Any, Dict, Optional
from typing import Any, Dict, Optional, Union
from openapi_client.models.pet import Pet
from openapi_client.models.tag import Tag
@@ -176,6 +177,158 @@ class BodyApi(object):
collection_formats=_collection_formats,
_request_auth=_params.get('_request_auth'))
@validate_arguments
def test_body_application_octetstream_binary(self, body : Optional[Union[StrictBytes, StrictStr]] = None, **kwargs) -> str: # noqa: E501
"""Test body parameter(s) # noqa: E501
Test body parameter(s) # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.test_body_application_octetstream_binary(body, async_req=True)
>>> result = thread.get()
:param body:
:type body: bytearray
:param async_req: Whether to execute the request asynchronously.
:type async_req: bool, optional
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:type _preload_content: bool, optional
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: Returns the result object.
If the method is called asynchronously,
returns the request thread.
:rtype: str
"""
kwargs['_return_http_data_only'] = True
return self.test_body_application_octetstream_binary_with_http_info(body, **kwargs) # noqa: E501
@validate_arguments
def test_body_application_octetstream_binary_with_http_info(self, body : Optional[Union[StrictBytes, StrictStr]] = None, **kwargs): # noqa: E501
"""Test body parameter(s) # noqa: E501
Test body parameter(s) # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.test_body_application_octetstream_binary_with_http_info(body, async_req=True)
>>> result = thread.get()
:param body:
:type body: bytearray
:param async_req: Whether to execute the request asynchronously.
:type async_req: bool, optional
:param _return_http_data_only: response data without head status code
and headers
:type _return_http_data_only: bool, optional
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:type _preload_content: bool, optional
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:param _request_auth: set to override the auth_settings for an a single
request; this effectively ignores the authentication
in the spec for a single request.
:type _request_auth: dict, optional
:type _content_type: string, optional: force content-type for the request
:return: Returns the result object.
If the method is called asynchronously,
returns the request thread.
:rtype: tuple(str, status_code(int), headers(HTTPHeaderDict))
"""
_params = locals()
_all_params = [
'body'
]
_all_params.extend(
[
'async_req',
'_return_http_data_only',
'_preload_content',
'_request_timeout',
'_request_auth',
'_content_type',
'_headers'
]
)
# validate the arguments
for _key, _val in _params['kwargs'].items():
if _key not in _all_params:
raise ApiTypeError(
"Got an unexpected keyword argument '%s'"
" to method test_body_application_octetstream_binary" % _key
)
_params[_key] = _val
del _params['kwargs']
_collection_formats = {}
# process the path parameters
_path_params = {}
# process the query parameters
_query_params = []
# process the header parameters
_header_params = dict(_params.get('_headers', {}))
# process the form parameters
_form_params = []
_files = {}
# process the body parameter
_body_params = None
if _params['body'] is not None:
_body_params = _params['body']
# convert to byte array if the input is a file name (str)
if isinstance(_body_params, str):
with io.open(_body_params, "rb") as _fp:
_body_params_from_file = _fp.read()
_body_params = _body_params_from_file
# set the HTTP header `Accept`
_header_params['Accept'] = self.api_client.select_header_accept(
['text/plain']) # noqa: E501
# set the HTTP header `Content-Type`
_content_types_list = _params.get('_content_type',
self.api_client.select_header_content_type(
['application/octet-stream']))
if _content_types_list:
_header_params['Content-Type'] = _content_types_list
# authentication setting
_auth_settings = [] # noqa: E501
_response_types_map = {
'200': "str",
}
return self.api_client.call_api(
'/body/application/octetstream/binary', 'POST',
_path_params,
_query_params,
_header_params,
body=_body_params,
post_params=_form_params,
files=_files,
response_types_map=_response_types_map,
auth_settings=_auth_settings,
async_req=_params.get('async_req'),
_return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501
_preload_content=_params.get('_preload_content', True),
_request_timeout=_params.get('_request_timeout'),
collection_formats=_collection_formats,
_request_auth=_params.get('_request_auth'))
@validate_arguments
def test_echo_body_free_form_object_response_string(self, body : Annotated[Optional[Dict[str, Any]], Field(description="Free form object")] = None, **kwargs) -> str: # noqa: E501
"""Test free form object # noqa: E501

View File

@@ -14,6 +14,7 @@
import re # noqa: F401
import io
from pydantic import validate_arguments, ValidationError
from typing_extensions import Annotated

View File

@@ -14,6 +14,7 @@
import re # noqa: F401
import io
from pydantic import validate_arguments, ValidationError
from typing_extensions import Annotated

View File

@@ -14,6 +14,7 @@
import re # noqa: F401
import io
from pydantic import validate_arguments, ValidationError
from typing_extensions import Annotated

View File

@@ -14,6 +14,7 @@
import re # noqa: F401
import io
from pydantic import validate_arguments, ValidationError
from typing_extensions import Annotated

View File

@@ -15,6 +15,7 @@ from __future__ import absolute_import
import unittest
import datetime
import base64
import os
import openapi_client
from openapi_client.api.query_api import QueryApi # noqa: E501
@@ -23,8 +24,15 @@ from openapi_client.rest import ApiException
class TestManual(unittest.TestCase):
"""Manually written tests"""
gif_base64 = "R0lGODlhAQABAIABAP///wAAACH5BAEKAAEALAAAAAABAAEAAAICTAEAOw=="
def setUpFiles(self):
self.test_file_dir = os.path.join(os.path.dirname(__file__), "..", "testfiles")
self.test_file_dir = os.path.realpath(self.test_file_dir)
self.test_gif = os.path.join(self.test_file_dir, "test.gif")
def setUp(self):
pass
self.setUpFiles()
def tearDown(self):
pass
@@ -71,7 +79,7 @@ class TestManual(unittest.TestCase):
# Test binary response
api_response = api_instance.test_binary_gif()
self.assertEqual((base64.b64encode(api_response)).decode("utf-8"), "R0lGODlhAQABAIABAP///wAAACH5BAEKAAEALAAAAAABAAEAAAICTAEAOw==")
self.assertEqual((base64.b64encode(api_response)).decode("utf-8"), self.gif_base64)
def testNumberPropertiesOnly(self):
n = openapi_client.NumberPropertiesOnly.from_json('{"number": 123, "float": 456, "double": 34}')
@@ -84,6 +92,28 @@ class TestManual(unittest.TestCase):
self.assertEqual(n.float, 456.2)
self.assertEqual(n.double, 34.3)
def testApplicatinOctetStreamBinaryBodyParameter(self):
api_instance = openapi_client.BodyApi()
binary_body = base64.b64decode(self.gif_base64)
api_response = api_instance.test_body_application_octetstream_binary(binary_body)
e = EchoServerResponseParser(api_response)
self.assertEqual(e.path, "/body/application/octetstream/binary")
self.assertEqual(e.headers["Content-Type"], 'application/octet-stream')
self.assertEqual(bytes(e.body, "utf-8"), b'GIF89a\x01\x00\x01\x00\xef\xbf\xbd\x01\x00\xef\xbf\xbd\xef\xbf\xbd\xef\xbf\xbd\x00\x00\x00!\xef\xbf\xbd\x04\x01\n\x00\x01\x00,\x00\x00\x00\x00\x01\x00\x01\x00\x00\x02\x02L\x01\x00;')
def testApplicatinOctetStreamBinaryBodyParameterWithFile(self):
api_instance = openapi_client.BodyApi()
try:
api_response = api_instance.test_body_application_octetstream_binary("invalid_file_path")
except FileNotFoundError as err:
self.assertEqual("[Errno 2] No such file or directory: 'invalid_file_path'", str(err))
api_response = api_instance.test_body_application_octetstream_binary(self.test_gif)
e = EchoServerResponseParser(api_response)
self.assertEqual(e.path, "/body/application/octetstream/binary")
self.assertEqual(e.headers["Content-Type"], 'application/octet-stream')
self.assertEqual(bytes(e.body, "utf-8"), b'GIF89a\x01\x00\x01\x00\xef\xbf\xbd\x01\x00\xef\xbf\xbd\xef\xbf\xbd\xef\xbf\xbd\x00\x00\x00!\xef\xbf\xbd\x04\x01\n\x00\x01\x00,\x00\x00\x00\x00\x01\x00\x01\x00\x00\x02\x02L\x01\x00;')
def testBodyParameter(self):
n = openapi_client.Pet.from_dict({"name": "testing", "photoUrls": ["http://1", "http://2"]})
api_instance = openapi_client.BodyApi()
@@ -121,7 +151,7 @@ class EchoServerResponseParser():
if http_response is None:
raise ValueError("http response must not be None.")
lines = http_response.split("\n")
lines = http_response.splitlines()
self.headers = dict()
x = 0
while x < len(lines):
@@ -131,7 +161,7 @@ class EchoServerResponseParser():
self.path = items[1];
self.protocol = items[2];
elif lines[x] == "": # blank line
self.body = "\n".join(lines[x:])
self.body = "\n".join(lines[x+1:])
break
else:
key_value = lines[x].split(": ")

Binary file not shown.

After

Width:  |  Height:  |  Size: 43 B