Perl Hackers Hub

第52回 Perlで堅牢な開発―構文チェック,静的検査,型制約(1)

この記事を読むのに必要な時間:およそ 4 分

本連載では第一線のPerlハッカーが回替わりで執筆していきます。今回のハッカーは小林謙太さんで,テーマは「Perlで堅牢な開発」です。

堅牢な開発とは,異常時への対処や予防を十分行いつつ進める開発手法を指します。堅牢な開発を実現するためには設計手法を含めさまざまな取り組みが考えられますが,今回はPerlの構文チェックや型制約を活用する方法について述べます。

本稿は,Perl 5.28.0を用いて説明していきます。本稿のサンプルコードは,本誌「WEB+DB PRESS Vol.107」サポートサイトから入手できます。

Perlに約束を入れて,異常を予防する

異常が起きてから対処するより,そもそもの予防をしていくことが,影響を拡大させないために肝心です。そのために本節では,構文チェックについて書きます。

checkオプションで構文チェックを行う

Perlで書いたプログラムの構文が正しいかを確認するには,perl -c foo.plのように-c(check)オプションを付けてプログラムを実行します。perldoc perlrunに書いてあるとおり,このオプションはPerlの構文チェックだけでなく,BEGINUNITCHECKCHECKブロックのコードを実行します。たとえば次のコードでperl -cした場合,BEGINブロックの中が実行されてHELLOと標準出力して,pprintの記述が構文エラーであると指摘します。こういったブロックにアプリケーションロジックを記述することは,意図せぬ動作を招くため注意が必要です。

BEGIN {
  print "HELLO\n" # print HELLO
}
pprint "WORLD\n" # error! NOT print

一方,このように構文チェック以外にも処理が実行できるしくみを利用して,Perlインタプリタに構文チェックのやり方を指示できれば,プログラム全体の実行前により多くの問題に気付けます。

プラグマを利用し,より厳しい構文チェックを行う

Perlインタプリタにヒントを与えるためのしくみとして,$^{WARNING_BITS}やヒントハッシュと呼ばれる$^H%^Hといった組込みの変数があり,これを参照し構文チェック時や実行時の振る舞いを変更できます。

BEGIN {
    $^H{"main/myrand"} = rand;
}

sub hello {
    # caller
    my $hinthash = (caller(0))[10];
    if ($hinthash->{"main/myrand"} < 0.5) {
        print "HELLO";
    }
}

hello; # HELLOをランダムに出力

このコードでは,BEGINブロックで抽選した値に応じ,関数の挙動を変更しています。こういった変数は今後挙動が変わる可能性があるため,直接触ることは望ましくありません。実際には多くの場合,このしくみを利用したプラグマと呼ばれるモジュールを利用します。

まずは標準プラグマのstrictプラグマとwarningsプラグマを紹介します。これらのプラグマは本連載第7回「新人さんのための仕事で使えるPerl基礎知識」でも紹介されています。

strictプラグマで,安全でない構文を制限する

strictプラグマを使わなかった場合,次のコードのように変数$varの値を"var"という文字列だけで参照できます。柔軟ですが,意図せぬ挙動を招くので,strictプラグマを利用し,致命的エラーにすると良いでしょう注1)⁠

our $var = "foo";
print ${"var"}; # 文字列 "var" のデリファレンス
# => foo

{
    use strict;
    print ${"var"}
    # => 致命的なエラー:
    # Can't use string ("var") as a SCALAR ref while "stri
ct refs" in use
    # at src/3_strict_refs_example.pl line 7.
}

strictプラグマがほかに制限できる構文について,詳しくはperldoc strictを参照してください。

注1)
シンボリックリファレンスの制限と言います。
warinigsプラグマで,警告ではなく致命的なエラーを選択する

warningsプラグマも,strictプラグマと同様に意図せぬ挙動になりがちなPerlの構文を制限します。たとえば,次のコードは文字列と数字の足し算をしたときに警告を出します。

use warnings;
my $total = "foo" + 123;
print $total;
# =>
# Argument "foo" isn't numeric in addition (+)
# at bar.pl line 2.
123

しかし,これは警告でよいのでしょうか。不確かなデータのまま,コードの実行が続くことで問題は肥大化します。warningsプラグマは,警告を致命的なエラーへと昇格する機能も備えています。具体的には,FATALオプションにどの警告カテゴリを昇格させるかを指定します。

use warnings FATAL => 'numeric';
my $total = "foo" + 123;
print $total;
# =>
# Argument "foo" isn't numeric in addition (+)
# at bar.pl line 2.

このコードでは,FATALオプションに警告カテゴリのnumericを指定しています。これにより,文字列と数字の足し算で致命的エラーとなり,それ以降のコードは実行されていないことがわかります。ほかに,FATALオプションにallを指定することで,すべての警告カテゴリを致命的エラーに昇格させることもできます。

表1に,選択できる主な警告カテゴリを紹介します。詳しくはperldoc perldiagを参照してください。

表1 主な警告カテゴリ

警告のカテゴリ内容
numeric文字列が,数値が必要な演算子の引数として与えられた
experimentalsignaturesといったPerlの実験的な機能の使用
deprecatedPerlで非推奨となった機能の使用
once一意な変数名がtypo(誤字)の可能性がある
redefineサブルーチンを再定義したとき
execsystem()exec()などで,指定されたプログラムが実行できなかったときなど
recursion無限再帰の可能性がある
newlineファイル名に改行文字が含まれる可能性がある
portable32ビットで表現できる数値を超えている

著者プロフィール

小林謙太(こばやしけんた)

東北大学大学院数学専攻修了後,2011年に株式会社モバイルファクトリーに新卒入社。

ソーシャルゲームの開発やプロダクトマネジメントに従事したのち,現在は,育成・採用・広報などのエンジニア組織の課題解決に取り組む。また,Japan Perl Associationのメンバーとして,YAPC::JapanやGotanda.pmなどのコミュニティを中心に活動している。

コメント

コメントの記入