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 default suggestions in settings.py to ones that work #1538

Closed
merelcht opened this issue May 16, 2022 · 3 comments · Fixed by #2587
Closed

Update default suggestions in settings.py to ones that work #1538

merelcht opened this issue May 16, 2022 · 3 comments · Fixed by #2587
Labels
Component: Documentation 📄 Issue/PR for markdown and API documentation

Comments

@merelcht
Copy link
Member

merelcht commented May 16, 2022

Description

Update docs and default suggestions in settings.py, because currently some of those suggestions don't actually work.

Currently, the BaseSessionStore is the default session store. The other possible stores a user can use are the ShelveStore and the SQLiteStore (currently part of viz).

The ShelveStore is the default suggestion to override the default in settings.py, but when users are using some sort of multiprocessing this store type will not work. See: #1442

Also look at the other default suggestions and verify that they make sense.

(Later consideration, but not part of this work)
If we move the SQLiteStore from viz to kedro core, we could add that as the default suggestion instead.

@merelcht merelcht added the Component: Documentation 📄 Issue/PR for markdown and API documentation label Jun 13, 2022
@merelcht merelcht changed the title Make SQLiteStore default suggestion for session store Update default suggestions in settings.py to ones that work Jun 13, 2022
@noklam
Copy link
Contributor

noklam commented Jul 25, 2022

I suggest remove the ProjectHooks default too since it's not available anymore. But we should leave the HOOKS variable there or provide an example so people understand that they need to pass in a hook instance into a tuple.

@astrojuanlu
Copy link
Member

astrojuanlu commented May 17, 2023

@noklam you refer to this right?

# Instantiated project hooks.
# from {{cookiecutter.python_package}}.hooks import ProjectHooks
# HOOKS = (ProjectHooks(),)

What would be a better suggestion nowadays?

@astrojuanlu
Copy link
Member

For reference, hooks.py was removed from the project template in #1074

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
Projects
Archived in project
Development

Successfully merging a pull request may close this issue.

3 participants