マジックコメントによるスクリプトエンコーディングの指定 (Ruby)
[1]
Ruby ではスクリプトエンコーディングの指定にマジックコメントを使えます。
>>2
[20]
構文として、
- [22]
# coding: エンコーディング - [21]
# encoding: エンコーディング - [23]
# -*- coding: エンコーディング -*- - [24]
# vim:set fileencoding=エンコーディング:
などがあります。 >>2
[27] 「など」が何を指すのかは定かではありません。[28]
>>20 のマジックコメントは、
1行目に置くことができます。ただし 1行目が shebang のときは、
その次の行に置くことができます。
>>2
[29]
ここで、 shebang は
#!/bin/sh
exec ruby19 -x "$0" "$@"
#!ruby
# coding: utf-8
のような場合も想定され、 -x が指定された場合に
#! で始まり ruby を含む行が shebang になるとされています。
>>2
これがどういうことかドキュメント上明らかではありませんが、
1行目が shebang で ruby でない場合は、
ruby の shebang を探し、それを shebang
とみなした次の行が魔法注釈である、
ということでしょうか。
shebang がかなり後ろの行になることも考えられますが、
どこまで探すかの制限があるのかどうか、ドキュメント上明らかではありません。
[31]
現行ドキュメントによると、魔法注釈の
encoding
指令が符号化を表すのであり、
coding
はその別名と説明されています。 >>30
[32]
また、 -*- 構文は通常1行1指令で書かれる # encoding:
構文を複数指令まとめて1行にできる別構文とされています。 >>30
[33]
これによれば -*- には coding だけでなく encoding
とも記述できます。また、他の指令も記述できます。
ただし、それらのうち Emacs と同等に解釈されるのはおそらく
coding
だけです。
[36]
値として期待されるのは Ruby が認識するエンコーディングの名前のようです。
Emacs の coding-system の名前とは主要な文字符号化の名前に於いて重なりますが、
同一ではありません。
[2] 多言語化 (Ruby 1.9.3)
()
http://docs.ruby-lang.org/ja/1.9.3/doc/spec=2fm17n.html#magic_commentマジックコメントを使うことにより Ruby 実行系にスクリプトエンコーディングを 伝えることができます。マジックコメントとはスクリプトファイルの1行目に書かれた
# coding: euc-jp
という形式のコメントのことです。1 行目が shebang である場合、マジックコメントは 2 行目に 書くことができます(それ以降の行ではいけません。無視されます)。上の形式以外にも
# encoding: euc-jp
# -*- coding: euc-jp -*-
# vim:set fileencoding=euc-jp:
などの形式を解釈します。
#!/bin/sh
exec ruby19 -x "$0" "$@"
#!ruby
# coding: utf-8
このように -x オプションを使っている場合には「#! で始まり、ruby がある行」 の次の行に書きます。
- [30]
comments - Documentation for Ruby 3.5, , https://docs.ruby-lang.org/en/master/syntax/comments_rdoc.html#label-encoding+Directive
[4] pod にも # ENCODING: を書く流儀 (非標準) があるようです。
=encoding
[34] 標準の方法は =encoding です。[35] Ruby との関連は不明です。大文字と小文字の違いがありますが、
Ruby, pod のどちらとも、少なくてもドキュメント上は、
大文字と小文字を区別しないとは説明されていません。
魔法注釈による符号化の指定 (Python)
[37]
Python
では
PEP 263
の提案により符号化を魔法注釈として記述できます。
>>19
[38]
行が正規表現
^[ \t\f]*#.*?coding[:=][ \t]*([-_.a-zA-Z0-9]+)
に一致するとき、群で捕獲された部分が符号化の名前です。
>>19
[39]
これは最初の行で検査され、一致しなければ2つ目の行で検査されます。
>>19
[40] 文言通り解釈すると、最初の行に何らかの Python のコードがあり、
2行目に魔法注釈があることも認められているようです。
本来の意図は shebang を認めることと思われますが。[43] 次のような指定が想定されています。 >>19
- [44]
# coding=符号化名 - [48]
# This Python file uses the following encoding: utf-8 - [49]
#!/usr/local/bin/python
# coding: latin-1
- [45]
#!/usr/bin/python
# -*- coding: 符号化名 -*-
- [47]
#!/usr/bin/python
# -*- coding: latin-1 -*-
- [46]
#!/usr/bin/python
# vim: set fileencoding=符号化名 :
[41]
ファイルの先頭に UTF-8 BOM を置くことができ、
その場合、指定された符号化は utf-8 でなければなりません。
そうでなければエラーとなります。
>>19
[42]
指定された符号化が認識できないとき、エラーとなります。
>>19
[50]
この方法は
Emacs,
Vim
の一般的な指定方法に対応可能であり、
Ruby
の一般的な指定方法とも同等ですが、
厳密な評価をしないかわりに簡潔に符号化名を取り出すことができます。
Emacs や Vim
の機能をフル活用して複雑な記述をしている場合は誤認する可能性がありますが、
そんなことはほとんど起こらないだろうと割り切っているのでしょう。
-
[19]
PEP 263 -- Defining Python Source Code Encodings | Python.org
()
https://www.python.org/dev/peps/pep-0263/