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

Update specs in pipeline hooks docstrings #2598

Merged
Merged
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
6 changes: 6 additions & 0 deletions RELEASE.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,12 @@

## Breaking changes to the API
* `kedro package` does not produce `.egg` files anymore, and now relies exclusively on `.whl` files.

## Community contributions
Many thanks to the following Kedroids for contributing PRs to this release:

* [tomasvanpottelbergh](https://github.com/tomasvanpottelbergh)

## Upcoming deprecations for Kedro 0.19.0


Expand Down
13 changes: 10 additions & 3 deletions kedro/framework/hooks/specs.py
Original file line number Diff line number Diff line change
Expand Up @@ -155,8 +155,10 @@ def before_pipeline_run(
"from_inputs": Optional[List[str]],
"to_outputs": Optional[List[str]],
"load_versions": Optional[List[str]],
"pipeline_name": str,
"extra_params": Optional[Dict[str, Any]]
"pipeline_name": str,
"namespace": Optional[str],
"runner": str,
}

pipeline: The ``Pipeline`` that will be run.
Expand Down Expand Up @@ -190,8 +192,10 @@ def after_pipeline_run(
"from_inputs": Optional[List[str]],
"to_outputs": Optional[List[str]],
"load_versions": Optional[List[str]],
"pipeline_name": str,
"extra_params": Optional[Dict[str, Any]]
"pipeline_name": str,
"namespace": Optional[str],
"runner": str,
}

run_result: The output of ``Pipeline`` run.
Expand Down Expand Up @@ -229,9 +233,12 @@ def on_pipeline_error(
"from_inputs": Optional[List[str]],
"to_outputs": Optional[List[str]],
"load_versions": Optional[List[str]],
"pipeline_name": str,
"extra_params": Optional[Dict[str, Any]]
"pipeline_name": str,
"namespace": Optional[str],
"runner": str,
}

pipeline: The ``Pipeline`` that will was run.
catalog: The ``DataCatalog`` used during the run.
"""
Expand Down