Skip to content

Commit 7e1a130

Browse files
authored
DOCS: Suggest always calling exec with a globals argument and no locals argument (GH-119235)
Many users think they want a locals argument for various reasons but they do not understand that it makes code be treated as a class definition. They do not want their code treated as a class definition and get surprised. The reason not to pass locals specifically is that the following code raises a `NameError`: ```py exec(""" def f(): print("hi") f() def g(): f() g() """, {}, {}) ``` The reason not to leave out globals is as follows: ```py def t(): exec(""" def f(): print("hi") f() def g(): f() g() """) ```
1 parent 1195c16 commit 7e1a130

File tree

1 file changed

+7
-3
lines changed

1 file changed

+7
-3
lines changed

Doc/library/functions.rst

+7-3
Original file line numberDiff line numberDiff line change
@@ -608,9 +608,13 @@ are always available. They are listed here in alphabetical order.
608608
will be used for both the global and the local variables. If *globals* and
609609
*locals* are given, they are used for the global and local variables,
610610
respectively. If provided, *locals* can be any mapping object. Remember
611-
that at the module level, globals and locals are the same dictionary. If exec
612-
gets two separate objects as *globals* and *locals*, the code will be
613-
executed as if it were embedded in a class definition.
611+
that at the module level, globals and locals are the same dictionary.
612+
613+
.. note::
614+
615+
Most users should just pass a *globals* argument and never *locals*.
616+
If exec gets two separate objects as *globals* and *locals*, the code
617+
will be executed as if it were embedded in a class definition.
614618

615619
If the *globals* dictionary does not contain a value for the key
616620
``__builtins__``, a reference to the dictionary of the built-in module

0 commit comments

Comments
 (0)