Support headers, cookies, and timeout config in Client.

Author: dbanty

CHANGELOG.md

@@ -16,12 +16,16 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
   the `sync()` and `asyncio()` functions for a path operation will return `None`. This means all return types are now 
   `Optional`, so mypy will require you to handle potential errors (or explicitly ignore them).
 - Moved `models.types` generated module up a level, so just `types`.
+- `Client` and `AuthenticatedClient` are now declared using the `attrs` package instead of builtin `dataclass`
 
 ### Additions
 - Every generated API module will have a `sync_detailed()` and `asyncio_detailed()` function which work like their 
   non-detailed counterparts, but return a `types.Response[T]` instead of an `Optional[T]` (where T is the parsed body type).
   `types.Response` contains `status_code`, `content` (bytes of returned content), `headers`, and `parsed` (the 
   parsed return type you would get from the non-detailed function). (#115)
+- It's now possible to include custom headers and cookies in requests, as well as set a custom timeout. This can be done 
+    either by directly setting those parameters on a `Client` (e.g. `my_client.headers = {"Header": "Value"}`) or using 
+    a fluid api (e.g. `my_endpoint.sync(my_client.with_cookies({"MyCookie": "cookie"}).with_timeout(10.0))`).
 
 
 ## 0.5.4 - Unreleased

end_to_end_tests/golden-master/my_test_api_client/api/default/ping_ping_get.py

@@ -18,6 +18,8 @@ def _get_kwargs(
     return {
         "url": url,
         "headers": headers,
+        "cookies": client.get_cookies(),
+        "timeout": client.get_timeout(),
     }
 
 

end_to_end_tests/golden-master/my_test_api_client/api/tests/get_user_list.py

@@ -41,6 +41,8 @@ def _get_kwargs(
     return {
         "url": url,
         "headers": headers,
+        "cookies": client.get_cookies(),
+        "timeout": client.get_timeout(),
         "params": params,
     }
 

end_to_end_tests/golden-master/my_test_api_client/api/tests/json_body_tests_json_body_post.py

@@ -23,6 +23,8 @@ def _get_kwargs(
     return {
         "url": url,
         "headers": headers,
+        "cookies": client.get_cookies(),
+        "timeout": client.get_timeout(),
         "json": json_json_body,
     }
 

end_to_end_tests/golden-master/my_test_api_client/api/tests/test_defaults_tests_test_defaults_post.py

@@ -75,6 +75,8 @@ def _get_kwargs(
     return {
         "url": url,
         "headers": headers,
+        "cookies": client.get_cookies(),
+        "timeout": client.get_timeout(),
         "json": json_json_body,
         "params": params,
     }

end_to_end_tests/golden-master/my_test_api_client/api/tests/test_octet_stream_tests_test_octet_stream_get.py

@@ -18,6 +18,8 @@ def _get_kwargs(
     return {
         "url": url,
         "headers": headers,
+        "cookies": client.get_cookies(),
+        "timeout": client.get_timeout(),
     }
 
 

end_to_end_tests/golden-master/my_test_api_client/api/tests/upload_file_tests_upload_post.py

@@ -18,12 +18,15 @@ def _get_kwargs(
     url = "{}/tests/upload".format(client.base_url)
 
     headers: Dict[str, Any] = client.get_headers()
+
     if keep_alive is not None:
         headers["keep-alive"] = keep_alive
 
     return {
         "url": url,
         "headers": headers,
+        "cookies": client.get_cookies(),
+        "timeout": client.get_timeout(),
         "files": multipart_data.to_dict(),
     }
 

end_to_end_tests/golden-master/my_test_api_client/client.py

@@ -1,24 +1,46 @@
-from dataclasses import dataclass
-from typing import Dict, Union
+from typing import Dict
 
+import attr
 
-@dataclass
+
+@attr.s
 class Client:
     """ A class for keeping track of data related to the API """
 
     base_url: str
+    cookies: Dict[str, str] = attr.ib(factory=dict, kw_only=True)
+    headers: Dict[str, str] = attr.ib(factory=dict, kw_only=True)
+    timeout: float = attr.ib(5.0, kw_only=True)
 
     def get_headers(self) -> Dict[str, str]:
         """ Get headers to be used in all endpoints """
-        return {}
+        return {**self.headers}
+
+    def with_headers(self, headers: Dict[str, str]) -> "Client":
+        """ Get a new client matching this one with additional headers """
+        return attr.evolve(self, headers={**self.headers, **headers})
+
+    def get_cookies(self) -> Dict[str, str]:
+        return {**self.cookies}
+
+    def with_cookies(self, cookies: Dict[str, str]) -> "Client":
+        """ Get a new client matching this one with additional cookies """
+        return attr.evolve(self, cookies={**self.cookies, **cookies})
+
+    def get_timeout(self) -> float:
+        return self.timeout
+
+    def with_timeout(self, timeout: float) -> "Client":
+        """ Get a new client matching this one with a new timeout (in seconds) """
+        return attr.evolve(self, timeout=timeout)
 
 
-@dataclass
+@attr.s
 class AuthenticatedClient(Client):
     """ A Client which has been authenticated for use on secured endpoints """
 
     token: str
 
     def get_headers(self) -> Dict[str, str]:
         """ Get headers to be used in authenticated endpoints """
-        return {"Authorization": f"Bearer {self.token}"}
+        return {"Authorization": f"Bearer {self.token}", **self.headers}

end_to_end_tests/golden-master/pyproject.toml

@@ -15,6 +15,7 @@ include = ["CHANGELOG.md", "my_test_api_client/py.typed"]
 [tool.poetry.dependencies]
 python = "^3.8"
 httpx = "^0.13.3"
+attrs = "^20.1.0"
 
 [tool.black]
 line-length = 120

openapi_python_client/templates/client.pyi

@@ -1,22 +1,44 @@
-from dataclasses import dataclass
-from typing import Dict, Union
+from typing import Dict
 
-@dataclass
+import attr
+
+@attr.s
 class Client:
     """ A class for keeping track of data related to the API """
 
     base_url: str
+    cookies: Dict[str, str] = attr.ib(factory=dict, kw_only=True)
+    headers: Dict[str, str] = attr.ib(factory=dict, kw_only=True)
+    timeout: float = attr.ib(5.0, kw_only=True)
 
     def get_headers(self) -> Dict[str, str]:
         """ Get headers to be used in all endpoints """
-        return {}
+        return {**self.headers}
+
+    def with_headers(self, headers: Dict[str, str]) -> "Client":
+        """ Get a new client matching this one with additional headers """
+        return attr.evolve(self, headers={**self.headers, **headers})
+
+    def get_cookies(self) -> Dict[str, str]:
+        return {**self.cookies}
+
+    def with_cookies(self, cookies: Dict[str, str]) -> "Client":
+        """ Get a new client matching this one with additional cookies """
+        return attr.evolve(self, cookies={**self.cookies, **cookies})
+
+    def get_timeout(self) -> float:
+        return self.timeout
+
+    def with_timeout(self, timeout: float) -> "Client":
+        """ Get a new client matching this one with a new timeout (in seconds) """
+        return attr.evolve(self, timeout=timeout)
 
-@dataclass
+@attr.s
 class AuthenticatedClient(Client):
     """ A Client which has been authenticated for use on secured endpoints """
 
     token: str
 
     def get_headers(self) -> Dict[str, str]:
         """ Get headers to be used in authenticated endpoints """
-        return {"Authorization": f"Bearer {self.token}"}
+        return {"Authorization": f"Bearer {self.token}", **self.headers}

openapi_python_client/templates/endpoint_module.pyi

@@ -23,6 +23,7 @@ def _get_kwargs(
     )
 
     headers: Dict[str, Any] = client.get_headers()
+
     {{ header_params(endpoint) | indent(4) }}
 
     {{ query_params(endpoint) | indent(4) }}
@@ -32,6 +33,8 @@ def _get_kwargs(
     return {
         "url": url,
         "headers": headers,
+        "cookies": client.get_cookies(),
+        "timeout": client.get_timeout(),
         {% if endpoint.form_body_reference %}
         "data": asdict(form_data),
         {% endif %}

openapi_python_client/templates/pyproject.toml

@@ -15,6 +15,7 @@ include = ["CHANGELOG.md", "{{ package_name }}/py.typed"]
 [tool.poetry.dependencies]
 python = "^3.8"
 httpx = "^0.13.3"
+attrs = "^20.1.0"
 
 [tool.black]
 line-length = 120

poetry.lock

@@ -31,6 +31,7 @@ isort = "^5.0.5"
 pyyaml = "^5.3.1"
 importlib_metadata = {version = "^1.6.0", python = "==3.7"}
 pydantic = "^1.6.1"
+attrs = "^20.1.0"
 
 [tool.poetry.scripts]
 openapi-python-client = "openapi_python_client.cli:app"

pyproject.toml

@@ -20,6 +20,8 @@ def _get_kwargs(
     return {
         "url": url,
         "headers": headers,
+        "cookies": client.get_cookies(),
+        "timeout": client.get_timeout(),
         "data": asdict(form_data),
         "files": multipart_data.to_dict(),
         "json": json_json_body,