値

[13] coding の値には coding system を指定できます。

[14] Emacs の coding system は、文字コードと改行コードを組合せた概念です。 文字コードの名称または文字コードと改行コードを組合せた名称を記述できます。 coding system

文脈

マジックコメントによるスクリプトエンコーディングの指定 (Ruby)

[1] Ruby ではスクリプトエンコーディングの指定にマジックコメントを使えます。 >>2

[20] 構文として、

• [22] # coding: エンコーディング
• [21] # encoding: エンコーディング
• [23] # -*- coding: エンコーディング -*-
  • [25] Emacs の -*- 行
• [24] # vim:set fileencoding=エンコーディング:
  • [26] Vim のモード行

などがあります。 >>2

[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 の名前とは主要な文字符号化の名前に於いて重なりますが、 同一ではありません。

[4] pod にも # ENCODING: を書く流儀 (非標準) があるようです。 =encoding

[35] Ruby との関連は不明です。大文字と小文字の違いがありますが、 Ruby, pod のどちらとも、少なくてもドキュメント上は、 大文字と小文字を区別しないとは説明されていません。

魔法注釈による符号化の指定 (Python)

[37] Python では PEP 263 の提案により符号化を魔法注釈として記述できます。 >>19

[38] 行が正規表現

^[ \t\f]*#.*?coding[:=][ \t]*([-_.a-zA-Z0-9]+)

に一致するとき、群で捕獲された部分が符号化の名前です。 >>19

[39] これは最初の行で検査され、一致しなければ2つ目の行で検査されます。 >>19

[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 の機能をフル活用して複雑な記述をしている場合は誤認する可能性がありますが、 そんなことはほとんど起こらないだろうと割り切っているのでしょう。

関連

Emacsにおける文字コード

[5] vim: も参照。

メモ

• [6] PEP 263 -- Defining Python Source Code Encodings | Python.org (2017-02-22 15:06:02 +09:00) https://www.python.org/dev/peps/pep-0263/
  • [7] 移転確認 2025-11-03T15:35:52.800Z
  • [3] PEP 263 – Defining Python Source Code Encodings | peps.python.org, 2025-05-17T08:38:59.000Z, 2025-05-19T08:42:59.557Z https://peps.python.org/pep-0263/