aiohttp powered apollo like graphql client
Project description
rath
BETA
Inspiration
Rath is like Apollo, but for python. It adheres to the design principle of Links and enables complex GraphQL setups, like seperation of query and subscription endpoints, dynamic token loading, etc..
Installation
pip install rath
Usage Example
from rath.links.auth import AuthTokenLink
from rath.links.aiohttp import AIOHttpLink
from rath.links import compose, split
from rath.gql import gql
async def aload_token():
return "SERVER_TOKEN"
auth = AuthTokenLink(token_loader=aload_token)
link = AIOHttpLink(endpoint_url="https://api.spacex.land/graphql/")
with Rath(links=compose(auth,link)) as rath:
query = """query TestQuery {
capsules {
id
missions {
flight
}
}
}
"""
result = rath.query(query)
This example composes both the AuthToken and AioHttp link: During each query the Bearer headers are set to the retrieved token, on authentication fail (for example if Token Expired) the AuthToken automatically refetches the token and retries the query.
Async Usage
Rath is build for async usage but uses koil, for async/sync compatibility
from rath.links.auth import AuthTokenLink
from rath.links.aiohttp import AIOHttpLink
from rath.links import compose, split
from rath.gql import gql
async def aload_token():
return "SERVER_TOKEN"
auth = AuthTokenLink(token_loader=aload_token)
link = AIOHttpLink(endpoint_url="https://api.spacex.land/graphql/")
async def main():
async with Rath(links=compose(auth,link)) as rath:
query = """query TestQuery {
capsules {
id
missions {
flight
}
}
}
"""
result = await rath.query(query)
asyncio.run(main())
Example Transport Switch
Links allow the composition of additional logic based on your graphql operation. For example you might want to use different grapqhl transports for different kind of operations (e.g using websockets for subscriptions, but using standard http requests for potential caching on queries and mutations). This can be easily accomplished by providing a split link.
link = SplitLink(
AioHttpLink(url="https://api.spacex.land/graphql/"),
WebsocketLink(url="ws://api.spacex.land/graphql/",
lamda o: o.node.operation == OperationType.SUBSCRIPTION
)
rath = Rath(link=link)
Included Links
- Validating Link (validate query against local schema (or introspect the schema))
- Reconnecting WebsocketLink
- AioHttpLink (supports multipart uploads)
- SplitLink (allows to split the terminating link - Subscription into WebsocketLink, Query, Mutation into Aiohttp)
- AuthTokenLink (Token insertion with automatic refres
Authentication
If you want to use rath with herre for getting access_tokens in oauth2/openid-connect scenarios, there is also a herre link in this repository
Why Rath
Well "apollo" is already taken as a name, and rath (according to wikipedia) is an etruscan deity identified with Apollo.
Rath + Turms
Rath works especially well with turms generated typed operations:
import asyncio
from examples.api.schema import aget_capsules
from rath.rath import Rath
from rath.links.aiohttp import AIOHttpLink
from rath.links.auth import AuthTokenLink
from rath.links.compose import compose
async def token_loader():
return ""
link = compose(
AuthTokenLink(token_loader), AIOHttpLink("https://api.spacex.land/graphql/")
)
rath = Rath(
link=link,
register=True, # allows global access (singleton-antipattern, but rath has no state)
)
async def main():
async with rath:
capsules = await aget_capsules() # fully typed pydantic powered dataclasses generated through turms
print(capsules)
asyncio.run(main())
Examples
This github repository also contains an example client with a turms generated query with the public SpaceX api, as well as a sample of the generated api.
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.
