Refactor API client (#1018)

* Refactor API client

This moves thread support from the main client, and extract the behavior
flags in the configuration.

* Small tweak

* Implement close

* Apply suggestions from code review

Co-authored-by: NouemanKHAL <[email protected]>

* Rebase

* Doc tweak

* Fix one docstring escape

* Make zstd optional

Co-authored-by: NouemanKHAL <[email protected]>

Author: therve

.generator/src/generator/formatter.py

@@ -95,7 +95,7 @@ def header(self, text, level, raw=None):
 
 
 def docstring(text):
-    return m2r2.convert(text.replace("\\n", "\\\\n"), renderer=CustomRenderer())[1:-1].replace("\\ ", " ")
+    return m2r2.convert(text.replace("\\n", "\\\\n"), renderer=CustomRenderer())[1:-1].replace("\\ ", " ").replace("\\`", "\\\\`")
 
 
 def _merge_imports(a, b):

.generator/src/generator/templates/api.j2

@@ -139,14 +139,6 @@ class {{ classname }}:
 {% if operation.description %}
         {{ operation.description|docstring|indent(8) }}
 {% endif %}
-        This method makes a synchronous HTTP request by default. To make an
-        asynchronous HTTP request, please pass async_req=True.
-
-        >>> thread = api.{{ operation.operationId|safe_snake_case }}(
-{%- for name, parameter in operation|parameters if parameter.required %}{{name|attribute_name}}, {% endfor %}async_req=True)
-        >>> result = thread.get()
-{# keep new line #}
-
 {%- for name, parameter in operation|parameters if parameter.required %}
 {%- if parameter.description %}
         :param {{ name|attribute_name }}: {{ parameter.description|docstring|indent(12) }}{% if parameter.default %} Defaults to {{ parameter.default }}.{% endif %}{% endif %}
@@ -157,34 +149,10 @@ class {{ classname }}:
         :param {{ name|attribute_name }}: {{ parameter.description|docstring|indent(12) }}{%- if parameter.default %} If omitted the server will use the default value of {{ parameter.default }}.{% endif %}{% endif %}
         :type {{ name|attribute_name }}: {{ get_type_for_parameter(parameter) }}, optional
 {%- endfor %}
-        :param _return_http_data_only: Response data without head status
-            code and headers. Default is True.
-        :type _return_http_data_only: bool
-        :param _preload_content: If False, the urllib3.HTTPResponse object
-            will be returned without reading/decoding response data.
-            Default is True.
-        :type _preload_content: bool
-        :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.  Default is None.
-        :type _request_timeout: float/tuple
-        :param _check_input_type: Specifies if type checking should be done one
-            the data sent to the server. Default is True.
-        :type _check_input_type: bool
-        :param _check_return_type: Specifies if type checking should be done
-            one the data received from the server. Default is True.
-        :type _check_return_type: bool
-        :param _host_index: Specifies the index of the server that we want to
-            use. Default is read from the configuration.
-        :type _host_index: int/None
-        :param async_req: Execute request asynchronously.
-        :type async_req: bool
 
-        :return: If the method is called asynchronously, returns the request thread.
 {%- set returnType = operation|return_type %}
         :rtype: {% if returnType %}{{ returnType }}{% else %}None{% endif %}
         """
-        kwargs = self._{{ operation.operationId|safe_snake_case }}_endpoint.default_arguments(kwargs)
 {%- for name, parameter in operation|parameters if parameter.required %}
         kwargs["{{ name|attribute_name }}"] = {{ name|attribute_name }}
 {% endfor %}
@@ -207,24 +175,10 @@ class {{ classname }}:
         :param {{ name|attribute_name }}: {{ parameter.description|docstring|indent(12) }}{%- if parameter.default %} If omitted the server will use the default value of {{ parameter.default }}.{% endif %}{% endif %}
         :type {{ name|attribute_name }}: {{ get_type_for_parameter(parameter) }}, optional
 {%- endfor %}
-        :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.  Default is None.
-        :type _request_timeout: float/tuple
-        :param _check_input_type: Specifies if type checking should be done one
-            the data sent to the server. Default is True.
-        :type _check_input_type: bool
-        :param _check_return_type: Specifies if type checking should be done
-            one the data received from the server. Default is True.
-        :type _check_return_type: bool
-        :param _host_index: Specifies the index of the server that we want to
-            use. Default is read from the configuration.
-        :type _host_index: int/None
 
         :return: A generator of paginated results.
         :rtype: collections.abc.Iterable[{{ get_type_at_path(operation, pagination.resultsPath) }}]
         """
-        kwargs = self._{{ operation.operationId|safe_snake_case }}_endpoint.default_arguments(kwargs)
 {%- for name, parameter in operation|parameters if parameter.required %}
         kwargs["{{ name|attribute_name }}"] = {{ name|attribute_name }}
 {% endfor %}