Skip to content

Commit 8827da8

Browse files
fa0311fa0311
authored
[python] fix typing for API responses (#16802)
* [python] remove _preload_content Signed-off-by: ふぁ <[email protected]> * [python] remove _return_http_data_only Signed-off-by: ふぁ <[email protected]> * [python] remove async_req Signed-off-by: ふぁ <[email protected]> * [python] fix typing for API responses Signed-off-by: ふぁ <[email protected]> * [python] update samples Signed-off-by: ふぁ <[email protected]> * [python] fix AttributeError Signed-off-by: ふぁ <[email protected]> * [python] remove _preload_content Signed-off-by: ふぁ <[email protected]> * [python] fix response_type Signed-off-by: ふぁ <[email protected]> * [python] fix typo Signed-off-by: ふぁ <[email protected]> * [python] update simplify RESTClientObject Signed-off-by: ふぁ <[email protected]> * [python] update split call_api into 4 functions Signed-off-by: ふぁ <[email protected]> * [python] update samples Signed-off-by: ふぁ <[email protected]> * [python] update improve stream Signed-off-by: ふぁ <[email protected]> * [python] remove kwargs Signed-off-by: ふぁ <[email protected]> * [python] update ApiResponse Signed-off-by: ふぁ <[email protected]> * [python] add method for each return value Signed-off-by: ふぁ <[email protected]> * [python] update test Signed-off-by: ふぁ <[email protected]> * [python] update samples Signed-off-by: ふぁ <[email protected]> * [python] update docs Signed-off-by: ふぁ <[email protected]> * [python] add constantParams Signed-off-by: ふぁ <[email protected]> * [python] fix ImportError Signed-off-by: ふぁ <[email protected]> * [python] fix SyntaxError in RESTResponse Signed-off-by: ふぁ <[email protected]> * [python] add ApiResponse model_config Signed-off-by: ふぁ <[email protected]> * [python] fix when isBinary is str Signed-off-by: ふぁ <[email protected]> * [python] update type Signed-off-by: ふぁ <[email protected]> * [python] update samples Signed-off-by: ふぁ <[email protected]> * [python] add rest with pydantic v1 Signed-off-by: ふぁ <[email protected]> * [python] update format Signed-off-by: ふぁ <[email protected]> * [python] update format and type Signed-off-by: ふぁ <[email protected]> * [python] add test Signed-off-by: ふぁ <[email protected]> * [python] update type to pydantic strict type Signed-off-by: ふぁ <[email protected]> * [python] remove leftover files Signed-off-by: ふぁ <[email protected]> * [python] remove descriptions per field Signed-off-by: ふぁ <[email protected]> * [python] add test Signed-off-by: ふぁ <[email protected]> * [python] fix test Signed-off-by: ふぁ <[email protected]> * [python] fix test Signed-off-by: ふぁ <[email protected]> * [python] remove multiprocessing Signed-off-by: ふぁ <[email protected]> * [python] update samples Signed-off-by: ふぁ <[email protected]> * [python] add blank line to docstring Signed-off-by: ふぁ <[email protected]> * [python] update docstring Signed-off-by: ふぁ <[email protected]> * [python] remove unwanted imports in rest Signed-off-by: ふぁ <[email protected]> --------- Signed-off-by: ふぁ <[email protected]>
1 parent 3422ef1 commit 8827da8

238 files changed

Lines changed: 32491 additions & 17168 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/AbstractPythonCodegen.java‎

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -946,16 +946,17 @@ private ModelsMap postProcessModelsMap(ModelsMap objs) {
946946
}
947947
}
948948

949-
// if model_generic.mustache is used and support additionalProperties
950-
if (model.oneOf.isEmpty() && model.anyOf.isEmpty()
951-
&& !model.isEnum
952-
&& !this.disallowAdditionalPropertiesIfNotPresent) {
949+
// if model_generic.mustache is used
950+
if (model.oneOf.isEmpty() && model.anyOf.isEmpty() && !model.isEnum) {
951+
typingImports.add("ClassVar");
953952
typingImports.add("Dict");
954-
typingImports.add("List");
955953
typingImports.add("Any");
956-
typingImports.add("ClassVar");
954+
if(this.disallowAdditionalPropertiesIfNotPresent || model.isAdditionalPropertiesTrue) {
955+
typingImports.add("List");
956+
}
957957
}
958958

959+
959960
//loop through properties/schemas to set up typing, pydantic
960961
for (CodegenProperty cp : codegenProperties) {
961962
// is readOnly?

‎modules/openapi-generator/src/main/resources/python-pydantic-v1/asyncio/rest.mustache‎

Lines changed: 241 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,241 @@
1+
# coding: utf-8
2+
3+
{{>partial_header}}
4+
5+
import io
6+
import json
7+
import logging
8+
import re
9+
import ssl
10+
11+
import aiohttp
12+
from urllib.parse import urlencode, quote_plus
13+
14+
from {{packageName}}.exceptions import ApiException, ApiValueError
15+
16+
logger = logging.getLogger(__name__)
17+
18+
19+
class RESTResponse(io.IOBase):
20+
21+
def __init__(self, resp, data) -> None:
22+
self.aiohttp_response = resp
23+
self.status = resp.status
24+
self.reason = resp.reason
25+
self.data = data
26+
27+
def getheaders(self):
28+
"""Returns a CIMultiDictProxy of the response headers."""
29+
return self.aiohttp_response.headers
30+
31+
def getheader(self, name, default=None):
32+
"""Returns a given response header."""
33+
return self.aiohttp_response.headers.get(name, default)
34+
35+
36+
class RESTClientObject:
37+
38+
def __init__(self, configuration, pools_size=4, maxsize=None) -> None:
39+
40+
# maxsize is number of requests to host that are allowed in parallel
41+
if maxsize is None:
42+
maxsize = configuration.connection_pool_maxsize
43+
44+
ssl_context = ssl.create_default_context(cafile=configuration.ssl_ca_cert)
45+
if configuration.cert_file:
46+
ssl_context.load_cert_chain(
47+
configuration.cert_file, keyfile=configuration.key_file
48+
)
49+
50+
if not configuration.verify_ssl:
51+
ssl_context.check_hostname = False
52+
ssl_context.verify_mode = ssl.CERT_NONE
53+
54+
connector = aiohttp.TCPConnector(
55+
limit=maxsize,
56+
ssl=ssl_context
57+
)
58+
59+
self.proxy = configuration.proxy
60+
self.proxy_headers = configuration.proxy_headers
61+
62+
# https pool manager
63+
self.pool_manager = aiohttp.ClientSession(
64+
connector=connector,
65+
trust_env=True
66+
)
67+
68+
async def close(self):
69+
await self.pool_manager.close()
70+
71+
async def request(self, method, url, query_params=None, headers=None,
72+
body=None, post_params=None, _preload_content=True,
73+
_request_timeout=None):
74+
"""Execute request
75+
76+
:param method: http request method
77+
:param url: http request url
78+
:param query_params: query parameters in the url
79+
:param headers: http request headers
80+
:param body: request json body, for `application/json`
81+
:param post_params: request post parameters,
82+
`application/x-www-form-urlencoded`
83+
and `multipart/form-data`
84+
:param _preload_content: this is a non-applicable field for
85+
the AiohttpClient.
86+
:param _request_timeout: timeout setting for this request. If one
87+
number provided, it will be total request
88+
timeout. It can also be a pair (tuple) of
89+
(connection, read) timeouts.
90+
"""
91+
method = method.upper()
92+
assert method in ['GET', 'HEAD', 'DELETE', 'POST', 'PUT',
93+
'PATCH', 'OPTIONS']
94+
95+
if post_params and body:
96+
raise ApiValueError(
97+
"body parameter cannot be used with post_params parameter."
98+
)
99+
100+
post_params = post_params or {}
101+
headers = headers or {}
102+
# url already contains the URL query string
103+
# so reset query_params to empty dict
104+
query_params = {}
105+
timeout = _request_timeout or 5 * 60
106+
107+
if 'Content-Type' not in headers:
108+
headers['Content-Type'] = 'application/json'
109+
110+
args = {
111+
"method": method,
112+
"url": url,
113+
"timeout": timeout,
114+
"headers": headers
115+
}
116+
117+
if self.proxy:
118+
args["proxy"] = self.proxy
119+
if self.proxy_headers:
120+
args["proxy_headers"] = self.proxy_headers
121+
122+
if query_params:
123+
args["url"] += '?' + urlencode(query_params)
124+
125+
# For `POST`, `PUT`, `PATCH`, `OPTIONS`, `DELETE`
126+
if method in ['POST', 'PUT', 'PATCH', 'OPTIONS', 'DELETE']:
127+
if re.search('json', headers['Content-Type'], re.IGNORECASE):
128+
if body is not None:
129+
body = json.dumps(body)
130+
args["data"] = body
131+
elif headers['Content-Type'] == 'application/x-www-form-urlencoded': # noqa: E501
132+
args["data"] = aiohttp.FormData(post_params)
133+
elif headers['Content-Type'] == 'multipart/form-data':
134+
# must del headers['Content-Type'], or the correct
135+
# Content-Type which generated by aiohttp
136+
del headers['Content-Type']
137+
data = aiohttp.FormData()
138+
for param in post_params:
139+
k, v = param
140+
if isinstance(v, tuple) and len(v) == 3:
141+
data.add_field(k,
142+
value=v[1],
143+
filename=v[0],
144+
content_type=v[2])
145+
else:
146+
data.add_field(k, v)
147+
args["data"] = data
148+
149+
# Pass a `bytes` parameter directly in the body to support
150+
# other content types than Json when `body` argument is provided
151+
# in serialized form
152+
elif isinstance(body, bytes):
153+
args["data"] = body
154+
else:
155+
# Cannot generate the request from given parameters
156+
msg = """Cannot prepare a request message for provided
157+
arguments. Please check that your arguments match
158+
declared content type."""
159+
raise ApiException(status=0, reason=msg)
160+
161+
r = await self.pool_manager.request(**args)
162+
if _preload_content:
163+
164+
data = await r.read()
165+
r = RESTResponse(r, data)
166+
167+
# log response body
168+
logger.debug("response body: %s", r.data)
169+
170+
if not 200 <= r.status <= 299:
171+
raise ApiException(http_resp=r)
172+
173+
return r
174+
175+
async def get_request(self, url, headers=None, query_params=None,
176+
_preload_content=True, _request_timeout=None):
177+
return (await self.request("GET", url,
178+
headers=headers,
179+
_preload_content=_preload_content,
180+
_request_timeout=_request_timeout,
181+
query_params=query_params))
182+
183+
async def head_request(self, url, headers=None, query_params=None,
184+
_preload_content=True, _request_timeout=None):
185+
return (await self.request("HEAD", url,
186+
headers=headers,
187+
_preload_content=_preload_content,
188+
_request_timeout=_request_timeout,
189+
query_params=query_params))
190+
191+
async def options_request(self, url, headers=None, query_params=None,
192+
post_params=None, body=None, _preload_content=True,
193+
_request_timeout=None):
194+
return (await self.request("OPTIONS", url,
195+
headers=headers,
196+
query_params=query_params,
197+
post_params=post_params,
198+
_preload_content=_preload_content,
199+
_request_timeout=_request_timeout,
200+
body=body))
201+
202+
async def delete_request(self, url, headers=None, query_params=None, body=None,
203+
_preload_content=True, _request_timeout=None):
204+
return (await self.request("DELETE", url,
205+
headers=headers,
206+
query_params=query_params,
207+
_preload_content=_preload_content,
208+
_request_timeout=_request_timeout,
209+
body=body))
210+
211+
async def post_request(self, url, headers=None, query_params=None,
212+
post_params=None, body=None, _preload_content=True,
213+
_request_timeout=None):
214+
return (await self.request("POST", url,
215+
headers=headers,
216+
query_params=query_params,
217+
post_params=post_params,
218+
_preload_content=_preload_content,
219+
_request_timeout=_request_timeout,
220+
body=body))
221+
222+
async def put_request(self, url, headers=None, query_params=None, post_params=None,
223+
body=None, _preload_content=True, _request_timeout=None):
224+
return (await self.request("PUT", url,
225+
headers=headers,
226+
query_params=query_params,
227+
post_params=post_params,
228+
_preload_content=_preload_content,
229+
_request_timeout=_request_timeout,
230+
body=body))
231+
232+
async def patch_request(self, url, headers=None, query_params=None,
233+
post_params=None, body=None, _preload_content=True,
234+
_request_timeout=None):
235+
return (await self.request("PATCH", url,
236+
headers=headers,
237+
query_params=query_params,
238+
post_params=post_params,
239+
_preload_content=_preload_content,
240+
_request_timeout=_request_timeout,
241+
body=body))

0 commit comments

Comments
 (0)