# Scope of Variables

The scope of a variable is the region of code within which a variable is visible. Variable scoping helps avoid variable naming conflicts. The concept is intuitive: two functions can both have arguments called `x` without the two `x`'s referring to the same thing. Similarly, there are many other cases where different blocks of code can use the same name without referring to the same thing. The rules for when the same variable name does or doesn't refer to the same thing are called scope rules; this section spells them out in detail.

Certain constructs in the language introduce scope blocks, which are regions of code that are eligible to be the scope of some set of variables. The scope of a variable cannot be an arbitrary set of source lines; instead, it will always line up with one of these blocks. There are two main types of scopes in Julia, global scope and local scope. The latter can be nested. There is also a distinction in Julia between constructs which introduce a "hard scope" and those which only introduce a "soft scope", which affects whether shadowing a global variable by the same name is allowed or not.

### Scope constructs

The constructs introducing scope blocks are:

Construct | Scope type | Allowed within
--- | --- | ---
`module`, `baremodule` | global | global
`struct` | local (soft) | global
`for`, `while`, `try` | local (soft) | global, local
`macro` | local (hard) | global
functions, `do` blocks, `let` blocks, comprehensions, generators | local (hard) | global, local

Notably missing from this table are begin blocks and if blocks which do not introduce new scopes. The three types of scopes follow somewhat different rules which will be explained below.

Julia uses lexical scoping, meaning that a function's scope does not inherit from its caller's scope, but from the scope in which the function was defined. For example, in the following code the `x` inside `foo` refers to the `x` in the global scope of its module `Bar`:

    julia> module Bar
               x = 1
               foo() = x
           end;

and not a `x` in the scope where `foo` is used:

    julia> import .Bar

    julia> x = -1;

    julia> Bar.foo()
    1

Thus lexical scope means that what a variable in a particular piece of code refers to can be deduced from the code in which it appears alone and does not depend on how the program executes. A scope nested inside another scope can "see" variables in all the outer scopes in which it is contained. Outer scopes, on the other hand, cannot see variables in inner scopes.

## Global Scope

Each module introduces a new global scope, separate from the global scope of all other modules—there is no all-encompassing global scope. Modules can introduce variables of other modules into their scope through the using or import statements or through qualified access using the dot-notation, i.e. each module is a so-called namespace as well as a first-class data structure associating names with values. Note that while variable bindings can be read externally, they can only be changed within the module to which they belong. As an escape hatch, you can always evaluate code inside that module to modify a variable; this guarantees, in particular, that module bindings cannot be modified externally by code that never calls `eval`.

    julia> module A
               a = 1 # a global in A's scope
           end;

    julia> module B
               module C
                   c = 2
               end
               b = C.c    # can access the namespace of a nested global scope
                          # through a qualified access
               import ..A # makes module A available
               d = A.a
           end;

    julia> module D
               b = a # errors as D's global scope is separate from A's
           end;
    ERROR: UndefVarError: a not defined

    julia> module E
               import ..A # make module A available
               A.a = 2    # throws below error
           end;
    ERROR: cannot assign variables in other modules

Note that the interactive prompt (aka REPL) is in the global scope of the module `Main`.

## Local Scope

A new local scope is introduced by most code blocks (see above table for a complete list). Some programming languages require explicitly declaring new variables before using them. Explicit declaration works in Julia too: in any local scope, writing `local x` declares a new local variable in that scope, regardless of whether there is already a variable named `x` in an outer scope or not. Declaring each new local like this is somewhat verbose and tedious, however, so Julia, like many other languages, considers assignment to a new variable in a local scope to implicitly declare that variable as a new local. Mostly this is pretty intuitive, but as with many things that behave intuitively, the details are more subtle than one might naïvely imagine.

When `x = <value>` occurs in a local scope, Julia applies the following rules to decide what the expression means based on where the assignment expression occurs and what `x` already refers to at that location:

1. Existing local: If `x` is already a local variable, then the existing local `x` is assigned;
2. Hard scope: If `x` is not already a local variable and assignment occurs inside of any hard scope construct (i.e. within a let block, function or macro body, comprehension, or generator), a new local named `x` is created in the scope of the assignment;
3. Soft scope: If `x` is not already a local variable and all of the scope constructs containing the assignment are soft scopes (loops, `try`/`catch` blocks, or `struct` blocks), the behavior depends on whether the global variable `x` is defined:
   - if global `x` is undefined, a new local named `x` is created in the scope of the assignment;
   - if global `x` is defined, the assignment is considered ambiguous:
     - in non-interactive contexts (files, eval), an ambiguity warning is printed and a new local is created;
     - in interactive contexts (REPL, notebooks), the global variable `x` is assigned.

You may note that in non-interactive contexts the hard and soft scope behaviors are identical except that a warning is printed when an implicitly local variable (i.e. not declared with `local x`) shadows a global. In interactive contexts, the rules follow a more complex heuristic for the sake of convenience. This is covered in depth in examples that follow.

Now that you know the rules, let's look at some examples. Each example is assumed to be evaluated in a fresh REPL session so that the only globals in each snippet are the ones that are assigned in that block of code.

We'll begin with a nice and clear-cut situation—assignment inside of a hard scope, in this case a function body, when no local variable by that name already exists:

    julia> function greet()
               x = "hello" # new local
               println(x)
           end
    greet (generic function with 1 method)

    julia> greet()
    hello

    julia> x # global
    ERROR: UndefVarError: x not defined

Inside of the `greet` function, the assignment `x = "hello"` causes `x` to be a new local variable in the function's scope. There are two relevant facts: the assignment occurs in local scope and there is no existing local `x` variable. Since `x` is local, it doesn't matter if there is a global named `x` or not. Here for example we define `x = 123` before defining and calling `greet`:

    julia> x = 123 # global
    123

    julia> function greet()
               x = "hello" # new local
               println(x)
           end
    greet (generic function with 1 method)

    julia> greet()
    hello

    julia> x # global
    123

Since the `x` in `greet` is local, the value (or lack thereof) of the global `x` is unaffected by calling `greet`. The hard scope rule doesn't care whether a global named `x` exists or not: assignment to `x` in a hard scope is local (unless `x` is declared global).

The next clear cut situation we'll consider is when there is already a local variable named `x`, in which case `x = <value>` always assigns to this existing local `x`. The function `sum_to` computes the sum of the numbers from one up to `n`:

    function sum_to(n)
        s = 0 # new local
        for i = 1:n
            s = s + i # assign existing local
        end
        return s # same local
    end

As in the previous example, the first assignment to `s` at the top of `sum_to` causes `s` to be a new local variable in the body of the function. The `for` loop has its own inner local scope within the function scope. At the point where `s = s + i` occurs, `s` is already a local variable, so the assignment updates the existing `s` instead of creating a new local. We can test this out by calling `sum_to` in the REPL:

    julia> function sum_to(n)
               s = 0 # new local
               for i = 1:n
                   s = s + i # assign existing local
               end
               return s # same local
           end
    sum_to (generic function with 1 method)

    julia> sum_to(10)
    55

    julia> s # global
    ERROR: UndefVarError: s not defined

Since `s` is local to the function `sum_to`, calling the function has no effect on the global variable `s`. We can also see that the update `s = s + i` in the `for` loop must have updated the same `s` created by the initialization `s = 0` since we get the correct sum of 55 for the integers 1 through 10.

Let's dig into the fact that the `for` loop body has its own scope for a second by writing a slightly more verbose variation which we'll call `sum_to_def`, in which we save the sum `s + i` in a variable `t` before updating `s`:

    julia> function sum_to_def(n)
               s = 0 # new local
               for i = 1:n
                   t = s + i # new local `t`
                   s = t # assign existing local `s`
               end
               return s, @isdefined(t)
           end
    sum_to_def (generic function with 1 method)

    julia> sum_to_def(10)
    (55, false)

This version returns `s` as before but it also uses the `@isdefined` macro to return a boolean indicating whether there is a local variable named `t` defined in the function's outermost local scope. As you can see, there is no `t` defined outside of the `for` loop body. This is because of the hard scope rule again: since the assignment to `t` occurs inside of a function, which introduces a hard scope, the assignment causes `t` to become a new local variable in the local scope where it appears, i.e. inside of the loop body. Even if there were a global named `t`, it would make no difference—the hard scope rule isn't affected by anything in global scope.

Let's move onto some more ambiguous cases covered by the soft scope rule. We'll explore this by extracting the bodies of the `greet` and `sum_to_def` functions into soft scope contexts. First, let's put the body of `greet` in a `for` loop—which is soft, rather than hard—and evaluate it in the REPL:

    julia> for i = 1:3
               x = "hello" # new local
               println(x)
           end
    hello
    hello
    hello

    julia> x
    ERROR: UndefVarError: x not defined

Since the global `x` is not defined when the `for` loop is evaluated, the first clause of the soft scope rule applies and `x` is created as local to the `for` loop and therefore global `x` remains undefined after the loop executes. Next, let's consider the body of `sum_to_def` extracted into global scope, fixing its argument to `n = 10`

    s = 0
    for i = 1:10
        t = s + i
        s = t
    end
    s
    @isdefined(t)

What does this code do? Hint: it's a trick question. The answer is "it depends." If this code is entered interactively, it behaves the same way it does in a function body. But if the code appears in a file, it prints an ambiguity warning and throws an undefined variable error. Let's see it working in the REPL first:

    julia> s = 0 # global
    0

    julia> for i = 1:10
               t = s + i # new local `t`
               s = t # assign global `s`
           end

    julia> s # global
    55

    julia> @isdefined(t) # global
    false

The REPL approximates being in the body of a function by deciding whether assignment inside the loop assigns to a global or creates new local based on whether a global variable by that name is defined or not. If a global by the name exists, then the assignment updates it. If no global exists, then the assignment creates a new local variable. In this example we see both cases in action:

- There is no global named `t`, so `t = s + i` creates a new `t` that is local to the `for` loop;
- There is a global named `s`, so `s = t` assigns to it.

The second fact is why execution of the loop changes the global value of `s` and the first fact is why `t` is still undefined after the loop executes. Now, let's try evaluating this same code as though it were in a file instead:

    julia> code = """
           s = 0 # global
           for i = 1:10
               t = s + i # new local `t`
               s = t # new local `s` with warning
           end
           s, # global
           @isdefined(t) # global
           """;

    julia> include_string(Main, code)
    ┌ Warning: Assignment to `s` in soft scope is ambiguous because a global variable by the same name exists: `s` will be treated as a new local. Disambiguate by using `local s` to suppress this warning or `global s` to assign to the existing global variable.
    └ @ string:4
    ERROR: LoadError: UndefVarError: s not defined

Here we use `include_string`, to evaluate `code` as though it were the contents of a file. We could also save `code` to a file and then call `include` on that file—the result would be the same. As you can see, this behaves quite different from evaluating the same code in the REPL. Let's break down what's happening here:

- global `s` is defined with the value `0` before the loop is evaluated
- the assignment `s = t` occurs in a soft scope—a `for` loop outside of any function body or other hard scope construct
- therefore the second clause of the soft scope rule applies, and the assignment is ambiguous so a warning is emitted
- execution continues, making `s` local to the `for` loop body
- since `s` is local to the `for` loop, it is undefined when `t = s + i` is evaluated, causing an error
- evaluation stops there, but if it got to `s` and `@isdefined(t)`, it would return `0` and `false`.

This demonstrates some important aspects of scope: in a scope, each variable can only have one meaning, and that meaning is determined regardless of the order of expressions. The presence of the expression `s = t` in the loop causes `s` to be local to the loop, which means that it is also local when it appears on the right hand side of `t = s + i`, even though that expression appears first and is evaluated first. One might imagine that the `s` on the first line of the loop could be global while the `s` on the second line of the loop is local, but that's not possible since the two lines are in the same scope block and each variable can only mean one thing in a given scope.

#### On Soft Scope

We have now covered all the local scope rules, but before wrapping up this section, perhaps a few words should be said about why the ambiguous soft scope case is handled differently in interactive and non-interactive contexts. There are two obvious questions one could ask:

1. Why doesn't it just work like the REPL everywhere?
2. Why doesn't it just work like in files everywhere? And maybe skip the warning?

In Julia ≤ 0.6, all global scopes did work like the current REPL: when `x = <value>` occurred in a loop (or `try`/`catch`, or `struct` body) but outside of a function body (or `let` block or comprehension), it was decided based on whether a global named `x` was defined or not whether `x` should be local to the loop. This behavior has the advantage of being intuitive and convenient since it approximates the behavior inside of a function body as closely as possible. In particular, it makes it easy to move code back and forth between a function body and the REPL when trying to debug the behavior of a function. However, it has some downsides. First, it's quite a complex behavior: many people over the years were confused about this behavior and complained that it was complicated and hard both to explain and understand. Fair point. Second, and arguably worse, is that it's bad for programming "at scale." When you see a small piece of code in one place like this, it's quite clear what's going on:

    s = 0
    for i = 1:10
        s += i
    end

Obviously the intention is to modify the existing global variable `s`. What else could it mean? However, not all real world code is so short or so clear. We found that code like the following often occurs in the wild:

    x = 123

    # much later
    # maybe in a different file

    for i = 1:10
        x = "hello"
        println(x)
    end

    # much later
    # maybe in yet another file
    # or maybe back in the first one where `x = 123`

    y = x + 234

It's far less clear what should happen here. Since `x + "hello"` is a method error, it seems probable that the intention is for `x` to be local to the `for` loop. But runtime values and what methods happen to exist cannot be used to determine the scopes of variables. With the Julia ≤ 0.6 behavior, it's especially concerning that someone might have written the `for` loop first, had it working just fine, but later when someone else adds a new global far away—possibly in a different file—the code suddenly changes meaning and either breaks noisily or, worse still, silently does the wrong thing. This kind of "spooky action at a distance" is something that good programming language designs should prevent.

So in Julia 1.0, we simplified the rules for scope: in any local scope, assignment to a name that wasn't already a local variable created a new local variable. This eliminated the notion of soft scope entirely as well as removing the potential for spooky action. We uncovered and fixed a significant number of bugs due to the removal of soft scope, vindicating the choice to get rid of it. And there was much rejoicing! Well, no, not really. Because some people were angry that they now had to write:

    s = 0
    for i = 1:10
        global s += i
    end

Do you see that `global` annotation in there? Hideous. Obviously this situation could not be tolerated. But seriously, there are two main issues with requiring `global` for this kind of top-level code:

1. It's no longer convenient to copy and paste the code from inside a function body into the REPL to debug it—you have to add `global` annotations and then remove them again to go back;

2. Beginners will write this kind of code without the `global` and have no idea why their code doesn't work—the error that they get is that `s` is undefined, which does not seem to enlighten anyone who happens to make this mistake.

As of Julia 1.5, this code works without the `global` annotation in interactive contexts like the REPL or Jupyter notebooks (just like Julia 0.6) and in files and other non-interactive contexts, it prints this very direct warning:

> Assignment to `s` in soft scope is ambiguous because a global variable by the same name exists: `s` will be treated as a new local. Disambiguate by using `local s` to suppress this warning or `global s` to assign to the existing global variable.

This addresses both issues while preserving the "programming at scale" benefits of the 1.0 behavior: global variables have no spooky effect on the meaning of code that may be far away; in the REPL copy-and-paste debugging works and beginners don't have any issues; any time someone either forgets a `global` annotation or accidentally shadows an existing global with a local in a soft scope, which would be confusing anyway, they get a nice clear warning.

An important property of this design is that any code that executes in a file without a warning will behave the same way in a fresh REPL. And on the flip side, if you take a REPL session and save it to file, if it behaves differently than it did in the REPL, then you will get a warning.

### Let Blocks

Unlike assignments to local variables, `let` statements allocate new variable bindings each time they run. An assignment modifies an existing value location, and `let` creates new locations. This difference is usually not important, and is only detectable in the case of variables that outlive their scope via closures. The `let` syntax accepts a comma-separated series of assignments and variable names:

    julia> x, y, z = -1, -1, -1;

    julia> let x = 1, z
               println("x: $x, y: $y") # x is local variable, y the global
               println("z: $z") # errors as z has not been assigned yet but is local
           end
    x: 1, y: -1
    ERROR: UndefVarError: z not defined

The assignments are evaluated in order, with each right-hand side evaluated in the scope before the new variable on the left-hand side has been introduced. Therefore it makes sense to write something like `let x = x` since the two `x` variables are distinct and have separate storage. Here is an example where the behavior of `let` is needed:

    julia> Fs = Vector{Any}(undef, 2); i = 1;

    julia> while i <= 2
               Fs[i] = ()->i
               global i += 1
           end

    julia> Fs[1]()
    3

    julia> Fs[2]()
    3

Here we create and store two closures that return variable `i`. However, it is always the same variable `i`, so the two closures behave identically. We can use `let` to create a new binding for `i`:

    julia> Fs = Vector{Any}(undef, 2); i = 1;

    julia> while i <= 2
               let i = i
                   Fs[i] = ()->i
               end
               global i += 1
           end

    julia> Fs[1]()
    1

    julia> Fs[2]()
    2

Since the `begin` construct does not introduce a new scope, it can be useful to use a zero-argument `let` to just introduce a new scope block without creating any new bindings:

    julia> let
               local x = 1
               let
                   local x = 2
               end
               x
           end
    1

Since `let` introduces a new scope block, the inner local `x` is a different variable than the outer local `x`.

### Loops and Comprehensions

In loops and comprehensions, new variables introduced in their body scopes are freshly allocated for each loop iteration, as if the loop body were surrounded by a `let` block, as demonstrated by this example:

    julia> Fs = Vector{Any}(undef, 2);

    julia> for j = 1:2
               Fs[j] = ()->j
           end

    julia> Fs[1]()
    1

    julia> Fs[2]()
    2

A `for` loop or comprehension iteration variable is always a new variable:

    julia> function f()
               i = 0
               for i = 1:3
                   # empty
               end
               return i
           end;

    julia> f()
    0

However, it is occasionally useful to reuse an existing local variable as the iteration variable. This can be done conveniently by adding the keyword `outer`:

    julia> function f()
               i = 0
               for outer i = 1:3
                   # empty
               end
               return i
           end;

    julia> f()
    3

## Constants

A common use of variables is giving names to specific, unchanging values. Such variables are only assigned once. This intent can be conveyed to the compiler using the `const` keyword:

    julia> const e  = 2.71828182845904523536;

    julia> const pi = 3.14159265358979323846;

Multiple variables can be declared in a single `const` statement:

    julia> const a, b = 1, 2
    (1, 2)

The `const` declaration should only be used in global scope on globals. It is difficult for the compiler to optimize code involving global variables, since their values (or even their types) might change at almost any time. If a global variable will not change, adding a `const` declaration solves this performance problem.

Local constants are quite different. The compiler is able to determine automatically when a local variable is constant, so local constant declarations are not necessary, and in fact are currently not supported.

Special top-level assignments, such as those performed by the `function` and `struct` keywords, are constant by default.

Note that `const` only affects the variable binding; the variable may be bound to a mutable object (such as an array), and that object may still be modified. Additionally when one tries to assign a value to a variable that is declared constant the following scenarios are possible:

- if a new value has a different type than the type of the constant then an error is thrown:

    julia> const x = 1.0
    1.0

    julia> x = 1
    ERROR: invalid redefinition of constant x

- if a new value has the same type as the constant then a warning is printed:

    julia> const y = 1.0
    1.0

    julia> y = 2.0
    WARNING: redefinition of constant y. This may fail, cause incorrect answers, or produce other errors.
    2.0

- if an assignment would not result in the change of variable value no message is given:

    julia> const z = 100
    100

    julia> z = 100
    100

The last rule applies to immutable objects even if the variable binding would change, e.g.:

    julia> const s1 = "1"
    "1"

    julia> s2 = "1"
    "1"

    julia> pointer.([s1, s2], 1)
    2-element Array{Ptr{UInt8},1}:
     Ptr{UInt8} @0x00000000132c9638
     Ptr{UInt8} @0x0000000013dd3d18

    julia> s1 = s2
    "1"

    julia> pointer.([s1, s2], 1)
    2-element Array{Ptr{UInt8},1}:
     Ptr{UInt8} @0x0000000013dd3d18
     Ptr{UInt8} @0x0000000013dd3d18

However, for mutable objects the warning is printed as expected:

    julia> const a = [1]
    1-element Vector{Int64}:
     1

    julia> a = [1]
    WARNING: redefinition of constant a. This may fail, cause incorrect answers, or produce other errors.
    1-element Vector{Int64}:
     1

Note that although sometimes possible, changing the value of a `const` variable is strongly discouraged, and is intended only for convenience during interactive use. Changing constants can cause various problems or unexpected behaviors. For instance, if a method references a constant and is already compiled before the constant is changed, then it might keep using the old value:

    julia> const x = 1
    1

    julia> f() = x
    f (generic function with 1 method)

    julia> f()
    1

    julia> x = 2
    WARNING: redefinition of constant x. This may fail, cause incorrect answers, or produce other errors.
    2

    julia> f()
    1

Theme

This document was generated with Documenter.jl on Friday 24 September 2021. Using Julia version 1.6.3.