Skip to content
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.

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

Complete Hook example #4298

Open
wants to merge 6 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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: 2 additions & 0 deletions .github/workflows/py-ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,8 @@ jobs:
python-version: '3.11'
- name: install poetry
run: python -m pip install poetry
- name: install current version of quilt
run: python -m pip install api/python
- name: install deps
run: cd testdocs && poetry install
- name: test codeblocks
Expand Down
4 changes: 4 additions & 0 deletions api/python/quilt3/hooks.py
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,8 @@ def set_build_s3_client_hook(hook: T.Optional[BuildClientHook]) -> T.Optional[Bu
Example for overriding `ServerSideEncryption` parameter for certain S3 operations:

```python
from quilt3.hooks import set_build_s3_client_hook

def event_handler(params, **kwargs):
# Be mindful with parameters you set here.
# Specifically it's not recommended to override/delete already set parameters
Expand All @@ -48,6 +50,8 @@ def hook(build_client_base, session, client_kwargs, **kwargs):
):
client.meta.events.register(f"before-parameter-build.s3.{op}", event_handler)
return client

old_hook = set_build_s3_client_hook(hook)
```

Args:
Expand Down
4 changes: 4 additions & 0 deletions docs/api-reference/Hooks.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,8 @@ Set build S3 client hook.
Example for overriding `ServerSideEncryption` parameter for certain S3 operations:

```python
from quilt3.hooks import set_build_s3_client_hook

def event_handler(params, **kwargs):
# Be mindful with parameters you set here.
# Specifically it's not recommended to override/delete already set parameters
Expand All @@ -28,6 +30,8 @@ def hook(build_client_base, session, client_kwargs, **kwargs):
):
client.meta.events.register(f"before-parameter-build.s3.{op}", event_handler)
return client

old_hook = set_build_s3_client_hook(hook)
```

__Arguments__
Expand Down
Loading