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

Document the LIFO order in which hooks are executed in settings.py #1940

Closed
2 tasks
Tracked by #3014
merelcht opened this issue Oct 17, 2022 · 7 comments · Fixed by #3013 or #3045
Closed
2 tasks
Tracked by #3014

Document the LIFO order in which hooks are executed in settings.py #1940

merelcht opened this issue Oct 17, 2022 · 7 comments · Fixed by #3013 or #3045
Assignees
Labels
Component: Documentation 📄 Issue/PR for markdown and API documentation Type: Parent Issue

Comments

@merelcht
Copy link
Member

merelcht commented Oct 17, 2022

Description

We mention that hook implementations registered in settings.py run in LIFO order and that auto discovered hooks run before hooks in settings.py.

  • We need to also document what the order is in which auto-discovered hooks run. Add this to: https://kedro.readthedocs.io/en/stable/hooks/introduction.html To verify the run order, create a project and install several plugins with hooks to test.
  • Add a comment in the settings.py template file to explain the run order of hooks
@merelcht merelcht added the Component: Documentation 📄 Issue/PR for markdown and API documentation label Oct 17, 2022
@stichbury
Copy link
Contributor

Also, while we are modifying hooks documentation, we need to take another look at the work involved with #978

@astrojuanlu
Copy link
Member

Potentially overlapping with #1718, or that one should be a parent issue of this one.

@noklam noklam changed the title Document the order in which hooks are executed Document the order in which hooks are executed in settings.py Jul 31, 2023
@noklam noklam changed the title Document the order in which hooks are executed in settings.py Document the LIFO order in which hooks are executed in settings.py Jul 31, 2023
@noklam
Copy link
Contributor

noklam commented Jul 31, 2023

Agree with @astrojuanlu. #1718 is a larger task, we can keep the scope for this one small.

Simply document about the LIFO order. It's not the full picture of how hooks are executed yet. I have updated the description to reflect that.

@stichbury
Copy link
Contributor

OK, let's do this. @noklam do you want to pick up the first draft of this in the upcoming sprint w/c 4th September? If so, please let @merelcht know to assign it to you within the sprint. Otherwise will keep an eye out for this to come next sprint if you are already maxed out with upcoming hack days & values day.

@noklam
Copy link
Contributor

noklam commented Sep 4, 2023

That should be fine! I am fairly familiar with the hooks stuff so it shouldn't be too much work.

@noklam
Copy link
Contributor

noklam commented Sep 7, 2023

I've bumped the estimate from 3 -> 5. See #3013 for more details (The PR will be only documentation change). There will be follow up PR but basically I found that there are extra documentation and development work that we should do.

@noklam noklam linked a pull request Sep 7, 2023 that will close this issue
12 tasks
@noklam noklam reopened this Sep 18, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Component: Documentation 📄 Issue/PR for markdown and API documentation Type: Parent Issue
Projects
Archived in project
Development

Successfully merging a pull request may close this issue.

5 participants