• 単一の先頭アンダースコア:_var
  • 単一の末尾アンダースコア:var_
  • 二重の先頭アンダースコア:__var
  • 二重の先頭および末尾アンダースコア:__var__
  • 単一アンダースコア:_

記事の最後には、5つの異なるアンダースコア命名規則とその意味をまとめた簡潔な「早見表」と、それらの動作を実際に体験できる短いビデオチュートリアルがあります。

さっそく始めましょう!

1. 単一の先頭アンダースコア _var

変数やメソッド名に関しては、単一のアンダースコア接頭辞には慣習的な意味があります。これはプログラマーへのヒントです。つまり、Pythonコミュニティがこういう意味であるべきだと合意しているということであり、プログラムの動作には影響しません。

アンダースコア接頭辞の意味は、他のプログラマーに「単一のアンダースコアで始まる変数やメソッドは内部使用専用である」ことを伝えることです。この規則はPEP 8で定義されています。

これはPythonによって強制されるものではありません。PythonはJavaのように「プライベート」変数と「パブリック」変数の間に強い区別がありません。これは、誰かが小さなアンダースコアの警告標識を掲げて、こう言っているようなものです:

「おい、これは本当にクラスのパブリックインターフェースの一部になるつもりはないんだ。ほっといてくれ。」

次の例を見てください:

class Test:
   def __init__(self):
       self.foo = 11
       self._bar = 23

このクラスをインスタンス化し、__init__コンストラクタで定義されたfooと_bar属性にアクセスしようとするとどうなるでしょうか?見てみましょう:

>>> t = Test()
>>> t.foo
11
>>> t._bar
23

_barの単一のアンダースコアは、クラスに「入り込んで」その変数の値にアクセスすることを妨げないことがわかるでしょう。

これは、Pythonの単一のアンダースコア接頭辞が単なる慣習にすぎないためです(少なくとも変数名とメソッド名に関しては)。

ただし、先頭のアンダースコアはモジュールから名前をインポートする方法に確かに影響を与えます。

my_moduleという名前のモジュールに次のコードがあるとします:

# This is my_module.py:

def external_func():
   return 23

def _internal_func():
   return 42

さて、ワイルドカードを使ってモジュールからすべての名前をインポートする場合、Pythonは先頭にアンダースコアが付いた名前をインポートしません(モジュールがこの動作を上書きする__all__リストを定義している場合を除きます):

>>> from my_module import *
>>> external_func()
23
>>> _internal_func()
NameError: "name '_internal_func' is not defined"

ちなみに、ワイルドカードインポートは名前空間にどのような名前が存在するのか不明瞭になるため避けるべきです。明確にするには、通常のインポートを使う方が良いでしょう。

ワイルドカードインポートとは異なり、通常のインポートは先頭の単一アンダースコア命名規則の影響を受けません:

>>> import my_module
>>> my_module.external_func()
23
>>> my_module._internal_func()
42

これは少し混乱するかもしれません。PEP 8の推奨に従ってワイルドカードインポートを避けるなら、実際に覚えておく必要があるのはこれだけです:

単一のアンダースコアは、その名前が内部使用向けであることを示すPythonの命名規則です。通常、Pythonインタープリタによって強制されるものではなく、単にプログラマーへのヒントとして機能します。

2. 単一の末尾アンダースコア var_

時々、変数に最も適した名前がすでにキーワードによって占有されていることがあります。そのため、classやdefのような名前はPythonの変数名として使用できません。このような場合、アンダースコアを追加して名前の衝突を解決できます:

>>> def make_object(name, class):
SyntaxError: "invalid syntax"

>>> def make_object(name, class_):
...    pass

要するに、単一の末尾アンダースコア(接尾辞)は、Pythonのキーワードとの名前の衝突を避けるための規則です。PEP 8がこの規則を説明しています。

3. 二重の先頭アンダースコア __var

ここまでに説明したすべての命名パターンの意味は、合意された慣習に由来しています。しかし、二重アンダースコアで始まるPythonクラスの属性(変数とメソッドを含む)については、事情が少し異なります。

二重アンダースコアの接頭辞は、Pythonインタープリタが属性名を書き換えて、サブクラス内での名前の衝突を避けるようにします。

これは名前マングリング(name mangling)とも呼ばれます。インタープリタが変数の名前を変更することで、クラスが拡張されたときに衝突が発生しにくくなります。

抽象的には聞こえるかもしれません。そこで、説明のために小さなコード例を用意しました:

class Test:
   def __init__(self):
       self.foo = 11
       self._bar = 23
       self.__baz = 23

組み込みのdir()関数を使って、このオブジェクトの属性を見てみましょう:

>>> t = Test()
>>> dir(t)
['_Test__baz', '__class__', '__delattr__', '__dict__', '__dir__',
'__doc__', '__eq__', '__format__', '__ge__', '__getattribute__',
'__gt__', '__hash__', '__init__', '__le__', '__lt__', '__module__',
'__ne__', '__new__', '__reduce__', '__reduce_ex__', '__repr__',
'__setattr__', '__sizeof__', '__str__', '__subclasshook__',
'__weakref__', '_bar', 'foo']

以上がこのオブジェクトの属性のリストです。このリストを見て、元の変数名foo、_bar、__bazを探してみましょう。きっと興味深い変化に気づくはずです。

self.foo変数は属性リストでは変更されずfooとして表示されます。

self._barも同様に動作し、_barとしてクラスに表示されます。先ほど述べたように、この場合の先頭のアンダースコアは単なる慣習であり、プログラマーへのヒントにすぎません。 しかし、self.__bazについては事情が少し異なります。このリストで__bazを探しても、その名前の変数は見つからないでしょう。

__bazはどうなったのでしょうか?

よく見ると、このオブジェクトには_Test__bazという名前の属性があることがわかります。これがPythonインタープリタによる名前マングリングです。これは、変数がサブクラスで上書きされないようにするためです。

Testクラスを拡張する別のクラスを作成し、コンストラクタで追加された既存の属性を上書きしてみましょう:

class ExtendedTest(Test):
   def __init__(self):
       super().__init__()
       self.foo = 'overridden'
       self._bar = 'overridden'
       self.__baz = 'overridden'

さて、foo、_bar、__bazの値はこのExtendedTestクラスのインスタンスに現れるでしょうか?見てみましょう:

>>> t2 = ExtendedTest()
>>> t2.foo
'overridden'
>>> t2._bar
'overridden'
>>> t2.__baz
AttributeError: "'ExtendedTest' object has no attribute '__baz'"

ちょっと待って、t2.__bazの値を確認しようとすると、なぜAttributeErrorが発生するのでしょうか?名前マングリングが再び発生したのです!実際、このオブジェクトには__baz属性すら存在しません:

>>> dir(t2)
['_ExtendedTest__baz', '_Test__baz', '__class__', '__delattr__',
'__dict__', '__dir__', '__doc__', '__eq__', '__format__', '__ge__',
'__getattribute__', '__gt__', '__hash__', '__init__', '__le__',
'__lt__', '__module__', '__ne__', '__new__', '__reduce__',
'__reduce_ex__', '__repr__', '__setattr__', '__sizeof__', '__str__',
'__subclasshook__', '__weakref__', '_bar', 'foo', 'get_vars']

ご覧のとおり、__bazは予期しない変更を防ぐために_ExtendedTest__bazになっています:

>>> t2._ExtendedTest__baz
'overridden'

しかし元の_Test__bazはまだ存在しています:

>>> t2._Test__baz
42

二重アンダースコアの名前マングリングはプログラマーには完全に透過的です。次の例がこれを裏付けています:

class ManglingTest:
   def __init__(self):
       self.__mangled = 'hello'

   def get_mangled(self):
       return self.__mangled

>>> ManglingTest().get_mangled()
'hello'
>>> ManglingTest().__mangled
AttributeError: "'ManglingTest' object has no attribute '__mangled'"

名前マングリングはメソッド名にも適用されるのでしょうか?はい、適用されます。名前マングリングは、クラスのコンテキスト内で2つのアンダースコア文字(「ダンダー」)で始まるすべての名前に対して影響します:

class MangledMethod:
   def __method(self):
       return 42

   def call_it(self):
       return self.__method()

>>> MangledMethod().__method()
AttributeError: "'MangledMethod' object has no attribute '__method'"
>>> MangledMethod().call_it()
42

これは、おそらく驚くべき名前マングリングの応用例です:

_MangledGlobal__mangled = 23

class MangledGlobal:
   def test(self):
       return __mangled

>>> MangledGlobal().test()
23

この例では、_MangledGlobal__mangledという名前のグローバル変数を宣言しました。そして、MangledGlobalという名前のクラスのコンテキスト内でその変数にアクセスします。名前マングリングにより、クラスのtest()メソッド内で__mangledを使って_MangledGlobal__mangledグローバル変数を参照できます。

Pythonインタープリタは、__mangledが2つのアンダースコア文字で始まるため、自動的に_MangledGlobal__mangledに展開します。これは、名前マングリングがクラス属性に特に関連付けられているわけではないことを示しています。クラスのコンテキストで使用される、2つのアンダースコア文字で始まる任意の名前に対して適用されます。

吸収すべき内容がたくさんありますね。

正直に言うと、これらの例や説明は私の頭から突然出てきたわけではありません。調査と整理をして作り上げました。私は長年Pythonを使ってきましたが、こうした規則や特殊なケースはいつも頭に浮かんでいるわけではありません。

プログラマーにとって最も重要なスキルは「パターン認識」であり、どこで情報を調べるかを知っていることです。この点で少し圧倒されていると感じても、心配しないでください。ゆっくりと、この記事の例をいくつか試してみてください。

これらの概念をしっかりと落とし込んで、名前マングリングの全体的な考え方や、私が示した他のいくつかの動作を理解できるようにしてください。いつかそれらに出くわしたとき、ドキュメントで何を調べればよいかわかるでしょう。

4. 二重の先頭および末尾アンダースコア _var_

驚くべきことに、名前が二重アンダースコアで始まり、かつ二重アンダースコアで終わる場合、名前マングリングは適用されません。二重アンダースコアの接頭辞と接尾辞で囲まれた変数は、Pythonインタープリタによって変更されません:

class PrefixPostfixTest:
   def __init__(self):
       self.__bam__ = 42

>>> PrefixPostfixTest().__bam__
42

しかし、Pythonは二重の先頭および末尾アンダースコアを持つ名前を特別な目的のために予約しています。例としては、オブジェクトコンストラクタの__init__や、オブジェクトを呼び出し可能にする__call__などがあります。

これらのダンダーメソッドは通常「マジックメソッド」と呼ばれますが、Pythonコミュニティの多くの人々(私自身を含む)はこの呼び方を好みません。

将来のPython言語の変更との衝突を避けるために、自分のプログラムでは二重アンダースコア(「ダンダー」)で始まり終わる名前の使用を避けるのが最善です。

5. 単一アンダースコア _

慣習として、単一の独立したアンダースコアは、ある変数が一時的または重要でないことを示す名前として使われることがあります。

例えば、次のループでは、実行中のインデックスにアクセスする必要がないため、"_"を使ってそれが単なる一時的な値であることを示せます:

>>> for _ in range(32):
...    print('Hello, World.')

また、アンパッキング(分割)式で単一アンダースコアを「関心のない」変数として使い、特定の値を無視することもできます。繰り返しますが、この意味は「慣習によるもの」であり、Pythonインタープリタで特別な動作を引き起こすものではありません。単一アンダースコアは単なる有効な変数名であり、そのような用途に使われるだけです。

次のコード例では、自動車のタプルを個別の変数に分割していますが、私は色と走行距離の値にのみ関心があります。ただし、分割式を正常に実行するには、タプルに含まれるすべての値を変数に代入する必要があります。このような場合、"_"がプレースホルダー変数として役立ちます:

>>> car = ('red', 'auto', 12, 3812.4)
>>> color, _, _, mileage = car

>>> color
'red'
>>> mileage
3812.4
>>> _
12

一時変数として使われる以外に、"_" はほとんどの Python REPL における特別な変数であり、インタープリターによって評価された直前の式の結果を表します。

これは非常に便利です。例えば、インタープリターセッション内で以前計算した結果にアクセスしたり、動的に複数のオブジェクトを構築してそれらと対話する場合に、事前にこれらのオブジェクトに名前を割り当てる必要がありません:

>>> 20 + 3
23
>>> _
23
>>> print(_)
23

>>> list()
[]
>>> _.append(1)
>>> _.append(2)
>>> _.append(3)
>>> _
[1, 2, 3]

Pythonのアンダースコア命名パターン - まとめ

以下は、私がこの記事で説明した5つの Python のアンダースコアパターンの意味を列挙した短いまとめ、いわゆる「早見表」です。

原文アドレス:https://zhuanlan.zhihu.com/p/36173202