Put watchdog loop behind __name__ == '__main__'
#680
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
I've been running runtime-introspection tools (particularly stubtest) on docassemble's code base recently, and when you simply `import watchdog`, the tool will get stuck in an infinite loop because the only thing in the file is an infinite `while: True` loop. This patch puts that behind `if __name__ == '__main__'`, so only people who are running this module as the main module will get the desired infinite loop. The only documented way of running this module is through `run-watchdog.sh`, which runs `python -m docassemble.webapp.watchdog &`, so this shouldn't break any existing functionality.
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.
I've been using some runtime-introspection tools (particularly
stubtest) on docassemble's code base recently, and when you simplyimport watchdog, the tool will get stuck in an infinite loop because the only thing in the file is an infinitewhile: Trueloop.This patch puts that behind
if __name__ == '__main__', so only people who are running this module as the main module will get the desired infinite loop. The only documented way of running this module is throughrun-watchdog.sh, which runspython -m docassemble.webapp.watchdog &, so this shouldn't break any existing functionality.Tested running in a built docker image, the watchdog process still is running after starting the container, so looks to be all good.