forked from cmr-surgical/ahasura
-
Notifications
You must be signed in to change notification settings - Fork 0
/
ahasura.py
240 lines (179 loc) · 6.76 KB
/
ahasura.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
"""Async and sync Hasura client"""
__version__ = "1.4.2"
from typing import Any, Dict, List, Optional
import httpx
ADMIN = "ADMIN"
class Hasura:
"""Async and sync Hasura client"""
graphql_endpoint: str
sql_endpoint: str
admin_secret: Optional[str] = None
timeout: Optional[float]
def __init__(
self,
endpoint: str,
admin_secret: Optional[str] = None,
timeout: Optional[float] = 10,
) -> None:
"""Create Hasura client
It just keeps the configuration passed, so you can reuse global client(s)
Args:
endpoint: `HASURA_GRAPHQL_ENDPOINT`, without trailing `/` or `/v1/graphql`
admin_secret: `HASURA_GRAPHQL_ADMIN_SECRET`, required for `auth=ADMIN` only
timeout: Seconds of network inactivity allowed. `None` disables the timeout
Examples:
Client::
hasura = Hasura(...)
`hasura(...)` is a shortcut for sync GraphQL client: `hasura.gql(...)`
You can define a shortcut for Async GraphQL client::
ahasura = hasura.agql
"""
assert not endpoint.endswith("/")
assert not endpoint.endswith("/v1/graphql")
assert not endpoint.endswith("/v2/query")
self.graphql_endpoint = f"{endpoint}/v1/graphql"
self.sql_endpoint = f"{endpoint}/v2/query"
self.admin_secret = admin_secret
self.timeout = timeout
def gql(
self,
query: str,
auth: str,
headers: Optional[Dict[str, str]] = None,
**variables,
) -> Dict[str, Any]:
"""Execute GraphQL query at Hasura, sync version
Args:
query: GraphQL query, e.g. `query { item { id }}`
auth: Either `ADMIN` or value of `Authorization` header, e.g. `Bearer {JWT}`
headers: Custom headers, if any
**variables: Variables used in `query`, if any
Returns:
GraphQL response data, e.g. `{"item": [{"id": "..."}]}`
Raises:
HasuraError: If JSON response from Hasura contains `errors` key
Examples:
With shortcut::
data = hasura(...)
Without shortcut::
data = hasura.gql(...)
"""
response = httpx.post(
self.graphql_endpoint,
headers=self._get_headers(auth, headers),
json={"query": query, "variables": variables},
timeout=self.timeout,
)
return self._get_data(response.json())
__call__ = gql # `hasura(...)` is a shortcut for `hasura.gql(...)`
async def agql(
self,
query: str,
auth: str,
headers: Optional[Dict[str, str]] = None,
**variables,
) -> Dict[str, Any]:
"""Execute GraphQL query at Hasura, async version
Please see the docs of sync version
Examples:
With shortcut::
data = await ahasura(...)
Without shortcut::
data = await hasura.agql(...)
"""
async with httpx.AsyncClient() as ahttpx:
response = await ahttpx.post(
self.graphql_endpoint,
headers=self._get_headers(auth, headers),
json={"query": query, "variables": variables},
timeout=self.timeout,
)
return self._get_data(response.json())
def sql(
self,
query: str,
headers: Optional[Dict[str, str]] = None,
) -> List[Dict[str, Any]]:
"""Execute SQL query at Hasura, sync version
Args:
query: SQL query, e.g. `SELECT "id" FROM "item"`
headers: Custom headers, if any
Returns:
Rows selected by `SELECT` query, e.g. `[{"id": "..."}]`,
or `[{"ok": True}]` for non-`SELECT` query
Raises:
HasuraError: If JSON response from Hasura contains `error` key
Example::
rows = hasura.sql(...)
"""
response = httpx.post(
self.sql_endpoint,
headers=self._get_headers(ADMIN, headers),
json=self._get_run_sql_content(query),
timeout=self.timeout,
)
return self._get_rows(response.json())
async def asql(
self,
query: str,
headers: Optional[Dict[str, str]] = None,
) -> List[Dict[str, Any]]:
"""Execute SQL query at Hasura, async version
Please see the docs of sync version
Example::
rows = await hasura.asql(...)
"""
async with httpx.AsyncClient() as ahttpx:
response = await ahttpx.post(
self.sql_endpoint,
headers=self._get_headers(ADMIN, headers),
json=self._get_run_sql_content(query),
timeout=self.timeout,
)
return self._get_rows(response.json())
# Private DRY implementation parts of the public API above:
def _get_headers(
self,
auth: str,
headers: Optional[Dict[str, str]] = None,
) -> Dict[str, str]:
if auth == ADMIN:
assert self.admin_secret
result = {"x-hasura-admin-secret": self.admin_secret}
else:
result = {"authorization": auth}
if headers:
result.update(headers)
return result
def _get_run_sql_content(self, query: str) -> Dict[str, Any]:
read_only = query.lstrip()[:6].upper() == "SELECT"
return {"type": "run_sql", "args": {"sql": query, "read_only": read_only}}
def _get_data(self, response_json: Dict[str, Any]) -> Dict[str, Any]:
if "errors" in response_json:
raise HasuraError(response_json)
data = response_json["data"]
assert isinstance(data, dict)
return data
def _get_rows(self, response_json: Dict[str, Any]) -> List[Dict[str, Any]]:
if "error" in response_json:
raise HasuraError(response_json)
if response_json["result_type"] == "CommandOk":
return [{"ok": True}]
assert response_json["result_type"] == "TuplesOk", response_json
result = response_json["result"]
column_names = result[0]
return [dict(zip(column_names, row)) for row in result[1:]]
class HasuraError(Exception):
"""Exception raised if JSON response from Hasura contains `errors` or `error` key
Attributes:
response - Parsed JSON response from Hasura
Examples:
Testing::
def test_error() -> None:
with pytest.raises(HasuraError) as error:
hasura("bad query", auth="bad auth")
assert error.value.response == {"errors": [...]}
"""
def __init__(self, response: Dict[str, Any]):
self.response = response
super().__init__(response)