Framework for tartiflette request/resolver context data assignment
Project description
Tartiflette Request Context Hooks
Framework to facilitate the creation of per-request context data for your resolvers using simple python context managers.
Allows for processing of request/response headers, dependent on the http server you're using.
Installation
pip install tartiflette-request-context-hooks
Usage
This requires:
- Creation of your hooks.
- Configuration of your hooks in your application.
- Update your resolvers to access your data.
1 - Creation of your hooks
Create a context manager to run on each request.
Example:
from tartiflette_request_contexts_hooks import BaseRequestContextHooks
class MyContextHooks(BaseRequestContextHooks):
# required short arbitrary unique hook label
label = 'MyHk'
def __init__(self, my_hook_params):
BaseRequestContextHooks.__init__(self)
# do things necessary for repeated use across all of the requests, e.g.
# configure factories
async def __aenter__(self):
# provide the data or method to be used in all queries for a single
# request.
your_method_or_data = ...
# store the data/method to be reused for this request
await self.store_request_data(your_method_or_data)
async def __aexit__(self, exc_type, exc_val, exc_tb):
# optional: for if you need to do something when the request is
# completed
data = await self.get_request_data()
data.close_or_whatever()
There are more examples in the examples directory including one with access to AIOHTTP request headers.
2 - Configuration of your hooks in your app
Currently only AIOHTTP is supported but the library is extensible if others would like to submit a pull request to support other servers that Tartiflette supports.
Limited AIOHTTP setup example, imports and configuration kept to hook specific details:
from tartiflette_request_context_hooks.middleware.aiohttp import\
get_hooks_service_middleware
import MyContextHooks # your hook
my_request_context_service = MyContextHooks(
my_hooks_params={},
)
my_request_session_middleware = get_hooks_service_middleware(
context_service=my_request_context_service
)
app = web.Application(middlewares=[
my_request_session_middleware
])
ctx = {
'my_session_service': my_request_context_service,
}
web.run_app(
register_graphql_handlers(
# your configuration
executor_context=ctx,
)
)
3 - Access data in your resolvers' context
Works in queries, mutations, and subscriptions.
@Resolver('Query.whatever')
async def resolve_query_user_login(parent, args, ctx, info):
my_data = await ctx['my_session_service']()
Project details
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 tartiflette-request-context-hooks-1.0.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 72836be2559890e981159b27103b9737a2a29a7bf143f34ff6bf8f4e67c61b2a |
|
MD5 | 28a084f23c72c8296f9831d4a3f09e18 |
|
BLAKE2b-256 | 6095d02de0a1e2406b50a0361eed688bef9c926c953bb07c186f5f9aedb6e79d |
Hashes for tartiflette_request_context_hooks-1.0.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | d795782de3f644e4d633dcf69632918df7e1393fbcfa0eca9e4113642cefb774 |
|
MD5 | f887faf4d2c6e71b70019b8b7ab95f13 |
|
BLAKE2b-256 | 6ab27f91a94d210c2d6ff477f416a4db52c26338d338e9ab21c2b03f67362118 |