1928 - allow for customised naming of hooks and sort hooks for execution #1956
Conversation
|
@david-abn I like this PR. Could you add a new test to show this is working? |
Added new commit to update unit test. Thank you |
| :param hook_file: The hook file to consider for validity | ||
| :param hook_name: The hook to find | ||
| :return: The hook file validity | ||
| """ | ||
| filename = os.path.basename(hook_file) | ||
| basename = os.path.splitext(filename)[0] | ||
| matching_hook = basename == hook_name | ||
| supported_hook = basename in _HOOKS | ||
| matching_hook = hook_name in basename |
There was a problem hiding this comment.
I think it should be a requirement that file names start with the hook identifier to avoid unintended execution of files. For example, without this constraint, a file like utils_for_pre_gen_project.py could run as a hook unintentionally.
| matching_hook = hook_name in basename | |
| matching_hook = basename.startswith(hook_name) |
| matching_hook = basename == hook_name | ||
| supported_hook = basename in _HOOKS | ||
| matching_hook = hook_name in basename | ||
| supported_hook = [i for i in _HOOKS if i in basename] |
There was a problem hiding this comment.
The row above already tests that the file is a requested hook type.
It should now be enogh to test if the requested hook type is supported.
| supported_hook = [i for i in _HOOKS if i in basename] | |
| supported_hook = hook_name in _HOOKS |
Alternatively the any() function could be utilized to get a boolean value right away
| supported_hook = [i for i in _HOOKS if i in basename] | |
| supported_hook = any(basename.startswith(supported_hook_name) for supported_hook_name in _HOOKS) |
| @@ -59,14 +59,22 @@ def test_run_python_hooks(): | |||
| def test_run_python_hooks_cwd(): | |||
| """Verify pre and post generation python hooks executed and result in current dir. | |||
|
|
|||
| Check that multiple hooks can be created with python_post and python_post_2. | |||
| python_post_2 should be created before python_post to verify it is sorted. | |||
There was a problem hiding this comment.
| python_post_2 should be created before python_post to verify it is sorted. | |
| python_post_2 should be created after python_post to verify it is sorted. |
Issue
#1928
About
This PR will allow cookiecutter users to create multiple scripts for any hook type. It will also sort them.
i.e.
pre_prompt_1, pre_prompt_2Testing
Created
post_gen_project_2.shin new cookiecutter template withVerified that this file is created, and the files are run in sorted order.
Documentation
Updated documentation with this new functionality