Client library for the sink API
Project description
Sink Custom Python Title 3 API Library
The Sink Custom Python Title 3 library provides convenient access to the Sink REST API from any Python 3.7+ application. It includes type definitions for all request params and response fields, and offers both synchronous and asynchronous clients powered by httpx.
Documentation
The API documentation can be found here.
Installation
pip install sink-pypi
Usage
The full API of this library can be found in api.md.
from sink import Sink
client = Sink(
# defaults to os.environ.get("SINK_CUSTOM_API_KEY_ENV")
user_token="my user token",
# defaults to "production".
environment="sandbox",
username="Robert",
required_arg_no_env="<example>",
)
card = client.cards.create(
type="SINGLE_USE",
not_="TEST",
)
print(card.token)
While you can provide a user_token
keyword argument, we recommend using python-dotenv
and adding SINK_CUSTOM_API_KEY_ENV="my user token"
to your .env
file so that your user token is not stored in source control.
Async Usage
Simply import AsyncSink
instead of Sink
and use await
with each API call:
from sink import AsyncSink
client = AsyncSink(
# defaults to os.environ.get("SINK_CUSTOM_API_KEY_ENV")
user_token="my user token",
# defaults to "production".
environment="sandbox",
username="Robert",
required_arg_no_env="<example>",
)
async def main():
card = await client.cards.create(
type="SINGLE_USE",
not_="TEST",
)
print(card.token)
asyncio.run(main())
Functionality between the synchronous and asynchronous clients is otherwise identical.
Using Types
Nested request parameters are TypedDicts. Responses are Pydantic models, which provide helper methods for things like serializing back into json (v1, v2). To get a dictionary, you can call dict(model)
.
This helps provide autocomplete and documentation within your editor. If you would like to see type errors in VS Code to help catch bugs earlier, set python.analysis.typeCheckingMode
to "basic"
.
Pagination
List methods in the Sink API are paginated.
This library provides auto-paginating iterators with each list response, so you do not have to request successive pages manually:
import sink
client = Sink(
username="Robert",
required_arg_no_env="<example>",
)
all_offsets = []
# Automatically fetches more pages as needed.
for offset in client.pagination_tests.offset.list():
# Do something with offset here
all_offsets.append(offset)
print(all_offsets)
Or, asynchronously:
import asyncio
import sink
client = AsyncSink(
username="Robert",
required_arg_no_env="<example>",
)
async def main() -> None:
all_offsets = []
# Iterate through items across all pages, issuing requests as needed.
async for offset in client.pagination_tests.offset.list():
all_offsets.append(offset)
print(all_offsets)
asyncio.run(main())
Alternatively, you can use the .has_next_page()
, .next_page_info()
, or .get_next_page()
methods for more granular control working with pages:
first_page = await client.pagination_tests.offset.list()
if first_page.has_next_page():
print(f"will fetch next page using these details: {first_page.next_page_info()}")
next_page = await first_page.get_next_page()
print(f"number of items we just fetched: {len(next_page.data)}")
# Remove `await` for non-async usage.
Or just work directly with the returned data:
first_page = await client.pagination_tests.offset.list()
print(
f"the current start offset for this page: {first_page.offset}"
) # => "the current start offset for this page: 1"
for offset in first_page.data:
print(offset.bar)
# Remove `await` for non-async usage.
Nested params
Nested parameters are dictionaries, typed using TypedDict
, for example:
from sink import Sink
client = Sink(
username="Robert",
required_arg_no_env="<example>",
)
client.cards.create(
foo={
"bar": True,
},
)
File Uploads
Request parameters that correspond to file uploads can be passed as bytes
or a tuple of (filename, contents, media type)
.
from pathlib import Path
from sink import Sink
client = Sink(
username="Robert",
required_arg_no_env="<example>",
)
contents = Path("foo/bar.txt").read_bytes()
client.files.create_multipart(
file=contents,
)
The async client uses the exact same interface. This example uses aiofiles
to asynchronously read the file contents but you can use whatever method you would like.
import aiofiles
from sink import Sink
client = Sink(
username="Robert",
required_arg_no_env="<example>",
)
async with aiofiles.open("foo/bar.txt", mode="rb") as f:
contents = await f.read()
await client.files.create_multipart(
file=contents,
)
Handling errors
When the library is unable to connect to the API (e.g., due to network connection problems or a timeout), a subclass of sink.APIConnectionError
is raised.
When the API returns a non-success status code (i.e., 4xx or 5xx
response), a subclass of sink.APIStatusError
will be raised, containing status_code
and response
properties.
All errors inherit from sink.APIError
.
import sink
from sink import Sink
client = Sink(
username="Robert",
required_arg_no_env="<example>",
)
try:
client.cards.create(
type="an_incorrect_type",
)
except sink.APIConnectionError as e:
print("The server could not be reached")
print(e.__cause__) # an underlying Exception, likely raised within httpx.
except sink.RateLimitError as e:
print("A 429 status code was received; we should back off a bit.")
except sink.APIStatusError as e:
print("Another non-200-range status code was received")
print(e.status_code)
print(e.response)
Error codes are as followed:
Status Code | Error Type |
---|---|
400 | BadRequestError |
401 | AuthenticationError |
403 | PermissionDeniedError |
404 | NotFoundError |
422 | UnprocessableEntityError |
429 | RateLimitError |
>=500 | InternalServerError |
N/A | APIConnectionError |
Retries
Certain errors will be automatically retried 2 times by default, with a short exponential backoff. Connection errors (for example, due to a network connectivity problem), 409 Conflict, 429 Rate Limit, and >=500 Internal errors will all be retried by default.
You can use the max_retries
option to configure or disable this:
from sink import Sink
# Configure the default for all requests:
client = Sink(
# default is 2
max_retries=0,
username="Robert",
required_arg_no_env="<example>",
)
# Or, configure per-request:
client.with_options(max_retries=5).cards.list(
page_size=10,
)
Timeouts
Requests time out after 1 minute by default. You can configure this with a timeout
option,
which accepts a float or an httpx.Timeout
:
from sink import Sink
# Configure the default for all requests:
client = Sink(
# default is 60s
timeout=20.0,
username="Robert",
required_arg_no_env="<example>",
)
# More granular control:
client = Sink(
timeout=httpx.Timeout(60.0, read=5.0, write=10.0, connect=2.0),
username="Robert",
required_arg_no_env="<example>",
)
# Override per-request:
client.with_options(timeout=5 * 1000).cards.list(
page_size=10,
)
On timeout, an APITimeoutError
is thrown.
Note that requests which time out will be retried twice by default.
Default Headers
We automatically send the following headers with all requests.
Header | Value |
---|---|
My-Api-Version |
11 |
X-Enable-Metrics |
1 |
If you need to, you can override these headers by setting default headers per-request or on the client object.
from sink import Sink
client = Sink(
default_headers={"My-Api-Version": "My-Custom-Value"},
username="Robert",
required_arg_no_env="<example>",
)
Advanced
How to tell whether None
means null
or missing
In an API response, a field may be explicitly null, or missing entirely; in either case, its value is None
in this library. You can differentiate the two cases with .model_fields_set
:
if response.my_field is None:
if 'my_field' not in response.model_fields_set:
print('Got json like {}, without a "my_field" key present at all.')
else:
print('Got json like {"my_field": null}.')
Configuring custom URLs, proxies, and transports
You can configure the following keyword arguments when instantiating the client:
import httpx
from sink import Sink
client = Sink(
# Use a custom base URL
base_url="http://my.test.server.example.com:8083",
proxies="http://my.test.proxy.example.com",
transport=httpx.HTTPTransport(local_address="0.0.0.0"),
username="Robert",
required_arg_no_env="<example>",
)
See the httpx documentation for information about the proxies
and transport
keyword arguments.
Managing HTTP resources
By default we will close the underlying HTTP connections whenever the client is garbage collected is called but you can also manually close the client using the .close()
method if desired, or with a context manager that closes when exiting.
Versioning
This package generally attempts to follow SemVer conventions, though certain backwards-incompatible changes may be released as minor versions:
- Changes that only affect static types, without breaking runtime behavior.
- Changes to library internals which are technically public but not intended or documented for external use. (Please open a GitHub issue to let us know if you are relying on such internals).
- Changes that we do not expect to impact the vast majority of users in practice.
We take backwards-compatibility seriously and work hard to ensure you can rely on a smooth upgrade experience.
We are keen for your feedback; please open an issue with questions, bugs, or suggestions.
Requirements
Python 3.7 or higher.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for sink_pypi-0.2.10-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 13ce5947e969d4f57c7a2b6c550ea328a09af6d9acbfe630ef0f370c723fb82d |
|
MD5 | ae969222a8428b117e660c4245b72842 |
|
BLAKE2b-256 | 0a2ed8f36bd6cf4a740768d2d09457c19f3a75bbc7ac53bda93bf4ae712330e2 |