Add progress bars to finder.find() #117
Merged
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
laserkelvin
approved these changes
Oct 9, 2024
Parsing each file in the codebase and subsequent preprocessing are the two most time-consuming steps of running codebasin. Adding progress bars for these steps is expected to be a significant improvement to user experience, as it enables a user to reason about how fast codebasin is running and when it may complete. Signed-off-by: John Pennycook <[email protected]>
Signed-off-by: John Pennycook <[email protected]>
By default, progress bar renders as XXfile/s instead of XX file/s. Signed-off-by: John Pennycook <[email protected]>
Pennycook
force-pushed
the
progress-bars
branch
from
4703339
to
4588e20
Compare
Signed-off-by: John Pennycook <[email protected]>
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.
Parsing each file in the codebase and subsequent preprocessing are the two most time-consuming steps of running codebasin.
Adding progress bars for these steps is expected to be a significant improvement to user experience, as it enables a user to reason about how fast codebasin is running and when it may complete.
Related issues
N/A
Proposed changes
tqdmto implement a progress bar for parsing all source files. The codebase and platform configuration loops are collapsed because we only parse source files once (even if they are used by multiple platforms).tqdmto implement nested progress bars for preprocessing: the outer bar tracks preprocessing for each platform, and the inner bar tracks preprocessing for each source file used by that platform.show_progressoption that defaults toFalse, since other tools (e.g.,cbicov?) may wish to run the preprocessor without showing the progress bars.