bpo-17232: Clarify docs for -O and -OO command line options by csabella · Pull Request #5839 · python/cpython

csabella · 2018-02-23T18:02:25Z

Original patch by Terry Reedy.

https://bugs.python.org/issue17232

vadmium · 2018-02-24T01:16:22Z

-OO    : remove doc-strings in addition to the -O optimizations\n\
+-O     : remove assert and __debug__-dependent statements; add .opt1 before\n\
+         .pyc extension; also PYTHONOPTIMIZE=x\n\
+-OO    : do -O changes and also discard docstrings; add .opt2 before\n\


Why do these say “.opt1” etc without a dash, but the other cases have a dash in “.opt-1” etc?

I presume oversight on Cheryl's part. I will fix.

I presume oversight. I checked my cache and '-' is correct.

Yes, thank you for noticing that, Martin, and thank you, Terry, for fixing it. It was an oversight.

terryjreedy

Thanks for moving this along. I will edit and test locally.
Approve was a click mistake.

terryjreedy · 2018-02-24T05:36:22Z

-OO    : remove doc-strings in addition to the -O optimizations\n\
+-O     : remove assert and __debug__-dependent statements; add .opt1 before\n\
+         .pyc extension; also PYTHONOPTIMIZE=x\n\
+-OO    : do -O changes and also discard docstrings; add .opt2 before\n\


I presume oversight on Cheryl's part. I will fix.

terryjreedy · 2018-02-24T05:43:19Z

-   Turn on basic optimizations.  See also :envvar:`PYTHONOPTIMIZE`.
+   Remove assert statements and any code conditional on the value of
+   :const:`__debug__`.  Change the filename extension for compiled
+   (:term:`bytecode`) files to include ``.opt-1`` before the ``.pyc``


I will change these to read 'Augment the filename for compiled bytecode files by adding .opt-1 before the .pyc extension. ' It does not matter whether one thinks of the addition as a 2nd extension or not, and the change is strictly an addition.

terryjreedy · 2018-02-24T05:44:31Z

-OO    : remove doc-strings in addition to the -O optimizations\n\
+-O     : remove assert and __debug__-dependent statements; add .opt1 before\n\
+         .pyc extension; also PYTHONOPTIMIZE=x\n\
+-OO    : do -O changes and also discard docstrings; add .opt2 before\n\


I presume oversight. I checked my cache and '-' is correct.

terryjreedy · 2018-02-24T06:35:12Z

 .TP
 .B \-OO
-Discard docstrings in addition to the \fB-O\fP optimizations.
+Do \fB-O\fP and also discard docstrings; change the filename for


Cheryl, can you explain the \fB, \fP markup and verify that you somehow tested that it does 'the right thing'? I looked at both the web page and python -h output.

When I changed the line, I kept that part from the original line and simply add the other text around it. However, it appears the Github does attempt to show what will happen with it. If you click on the 'View' button for this source, Github applies the markup in non-raw mode. This shows up as bolded as does some of the text in the -i and -I option that has similar (though not exactly the same) markup.

Thanks. Enough to comfortably merge without personal test.

bedevere-bot · 2018-02-25T03:04:43Z

@terryjreedy: Please replace # with GH- in the commit message next time. Thanks!

miss-islington · 2018-02-25T03:04:43Z

Thanks @csabella for the PR, and @terryjreedy for merging it 🌮🎉.. I'm working now to backport this PR to: 3.6, 3.7.
🐍🍒⛏🤖 I'm not a witch! I'm not a witch!

…-5839) The 'optimization' is for space in the executable file, not for run time. (cherry picked from commit 186b606) Co-authored-by: Cheryl Sabella <cheryl.sabella@gmail.com>

bedevere-bot · 2018-02-25T03:05:51Z

GH-5867 is a backport of this pull request to the 3.7 branch.

bedevere-bot · 2018-02-25T03:06:51Z

GH-5868 is a backport of this pull request to the 3.6 branch.

…-5839) The 'optimization' is for space in the executable file, not for run time. (cherry picked from commit 186b606) Co-authored-by: Cheryl Sabella <cheryl.sabella@gmail.com>

The 'optimization' is for space in the executable file, not for run time. (cherry picked from commit 186b606) Co-authored-by: Cheryl Sabella <cheryl.sabella@gmail.com>

bpo-17232: Clarify docs for -O and -OO command line options

ee3ca70

the-knights-who-say-ni added the CLA signed label Feb 23, 2018

bedevere-bot added the awaiting review label Feb 23, 2018

vadmium reviewed Feb 24, 2018

View reviewed changes

terryjreedy approved these changes Feb 24, 2018

View reviewed changes

bedevere-bot added awaiting merge and removed awaiting review labels Feb 24, 2018

terryjreedy added needs backport to 3.6 labels Feb 24, 2018

Edit as in comments.

d0a8802

terryjreedy reviewed Feb 24, 2018

View reviewed changes

terryjreedy merged commit 186b606 into python:master Feb 25, 2018

bedevere-bot removed the awaiting merge label Feb 25, 2018

bedevere-bot removed the needs backport to 3.7 label Feb 25, 2018

bedevere-bot removed the needs backport to 3.6 label Feb 25, 2018

csabella deleted the bpo17232 branch February 25, 2018 09:59

Uh oh!

Conversation

csabella commented Feb 23, 2018 • edited by bedevere-bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

terryjreedy left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

bedevere-bot commented Feb 25, 2018

Uh oh!

miss-islington commented Feb 25, 2018

Uh oh!

bedevere-bot commented Feb 25, 2018

Uh oh!

bedevere-bot commented Feb 25, 2018

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

csabella commented Feb 23, 2018 •

edited by bedevere-bot

Loading

terryjreedy left a comment •

edited

Loading