Edited at

Pythonで変数名をつけるときには予約語だけでなく組み込み関数との衝突も気を付けましょう

More than 1 year has passed since last update.

よくPythonは予約語が少ないと言われる。それは間違いではなくて、

>>> __import__('keyword').kwlist

['False', 'None', 'True', 'and', 'as', 'assert', 'break', 'class', 'continue', 'def', 'del', 'elif', 'else', 'except', 'finally', 'for', 'from', 'global', 'if', 'import', 'in', 'is', 'lambda', 'nonlocal', 'not', 'or', 'pass', 'raise', 'return', 'try', 'while', 'with', 'yield']

バージョン3.3.4時点でこの33個だ。しかし、予約語は


プログラミング言語において字句的には識別子(変数名、関数名、クラス名など)としてのルールを満たしているにもかかわらず、識別子として使えない字句要素。


であって、「識別子として使えるけれども使わない方がいい文字列」はもう少しある。

ちなみに、「Python予約語少ない」と言われる文脈での「Perl予約語多い」というのも厳密には嘘で(参考:Perlに予約語ってあるのだろうか? - Life is very short)、あくまで「識別子として使えるけれども使わない方がいい文字列」が多いだけだ。

「識別子として使えるけれども使わない方がいい文字列」の代表的なものが組み込み関数の関数名で、

>>> list(set([1,2,3,4,3,2,1]))

[1, 2, 3, 4]
>>> list = [1,2,3]
>>> list(set([1,2,3,4,3,2,1]))
Traceback (most recent call last):
File "<stdin>", line 1, in <module>
TypeError: 'list' object is not callable

のように、不用意に使うと組み込み関数を上書きしてしまう危険性がある。組み込み関数の一覧は以下の通り。

>>> dir(__builtins__)

['ArithmeticError', 'AssertionError', 'AttributeError', 'BaseException', 'BlockingIOError', 'BrokenPipeError', 'BufferError', 'BytesWarning', 'ChildProcessError', 'ConnectionAbortedError', 'ConnectionError', 'ConnectionRefusedError', 'ConnectionResetError', 'DeprecationWarning', 'EOFError', 'Ellipsis', 'EnvironmentError', 'Exception', 'False', 'FileExistsError', 'FileNotFoundError', 'FloatingPointError', 'FutureWarning', 'GeneratorExit', 'IOError', 'ImportError', 'ImportWarning', 'IndentationError', 'IndexError', 'InterruptedError', 'IsADirectoryError', 'KeyError', 'KeyboardInterrupt', 'LookupError', 'MemoryError', 'NameError', 'None', 'NotADirectoryError', 'NotImplemented', 'NotImplementedError', 'OSError', 'OverflowError', 'PendingDeprecationWarning', 'PermissionError', 'ProcessLookupError', 'ReferenceError', 'ResourceWarning', 'RuntimeError', 'RuntimeWarning', 'StopIteration', 'SyntaxError', 'SyntaxWarning', 'SystemError', 'SystemExit', 'TabError', 'TimeoutError', 'True', 'TypeError', 'UnboundLocalError', 'UnicodeDecodeError', 'UnicodeEncodeError', 'UnicodeError', 'UnicodeTranslateError', 'UnicodeWarning', 'UserWarning', 'ValueError', 'Warning', 'WindowsError', 'ZeroDivisionError', '_', '__build_class__', '__debug__', '__doc__', '__import__', '__loader__', '__name__', '__package__', 'abs', 'all', 'any', 'ascii', 'bin', 'bool', 'bytearray', 'bytes', 'callable', 'chr', 'classmethod', 'compile', 'complex', 'copyright', 'credits', 'delattr', 'dict', 'dir', 'divmod', 'enumerate', 'eval', 'exec', 'exit', 'filter', 'float', 'format', 'frozenset', 'getattr', 'globals', 'hasattr', 'hash', 'help', 'hex', 'id', 'input', 'int', 'isinstance', 'issubclass', 'iter', 'len', 'license', 'list', 'locals', 'map', 'max', 'memoryview', 'min', 'next', 'object', 'oct', 'open', 'ord', 'pow', 'print', 'property', 'quit', 'range', 'repr', 'reversed', 'round', 'set', 'setattr', 'slice', 'sorted', 'staticmethod', 'str', 'sum', 'super', 'tuple', 'type', 'vars', 'zip']

149個もある!実質気をつかうのは abs 以降の 72個だろうが、それでも予約語と合わせると100を超える。衝突を起こしてコードが動かなくなることがなくても、読む側にとって混乱の元なので、できるだけこれらを変数名に使うことは避けたい。

そもそもアンダースコア(_)から始まる変数には特殊な意味があるとか、他に気を付けた方がイイことはPEP8の命名ルールに丁寧に書いてあるので参考に。

ここに、


インスタンスメソッドの第一引数には常に self を使います。

クラスメソッドの第一引数には常に cls を使います。


みたいなことが書かれているので、self と cls も「識別子として使えるけれども(決められた用途以外に)使わない方がいい文字列」になるでしょう。(じゃあなんでこれらは予約語にならないのかについては 和訳 なぜPythonのメソッド引数に明示的にselfと書くのか あたりをご参考に)

また、PEP8 では 冒頭の list の例のように、keyword と衝突する場合、どう名前をつけかえるかについても list_ のように _ を一つつけるという方法が紹介されている(_の使い方として紹介されている)。lst みたいな省略を行って可読性を損なうなと。私は極力 name_list 等のようにより具体化することで可読性を高めるようにしている。