Skip to content

Support custom JSON serializers #945

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
0x12th wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Support custom JSON serializers #945

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -120,7 +120,7 @@ what gets sent over the wire.*
>>> response = client.send(request)
```

* `def __init__(method, url, [params], [headers], [cookies], [content], [data], [files], [json], [stream])`
* `def __init__(method, url, [params], [headers], [cookies], [content], [data], [files], [json], [json_serializer], [json_deserializer], [stream])`
* `.method` - **str**
* `.url` - **URL**
* `.content` - **byte**, **byte iterator**, or **byte async iterator**
Expand Down
11 changes: 11 additions & 0 deletions docs/quickstart.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -249,6 +249,17 @@ For more complicated data structures you'll often want to use JSON encoding inst
}
```

The JSON serializer and deserializer can be customized per request or per client.
The serializer must accept the object passed as `json=...` and return either
`str` or `bytes`. This allows serializers such as `orjson.dumps` to be used
directly.

```pycon
>>> import orjson
>>> with httpx.Client(json_serializer=orjson.dumps, json_deserializer=orjson.loads) as client:
... r = client.post("https://httpbin.org/post", json=data)
```

## Sending Binary Request Data

For other encodings, you should use the `content=...` parameter, passing
Expand Down
32 changes: 32 additions & 0 deletions src/httpx2/httpx2/_api.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@
AuthTypes,
CookieTypes,
HeaderTypes,
JsonDeserializer,
JsonSerializer,
ProxyTypes,
QueryParamTypes,
RequestContent,
Expand Down Expand Up @@ -45,6 +47,8 @@ def request(
data: RequestData | None = None,
files: RequestFiles | None = None,
json: typing.Any | None = None,
json_serializer: JsonSerializer | None = None,
json_deserializer: JsonDeserializer | None = None,
headers: HeaderTypes | None = None,
cookies: CookieTypes | None = None,
auth: AuthTypes | None = None,
Expand Down Expand Up @@ -105,6 +109,7 @@ def request(
verify=verify,
timeout=timeout,
trust_env=trust_env,
json_deserializer=json_deserializer,
) as client:
return client.request(
method=method,
Expand All @@ -113,6 +118,8 @@ def request(
data=data,
files=files,
json=json,
json_serializer=json_serializer,
json_deserializer=json_deserializer,
params=params,
headers=headers,
auth=auth,
Expand All @@ -130,6 +137,8 @@ def stream(
data: RequestData | None = None,
files: RequestFiles | None = None,
json: typing.Any | None = None,
json_serializer: JsonSerializer | None = None,
json_deserializer: JsonDeserializer | None = None,
headers: HeaderTypes | None = None,
cookies: CookieTypes | None = None,
auth: AuthTypes | None = None,
Expand All @@ -155,6 +164,7 @@ def stream(
verify=verify,
timeout=timeout,
trust_env=trust_env,
json_deserializer=json_deserializer,
) as client:
with client.stream(
method=method,
Expand All @@ -163,6 +173,8 @@ def stream(
data=data,
files=files,
json=json,
json_serializer=json_serializer,
json_deserializer=json_deserializer,
params=params,
headers=headers,
auth=auth,
Expand All @@ -182,6 +194,7 @@ def get(
follow_redirects: bool = False,
verify: ssl.SSLContext | str | bool = True,
timeout: TimeoutTypes = DEFAULT_TIMEOUT_CONFIG,
json_deserializer: JsonDeserializer | None = None,
trust_env: bool = True,
) -> Response:
"""
Expand All @@ -203,6 +216,7 @@ def get(
follow_redirects=follow_redirects,
verify=verify,
timeout=timeout,
json_deserializer=json_deserializer,
trust_env=trust_env,
)

Expand All @@ -218,6 +232,7 @@ def options(
follow_redirects: bool = False,
verify: ssl.SSLContext | str | bool = True,
timeout: TimeoutTypes = DEFAULT_TIMEOUT_CONFIG,
json_deserializer: JsonDeserializer | None = None,
trust_env: bool = True,
) -> Response:
"""
Expand All @@ -239,6 +254,7 @@ def options(
follow_redirects=follow_redirects,
verify=verify,
timeout=timeout,
json_deserializer=json_deserializer,
trust_env=trust_env,
)

Expand All @@ -254,6 +270,7 @@ def head(
follow_redirects: bool = False,
verify: ssl.SSLContext | str | bool = True,
timeout: TimeoutTypes = DEFAULT_TIMEOUT_CONFIG,
json_deserializer: JsonDeserializer | None = None,
trust_env: bool = True,
) -> Response:
"""
Expand All @@ -275,6 +292,7 @@ def head(
follow_redirects=follow_redirects,
verify=verify,
timeout=timeout,
json_deserializer=json_deserializer,
trust_env=trust_env,
)

Expand All @@ -286,6 +304,7 @@ def post(
data: RequestData | None = None,
files: RequestFiles | None = None,
json: typing.Any | None = None,
json_serializer: JsonSerializer | None = None,
params: QueryParamTypes | None = None,
headers: HeaderTypes | None = None,
cookies: CookieTypes | None = None,
Expand All @@ -294,6 +313,7 @@ def post(
follow_redirects: bool = False,
verify: ssl.SSLContext | str | bool = True,
timeout: TimeoutTypes = DEFAULT_TIMEOUT_CONFIG,
json_deserializer: JsonDeserializer | None = None,
trust_env: bool = True,
) -> Response:
"""
Expand All @@ -308,6 +328,7 @@ def post(
data=data,
files=files,
json=json,
json_serializer=json_serializer,
params=params,
headers=headers,
cookies=cookies,
Expand All @@ -316,6 +337,7 @@ def post(
follow_redirects=follow_redirects,
verify=verify,
timeout=timeout,
json_deserializer=json_deserializer,
trust_env=trust_env,
)

Expand All @@ -327,6 +349,7 @@ def put(
data: RequestData | None = None,
files: RequestFiles | None = None,
json: typing.Any | None = None,
json_serializer: JsonSerializer | None = None,
params: QueryParamTypes | None = None,
headers: HeaderTypes | None = None,
cookies: CookieTypes | None = None,
Expand All @@ -335,6 +358,7 @@ def put(
follow_redirects: bool = False,
verify: ssl.SSLContext | str | bool = True,
timeout: TimeoutTypes = DEFAULT_TIMEOUT_CONFIG,
json_deserializer: JsonDeserializer | None = None,
trust_env: bool = True,
) -> Response:
"""
Expand All @@ -349,6 +373,7 @@ def put(
data=data,
files=files,
json=json,
json_serializer=json_serializer,
params=params,
headers=headers,
cookies=cookies,
Expand All @@ -357,6 +382,7 @@ def put(
follow_redirects=follow_redirects,
verify=verify,
timeout=timeout,
json_deserializer=json_deserializer,
trust_env=trust_env,
)

Expand All @@ -368,6 +394,7 @@ def patch(
data: RequestData | None = None,
files: RequestFiles | None = None,
json: typing.Any | None = None,
json_serializer: JsonSerializer | None = None,
params: QueryParamTypes | None = None,
headers: HeaderTypes | None = None,
cookies: CookieTypes | None = None,
Expand All @@ -376,6 +403,7 @@ def patch(
follow_redirects: bool = False,
verify: ssl.SSLContext | str | bool = True,
timeout: TimeoutTypes = DEFAULT_TIMEOUT_CONFIG,
json_deserializer: JsonDeserializer | None = None,
trust_env: bool = True,
) -> Response:
"""
Expand All @@ -390,6 +418,7 @@ def patch(
data=data,
files=files,
json=json,
json_serializer=json_serializer,
params=params,
headers=headers,
cookies=cookies,
Expand All @@ -398,6 +427,7 @@ def patch(
follow_redirects=follow_redirects,
verify=verify,
timeout=timeout,
json_deserializer=json_deserializer,
trust_env=trust_env,
)

Expand All @@ -412,6 +442,7 @@ def delete(
proxy: ProxyTypes | None = None,
follow_redirects: bool = False,
timeout: TimeoutTypes = DEFAULT_TIMEOUT_CONFIG,
json_deserializer: JsonDeserializer | None = None,
verify: ssl.SSLContext | str | bool = True,
trust_env: bool = True,
) -> Response:
Expand All @@ -434,5 +465,6 @@ def delete(
follow_redirects=follow_redirects,
verify=verify,
timeout=timeout,
json_deserializer=json_deserializer,
trust_env=trust_env,
)
Loading