Skip to content

Commit 836e46f

Browse files
docs(readme): example snippet for client context manager (#550)
1 parent 08977ef commit 836e46f

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -384,6 +384,16 @@ client.with_options(http_client=DefaultHttpxClient(...))
384384

385385
By default the library closes underlying HTTP connections whenever the client is [garbage collected](https://docs.python.org/3/reference/datamodel.html#object.__del__). You can manually close the client using the `.close()` method if desired, or with a context manager that closes when exiting.
386386

387+
```py
388+
from finch import Finch
389+
390+
with Finch() as client:
391+
# make requests here
392+
...
393+
394+
# HTTP client is now closed
395+
```
396+
387397
## Versioning
388398

389399
This package generally follows [SemVer](https://semver.org/spec/v2.0.0.html) conventions, though certain backwards-incompatible changes may be released as minor versions:

0 commit comments

Comments
 (0)