Python nested functions variable scoping [duplicate]

by

In Python 3, you can use the nonlocal statement to access non-local, non-global scopes.

The nonlocal statement causes a variable definition to bind to a previously created variable in the nearest scope. Here are some examples to illustrate:

def sum_list_items(_list):
    total = 0

    def do_the_sum(_list):
        for i in _list:
            total += i

    do_the_sum(_list)

    return total

sum_list_items([1, 2, 3])

The above example will fail with the error: UnboundLocalError: local variable 'total' referenced before assignment

Using nonlocal we can get the code to work:

def sum_list_items(_list):
    total = 0

    def do_the_sum(_list):

        # Define the total variable as non-local, causing it to bind
        # to the nearest non-global variable also called total.
        nonlocal total

        for i in _list:
            total += i

    do_the_sum(_list)

    return total

sum_list_items([1, 2, 3])

But what does “nearest” mean? Here is another example:

def sum_list_items(_list):

    total = 0

    def do_the_sum(_list):

        # The nonlocal total binds to this variable.
        total = 0

        def do_core_computations(_list):

            # Define the total variable as non-local, causing it to bind
            # to the nearest non-global variable also called total.
            nonlocal total

            for i in _list:
                total += i

        do_core_computations(_list)

    do_the_sum(_list)

    return total

sum_list_items([1, 2, 3])

In the above example, total will bind to the variable defined inside the do_the_sum function, and not the outer variable defined in the sum_list_items function, so the code will return 0. Note that it is still possible to do double nesting such as this: if total is declared nonlocal in do_the_sum the above example would work as expected.

def sum_list_items(_list):

    # The nonlocal total binds to this variable.
    total = 0

    def do_the_sum(_list):

        def do_core_computations(_list):

            # Define the total variable as non-local, causing it to bind
            # to the nearest non-global variable also called total.
            nonlocal total

            for i in _list:
                total += i

        do_core_computations(_list)

    do_the_sum(_list)

    return total

sum_list_items([1, 2, 3])

In the above example the nonlocal assignment traverses up two levels before it locates the total variable that is local to sum_list_items.

More Related Contents:

  1. UnboundLocalError on local variable when reassigned after first use
  2. What’s the scope of a variable initialized in an if statement?
  3. Python: load variables in a dict into namespace
  4. How to create module-wide variables in Python? [duplicate]
  5. Python – Why is this class variable not defined in the method?
  6. How references to variables are resolved in Python [duplicate]
  7. The letter ‘n’ is invalid syntax in Python? [closed]
  8. How to get the value of a variable given its name in a string? [duplicate]
  9. How do you create different variable names while in a loop? [duplicate]
  10. Scoping in Python ‘for’ loops
  11. Instance variables vs. class variables in Python
  12. Scope of python variable in for loop
  13. Explaining the ‘self’ variable to a beginner [duplicate]
  14. How to access outer class from an inner class?
  15. How can I change a global variable from within a function?
  16. Calling variable defined inside one function from another function
  17. Why does assigning to my global variables not work in Python?
  18. Getting an instance name inside class __init__() [duplicate]
  19. Function changes list values and not variable values in Python [duplicate]
  20. How to share variables across scripts in python?
  21. Assigning values to variables in a list using a loop
  22. How can a function access its own attributes?
  23. Python: Using vars() to assign a string to a variable
  24. Does filehandle get closed automatically in Python after it goes out of scope?
  25. Returning Variables in Functions Python Not Working Right
  26. How do I put a variable’s value inside a string (interpolate it into the string)?
  27. Nested list comprehension scope
  28. How to force/ensure class attributes are a specific type?
  29. How to assign each element of a list to a separate variable? [duplicate]
  30. How do the scoping rules work with classes?

Leave a Comment