gh-115177: Mention PYTHONOPTIMIZE in assert docs and add warning#151114
Open
nahcmon wants to merge 1 commit into
Open
gh-115177: Mention PYTHONOPTIMIZE in assert docs and add warning#151114nahcmon wants to merge 1 commit into
nahcmon wants to merge 1 commit into
Conversation
…add warning Add a cross-reference to the PYTHONOPTIMIZE environment variable alongside the existing -O flag mention, and add a warning advising against using assert for production data validation or interface enforcement.
|
All commit authors signed the Contributor License Agreement. |
|
You have reached your Codex usage limits for code reviews. You can see your limits in the Codex usage dashboard. |
bedevere-app
Bot
added
awaiting review
docs
Documentation build overview
|
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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 assert statement documentation at https://docs.python.org/3/reference/simple_stmts.html#the-assert-statement
mentions the
-Ocommand-line flag as the way to request optimization, but omits thePYTHONOPTIMIZEenvironment variable, which has the same effect. Users who encounterassertion failures (or missing assertions) set via the environment variable have no
path to this information from the assert docs.
Additionally, the section contains no guidance warning against using
assertforproduction-critical logic (input validation, interface enforcement, etc.) — a mistake
that leads to silent failures when optimization is enabled.
Changes
:envvar:\PYTHONOPTIMIZE`cross-reference alongside the existing:option:`-O``mention so both ways to enable optimization are visible together.
.. warning::directive advising against usingassertto enforceinterface constraints or validate data in production code.
Test coverage
Documentation-only change; no test file modifications needed. RST validated
with docutils;
:envvar:target confirmed defined atDoc/using/cmdline.rst:833.NEWS entry
Not required for documentation-only changes per the CPython developer guide.
CLA
Note: the CLA for the GitHub account
nahcmonmay not be signed. The PR will beheld by the CLA bot until it is signed at https://cla.python.org/.