Python で定数を定義する (typing.Final)

2018-01-08

Python 3.8 以降では、typing.Final による型アノテーションを使って、再代入できない変数（定数）であることを表現できます（参考: PEP 591）。定数名は すべて大文字（+ アンダースコア） で構成するのが慣例となっています。このあたりの標準的な命名規則は PEP8 に記載されています。

参考: PEP 8 – Style Guide for Python Code｜Python.org
Constants are usually defined on a module level and written in all capital letters with underscores separating words. Examples include MAX_OVERFLOW and TOTAL.

例: ファイル内（モジュールレベル）の定数

from typing import Final

MAX_FILE_NUM: Final = 10
ORIGIN_COORD: Final = (0, 0)
DEFAULT_NAME: Final = "Player"

クラス定数も下記のようにして同様に定義することができます。

例: クラス定数

from typing import Final

class Player:
    DEFAULT_NAME: Final = "Player"
    DEFAULT_LIFE: Final = 0

    def __init__(self, name: str = DEFAULT_NAME, life: int = DEFAULT_LIFE) -> None:
        self.name = name
        self.life = life

Final アノテーションは、Mypy などの型チェッカーが再代入を検出するためのヒントとして使用するものです。例えば、Visual Studio Code に Mypy 拡張をインストールしておくと、コーディング中に不正な再代入を検出してくれるようになります。ただし、コードの実行時には、Final を付けた変数に再代入できてしまうことに注意してください。

コラム: 定数を扱うためのモジュール (const.py) を作成する

下記のような、定数を扱うためのクラスが Python Recipes で紹介されています（Python3 の構文に合わせて若干書き換えてます）。

const.py

"""
Constant types in Python.
"""

class _const:
    class ConstError(TypeError):
        pass

    def __setattr__(self, name, value):
        if name in self.__dict__:
            raise self.ConstError("Can't rebind const (%s)" % name)
        self.__dict__[name] = value

import sys
sys.modules[__name__] = _const()

元ネタは書籍の『Python Cookbook』ですね。この定数モジュールは下記のように定数の入れ物として使用します。

sample.py

import const

const.FOO = 100
const.BAR = 'Hello'

下記のように、同じ名前の定数に再代入しようとすると、ランタイムエラー (独自定義の const.ConstError) が発生して、プログラムが停止します。

const.HOGE = 100
const.HOGE = 200  # const.ConstError: Can't rebind const (HOGE)

2018-01-08