Dynamically set local variable [duplicate]

by

Contrary to other answers already posted you cannot modify locals() directly and expect it to work.

>>> def foo():
    lcl = locals()
    lcl['xyz'] = 42
    print(xyz)


>>> foo()

Traceback (most recent call last):
  File "<pyshell#6>", line 1, in <module>
    foo()
  File "<pyshell#5>", line 4, in foo
    print(xyz)
NameError: global name 'xyz' is not defined

Modifying locals() is undefined. Outside a function when locals() and globals() are the same it will work; inside a function it will usually not work.

Use a dictionary, or set an attribute on an object:

d = {}
d['xyz'] = 42
print(d['xyz'])

or if you prefer, use a class:

class C: pass

obj = C()
setattr(obj, 'xyz', 42)
print(obj.xyz)

Edit:
Access to variables in namespaces that aren’t functions (so modules, class definitions, instances) are usually done by dictionary lookups (as Sven points out in the comments there are exceptions, for example classes that define __slots__). Function locals can be optimised for speed because the compiler (usually) knows all the names in advance, so there isn’t a dictionary until you call locals().

In the C implementation of Python locals() (called from inside a function) creates an ordinary dictionary initialised from the current values of the local variables. Within each function any number of calls to locals() will return the same dictionary, but every call to locals() will update it with the current values of the local variables. This can give the impression that assignment to elements of the dictionary are ignored (I originally wrote that this was the case). Modifications to existing keys within the dictionary returned from locals() therefore only last until the next call to locals() in the same scope.

In IronPython things work a bit differently. Any function that calls locals() inside it uses a dictionary for its local variables so assignments to local variables change the dictionary and assignments to the dictionary change the variables BUT that’s only if you explicitly call locals() under that name. If you bind a different name to the locals function in IronPython then calling it gives you the local variables for the scope where the name was bound and there’s no way to access the function locals through it:

>>> def foo():
...     abc = 123
...     lcl = zzz()
...     lcl['abc'] = 456
...     deF = 789
...     print(abc)
...     print(zzz())
...     print(lcl)
...
>>> zzz =locals
>>> foo()
123
{'__doc__': None, '__builtins__': <module '__builtin__' (built-in)>, 'zzz': <built-in function locals>, 'foo': <function foo at 0x000000000000002B>, '__name__': '__main__', 'abc': 456}
{'__doc__': None, '__builtins__': <module '__builtin__' (built-in)>, 'zzz': <built-in function locals>, 'foo': <function foo at 0x000000000000002B>, '__name__': '__main__', 'abc': 456}
>>>

This could all change at any time. The only thing guaranteed is that you cannot depend on the results of assigning to the dictionary returned by locals().

More Related Contents:

  1. What’s the difference between eval, exec, and compile?
  2. Django dynamic model fields
  3. How to dynamically change base class of instances at runtime?
  4. Use of eval in Python?
  5. Dynamic loading of python modules
  6. Avoid Pylint warning E1101: ‘Instance of .. has no .. member’ for class with dynamic attributes
  7. Change OptionMenu based on what is selected in another OptionMenu
  8. Access to value of variable with dynamic name
  9. How do I create an automatically updating GUI using Tkinter?
  10. Dynamically import a method in a file, from a string
  11. Dynamically creating classes – Python
  12. Why doesn’t Python run my bash code?
  13. Dealing with multiple Python versions and PIP?
  14. Adding value labels on a matplotlib bar chart
  15. Why do backslashes appear twice?
  16. What does it mean if a Python object is “subscriptable” or not?
  17. Splitting a list into N parts of approximately equal length
  18. python pandas remove duplicate columns
  19. Pandas groupby multiple fields then diff
  20. Remove duplicates from dataframe, based on two columns A,B, keeping row with max value in another column C
  21. Django download a file
  22. How do I forward-declare a function to avoid `NameError`s for functions defined later?
  23. How do I convert strings in a Pandas data frame to a ‘date’ data type?
  24. Django 1.7 – makemigrations not detecting changes
  25. What is the difference between subprocess.popen and subprocess.run
  26. How to make python window run as “Always On Top”?
  27. How to define a __str__ method for a class?
  28. Accessing a function within a function(nested function?) [duplicate]
  29. Python library to split and join mp3 files
  30. What does the slice() function do in Python?

Leave a Comment