parse bool values from environment variables #3204
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
The value of an environment variable is always a string and any non-empty string evals as true. If we want to support false values in the text we need to parse it ourselves. This commit fixes boolean options in the django settings file: DEBUG, IS_DEV, EMAIL_USE_TLS, BROKER_USE_SSL, and PIN_PASSCODE_ENABLED. In addition, AWS_S3_SECURE_URLS and AWS_QUERYSTRING_AUTH parsed the string value but in different manner. This commit uses the same approach in all, for the sake of consistency. We drop the use of distutils.util.strtobool because distutils is deprecated and will be removed in Python 3.12 but our implementation is compatible.
Environment variables are strings and any non-empty string evals as true. This commit only checks if the value is "True" and something fancier check True or False or error would be nicer but it's messy to do it on a dockerfile RUN command that is sh appending to a python file.
Tthomas63
approved these changes
Sep 13, 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.
This is similar in spirit to codalab/competitions-v1-compute-worker#24 but much more extensive to cover all other bool being read from environment variable.
I've noted that a proper check was already being done by
AWS_S3_SECURE_URLSandAWS_QUERYSTRING_AUTH, each on their own way. I've changed them only for the sake of consistency.Backwards compatibility note: this is not 100% backwards compatible. If someone was relying on setting an empty string to signal false, then this new behaviour is not compatible (but they'll get an error with a nice error message). I don't think that's expected since examples clearly use the string "False" for that. Similarly, if was someone was relying on setting some random string to signal true, then this change is also not backwards compatible (but again, they will get a nice error message). The only case where the new behaviour is incompatible and no error is raised is if they are setting the variables to one of
("n", "no", "f", "false", "off", "0")and expect them to be interpreted as true (hopefully no one is doing that).