Add IS_FILE_RENDERED filter to enhance file processing flexibility #1062
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Abdul-Muqadim-Arbisoft
added
the
enhancement
tutor/env.py
Outdated
|
|
||
| @hooks.Filters.IS_FILE_RENDERED.add() | ||
| def _do_not_render_binary_files(result: bool, path: str) -> bool: | ||
| """Return bianry file""" |
There was a problem hiding this comment.
nit: the docstring does not make sense. Please update it.
There was a problem hiding this comment.
concern addressed
| @@ -0,0 +1 @@ | |||
| - [Feature] Introduces the IS_FILE_RENDERED Filter, enabling developers to specify files that should be copied without rendering. (by @Abdul-Muqadim-Arbisoft) | |||
There was a problem hiding this comment.
nit: having a bit more context here can be helpful for the devs.
There was a problem hiding this comment.
concern addressed
|
@DawoudSheraz @regisb I have tested this and working fine. Can you plz review it? |
DawoudSheraz
approved these changes
May 21, 2024
|
@hinakhadim This is waiting on your review, thanks. |
hinakhadim
approved these changes
May 27, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
resolved #975
Description:
This pull request introduces a new filter, IS_FILE_RENDERED, designed to enhance the flexibility of file handling within Tutor plugins. The new IS_FILE_RENDERED filter allows plugin developers to specify files that should not be rendered but instead copied .
Implementation Details:
The IS_FILE_RENDERED filter works by accepting a boolean flag and a file path. It returns a boolean indicating whether the file should be rendered. By default, all files are set to be rendered unless explicitly specified .