Adding zip_safe flag to setuptools prevent "module references __file__" warnings #272
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.
Describe the change
Referenced in #249, the following warnings were thrown upon build:
These warning messages indicate that the package contains Python modules that reference the special variable
__file__
. The__file__
variable is a built-in variable that holds the name of the file that the currently executing code is located in.When a Python module references the
__file__
variable, setuptools will emit a warning message to inform you that the module may not work correctly when the package is installed as a zip file. This is because the file variable will not contain the correct value when the module is executed from within a zip file.This warning can be silenced by adding
zip_safe=True
tosetuptools.py
This flag has been added to the project's
setuptools.py
files, although is really only necessary for theBackend
.Describe testing procedures
Added flag and rebuilt without a cache.
Sample output
N/A
Checklist