シェルスクリプトのデバッグは typeset または declare を使うと良いかも

はじめに

つい最近知った便利なデバッグ方法
(長年シェルスクリプトを書いているのに知らなかった。これが常識だったら恥ずかしい…)

シェルスクリプトのデバッグでは echo で変数の中身を見るという原始的な方法をよく使うかと思います。
いわゆる プリントデバッグ というやつですね。

もう少し詳しいデバッグが必要な場合は、 set -x と set +x でデバッグしたい部分を囲むという方法もあります。

今回は プリントデバッグ で使う echo の代わりに typeset or declare を使うと良いというお話です。

プリントデバッグは typeset or declare を使おう

typeset or declare は変数宣言などでよく使うコマンドですが、変数の中身を見るのにも使えます。

echo と比べて何が良いのかというと、変数の中身はもちろん変数名や変数の型も表示してくれ、配列の場合にも良い感じに表示してくれるのです。

わざわざ echo "hoge=$hoge" とか echo "hoge=${hoge[@]}" などとしなくても良い。

typeset or declare はビルトインコマンドなので使用するシェルによって若干の違いがあります。
今回は私がよく使う sh/bash と zsh について触れます。
(sh と bash は今回の場合は同じなので区別しません)

sh/bash

bash では、typeset は obsolete となっています。
declare が使用できる環境では declare を使うと良いでしょう。
(typeset の方が馴染み深いかもしれませんが)

## 文字列
$ str='This is a pen.'

$ declare -p str
declare -- str="This is a pen."


## 配列
$ array=('This is' a pen.)

$ declare -p array
declare -a array='([0]="This is" [1]="a" [2]="pen.")'

変数名や型が表示されていて、配列も見やすく整形されているのが分かりますね。

zsh

zsh では typeset と declare は全く同じです。

## 文字列
$ str='This is a pen.'

$ typeset str
str='This is a pen.'

$ typeset -p str
typeset str='This is a pen.'


## 配列
$ array=('This is' a pen.)

$ typeset array
array=('This is' a pen.)

$ typeset -p array
typeset -a array
array=('This is' a pen.)

# 配列内のデータが多い場合などは以下のようにして改行区切りで表示させると良いでしょう
# j フラグについては後述
$ echo "${(j:\n:)array[@]}"
This is
a
pen


## 連想配列
$ typeset -A associative
$ associative=(key1 val1 key2 val2)

$ typeset associative
associative=(key1 val1 key2 val2 )

$ typeset -p associative
typeset -A associative
associative=(key1 val1 key2 val2 )

zsh だと型情報なしですが -p オプションを付けなくても表示されるので、タイプ数が少なくてすみますね。

(連想配列の表示はもう少し良い感じに表示してくれても良いのではと思わなくもない。
というか、配列もbashの方が分かりやすいような気も…)

それと、気づいた人もいるかもしれませんが、typeset or declare の出力をそのままファイルに保存して、あとでそのファイルを source することでデータを復元することができます。(sh/bash, zsh ともに可能)
(というか元々こういう用途なのかもしれない)

シリアアライズのようなものですね。

色々と使い道がありそうです。

おまけ - zsh の変数展開のデバッグについて

ここからはちょっと濃い話になります。
zsh を使わない方でも、zsh の凄さが分かるので、処理結果だけでも見てみて下さい。

zsh には、フラグを使った変数展開という機能があります。

とても便利な機能なのですが、デバッグするのが非常に大変です。
見慣れてない人だと、場合によっては発狂しかねません。

そこで今回紹介するのが、変数展開の q フラグです。

実際に例を見てみましょう。

例えば、以下の様な複数行のカンマ(,)区切りのデータがあるとします。

$ data='1,2,3
a,b,c
höge,fuga,piyo'

$ echo "$data"
1,2,3
a,b,c
höge,fuga,piyo

このデータを改行で分割したい。
→ f フラグを使うと改行で分割できます。

$ echo "${(f)data}"
1,2,3 a,b,c höge,fuga,piyo

これで改行で分割できました。出来てるはずです。

…でもこれじゃ改行は消えてるけど、どこで分割されてるのか分からないですよね。

では、qフラグを使ってみます。

$ echo "${(qqqf)data}"
"1,2,3" "a,b,c" "höge,fuga,piyo"

分割された部分がダブルコーテーションで囲われて分かりやすくなっていますね。
これが q フラグです。

さらにカンマでも分割したい。
→ j フラグ(join)を使うと、j:,: のように書いて、要素をカンマ(,)で結合できます (任意の文字でも可)
→ s フラグ(split)は s:,: のように書いて、要素をカンマ(,)で分割できます (任意の文字でも可)

$ echo "${(j:,:s:,:qqq)${(f)data}}"
"1" "2" "3" "a" "b" "c" "höge" "fuga" "piyo"

いかがでしょう。
非常に分かりやすいですよね。

最後に応用編です。

for文で1個ずつ処理をしたい場合。

$ for val in "${(j:,:s:,:)${(f)data}}"; do echo "Hello $val san."; done
Hello 1 san.
Hello 2 san.
Hello 3 san.
Hello a san.
Hello b san.
Hello c san.
Hello höge san.
Hello fuga san.
Hello piyo san.

行ごとに & カラムごとに別の処理をしたい。

i=0
for row in "${(f)data}"; do
    (( i++ ))
    echo -n "$i: "
    uppers=()
    for val in "${(s:,:)row}"; do
        uppers+=("${(U)val}")
    done
    echo "${(j:, :)uppers}"
done

# 結果 (行番号を入れつつ、大文字に変換してみました)
# 1: 1, 2, 3
# 2: A, B, C
# 3: HÖGE, FUGA, PIYO