Slightly improve clarity of logical bool ops #1938
Open
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.
The doc states that these "return true" but more precisely they're the "typical" short-circuiting boolean operations with Python-like semantics.
and
andor
may not return booleans at all depending on their inputs.I had a coworker express the expectation that
x or y
in a Jinja template would return a bool, in a context in whichx
andy
are bothstr | None
, based on this section of the docs.I don't read the doc in this way, but strictly speaking that's what it says (these don't say that they're Python-like boolean operations -- they say they "return true").
I think the clarification is possibly helpful and at worst harmless. It was written based off of the Python documentation for the boolean operators.1
Footnotes
https://docs.python.org/3/library/stdtypes.html#boolean-operations-and-or-not ↩