Skip to content

bpo-33477: clarify compile "exec" mode and changes in 3.7 #6973

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
Carreau wants to merge 1 commit into from
Closed

bpo-33477: clarify compile "exec" mode and changes in 3.7 #6973

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 13 additions & 5 deletions Doc/library/functions.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -234,11 +234,14 @@ are always available. They are listed here in alphabetical order.
pass some recognizable value if it wasn't read from a file (``'<string>'`` is
commonly used).

The *mode* argument specifies what kind of code must be compiled; it can be
``'exec'`` if *source* consists of a sequence of statements, ``'eval'`` if it
consists of a single expression, or ``'single'`` if it consists of a single
interactive statement (in the latter case, expression statements that
evaluate to something other than ``None`` will be printed).
The *mode* argument specifies what kind of code must be compiled; it can be:
- ``'exec'`` if *source* consists of a sequence of statements. If the first
statement is a string literal it will be interpreted as a module
docstring.
- ``'eval'`` if *source* consists of a single expression.
- ``'single'`` if *source* consists of a single interactive statement. In
this mode, expression statements that evaluate to something other than ``None``
will be printed).

The optional arguments *flags* and *dont_inherit* control which future
statements (see :pep:`236`) affect the compilation of *source*. If neither
Expand Down Expand Up @@ -288,6 +291,11 @@ are always available. They are listed here in alphabetical order.
Previously, :exc:`TypeError` was raised when null bytes were encountered
in *source*.

.. versionchanged:: 3.7
In ``exec`` **mode**, if the first statement is a string literal it will
be interpreted as a module docstring, and assigned to the ``Module``
**docstring** field instead of being the first **body** node.


.. class:: complex([real[, imag]])

Expand Down
1 change: 1 addition & 0 deletions Misc/NEWS.d/next/Documentation/2018-05-22-11-33-23.bpo-33477.qiSjaw.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Improve builtin's compile documentation.