encode/httpx
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: slightly clarify event hooks (#1645)

Browse Source 
* Be more specific about when the hooks are called
* Explicitly mention and demonstrate that hooks are allowed to modify requests

See https://github.com/encode/httpx/discussions/1637
This commit is contained in:
K900 2021-05-21 12:30:30 +03:00 committed by GitHub
parent 9b17671f15
commit 776dbb578b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 12 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
docs/advanced.md
View File

@ -228,10 +228,10 @@ every time a particular type of event takes place.
There are currently two event hooks:
* `request` - Called once a request is about to be sent. Passed the `request` instance.
* `response` - Called once the response has been returned. Passed the `response` instance.
* `request` - Called after a request is fully prepared, but before it is sent to the network. Passed the `request` instance.
* `response` - Called after the response has been fetched from the network, but before it is returned to the caller. Passed the `response` instance.
These allow you to install client-wide functionality such as logging and monitoring.
These allow you to install client-wide functionality such as logging, monitoring or tracing.
```python
def log_request(request):
@ -255,6 +255,15 @@ def raise_on_4xx_5xx(response):
client = httpx.Client(event_hooks={'response': [raise_on_4xx_5xx]})
```
The hooks are also allowed to modify `request` and `response` objects.
```python
def add_timestamp(request):
request.headers['x-request-timestamp'] = datetime.now(tz=datetime.utc).isoformat()
client = httpx.Client(event_hooks={'request': [add_timestamp]})
```
Event hooks must always be set as a **list of callables**, and you may register
multiple event hooks for each type of event.