Rework recursive process_file core calls #191
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
kukovecz
force-pushed
the
181-remove-recursion
branch
5 times, most recently
from
832600e to
07b1789
Compare
Merged
kukovecz
force-pushed
the
181-remove-recursion
branch
6 times, most recently
from
7c76c9e to
cdd7e82
Compare
We agreed that we need to rework the recursion around the `process_file` function, as this makes handling the unblob core codebase cumbersome to deal with. Now the `process_file` function calls are converted to `Task` objects, which are put to a `Queue` and during unblobbing, we are getting elements from the `Queue` and process them just like before. Additionally, we need to think of multiprocessing. The only hard part is to find the right way to recognize when there is nothing more to process, and never will be - a right exit condition (because every file processing can yield to multiple additional files to process). In this matter, the multiprocessing.JoinableQueue can help us by manually marking finished each Task in the Queue with the `task_done` function. In this way the worker processes can use the blocking `queue.get` indefinitely and the main process can check for the whole status by `queue.join`.
These are static and never changing values, we can easily pass them through the functions rather then always put the same values into each `Task`.
Now that the `process_file` is not called recursively, there is no need to provide these as parameters, as their initial value should be calculated from the `process_file` itself. Also renamed `current_depth` to `depth`.
We designed max_depth to be optional in the CLI, having a default value hardcoded in unblob. It should work the same way when directly calling the `process_file` function. Also add showing the default value to the CLI.
Using the builtin `breakpoint` function does not work with multiprocessing, as the Process forks has different STDIN so the pdb can not attach to it. Use this `multiprocessing_breakpoint` function instead, when you need a breakpoint for debugging.
kukovecz
force-pushed
the
181-remove-recursion
branch
from
cdd7e82 to
5dd6e6a
Compare
kissgyorgy
approved these changes
Jan 27, 2022
|
🚀 |
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.
Fixes #181