Language: Perl · Versions: Perl 5.40.0
The problem
In Perl, for (@items) aliases $_ directly to each element of @items. Furthermore, $_ is a package-global variable ($main::_) dynamically scoped across subroutine calls! When a loop iterates with for (@items) and calls a helper function (or while (<$fh>) inside a helper function!) that doesn't localize $_ (local $_ or my $_), two catastrophic things happen:
1. Modifying $_ inside the helper silently mutates the caller's @items array in-place (or throws Modification of a read-only value attempted if the caller passed a literal list for (1, 2, 3)!).
2. A bare while (<$fh>) inside a helper clobbers $_ to undef at EOF, wiping out the caller's array elements!
Minimal example
use v5.40;
sub count_config_lines ($path) {
open my $fh, '<', \$path;
my $n = 0;
while (<$fh>) { # Implicitly assigns to global $_ and sets $_ = undef at EOF!
$n++;
}
return $n;
}
my @hosts = ('alpha', 'beta', 'gamma');
for (@hosts) {
count_config_lines("dummy\ncontent\n");
}
say join(', ', map { $_ // 'UNDEF!' } @hosts);
Expected
alpha, beta, gamma
What happens instead
UNDEF!, UNDEF!, UNDEF!
Because for (@hosts) aliases $_ to $hosts[0], $hosts[1], $hosts[2] in turn, and while (<$fh>) inside count_config_lines reads lines into the global $_ until EOF (undef), every element of @hosts is overwritten with undef!
In modern Perl 5.40, why does while (<$fh>) still target global $_ without lexicalization, and what are the best idioms/critic rules to eliminate action-at-a-distance via $_ aliasing?
The behaviour you describe is real and documented, but one of the suggested fixes no longer exists.
Fix: don't use $_ in the helper at all
sub count_config_lines ($path) {
open my $fh, '<', \$path or die "open: $!";
my $n = 0;
while (my $line = <$fh>) { # perl wraps this in defined(...) too
$n++;
}
return $n;
}
If you must keep the bare form (a one-liner, or code you can't rewrite), add local $_; as the first line of the helper. Then the readline assigns to a fresh temporary instead of the caller's aliased element.
Why it happens
while (<$fh>)is defined in perlop ("I/O Operators") aswhile (defined($_ = <$fh>)). It is an ordinary assignment to the global$_, and nothing localizes it.foreachwith no loop variable aliases the global$_to each element. Every sub called from the loop body sees that alias, so a write to$_is a write to$hosts[i].- At EOF the readline returns
undef. Thedefined()test then ends the loop, but the assignment has already happened. That is how your elements end upundef. - The read-only error for
for (1,2,3)is the same mechanism. The aliased literals are constants. - I'm reasoning from perlop and perlsyn here, not from a run. Your example should reproduce what you show, and
local $_should make it printalpha, beta, gamma.
Why it's still this way in 5.40
$_ is a plain package variable, and backward compatibility keeps while (<FH>) working as it always has. use v5.40 only turns on features such as signatures and say. It doesn't change $_ semantics.
One correction: my $_ is not an option
Lexical $_ was experimental in 5.10, deprecated later, and removed in 5.24 (from memory of perldelta, so check if it matters). In 5.40 it is a compile error. The only tool for protecting $_ is local $_.
Idioms
- Use
for my $host (@hosts)in callers andwhile (my $line = <$fh>)in helpers. Reserve$_for short, self-contained expressions likemapandgrepblocks. - In any sub that touches
$_implicitly (while (<>),for,map,chomp;, regex matches), start withlocal $_;. - On Perl::Critic, I'm not aware of a core policy that flags bare
while (<$fh>)or a missinglocal $_. I haven't checked the policy list, so I won't name one.Variables::RequireInitializationForLocalVarsis relevant if you uselocal, but it only checks initialization. A custom policy or a grep-based CI check would settle it.