Compare commits
4 Commits
Author | SHA1 | Date | |
---|---|---|---|
a1c41cbd17 | |||
a4f6bb2a25 | |||
c05c588768 | |||
6d4b848568 |
@ -1,7 +1,9 @@
|
|||||||
# PhotosAPI_Client
|
# PhotosAPI_Client
|
||||||
|
|
||||||
A client library for accessing Photos API
|
A client library for accessing Photos API
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
|
|
||||||
First, create a client:
|
First, create a client:
|
||||||
|
|
||||||
```python
|
```python
|
||||||
@ -64,6 +66,7 @@ client = AuthenticatedClient(
|
|||||||
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.
|
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.
|
||||||
|
|
||||||
Things to know:
|
Things to know:
|
||||||
|
|
||||||
1. Every path/method combo becomes a Python module with four functions:
|
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`: 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. `sync_detailed`: Blocking request that always returns a `Request`, optionally with `parsed` set if the request was successful.
|
||||||
@ -75,7 +78,9 @@ Things to know:
|
|||||||
1. Any endpoint which did not have a tag will be in `photosapi_client.api.default`
|
1. Any endpoint which did not have a tag will be in `photosapi_client.api.default`
|
||||||
|
|
||||||
## Building / publishing this Client
|
## Building / publishing this Client
|
||||||
|
|
||||||
This project uses [Poetry](https://python-poetry.org/) to manage dependencies and packaging. Here are the basics:
|
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. Update the metadata in pyproject.toml (e.g. authors, version)
|
||||||
1. If you're using a private repository, configure it with Poetry
|
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 repositories.<your-repository-name> <url-to-your-repository>`
|
||||||
@ -83,6 +88,7 @@ This project uses [Poetry](https://python-poetry.org/) to manage dependencies a
|
|||||||
1. Publish the client with `poetry publish --build -r <your-repository-name>` or, if for public PyPI, just `poetry publish --build`
|
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:
|
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 using Poetry**, you can simply do `poetry add <path-to-this-client>` from that project
|
||||||
1. If that project is not using Poetry:
|
1. If that project is not using Poetry:
|
||||||
1. Build a wheel with `poetry build -f wheel`
|
1. Build a wheel with `poetry build -f wheel`
|
||||||
|
@ -1,2 +1,6 @@
|
|||||||
project_name_override: PhotosAPI_Client
|
project_name_override: PhotosAPI_Client
|
||||||
package_name_override: photosapi_client
|
package_name_override: photosapi_client
|
||||||
|
post_hooks:
|
||||||
|
- "autoflake -i -r --remove-all-unused-imports --remove-unused-variables --ignore-init-module-imports photosapi_client/"
|
||||||
|
- "isort photosapi_client/"
|
||||||
|
- "black photosapi_client/"
|
@ -1,4 +1,5 @@
|
|||||||
from http import HTTPStatus
|
from http import HTTPStatus
|
||||||
|
from io import BytesIO
|
||||||
from typing import Any, Dict, Optional, Union, cast
|
from typing import Any, Dict, Optional, Union, cast
|
||||||
|
|
||||||
import httpx
|
import httpx
|
||||||
@ -6,7 +7,7 @@ import httpx
|
|||||||
from ... import errors
|
from ... import errors
|
||||||
from ...client import AuthenticatedClient, Client
|
from ...client import AuthenticatedClient, Client
|
||||||
from ...models.http_validation_error import HTTPValidationError
|
from ...models.http_validation_error import HTTPValidationError
|
||||||
from ...types import Response
|
from ...types import File, Response
|
||||||
|
|
||||||
|
|
||||||
def _get_kwargs(
|
def _get_kwargs(
|
||||||
@ -29,7 +30,11 @@ def _get_kwargs(
|
|||||||
}
|
}
|
||||||
|
|
||||||
|
|
||||||
def _parse_response(*, client: Client, response: httpx.Response) -> Optional[Union[Any, HTTPValidationError]]:
|
def _parse_response(*, client: Client, response: httpx.Response) -> Optional[Union[Any, File, HTTPValidationError]]:
|
||||||
|
if response.status_code == HTTPStatus.OK:
|
||||||
|
response_200 = File(payload=BytesIO(response.content))
|
||||||
|
|
||||||
|
return response_200
|
||||||
if response.status_code == HTTPStatus.NOT_FOUND:
|
if response.status_code == HTTPStatus.NOT_FOUND:
|
||||||
response_404 = cast(Any, None)
|
response_404 = cast(Any, None)
|
||||||
return response_404
|
return response_404
|
||||||
@ -43,7 +48,7 @@ def _parse_response(*, client: Client, response: httpx.Response) -> Optional[Uni
|
|||||||
return None
|
return None
|
||||||
|
|
||||||
|
|
||||||
def _build_response(*, client: Client, response: httpx.Response) -> Response[Union[Any, HTTPValidationError]]:
|
def _build_response(*, client: Client, response: httpx.Response) -> Response[Union[Any, File, HTTPValidationError]]:
|
||||||
return Response(
|
return Response(
|
||||||
status_code=HTTPStatus(response.status_code),
|
status_code=HTTPStatus(response.status_code),
|
||||||
content=response.content,
|
content=response.content,
|
||||||
@ -56,7 +61,7 @@ def sync_detailed(
|
|||||||
id: str,
|
id: str,
|
||||||
*,
|
*,
|
||||||
client: AuthenticatedClient,
|
client: AuthenticatedClient,
|
||||||
) -> Response[Union[Any, HTTPValidationError]]:
|
) -> Response[Union[Any, File, HTTPValidationError]]:
|
||||||
"""Photo Get
|
"""Photo Get
|
||||||
|
|
||||||
Get a photo by id
|
Get a photo by id
|
||||||
@ -69,7 +74,7 @@ def sync_detailed(
|
|||||||
httpx.TimeoutException: If the request takes longer than Client.timeout.
|
httpx.TimeoutException: If the request takes longer than Client.timeout.
|
||||||
|
|
||||||
Returns:
|
Returns:
|
||||||
Response[Union[Any, HTTPValidationError]]
|
Response[Union[Any, File, HTTPValidationError]]
|
||||||
"""
|
"""
|
||||||
|
|
||||||
kwargs = _get_kwargs(
|
kwargs = _get_kwargs(
|
||||||
@ -89,7 +94,7 @@ def sync(
|
|||||||
id: str,
|
id: str,
|
||||||
*,
|
*,
|
||||||
client: AuthenticatedClient,
|
client: AuthenticatedClient,
|
||||||
) -> Optional[Union[Any, HTTPValidationError]]:
|
) -> Optional[Union[Any, File, HTTPValidationError]]:
|
||||||
"""Photo Get
|
"""Photo Get
|
||||||
|
|
||||||
Get a photo by id
|
Get a photo by id
|
||||||
@ -102,7 +107,7 @@ def sync(
|
|||||||
httpx.TimeoutException: If the request takes longer than Client.timeout.
|
httpx.TimeoutException: If the request takes longer than Client.timeout.
|
||||||
|
|
||||||
Returns:
|
Returns:
|
||||||
Union[Any, HTTPValidationError]
|
Union[Any, File, HTTPValidationError]
|
||||||
"""
|
"""
|
||||||
|
|
||||||
return sync_detailed(
|
return sync_detailed(
|
||||||
@ -115,7 +120,7 @@ async def asyncio_detailed(
|
|||||||
id: str,
|
id: str,
|
||||||
*,
|
*,
|
||||||
client: AuthenticatedClient,
|
client: AuthenticatedClient,
|
||||||
) -> Response[Union[Any, HTTPValidationError]]:
|
) -> Response[Union[Any, File, HTTPValidationError]]:
|
||||||
"""Photo Get
|
"""Photo Get
|
||||||
|
|
||||||
Get a photo by id
|
Get a photo by id
|
||||||
@ -128,7 +133,7 @@ async def asyncio_detailed(
|
|||||||
httpx.TimeoutException: If the request takes longer than Client.timeout.
|
httpx.TimeoutException: If the request takes longer than Client.timeout.
|
||||||
|
|
||||||
Returns:
|
Returns:
|
||||||
Response[Union[Any, HTTPValidationError]]
|
Response[Union[Any, File, HTTPValidationError]]
|
||||||
"""
|
"""
|
||||||
|
|
||||||
kwargs = _get_kwargs(
|
kwargs = _get_kwargs(
|
||||||
@ -146,7 +151,7 @@ async def asyncio(
|
|||||||
id: str,
|
id: str,
|
||||||
*,
|
*,
|
||||||
client: AuthenticatedClient,
|
client: AuthenticatedClient,
|
||||||
) -> Optional[Union[Any, HTTPValidationError]]:
|
) -> Optional[Union[Any, File, HTTPValidationError]]:
|
||||||
"""Photo Get
|
"""Photo Get
|
||||||
|
|
||||||
Get a photo by id
|
Get a photo by id
|
||||||
@ -159,7 +164,7 @@ async def asyncio(
|
|||||||
httpx.TimeoutException: If the request takes longer than Client.timeout.
|
httpx.TimeoutException: If the request takes longer than Client.timeout.
|
||||||
|
|
||||||
Returns:
|
Returns:
|
||||||
Union[Any, HTTPValidationError]
|
Union[Any, File, HTTPValidationError]
|
||||||
"""
|
"""
|
||||||
|
|
||||||
return (
|
return (
|
||||||
|
@ -0,0 +1,216 @@
|
|||||||
|
from http import HTTPStatus
|
||||||
|
from typing import Any, Dict, Optional, Union, cast
|
||||||
|
|
||||||
|
import httpx
|
||||||
|
|
||||||
|
from ... import errors
|
||||||
|
from ...client import AuthenticatedClient, Client
|
||||||
|
from ...models.http_validation_error import HTTPValidationError
|
||||||
|
from ...models.random_search_results_photo import RandomSearchResultsPhoto
|
||||||
|
from ...types import UNSET, Response, Unset
|
||||||
|
|
||||||
|
|
||||||
|
def _get_kwargs(
|
||||||
|
album: str,
|
||||||
|
*,
|
||||||
|
client: AuthenticatedClient,
|
||||||
|
caption: Union[Unset, None, str] = UNSET,
|
||||||
|
limit: Union[Unset, None, int] = 100,
|
||||||
|
) -> Dict[str, Any]:
|
||||||
|
url = "{}/albums/{album}/photos/random".format(client.base_url, album=album)
|
||||||
|
|
||||||
|
headers: Dict[str, str] = client.get_headers()
|
||||||
|
cookies: Dict[str, Any] = client.get_cookies()
|
||||||
|
|
||||||
|
params: Dict[str, Any] = {}
|
||||||
|
params["caption"] = caption
|
||||||
|
|
||||||
|
params["limit"] = limit
|
||||||
|
|
||||||
|
params = {k: v for k, v in params.items() if v is not UNSET and v is not None}
|
||||||
|
|
||||||
|
return {
|
||||||
|
"method": "get",
|
||||||
|
"url": url,
|
||||||
|
"headers": headers,
|
||||||
|
"cookies": cookies,
|
||||||
|
"timeout": client.get_timeout(),
|
||||||
|
"follow_redirects": client.follow_redirects,
|
||||||
|
"params": params,
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
def _parse_response(
|
||||||
|
*, client: Client, response: httpx.Response
|
||||||
|
) -> Optional[Union[Any, HTTPValidationError, RandomSearchResultsPhoto]]:
|
||||||
|
if response.status_code == HTTPStatus.OK:
|
||||||
|
response_200 = RandomSearchResultsPhoto.from_dict(response.json())
|
||||||
|
|
||||||
|
return response_200
|
||||||
|
if response.status_code == HTTPStatus.BAD_REQUEST:
|
||||||
|
response_400 = cast(Any, None)
|
||||||
|
return response_400
|
||||||
|
if response.status_code == HTTPStatus.NOT_FOUND:
|
||||||
|
response_404 = cast(Any, None)
|
||||||
|
return response_404
|
||||||
|
if response.status_code == HTTPStatus.UNPROCESSABLE_ENTITY:
|
||||||
|
response_422 = HTTPValidationError.from_dict(response.json())
|
||||||
|
|
||||||
|
return response_422
|
||||||
|
if client.raise_on_unexpected_status:
|
||||||
|
raise errors.UnexpectedStatus(response.status_code, response.content)
|
||||||
|
else:
|
||||||
|
return None
|
||||||
|
|
||||||
|
|
||||||
|
def _build_response(
|
||||||
|
*, client: Client, response: httpx.Response
|
||||||
|
) -> Response[Union[Any, HTTPValidationError, RandomSearchResultsPhoto]]:
|
||||||
|
return Response(
|
||||||
|
status_code=HTTPStatus(response.status_code),
|
||||||
|
content=response.content,
|
||||||
|
headers=response.headers,
|
||||||
|
parsed=_parse_response(client=client, response=response),
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def sync_detailed(
|
||||||
|
album: str,
|
||||||
|
*,
|
||||||
|
client: AuthenticatedClient,
|
||||||
|
caption: Union[Unset, None, str] = UNSET,
|
||||||
|
limit: Union[Unset, None, int] = 100,
|
||||||
|
) -> Response[Union[Any, HTTPValidationError, RandomSearchResultsPhoto]]:
|
||||||
|
"""Photo Random
|
||||||
|
|
||||||
|
Get one random photo, optionally by caption
|
||||||
|
|
||||||
|
Args:
|
||||||
|
album (str):
|
||||||
|
caption (Union[Unset, None, str]):
|
||||||
|
limit (Union[Unset, None, int]): Default: 100.
|
||||||
|
|
||||||
|
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[Union[Any, HTTPValidationError, RandomSearchResultsPhoto]]
|
||||||
|
"""
|
||||||
|
|
||||||
|
kwargs = _get_kwargs(
|
||||||
|
album=album,
|
||||||
|
client=client,
|
||||||
|
caption=caption,
|
||||||
|
limit=limit,
|
||||||
|
)
|
||||||
|
|
||||||
|
response = httpx.request(
|
||||||
|
verify=client.verify_ssl,
|
||||||
|
**kwargs,
|
||||||
|
)
|
||||||
|
|
||||||
|
return _build_response(client=client, response=response)
|
||||||
|
|
||||||
|
|
||||||
|
def sync(
|
||||||
|
album: str,
|
||||||
|
*,
|
||||||
|
client: AuthenticatedClient,
|
||||||
|
caption: Union[Unset, None, str] = UNSET,
|
||||||
|
limit: Union[Unset, None, int] = 100,
|
||||||
|
) -> Optional[Union[Any, HTTPValidationError, RandomSearchResultsPhoto]]:
|
||||||
|
"""Photo Random
|
||||||
|
|
||||||
|
Get one random photo, optionally by caption
|
||||||
|
|
||||||
|
Args:
|
||||||
|
album (str):
|
||||||
|
caption (Union[Unset, None, str]):
|
||||||
|
limit (Union[Unset, None, int]): Default: 100.
|
||||||
|
|
||||||
|
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:
|
||||||
|
Union[Any, HTTPValidationError, RandomSearchResultsPhoto]
|
||||||
|
"""
|
||||||
|
|
||||||
|
return sync_detailed(
|
||||||
|
album=album,
|
||||||
|
client=client,
|
||||||
|
caption=caption,
|
||||||
|
limit=limit,
|
||||||
|
).parsed
|
||||||
|
|
||||||
|
|
||||||
|
async def asyncio_detailed(
|
||||||
|
album: str,
|
||||||
|
*,
|
||||||
|
client: AuthenticatedClient,
|
||||||
|
caption: Union[Unset, None, str] = UNSET,
|
||||||
|
limit: Union[Unset, None, int] = 100,
|
||||||
|
) -> Response[Union[Any, HTTPValidationError, RandomSearchResultsPhoto]]:
|
||||||
|
"""Photo Random
|
||||||
|
|
||||||
|
Get one random photo, optionally by caption
|
||||||
|
|
||||||
|
Args:
|
||||||
|
album (str):
|
||||||
|
caption (Union[Unset, None, str]):
|
||||||
|
limit (Union[Unset, None, int]): Default: 100.
|
||||||
|
|
||||||
|
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[Union[Any, HTTPValidationError, RandomSearchResultsPhoto]]
|
||||||
|
"""
|
||||||
|
|
||||||
|
kwargs = _get_kwargs(
|
||||||
|
album=album,
|
||||||
|
client=client,
|
||||||
|
caption=caption,
|
||||||
|
limit=limit,
|
||||||
|
)
|
||||||
|
|
||||||
|
async with httpx.AsyncClient(verify=client.verify_ssl) as _client:
|
||||||
|
response = await _client.request(**kwargs)
|
||||||
|
|
||||||
|
return _build_response(client=client, response=response)
|
||||||
|
|
||||||
|
|
||||||
|
async def asyncio(
|
||||||
|
album: str,
|
||||||
|
*,
|
||||||
|
client: AuthenticatedClient,
|
||||||
|
caption: Union[Unset, None, str] = UNSET,
|
||||||
|
limit: Union[Unset, None, int] = 100,
|
||||||
|
) -> Optional[Union[Any, HTTPValidationError, RandomSearchResultsPhoto]]:
|
||||||
|
"""Photo Random
|
||||||
|
|
||||||
|
Get one random photo, optionally by caption
|
||||||
|
|
||||||
|
Args:
|
||||||
|
album (str):
|
||||||
|
caption (Union[Unset, None, str]):
|
||||||
|
limit (Union[Unset, None, int]): Default: 100.
|
||||||
|
|
||||||
|
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:
|
||||||
|
Union[Any, HTTPValidationError, RandomSearchResultsPhoto]
|
||||||
|
"""
|
||||||
|
|
||||||
|
return (
|
||||||
|
await asyncio_detailed(
|
||||||
|
album=album,
|
||||||
|
client=client,
|
||||||
|
caption=caption,
|
||||||
|
limit=limit,
|
||||||
|
)
|
||||||
|
).parsed
|
@ -1,4 +1,5 @@
|
|||||||
from http import HTTPStatus
|
from http import HTTPStatus
|
||||||
|
from io import BytesIO
|
||||||
from typing import Any, Dict, Optional, Union, cast
|
from typing import Any, Dict, Optional, Union, cast
|
||||||
|
|
||||||
import httpx
|
import httpx
|
||||||
@ -6,7 +7,7 @@ import httpx
|
|||||||
from ... import errors
|
from ... import errors
|
||||||
from ...client import AuthenticatedClient, Client
|
from ...client import AuthenticatedClient, Client
|
||||||
from ...models.http_validation_error import HTTPValidationError
|
from ...models.http_validation_error import HTTPValidationError
|
||||||
from ...types import Response
|
from ...types import File, Response
|
||||||
|
|
||||||
|
|
||||||
def _get_kwargs(
|
def _get_kwargs(
|
||||||
@ -29,7 +30,11 @@ def _get_kwargs(
|
|||||||
}
|
}
|
||||||
|
|
||||||
|
|
||||||
def _parse_response(*, client: Client, response: httpx.Response) -> Optional[Union[Any, HTTPValidationError]]:
|
def _parse_response(*, client: Client, response: httpx.Response) -> Optional[Union[Any, File, HTTPValidationError]]:
|
||||||
|
if response.status_code == HTTPStatus.OK:
|
||||||
|
response_200 = File(payload=BytesIO(response.content))
|
||||||
|
|
||||||
|
return response_200
|
||||||
if response.status_code == HTTPStatus.NOT_FOUND:
|
if response.status_code == HTTPStatus.NOT_FOUND:
|
||||||
response_404 = cast(Any, None)
|
response_404 = cast(Any, None)
|
||||||
return response_404
|
return response_404
|
||||||
@ -43,7 +48,7 @@ def _parse_response(*, client: Client, response: httpx.Response) -> Optional[Uni
|
|||||||
return None
|
return None
|
||||||
|
|
||||||
|
|
||||||
def _build_response(*, client: Client, response: httpx.Response) -> Response[Union[Any, HTTPValidationError]]:
|
def _build_response(*, client: Client, response: httpx.Response) -> Response[Union[Any, File, HTTPValidationError]]:
|
||||||
return Response(
|
return Response(
|
||||||
status_code=HTTPStatus(response.status_code),
|
status_code=HTTPStatus(response.status_code),
|
||||||
content=response.content,
|
content=response.content,
|
||||||
@ -56,7 +61,7 @@ def sync_detailed(
|
|||||||
id: str,
|
id: str,
|
||||||
*,
|
*,
|
||||||
client: AuthenticatedClient,
|
client: AuthenticatedClient,
|
||||||
) -> Response[Union[Any, HTTPValidationError]]:
|
) -> Response[Union[Any, File, HTTPValidationError]]:
|
||||||
"""Video Get
|
"""Video Get
|
||||||
|
|
||||||
Get a video by id
|
Get a video by id
|
||||||
@ -69,7 +74,7 @@ def sync_detailed(
|
|||||||
httpx.TimeoutException: If the request takes longer than Client.timeout.
|
httpx.TimeoutException: If the request takes longer than Client.timeout.
|
||||||
|
|
||||||
Returns:
|
Returns:
|
||||||
Response[Union[Any, HTTPValidationError]]
|
Response[Union[Any, File, HTTPValidationError]]
|
||||||
"""
|
"""
|
||||||
|
|
||||||
kwargs = _get_kwargs(
|
kwargs = _get_kwargs(
|
||||||
@ -89,7 +94,7 @@ def sync(
|
|||||||
id: str,
|
id: str,
|
||||||
*,
|
*,
|
||||||
client: AuthenticatedClient,
|
client: AuthenticatedClient,
|
||||||
) -> Optional[Union[Any, HTTPValidationError]]:
|
) -> Optional[Union[Any, File, HTTPValidationError]]:
|
||||||
"""Video Get
|
"""Video Get
|
||||||
|
|
||||||
Get a video by id
|
Get a video by id
|
||||||
@ -102,7 +107,7 @@ def sync(
|
|||||||
httpx.TimeoutException: If the request takes longer than Client.timeout.
|
httpx.TimeoutException: If the request takes longer than Client.timeout.
|
||||||
|
|
||||||
Returns:
|
Returns:
|
||||||
Union[Any, HTTPValidationError]
|
Union[Any, File, HTTPValidationError]
|
||||||
"""
|
"""
|
||||||
|
|
||||||
return sync_detailed(
|
return sync_detailed(
|
||||||
@ -115,7 +120,7 @@ async def asyncio_detailed(
|
|||||||
id: str,
|
id: str,
|
||||||
*,
|
*,
|
||||||
client: AuthenticatedClient,
|
client: AuthenticatedClient,
|
||||||
) -> Response[Union[Any, HTTPValidationError]]:
|
) -> Response[Union[Any, File, HTTPValidationError]]:
|
||||||
"""Video Get
|
"""Video Get
|
||||||
|
|
||||||
Get a video by id
|
Get a video by id
|
||||||
@ -128,7 +133,7 @@ async def asyncio_detailed(
|
|||||||
httpx.TimeoutException: If the request takes longer than Client.timeout.
|
httpx.TimeoutException: If the request takes longer than Client.timeout.
|
||||||
|
|
||||||
Returns:
|
Returns:
|
||||||
Response[Union[Any, HTTPValidationError]]
|
Response[Union[Any, File, HTTPValidationError]]
|
||||||
"""
|
"""
|
||||||
|
|
||||||
kwargs = _get_kwargs(
|
kwargs = _get_kwargs(
|
||||||
@ -146,7 +151,7 @@ async def asyncio(
|
|||||||
id: str,
|
id: str,
|
||||||
*,
|
*,
|
||||||
client: AuthenticatedClient,
|
client: AuthenticatedClient,
|
||||||
) -> Optional[Union[Any, HTTPValidationError]]:
|
) -> Optional[Union[Any, File, HTTPValidationError]]:
|
||||||
"""Video Get
|
"""Video Get
|
||||||
|
|
||||||
Get a video by id
|
Get a video by id
|
||||||
@ -159,7 +164,7 @@ async def asyncio(
|
|||||||
httpx.TimeoutException: If the request takes longer than Client.timeout.
|
httpx.TimeoutException: If the request takes longer than Client.timeout.
|
||||||
|
|
||||||
Returns:
|
Returns:
|
||||||
Union[Any, HTTPValidationError]
|
Union[Any, File, HTTPValidationError]
|
||||||
"""
|
"""
|
||||||
|
|
||||||
return (
|
return (
|
||||||
|
@ -0,0 +1,216 @@
|
|||||||
|
from http import HTTPStatus
|
||||||
|
from typing import Any, Dict, Optional, Union, cast
|
||||||
|
|
||||||
|
import httpx
|
||||||
|
|
||||||
|
from ... import errors
|
||||||
|
from ...client import AuthenticatedClient, Client
|
||||||
|
from ...models.http_validation_error import HTTPValidationError
|
||||||
|
from ...models.random_search_results_video import RandomSearchResultsVideo
|
||||||
|
from ...types import UNSET, Response, Unset
|
||||||
|
|
||||||
|
|
||||||
|
def _get_kwargs(
|
||||||
|
album: str,
|
||||||
|
*,
|
||||||
|
client: AuthenticatedClient,
|
||||||
|
caption: Union[Unset, None, str] = UNSET,
|
||||||
|
limit: Union[Unset, None, int] = 100,
|
||||||
|
) -> Dict[str, Any]:
|
||||||
|
url = "{}/albums/{album}/videos/random".format(client.base_url, album=album)
|
||||||
|
|
||||||
|
headers: Dict[str, str] = client.get_headers()
|
||||||
|
cookies: Dict[str, Any] = client.get_cookies()
|
||||||
|
|
||||||
|
params: Dict[str, Any] = {}
|
||||||
|
params["caption"] = caption
|
||||||
|
|
||||||
|
params["limit"] = limit
|
||||||
|
|
||||||
|
params = {k: v for k, v in params.items() if v is not UNSET and v is not None}
|
||||||
|
|
||||||
|
return {
|
||||||
|
"method": "get",
|
||||||
|
"url": url,
|
||||||
|
"headers": headers,
|
||||||
|
"cookies": cookies,
|
||||||
|
"timeout": client.get_timeout(),
|
||||||
|
"follow_redirects": client.follow_redirects,
|
||||||
|
"params": params,
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
def _parse_response(
|
||||||
|
*, client: Client, response: httpx.Response
|
||||||
|
) -> Optional[Union[Any, HTTPValidationError, RandomSearchResultsVideo]]:
|
||||||
|
if response.status_code == HTTPStatus.OK:
|
||||||
|
response_200 = RandomSearchResultsVideo.from_dict(response.json())
|
||||||
|
|
||||||
|
return response_200
|
||||||
|
if response.status_code == HTTPStatus.BAD_REQUEST:
|
||||||
|
response_400 = cast(Any, None)
|
||||||
|
return response_400
|
||||||
|
if response.status_code == HTTPStatus.NOT_FOUND:
|
||||||
|
response_404 = cast(Any, None)
|
||||||
|
return response_404
|
||||||
|
if response.status_code == HTTPStatus.UNPROCESSABLE_ENTITY:
|
||||||
|
response_422 = HTTPValidationError.from_dict(response.json())
|
||||||
|
|
||||||
|
return response_422
|
||||||
|
if client.raise_on_unexpected_status:
|
||||||
|
raise errors.UnexpectedStatus(response.status_code, response.content)
|
||||||
|
else:
|
||||||
|
return None
|
||||||
|
|
||||||
|
|
||||||
|
def _build_response(
|
||||||
|
*, client: Client, response: httpx.Response
|
||||||
|
) -> Response[Union[Any, HTTPValidationError, RandomSearchResultsVideo]]:
|
||||||
|
return Response(
|
||||||
|
status_code=HTTPStatus(response.status_code),
|
||||||
|
content=response.content,
|
||||||
|
headers=response.headers,
|
||||||
|
parsed=_parse_response(client=client, response=response),
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def sync_detailed(
|
||||||
|
album: str,
|
||||||
|
*,
|
||||||
|
client: AuthenticatedClient,
|
||||||
|
caption: Union[Unset, None, str] = UNSET,
|
||||||
|
limit: Union[Unset, None, int] = 100,
|
||||||
|
) -> Response[Union[Any, HTTPValidationError, RandomSearchResultsVideo]]:
|
||||||
|
"""Video Random
|
||||||
|
|
||||||
|
Get one random video, optionally by caption
|
||||||
|
|
||||||
|
Args:
|
||||||
|
album (str):
|
||||||
|
caption (Union[Unset, None, str]):
|
||||||
|
limit (Union[Unset, None, int]): Default: 100.
|
||||||
|
|
||||||
|
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[Union[Any, HTTPValidationError, RandomSearchResultsVideo]]
|
||||||
|
"""
|
||||||
|
|
||||||
|
kwargs = _get_kwargs(
|
||||||
|
album=album,
|
||||||
|
client=client,
|
||||||
|
caption=caption,
|
||||||
|
limit=limit,
|
||||||
|
)
|
||||||
|
|
||||||
|
response = httpx.request(
|
||||||
|
verify=client.verify_ssl,
|
||||||
|
**kwargs,
|
||||||
|
)
|
||||||
|
|
||||||
|
return _build_response(client=client, response=response)
|
||||||
|
|
||||||
|
|
||||||
|
def sync(
|
||||||
|
album: str,
|
||||||
|
*,
|
||||||
|
client: AuthenticatedClient,
|
||||||
|
caption: Union[Unset, None, str] = UNSET,
|
||||||
|
limit: Union[Unset, None, int] = 100,
|
||||||
|
) -> Optional[Union[Any, HTTPValidationError, RandomSearchResultsVideo]]:
|
||||||
|
"""Video Random
|
||||||
|
|
||||||
|
Get one random video, optionally by caption
|
||||||
|
|
||||||
|
Args:
|
||||||
|
album (str):
|
||||||
|
caption (Union[Unset, None, str]):
|
||||||
|
limit (Union[Unset, None, int]): Default: 100.
|
||||||
|
|
||||||
|
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:
|
||||||
|
Union[Any, HTTPValidationError, RandomSearchResultsVideo]
|
||||||
|
"""
|
||||||
|
|
||||||
|
return sync_detailed(
|
||||||
|
album=album,
|
||||||
|
client=client,
|
||||||
|
caption=caption,
|
||||||
|
limit=limit,
|
||||||
|
).parsed
|
||||||
|
|
||||||
|
|
||||||
|
async def asyncio_detailed(
|
||||||
|
album: str,
|
||||||
|
*,
|
||||||
|
client: AuthenticatedClient,
|
||||||
|
caption: Union[Unset, None, str] = UNSET,
|
||||||
|
limit: Union[Unset, None, int] = 100,
|
||||||
|
) -> Response[Union[Any, HTTPValidationError, RandomSearchResultsVideo]]:
|
||||||
|
"""Video Random
|
||||||
|
|
||||||
|
Get one random video, optionally by caption
|
||||||
|
|
||||||
|
Args:
|
||||||
|
album (str):
|
||||||
|
caption (Union[Unset, None, str]):
|
||||||
|
limit (Union[Unset, None, int]): Default: 100.
|
||||||
|
|
||||||
|
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[Union[Any, HTTPValidationError, RandomSearchResultsVideo]]
|
||||||
|
"""
|
||||||
|
|
||||||
|
kwargs = _get_kwargs(
|
||||||
|
album=album,
|
||||||
|
client=client,
|
||||||
|
caption=caption,
|
||||||
|
limit=limit,
|
||||||
|
)
|
||||||
|
|
||||||
|
async with httpx.AsyncClient(verify=client.verify_ssl) as _client:
|
||||||
|
response = await _client.request(**kwargs)
|
||||||
|
|
||||||
|
return _build_response(client=client, response=response)
|
||||||
|
|
||||||
|
|
||||||
|
async def asyncio(
|
||||||
|
album: str,
|
||||||
|
*,
|
||||||
|
client: AuthenticatedClient,
|
||||||
|
caption: Union[Unset, None, str] = UNSET,
|
||||||
|
limit: Union[Unset, None, int] = 100,
|
||||||
|
) -> Optional[Union[Any, HTTPValidationError, RandomSearchResultsVideo]]:
|
||||||
|
"""Video Random
|
||||||
|
|
||||||
|
Get one random video, optionally by caption
|
||||||
|
|
||||||
|
Args:
|
||||||
|
album (str):
|
||||||
|
caption (Union[Unset, None, str]):
|
||||||
|
limit (Union[Unset, None, int]): Default: 100.
|
||||||
|
|
||||||
|
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:
|
||||||
|
Union[Any, HTTPValidationError, RandomSearchResultsVideo]
|
||||||
|
"""
|
||||||
|
|
||||||
|
return (
|
||||||
|
await asyncio_detailed(
|
||||||
|
album=album,
|
||||||
|
client=client,
|
||||||
|
caption=caption,
|
||||||
|
limit=limit,
|
||||||
|
)
|
||||||
|
).parsed
|
@ -11,6 +11,8 @@ from .http_validation_error import HTTPValidationError
|
|||||||
from .photo import Photo
|
from .photo import Photo
|
||||||
from .photo_public import PhotoPublic
|
from .photo_public import PhotoPublic
|
||||||
from .photo_search import PhotoSearch
|
from .photo_search import PhotoSearch
|
||||||
|
from .random_search_results_photo import RandomSearchResultsPhoto
|
||||||
|
from .random_search_results_video import RandomSearchResultsVideo
|
||||||
from .search_results_album import SearchResultsAlbum
|
from .search_results_album import SearchResultsAlbum
|
||||||
from .search_results_photo import SearchResultsPhoto
|
from .search_results_photo import SearchResultsPhoto
|
||||||
from .search_results_video import SearchResultsVideo
|
from .search_results_video import SearchResultsVideo
|
||||||
@ -33,6 +35,8 @@ __all__ = (
|
|||||||
"Photo",
|
"Photo",
|
||||||
"PhotoPublic",
|
"PhotoPublic",
|
||||||
"PhotoSearch",
|
"PhotoSearch",
|
||||||
|
"RandomSearchResultsPhoto",
|
||||||
|
"RandomSearchResultsVideo",
|
||||||
"SearchResultsAlbum",
|
"SearchResultsAlbum",
|
||||||
"SearchResultsPhoto",
|
"SearchResultsPhoto",
|
||||||
"SearchResultsVideo",
|
"SearchResultsVideo",
|
||||||
|
72
photosapi_client/models/random_search_results_photo.py
Normal file
72
photosapi_client/models/random_search_results_photo.py
Normal file
@ -0,0 +1,72 @@
|
|||||||
|
from typing import TYPE_CHECKING, Any, Dict, List, Type, TypeVar
|
||||||
|
|
||||||
|
import attr
|
||||||
|
|
||||||
|
if TYPE_CHECKING:
|
||||||
|
from ..models.photo_search import PhotoSearch
|
||||||
|
|
||||||
|
|
||||||
|
T = TypeVar("T", bound="RandomSearchResultsPhoto")
|
||||||
|
|
||||||
|
|
||||||
|
@attr.s(auto_attribs=True)
|
||||||
|
class RandomSearchResultsPhoto:
|
||||||
|
"""
|
||||||
|
Attributes:
|
||||||
|
results (List['PhotoSearch']):
|
||||||
|
"""
|
||||||
|
|
||||||
|
results: List["PhotoSearch"]
|
||||||
|
additional_properties: Dict[str, Any] = attr.ib(init=False, factory=dict)
|
||||||
|
|
||||||
|
def to_dict(self) -> Dict[str, Any]:
|
||||||
|
results = []
|
||||||
|
for results_item_data in self.results:
|
||||||
|
results_item = results_item_data.to_dict()
|
||||||
|
|
||||||
|
results.append(results_item)
|
||||||
|
|
||||||
|
field_dict: Dict[str, Any] = {}
|
||||||
|
field_dict.update(self.additional_properties)
|
||||||
|
field_dict.update(
|
||||||
|
{
|
||||||
|
"results": results,
|
||||||
|
}
|
||||||
|
)
|
||||||
|
|
||||||
|
return field_dict
|
||||||
|
|
||||||
|
@classmethod
|
||||||
|
def from_dict(cls: Type[T], src_dict: Dict[str, Any]) -> T:
|
||||||
|
from ..models.photo_search import PhotoSearch
|
||||||
|
|
||||||
|
d = src_dict.copy()
|
||||||
|
results = []
|
||||||
|
_results = d.pop("results")
|
||||||
|
for results_item_data in _results:
|
||||||
|
results_item = PhotoSearch.from_dict(results_item_data)
|
||||||
|
|
||||||
|
results.append(results_item)
|
||||||
|
|
||||||
|
random_search_results_photo = cls(
|
||||||
|
results=results,
|
||||||
|
)
|
||||||
|
|
||||||
|
random_search_results_photo.additional_properties = d
|
||||||
|
return random_search_results_photo
|
||||||
|
|
||||||
|
@property
|
||||||
|
def additional_keys(self) -> List[str]:
|
||||||
|
return list(self.additional_properties.keys())
|
||||||
|
|
||||||
|
def __getitem__(self, key: str) -> Any:
|
||||||
|
return self.additional_properties[key]
|
||||||
|
|
||||||
|
def __setitem__(self, key: str, value: Any) -> None:
|
||||||
|
self.additional_properties[key] = value
|
||||||
|
|
||||||
|
def __delitem__(self, key: str) -> None:
|
||||||
|
del self.additional_properties[key]
|
||||||
|
|
||||||
|
def __contains__(self, key: str) -> bool:
|
||||||
|
return key in self.additional_properties
|
72
photosapi_client/models/random_search_results_video.py
Normal file
72
photosapi_client/models/random_search_results_video.py
Normal file
@ -0,0 +1,72 @@
|
|||||||
|
from typing import TYPE_CHECKING, Any, Dict, List, Type, TypeVar
|
||||||
|
|
||||||
|
import attr
|
||||||
|
|
||||||
|
if TYPE_CHECKING:
|
||||||
|
from ..models.video_search import VideoSearch
|
||||||
|
|
||||||
|
|
||||||
|
T = TypeVar("T", bound="RandomSearchResultsVideo")
|
||||||
|
|
||||||
|
|
||||||
|
@attr.s(auto_attribs=True)
|
||||||
|
class RandomSearchResultsVideo:
|
||||||
|
"""
|
||||||
|
Attributes:
|
||||||
|
results (List['VideoSearch']):
|
||||||
|
"""
|
||||||
|
|
||||||
|
results: List["VideoSearch"]
|
||||||
|
additional_properties: Dict[str, Any] = attr.ib(init=False, factory=dict)
|
||||||
|
|
||||||
|
def to_dict(self) -> Dict[str, Any]:
|
||||||
|
results = []
|
||||||
|
for results_item_data in self.results:
|
||||||
|
results_item = results_item_data.to_dict()
|
||||||
|
|
||||||
|
results.append(results_item)
|
||||||
|
|
||||||
|
field_dict: Dict[str, Any] = {}
|
||||||
|
field_dict.update(self.additional_properties)
|
||||||
|
field_dict.update(
|
||||||
|
{
|
||||||
|
"results": results,
|
||||||
|
}
|
||||||
|
)
|
||||||
|
|
||||||
|
return field_dict
|
||||||
|
|
||||||
|
@classmethod
|
||||||
|
def from_dict(cls: Type[T], src_dict: Dict[str, Any]) -> T:
|
||||||
|
from ..models.video_search import VideoSearch
|
||||||
|
|
||||||
|
d = src_dict.copy()
|
||||||
|
results = []
|
||||||
|
_results = d.pop("results")
|
||||||
|
for results_item_data in _results:
|
||||||
|
results_item = VideoSearch.from_dict(results_item_data)
|
||||||
|
|
||||||
|
results.append(results_item)
|
||||||
|
|
||||||
|
random_search_results_video = cls(
|
||||||
|
results=results,
|
||||||
|
)
|
||||||
|
|
||||||
|
random_search_results_video.additional_properties = d
|
||||||
|
return random_search_results_video
|
||||||
|
|
||||||
|
@property
|
||||||
|
def additional_keys(self) -> List[str]:
|
||||||
|
return list(self.additional_properties.keys())
|
||||||
|
|
||||||
|
def __getitem__(self, key: str) -> Any:
|
||||||
|
return self.additional_properties[key]
|
||||||
|
|
||||||
|
def __setitem__(self, key: str, value: Any) -> None:
|
||||||
|
self.additional_properties[key] = value
|
||||||
|
|
||||||
|
def __delitem__(self, key: str) -> None:
|
||||||
|
del self.additional_properties[key]
|
||||||
|
|
||||||
|
def __contains__(self, key: str) -> bool:
|
||||||
|
return key in self.additional_properties
|
2
setup.py
2
setup.py
@ -7,7 +7,7 @@ long_description = (here / "README.md").read_text(encoding="utf-8")
|
|||||||
|
|
||||||
setup(
|
setup(
|
||||||
name="PhotosAPI_Client",
|
name="PhotosAPI_Client",
|
||||||
version="0.3.0",
|
version="0.5.0",
|
||||||
description="A client library for accessing Photos API",
|
description="A client library for accessing Photos API",
|
||||||
long_description=long_description,
|
long_description=long_description,
|
||||||
long_description_content_type="text/markdown",
|
long_description_content_type="text/markdown",
|
||||||
|
Loading…
Reference in New Issue
Block a user