IWF-711 Review pyproject.toml version constraints and identify which packages should be updated (#101)

* Declare httpx as a dependency to the SDK

* run poetry update

* Revert "run poetry update"

This reverts commit 7459987.

* run poetry lock

* Declare httpx as a dependency to the SDK

* run poetry lock

* Update README command to generate the OpenAPI files

* Fix timeout param

* Lint fixes

* Fixing issues found during code review

* Remove fallback, as we couldn't reproduce a case for this

* Run lint

* Adding except clause to parse_unexpected_error

Author: samuel27m

README.md

@@ -99,9 +99,8 @@ git submodule update --remote --merge
 This project uses [openapi-python-client](https://github.com/openapi-generators/openapi-python-client) to generate an API client from the IDL. To update the generated client:
 
 ```bash
-mkdir iwf/iwf_api/iwf_api
-cd iwf && poetry run openapi-python-client update --path ../iwf-idl/iwf-sdk.yaml --config .openapi-python-client-config.yaml
-cd .. && cp -R iwf/iwf_api/iwf_api/* iwf/iwf_api && rm -R iwf/iwf_api/iwf_api && poetry update
+poetry run openapi-python-client generate --path iwf-idl/iwf-sdk.yaml --config iwf/.openapi-python-client-config.yaml
+cp -R iwf_api/iwf_api/* iwf/iwf_api && rm -R iwf_api/ && poetry update
 ```
 
 The last command will:

iwf/errors.py

@@ -1,6 +1,5 @@
 import json as jsonlib
-
-from httpx._utils import guess_json_utf
+from httpx import Response
 
 from iwf.iwf_api.models import (
     ErrorResponse,
@@ -112,9 +111,8 @@ def process_workflow_abnormal_exit_error(
 
 
 def parse_unexpected_error(err) -> ErrorResponse:
-    encoding = guess_json_utf(err.content)
-    if encoding is not None:
-        err_dict = jsonlib.loads(err.content.decode(encoding))
-    else:
-        err_dict = jsonlib.loads(err.content)
-    return ErrorResponse.from_dict(err_dict)
+    try:
+        response = Response(err.status_code, content=err.content)
+        return ErrorResponse.from_dict(response.json())
+    except Exception:
+        return ErrorResponse.from_dict(jsonlib.loads(err.content))

iwf/iwf_api/__init__.py

@@ -1,4 +1,4 @@
-""" A client library for accessing Workflow APIs """
+"""A client library for accessing Workflow APIs"""
 
 from .client import AuthenticatedClient, Client
 

iwf/iwf_api/api/__init__.py

@@ -1 +1 @@
-""" Contains methods for accessing the API """
+"""Contains methods for accessing the API"""

iwf/iwf_api/api/default/__init__.py

@@ -0,0 +1 @@
+"""Contains endpoint functions for accessing the API"""

iwf/iwf_api/api/default/get_info_healthcheck.py

@@ -1,37 +1,25 @@
 from http import HTTPStatus
-from typing import Any, Dict, Optional
+from typing import Any, Optional, Union
 
 import httpx
 
 from ... import errors
-from ...client import Client
+from ...client import AuthenticatedClient, Client
 from ...models.health_info import HealthInfo
 from ...types import Response
 
 
-def _get_kwargs(
-    *,
-    client: Client,
-) -> Dict[str, Any]:
-    url = "{}/info/healthcheck".format(client.base_url)
-
-    headers: Dict[str, str] = client.get_headers()
-    cookies: Dict[str, Any] = client.get_cookies()
-
-    return {
+def _get_kwargs() -> dict[str, Any]:
+    _kwargs: dict[str, Any] = {
         "method": "get",
-        "url": url,
-        "headers": headers,
-        "cookies": cookies,
-        "timeout": client.get_timeout(),
-        "follow_redirects": client.follow_redirects,
+        "url": "/info/healthcheck",
     }
 
+    return _kwargs
 
-def _parse_response(
-    *, client: Client, response: httpx.Response
-) -> Optional[HealthInfo]:
-    if response.status_code == HTTPStatus.OK:
+
+def _parse_response(*, client: Union[AuthenticatedClient, Client], response: httpx.Response) -> Optional[HealthInfo]:
+    if response.status_code == 200:
         response_200 = HealthInfo.from_dict(response.json())
 
         return response_200
@@ -41,9 +29,7 @@ def _parse_response(
         return None
 
 
-def _build_response(
-    *, client: Client, response: httpx.Response
-) -> Response[HealthInfo]:
+def _build_response(*, client: Union[AuthenticatedClient, Client], response: httpx.Response) -> Response[HealthInfo]:
     return Response(
         status_code=HTTPStatus(response.status_code),
         content=response.content,
@@ -54,7 +40,7 @@ def _build_response(
 
 def sync_detailed(
     *,
-    client: Client,
+    client: Union[AuthenticatedClient, Client],
 ) -> Response[HealthInfo]:
     """return health info of the server
 
@@ -66,12 +52,9 @@ def sync_detailed(
         Response[HealthInfo]
     """
 
-    kwargs = _get_kwargs(
-        client=client,
-    )
+    kwargs = _get_kwargs()
 
-    response = httpx.request(
-        verify=client.verify_ssl,
+    response = client.get_httpx_client().request(
         **kwargs,
     )
 
@@ -80,7 +63,7 @@ def sync_detailed(
 
 def sync(
     *,
-    client: Client,
+    client: Union[AuthenticatedClient, Client],
 ) -> Optional[HealthInfo]:
     """return health info of the server
 
@@ -99,7 +82,7 @@ def sync(
 
 async def asyncio_detailed(
     *,
-    client: Client,
+    client: Union[AuthenticatedClient, Client],
 ) -> Response[HealthInfo]:
     """return health info of the server
 
@@ -111,19 +94,16 @@ async def asyncio_detailed(
         Response[HealthInfo]
     """
 
-    kwargs = _get_kwargs(
-        client=client,
-    )
+    kwargs = _get_kwargs()
 
-    async with httpx.AsyncClient(verify=client.verify_ssl) as _client:
-        response = await _client.request(**kwargs)
+    response = await client.get_async_httpx_client().request(**kwargs)
 
     return _build_response(client=client, response=response)
 
 
 async def asyncio(
     *,
-    client: Client,
+    client: Union[AuthenticatedClient, Client],
 ) -> Optional[HealthInfo]:
     """return health info of the server
 

iwf/iwf_api/api/default/post_api_v1_workflow_config_update.py

@@ -1,45 +1,42 @@
 from http import HTTPStatus
-from typing import Any, Dict, Optional, Union, cast
+from typing import Any, Optional, Union, cast
 
 import httpx
 
 from ... import errors
-from ...client import Client
+from ...client import AuthenticatedClient, Client
 from ...models.error_response import ErrorResponse
 from ...models.workflow_config_update_request import WorkflowConfigUpdateRequest
 from ...types import Response
 
 
 def _get_kwargs(
     *,
-    client: Client,
-    json_body: WorkflowConfigUpdateRequest,
-) -> Dict[str, Any]:
-    url = "{}/api/v1/workflow/config/update".format(client.base_url)
+    body: WorkflowConfigUpdateRequest,
+) -> dict[str, Any]:
+    headers: dict[str, Any] = {}
 
-    headers: Dict[str, str] = client.get_headers()
-    cookies: Dict[str, Any] = client.get_cookies()
-
-    json_json_body = json_body.to_dict()
-
-    return {
+    _kwargs: dict[str, Any] = {
         "method": "post",
-        "url": url,
-        "headers": headers,
-        "cookies": cookies,
-        "timeout": client.get_timeout(),
-        "follow_redirects": client.follow_redirects,
-        "json": json_json_body,
+        "url": "/api/v1/workflow/config/update",
     }
 
+    _body = body.to_dict()
+
+    _kwargs["json"] = _body
+    headers["Content-Type"] = "application/json"
+
+    _kwargs["headers"] = headers
+    return _kwargs
+
 
 def _parse_response(
-    *, client: Client, response: httpx.Response
+    *, client: Union[AuthenticatedClient, Client], response: httpx.Response
 ) -> Optional[Union[Any, ErrorResponse]]:
-    if response.status_code == HTTPStatus.OK:
+    if response.status_code == 200:
         response_200 = cast(Any, None)
         return response_200
-    if response.status_code == HTTPStatus.BAD_REQUEST:
+    if response.status_code == 400:
         response_400 = ErrorResponse.from_dict(response.json())
 
         return response_400
@@ -50,7 +47,7 @@ def _parse_response(
 
 
 def _build_response(
-    *, client: Client, response: httpx.Response
+    *, client: Union[AuthenticatedClient, Client], response: httpx.Response
 ) -> Response[Union[Any, ErrorResponse]]:
     return Response(
         status_code=HTTPStatus(response.status_code),
@@ -62,13 +59,13 @@ def _build_response(
 
 def sync_detailed(
     *,
-    client: Client,
-    json_body: WorkflowConfigUpdateRequest,
+    client: Union[AuthenticatedClient, Client],
+    body: WorkflowConfigUpdateRequest,
 ) -> Response[Union[Any, ErrorResponse]]:
     """update the config of a workflow
 
     Args:
-        json_body (WorkflowConfigUpdateRequest):
+        body (WorkflowConfigUpdateRequest):
 
     Raises:
         errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
@@ -79,12 +76,10 @@ def sync_detailed(
     """
 
     kwargs = _get_kwargs(
-        client=client,
-        json_body=json_body,
+        body=body,
     )
 
-    response = httpx.request(
-        verify=client.verify_ssl,
+    response = client.get_httpx_client().request(
         **kwargs,
     )
 
@@ -93,13 +88,13 @@ def sync_detailed(
 
 def sync(
     *,
-    client: Client,
-    json_body: WorkflowConfigUpdateRequest,
+    client: Union[AuthenticatedClient, Client],
+    body: WorkflowConfigUpdateRequest,
 ) -> Optional[Union[Any, ErrorResponse]]:
     """update the config of a workflow
 
     Args:
-        json_body (WorkflowConfigUpdateRequest):
+        body (WorkflowConfigUpdateRequest):
 
     Raises:
         errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
@@ -111,19 +106,19 @@ def sync(
 
     return sync_detailed(
         client=client,
-        json_body=json_body,
+        body=body,
     ).parsed
 
 
 async def asyncio_detailed(
     *,
-    client: Client,
-    json_body: WorkflowConfigUpdateRequest,
+    client: Union[AuthenticatedClient, Client],
+    body: WorkflowConfigUpdateRequest,
 ) -> Response[Union[Any, ErrorResponse]]:
     """update the config of a workflow
 
     Args:
-        json_body (WorkflowConfigUpdateRequest):
+        body (WorkflowConfigUpdateRequest):
 
     Raises:
         errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
@@ -134,25 +129,23 @@ async def asyncio_detailed(
     """
 
     kwargs = _get_kwargs(
-        client=client,
-        json_body=json_body,
+        body=body,
     )
 
-    async with httpx.AsyncClient(verify=client.verify_ssl) as _client:
-        response = await _client.request(**kwargs)
+    response = await client.get_async_httpx_client().request(**kwargs)
 
     return _build_response(client=client, response=response)
 
 
 async def asyncio(
     *,
-    client: Client,
-    json_body: WorkflowConfigUpdateRequest,
+    client: Union[AuthenticatedClient, Client],
+    body: WorkflowConfigUpdateRequest,
 ) -> Optional[Union[Any, ErrorResponse]]:
     """update the config of a workflow
 
     Args:
-        json_body (WorkflowConfigUpdateRequest):
+        body (WorkflowConfigUpdateRequest):
 
     Raises:
         errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
@@ -165,6 +158,6 @@ async def asyncio(
     return (
         await asyncio_detailed(
             client=client,
-            json_body=json_body,
+            body=body,
         )
     ).parsed