[viewcfg] Add Python code header, prevent execution when importing #808
Conversation
This file contains hidden or 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
Add code headers missing from utils/viewcfg, as per the template from swiftlang#762.
In order to prevent the Python interpreter from running code that is meant to be executed directly, the convention is to check the context in which the code is being interpreted. Add a check for the context stored in the `__name__` variable, and only execute the viewcfg script if it is being run as a command-line script (that is, `__main__`).
gribozavr
added a commit
that referenced
this pull request
Dec 29, 2015
[viewcfg] Add Python code header, prevent execution when importing
|
@modocache Thanks! |
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.
What's in this pull request?
This adds the standard Python code header to
viewcfg. It also adds an idiomatic Python check that prevents code from being run if the file is imported by another Python script.Why merge this pull request?
What downsides are there to merging this pull request?
One could argue that a code header should be added to all Python files in the codebase at once, in a single commit. I'm not doing so here because I happened upon this file when using it, and decided to send a quick pull request, instead of trying to find all the remaining Python in this repository.