Golang mixed assignment and declaration

by

What you’re experiencing is commonly known as “variable shadowing”. When you use := with any variable in an inner scope, including in statements like if and for despite the lack of braces, a new value and type are associated with that variable:

n := "Example"
//Prints the string variable `n` to standard output and
// returns the number of bytes written in int variable `n` and
// an error indicator in error variable `err`.
if n, err := fmt.Println(n); err != nil {
    panic(err)
} else {
    fmt.Println(n, "bytes written")
}

//Prints the string variable `n` to standard output.
fmt.Printf("n = %q\n", n)

Output:

Example
8 bytes written
n = "Example"

There are a few different ways to fix the issue:

  • declare the variables you need before they’re used and use normal assignment with =
  • use different variable names
  • create a new scope and save the variable’s value for later access, use the variable name with := as you wanted, and before the scope ends, restore the value; it’s normally easier to just use different variable names since you’re creating another variable anyway

The opposite effect can also occur, where you declare something in an inner scope and don’t realize it:

if _, err := fmt.Println(n); err != nil {
    panic(err)
} else {
    fmt.Println(n, "bytes written")
}

//undefined: err
if _, err = fmt.Println(n); err != nil {
    //undefined: err
    panic(err)
}

There are, again, a few different ways to fix this issue:

  • declare the variables you need before they’re used and use normal assignment with =
  • separate the first := and if statement, so the variable is declared as intended; this allows you to use = for all other instances of that variable in the context of that scope and any scopes in which it’s enclosed
  • change all instances of = to := to fix the error

Note that you may encounter the variable shadowing issue in any of the last two cases when a function returns multiple values, but that can be resolved as explained above.

Try both examples on the Go Playground.

Your last example illustrates the combination of declaring and initializing a new variable b while also assigning a value to the existing variable a. No new scope is created, so you’re not shadowing the original variable a, which you can verify by printing the address of a after each assignment (but before the next declaration/assignment):

a := 1
fmt.Println(&a)
a, b := 2, 3
fmt.Println(&a)
a = b          // avoids a "declared but not used" error for `b`

Of course, if you didn’t declare b, then you’d receive an error from the compiler that there are no new variables on the left side of := for the second declaration, which is a roundabout way of saying that you’re trying to declare a twice in the same scope.

Note that this idea, if applied carefully, can also be used to find variables that are shadowed. For example, the “not working” code in your example would print different addresses for a, depending on whether the a inside the inner scope has been declared yet or not:

a := 1
{
    fmt.Println(&a)    // original `a`
    a, b := 2, 3
    fmt.Println(&a)    // new `a`
    a = b              // avoids a "declared but not used" error for `b`
}
fmt.Println(&a)        // original `a`

Leave a Comment

tech