-
-
Notifications
You must be signed in to change notification settings - Fork 200
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
This is just #1114 but with some docs & changeset --------- Co-authored-by: Eitan Mosenkis <[email protected]> Co-authored-by: Eitan Mosenkis <[email protected]> Co-authored-by: Dylan Anthony <[email protected]>
- Loading branch information
1 parent
a9c0784
commit 8864a5f
Showing
47 changed files
with
2,388 additions
and
55 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,14 @@ | ||
--- | ||
default: minor | ||
--- | ||
|
||
# Add `literal_enums` config setting | ||
|
||
Instead of the default `Enum` classes for enums, you can now generate `Literal` sets wherever `enum` appears in the OpenAPI spec by setting `literal_enums: true` in your config file. | ||
|
||
```yaml | ||
literal_enums: true | ||
``` | ||
Thanks to @emosenkis for PR #1114 closes #587, #725, #1076, and probably many more. | ||
Thanks also to @eli-bl, @expobrain, @theorm, @chrisguillory, and anyone else who helped getting to this design! |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,23 @@ | ||
__pycache__/ | ||
build/ | ||
dist/ | ||
*.egg-info/ | ||
.pytest_cache/ | ||
|
||
# pyenv | ||
.python-version | ||
|
||
# Environments | ||
.env | ||
.venv | ||
|
||
# mypy | ||
.mypy_cache/ | ||
.dmypy.json | ||
dmypy.json | ||
|
||
# JetBrains | ||
.idea/ | ||
|
||
/coverage.xml | ||
/.coverage |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,124 @@ | ||
# my-enum-api-client | ||
A client library for accessing My Enum API | ||
|
||
## Usage | ||
First, create a client: | ||
|
||
```python | ||
from my_enum_api_client import Client | ||
|
||
client = Client(base_url="https://api.example.com") | ||
``` | ||
|
||
If the endpoints you're going to hit require authentication, use `AuthenticatedClient` instead: | ||
|
||
```python | ||
from my_enum_api_client import AuthenticatedClient | ||
|
||
client = AuthenticatedClient(base_url="https://api.example.com", token="SuperSecretToken") | ||
``` | ||
|
||
Now call your endpoint and use your models: | ||
|
||
```python | ||
from my_enum_api_client.models import MyDataModel | ||
from my_enum_api_client.api.my_tag import get_my_data_model | ||
from my_enum_api_client.types import Response | ||
|
||
with client as client: | ||
my_data: MyDataModel = get_my_data_model.sync(client=client) | ||
# or if you need more info (e.g. status_code) | ||
response: Response[MyDataModel] = get_my_data_model.sync_detailed(client=client) | ||
``` | ||
|
||
Or do the same thing with an async version: | ||
|
||
```python | ||
from my_enum_api_client.models import MyDataModel | ||
from my_enum_api_client.api.my_tag import get_my_data_model | ||
from my_enum_api_client.types import Response | ||
|
||
async with client as client: | ||
my_data: MyDataModel = await get_my_data_model.asyncio(client=client) | ||
response: Response[MyDataModel] = await get_my_data_model.asyncio_detailed(client=client) | ||
``` | ||
|
||
By default, when you're calling an HTTPS API it will attempt to verify that SSL is working correctly. Using certificate verification is highly recommended most of the time, but sometimes you may need to authenticate to a server (especially an internal server) using a custom certificate bundle. | ||
|
||
```python | ||
client = AuthenticatedClient( | ||
base_url="https://internal_api.example.com", | ||
token="SuperSecretToken", | ||
verify_ssl="/path/to/certificate_bundle.pem", | ||
) | ||
``` | ||
|
||
You can also disable certificate validation altogether, but beware that **this is a security risk**. | ||
|
||
```python | ||
client = AuthenticatedClient( | ||
base_url="https://internal_api.example.com", | ||
token="SuperSecretToken", | ||
verify_ssl=False | ||
) | ||
``` | ||
|
||
Things to know: | ||
1. Every path/method combo becomes a Python module with four functions: | ||
1. `sync`: Blocking request that returns parsed data (if successful) or `None` | ||
1. `sync_detailed`: Blocking request that always returns a `Request`, optionally with `parsed` set if the request was successful. | ||
1. `asyncio`: Like `sync` but async instead of blocking | ||
1. `asyncio_detailed`: Like `sync_detailed` but async instead of blocking | ||
|
||
1. All path/query params, and bodies become method arguments. | ||
1. If your endpoint had any tags on it, the first tag will be used as a module name for the function (my_tag above) | ||
1. Any endpoint which did not have a tag will be in `my_enum_api_client.api.default` | ||
|
||
## Advanced customizations | ||
|
||
There are more settings on the generated `Client` class which let you control more runtime behavior, check out the docstring on that class for more info. You can also customize the underlying `httpx.Client` or `httpx.AsyncClient` (depending on your use-case): | ||
|
||
```python | ||
from my_enum_api_client import Client | ||
|
||
def log_request(request): | ||
print(f"Request event hook: {request.method} {request.url} - Waiting for response") | ||
|
||
def log_response(response): | ||
request = response.request | ||
print(f"Response event hook: {request.method} {request.url} - Status {response.status_code}") | ||
|
||
client = Client( | ||
base_url="https://api.example.com", | ||
httpx_args={"event_hooks": {"request": [log_request], "response": [log_response]}}, | ||
) | ||
|
||
# Or get the underlying httpx client to modify directly with client.get_httpx_client() or client.get_async_httpx_client() | ||
``` | ||
|
||
You can even set the httpx client directly, but beware that this will override any existing settings (e.g., base_url): | ||
|
||
```python | ||
import httpx | ||
from my_enum_api_client import Client | ||
|
||
client = Client( | ||
base_url="https://api.example.com", | ||
) | ||
# Note that base_url needs to be re-set, as would any shared cookies, headers, etc. | ||
client.set_httpx_client(httpx.Client(base_url="https://api.example.com", proxies="http://localhost:8030")) | ||
``` | ||
|
||
## Building / publishing this package | ||
This project uses [Poetry](https://python-poetry.org/) to manage dependencies and packaging. Here are the basics: | ||
1. Update the metadata in pyproject.toml (e.g. authors, version) | ||
1. If you're using a private repository, configure it with Poetry | ||
1. `poetry config repositories.<your-repository-name> <url-to-your-repository>` | ||
1. `poetry config http-basic.<your-repository-name> <username> <password>` | ||
1. Publish the client with `poetry publish --build -r <your-repository-name>` or, if for public PyPI, just `poetry publish --build` | ||
|
||
If you want to install this client into another project without publishing it (e.g. for development) then: | ||
1. If that project **is using Poetry**, you can simply do `poetry add <path-to-this-client>` from that project | ||
1. If that project is not using Poetry: | ||
1. Build a wheel with `poetry build -f wheel` | ||
1. Install that wheel from the other project `pip install <path-to-wheel>` |
8 changes: 8 additions & 0 deletions
8
end_to_end_tests/literal-enums-golden-record/my_enum_api_client/__init__.py
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
"""A client library for accessing My Enum API""" | ||
|
||
from .client import AuthenticatedClient, Client | ||
|
||
__all__ = ( | ||
"AuthenticatedClient", | ||
"Client", | ||
) |
1 change: 1 addition & 0 deletions
1
end_to_end_tests/literal-enums-golden-record/my_enum_api_client/api/__init__.py
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
"""Contains methods for accessing the API""" |
Empty file.
101 changes: 101 additions & 0 deletions
101
...iteral-enums-golden-record/my_enum_api_client/api/enums/bool_enum_tests_bool_enum_post.py
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,101 @@ | ||
from http import HTTPStatus | ||
from typing import Any, Dict, Optional, Union | ||
|
||
import httpx | ||
|
||
from ... import errors | ||
from ...client import AuthenticatedClient, Client | ||
from ...types import UNSET, Response | ||
|
||
|
||
def _get_kwargs( | ||
*, | ||
bool_enum: bool, | ||
) -> Dict[str, Any]: | ||
params: Dict[str, Any] = {} | ||
|
||
params["bool_enum"] = bool_enum | ||
|
||
params = {k: v for k, v in params.items() if v is not UNSET and v is not None} | ||
|
||
_kwargs: Dict[str, Any] = { | ||
"method": "post", | ||
"url": "/enum/bool", | ||
"params": params, | ||
} | ||
|
||
return _kwargs | ||
|
||
|
||
def _parse_response(*, client: Union[AuthenticatedClient, Client], response: httpx.Response) -> Optional[Any]: | ||
if response.status_code == HTTPStatus.OK: | ||
return None | ||
if client.raise_on_unexpected_status: | ||
raise errors.UnexpectedStatus(response.status_code, response.content) | ||
else: | ||
return None | ||
|
||
|
||
def _build_response(*, client: Union[AuthenticatedClient, Client], response: httpx.Response) -> Response[Any]: | ||
return Response( | ||
status_code=HTTPStatus(response.status_code), | ||
content=response.content, | ||
headers=response.headers, | ||
parsed=_parse_response(client=client, response=response), | ||
) | ||
|
||
|
||
def sync_detailed( | ||
*, | ||
client: Union[AuthenticatedClient, Client], | ||
bool_enum: bool, | ||
) -> Response[Any]: | ||
"""Bool Enum | ||
Args: | ||
bool_enum (bool): | ||
Raises: | ||
errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True. | ||
httpx.TimeoutException: If the request takes longer than Client.timeout. | ||
Returns: | ||
Response[Any] | ||
""" | ||
|
||
kwargs = _get_kwargs( | ||
bool_enum=bool_enum, | ||
) | ||
|
||
response = client.get_httpx_client().request( | ||
**kwargs, | ||
) | ||
|
||
return _build_response(client=client, response=response) | ||
|
||
|
||
async def asyncio_detailed( | ||
*, | ||
client: Union[AuthenticatedClient, Client], | ||
bool_enum: bool, | ||
) -> Response[Any]: | ||
"""Bool Enum | ||
Args: | ||
bool_enum (bool): | ||
Raises: | ||
errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True. | ||
httpx.TimeoutException: If the request takes longer than Client.timeout. | ||
Returns: | ||
Response[Any] | ||
""" | ||
|
||
kwargs = _get_kwargs( | ||
bool_enum=bool_enum, | ||
) | ||
|
||
response = await client.get_async_httpx_client().request(**kwargs) | ||
|
||
return _build_response(client=client, response=response) |
103 changes: 103 additions & 0 deletions
103
.../literal-enums-golden-record/my_enum_api_client/api/enums/int_enum_tests_int_enum_post.py
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,103 @@ | ||
from http import HTTPStatus | ||
from typing import Any, Dict, Optional, Union | ||
|
||
import httpx | ||
|
||
from ... import errors | ||
from ...client import AuthenticatedClient, Client | ||
from ...models.an_int_enum import AnIntEnum | ||
from ...types import UNSET, Response | ||
|
||
|
||
def _get_kwargs( | ||
*, | ||
int_enum: AnIntEnum, | ||
) -> Dict[str, Any]: | ||
params: Dict[str, Any] = {} | ||
|
||
json_int_enum: int = int_enum | ||
params["int_enum"] = json_int_enum | ||
|
||
params = {k: v for k, v in params.items() if v is not UNSET and v is not None} | ||
|
||
_kwargs: Dict[str, Any] = { | ||
"method": "post", | ||
"url": "/enum/int", | ||
"params": params, | ||
} | ||
|
||
return _kwargs | ||
|
||
|
||
def _parse_response(*, client: Union[AuthenticatedClient, Client], response: httpx.Response) -> Optional[Any]: | ||
if response.status_code == HTTPStatus.OK: | ||
return None | ||
if client.raise_on_unexpected_status: | ||
raise errors.UnexpectedStatus(response.status_code, response.content) | ||
else: | ||
return None | ||
|
||
|
||
def _build_response(*, client: Union[AuthenticatedClient, Client], response: httpx.Response) -> Response[Any]: | ||
return Response( | ||
status_code=HTTPStatus(response.status_code), | ||
content=response.content, | ||
headers=response.headers, | ||
parsed=_parse_response(client=client, response=response), | ||
) | ||
|
||
|
||
def sync_detailed( | ||
*, | ||
client: Union[AuthenticatedClient, Client], | ||
int_enum: AnIntEnum, | ||
) -> Response[Any]: | ||
"""Int Enum | ||
Args: | ||
int_enum (AnIntEnum): An enumeration. | ||
Raises: | ||
errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True. | ||
httpx.TimeoutException: If the request takes longer than Client.timeout. | ||
Returns: | ||
Response[Any] | ||
""" | ||
|
||
kwargs = _get_kwargs( | ||
int_enum=int_enum, | ||
) | ||
|
||
response = client.get_httpx_client().request( | ||
**kwargs, | ||
) | ||
|
||
return _build_response(client=client, response=response) | ||
|
||
|
||
async def asyncio_detailed( | ||
*, | ||
client: Union[AuthenticatedClient, Client], | ||
int_enum: AnIntEnum, | ||
) -> Response[Any]: | ||
"""Int Enum | ||
Args: | ||
int_enum (AnIntEnum): An enumeration. | ||
Raises: | ||
errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True. | ||
httpx.TimeoutException: If the request takes longer than Client.timeout. | ||
Returns: | ||
Response[Any] | ||
""" | ||
|
||
kwargs = _get_kwargs( | ||
int_enum=int_enum, | ||
) | ||
|
||
response = await client.get_async_httpx_client().request(**kwargs) | ||
|
||
return _build_response(client=client, response=response) |
Empty file.
Oops, something went wrong.