Add section about variable scopes.

trekhleb · trekhleb · commit cc59b5243029 · 2018-08-31T12:00:46.000+03:00
diff --git a/README.md b/README.md
@@ -85,6 +85,7 @@ written correctly.
     - [The `continue` statement](src/control_flow/test_break.py)
 5. **Functions**
     - [Function Definition](src/functions/test_function_definition.py) (`def` and `return` statements)
+    - [Scopes of Variables Inside Functions](src/functions/test_function_scopes.py) (`global` and `nonlocal` statements)
     - [Default Argument Values](src/functions/test_function_default_arguments.py)
     - [Keyword Arguments](src/functions/test_function_keyword_arguments.py)
     - [Arbitrary Argument Lists](src/functions/test_function_arbitrary_arguments.py)
diff --git a/src/functions/test_function_scopes.py b/src/functions/test_function_scopes.py
@@ -0,0 +1,107 @@
+"""Scopes and Namespaces.
+
+@see: https://docs.python.org/3/tutorial/classes.html#scopes-and-namespaces-example
+
+A NAMESPACE is a mapping from names to objects. Most namespaces are currently implemented as Python
+dictionaries, but that&rsquo;s normally not noticeable in any way (except for performance), and it may
+change in the future. Examples of namespaces are: the set of built-in names (containing functions
+such as abs(), and built-in exception names); the global names in a module; and the local names
+in a function invocation. In a sense the set of attributes of an object also form a namespace.
+The important thing to know about namespaces is that there is absolutely no relation between names
+in different namespaces; for instance, two different modules may both define a function maximize
+without confusion &mdash; users of the modules must prefix it with the module name.
+
+By the way, we use the word attribute for any name following a dot &mdash; for example, in the expression
+z.real, real is an attribute of the object z. Strictly speaking, references to names in modules are
+attribute references: in the expression modname.func_name, modname is a module object and func_name
+is an attribute of it. In this case there happens to be a straightforward mapping between the
+module&rsquo;s attributes and the global names defined in the module: they share the same namespace!
+
+A SCOPE is a textual region of a Python program where a namespace is directly accessible.
+&ldquo;Directly accessible&rdquo; here means that an unqualified reference to a name attempts to find the name
+in the namespace.
+
+Although scopes are determined statically, they are used dynamically. At any time during execution,
+there are at least three nested scopes whose namespaces are directly accessible:
+- the innermost scope, which is searched first, contains the local names.
+- the scopes of any enclosing functions, which are searched starting with the nearest enclosing
+scope, contains non-local, but also non-global names.
+- the next-to-last scope contains the current module&rsquo;s global names.
+- the outermost scope (searched last) is the namespace containing built-in names.
+
+BE CAREFUL!!!
+-------------
+Changing global or nonlocal variables from within an inner function might be a BAD
+practice and might lead to harder debugging and to more fragile code! Do this only if you know
+what you're doing.
+"""
+
+# pylint: disable=invalid-name
+test_variable = 'initial global value'
+
+
+def test_function_scopes():
+    """Scopes and Namespaces Example"""
+
+    # This is an example demonstrating how to reference the different scopes and namespaces, and
+    # how global and nonlocal affect variable binding:
+
+    # pylint: disable=redefined-outer-name
+    test_variable = 'initial value inside test function'
+
+    def do_local():
+        # Create variable that is only accessible inside current do_local() function.
+        # pylint: disable=redefined-outer-name
+        test_variable = 'local value'
+        return test_variable
+
+    def do_nonlocal():
+        # Address the variable from outer scope and try to change it.
+        # pylint: disable=redefined-outer-name
+        nonlocal test_variable
+        test_variable = 'nonlocal value'
+        return test_variable
+
+    def do_global():
+        # Address the variable from very global scope and try to change it.
+        # pylint: disable=redefined-outer-name,global-statement
+        global test_variable
+        test_variable = 'global value'
+        return test_variable
+
+    # On this level currently we have access to local for test_function_scopes() function variable.
+    assert test_variable == 'initial value inside test function'
+
+    # Do local assignment.
+    # It doesn't change global variable and variable from test_function_scopes() scope.
+    do_local()
+    assert test_variable == 'initial value inside test function'
+
+    # Do non local assignment.
+    # It doesn't change global variable but it does change variable
+    # from test_function_scopes() function scope.
+    do_nonlocal()
+    assert test_variable == 'nonlocal value'
+
+    # Do global assignment.
+    # This one changes global variable but doesn't change variable from
+    # test_function_scopes() function scope.
+    do_global()
+    assert test_variable == 'nonlocal value'
+
+
+def test_global_variable_access():
+    """Testing global variable access from within a function"""
+
+    # Global value of test_variable has been already changed by do_global() function in previous
+    # test so let's check that.
+    # pylint: disable=global-statement
+    global test_variable
+    assert test_variable == 'global value'
+
+    # On this example you may see how accessing and changing global variables from within inner
+    # functions might make debugging more difficult and code to be less predictable. Since you
+    # might have expected that test_variable should still be equal to 'initial global value' but
+    # it was changed by "someone" and you need to know about the CONTEXT of who had changed that.
+    # So once again access global and non local scope only if you know what you're doing otherwise
+    # it might be considered as bad practice.
