Perlのmodule_trueフラグを先取り！

Perl Advent Calendar 2022に穴が空いてしまったときの穴埋め用に温めていた記事です。無事完走したので公開してしまいます。

v5.38からmodule_true feature pragmaというのが入る予定らしいので試してみました。 v5.38は未リリースなので、開発版のv5.37.5で検証しています。

今まで挙動

Perlモジュールの末尾に1;という謎の記述を見たことはありませんか？

# SomeModule.pm
package SomeModule;

sub import {
  warn "You imported a module!\n";
}

1;

どこかに代入しているわけでもないので、ムダな一行に見えます。しかしこの一行がないとモジュールの読み込みに失敗する場合があります。以下のように1;を削除して、このモジュールを読み込んでみましょう。

# SomeModule.pm
package SomeModule;

sub import {
  warn "You imported a module!\n";
}

# program.pl
use FindBin;
use lib "$FindBin::Bin";
use SomeModule;

$ perl program.pl
SomeModule.pm did not return a true value at program.pl line 3.
BEGIN failed--compilation aborted at program.pl line 3.

“SomeModule.pmが値trueを返しませんでした"というエラーメッセージとともにプログラムが止まってしまいます。実は1;はモジュールの読み込みが成功したかを表すフラグなのです。

ただ1;を末尾につけるのはよく忘れるんですよね（実際自分も毎回忘れる）。忘れたとしても直前のコードがたまたまtrueを返してモジュールの読み込みが成功することもあるので、非常に気が付きにくいです。そこでこの機能を無効化するフラグが追加されました。

# SomeModule.pm
package SomeModule;

use feature 'module_true';

sub import {
  warn "You imported a module!\n";
}

$ perl program.pl
You imported a module!

5.37以降の機能を有効化するfeature bundleでデフォルト有効化されるので、以下のように記述してもOKです。

# SomeModule.pm
package SomeModule;

use v5.37;

sub import {
  warn "You imported a module!\n";
}

trueと判定されてればOKなので、末尾に埋め込むのは文字列でも大丈夫だったりします。

# SomeModule.pm
package SomeModule;

sub import {
  warn "You imported a module!\n";
}

"ok macopy";

Perl v5.38.0に導入予定の module_true feature pragma を試してみました。 Perlモジュール末尾の1;というおまじないが不要になります。最近のPerlはこういう罠を防ぐ機能が入って、どんどん便利になってますね！