型チェックを強化するPython 3.11の新機能Data Class Transforms（PEP 681）

• Ryuji Tsutsui @ryu22e

• 株式会社hokan所属（今年はGoldスポンサーとしてブースも出しています）

• Python歴は12年くらい（主にDjango）

• Python Boot Camp、Shonan.py、GCPUG Shonanなどコミュニティ活動もしています

• 著書（共著）：『 Python実践レシピ 』

• Python 3.11の新機能Data Class Transforms（PEP 681）について解説

• Data Class Transforms（PEP 681）登場以前にPythonに存在した問題を理解できる

• Data Class Transforms（PEP 681）によりどうやって前述の問題を解決するのか理解できる

• 上記2つを知ることで、Python 3.11以降がより堅牢なコードを書けることを理解できる

from dataclasses import dataclass

@dataclass
class Book:
    # ↓型アノテーション
    title: str
    price: int

book = Book(title="Python実践レシピ", price=2970)
print(book.title, book.price)
# price引数の型が間違っているので型チェッカーではエラーになる
book = Book(
    title="Python実践レシピ",
    price="定価2,970円（本体2,700円＋税10%）",
)
print(book.title, book.price)

• attrs

• Pydantic

• SQLAlchemy

• Django 内蔵のO/Rマッパー

from django.db import models

class Book(models.Model):
    title = models.CharField(max_length=255)
    price = models.IntegerField()

 # 使用例
 book = Book(title="Python実践レシピ", price=2970)
 book.save()

"""orm.py"""
class Base:
    """リレーショナルデータベースとマッピングさせるクラスの基底クラス"""
    def __init__(self, **kwargs):
        # 具体的な処理内容は省略
        print("Baseクラスの初期化処理")

 class String:
     """文字列フィールド用のクラス"""
     pass

 class Integer:
     """整数フィールド用のクラス"""
     pass

"""使用例"""
from orm import Base, String, Integer

class Book(Base):
    """書籍を表すクラス"""
    title = String()
    price = Integer()

book = Book(
    title="Python実践レシピ",
    # priceは整数型なのでこれは間違っている
    price="定価2,970円（本体2,700円＋税10%）",
)

>>> from books import Book
Baseクラスの初期化処理
>>> help(Book.__init__)
Help on function __init__ in module orm:

__init__(self, **kwargs)
    Initialize self.  See help(type(self)) for accurate signature.
(END)

from dataclasses import dataclass

@dataclass
class Book:
    title: str
    price: int

book = Book(
    title="Python実践レシピ",
    # priceは整数型なのでこれは間違っている
    price="定価2,970円（本体2,700円＋税10%）",
)

from dataclasses import dataclass

from orm import Base

# Baseクラスを継承したデータクラスを作る
@dataclass
class Book(Base):
    # Baseクラスで型アノテーションを元にフィールドを作る想定
    title: str
    price: int

book = Book(
    title="Python実践レシピ",
    # priceは整数型なのでこれは間違っている
    price="定価2,970円（本体2,700円＋税10%）",
)

>>> from books import Book
Baseクラスの初期化処理
>>> help(Book.__init__)
Help on function __init__ in module orm:

__init__(self, title: str, price: int) -> None
    Initialize self.  See help(type(self)) for accurate signature.

class Base:
    """リレーショナルデータベースとマッピングさせるクラスの基底クラス"""
    def __init__(self, **kwargs):
        # 具体的な処理内容は省略
        print("Baseクラスの初期化処理")  # ←これが呼ばれない

$ python books2.py  # "Baseクラスの初期化処理"が表示されない

 # 設定ファイル（mypy.ini）にこんな形でプラグインを指定できる
[mypy]
plugins = /one/plugin.py, other.plugin

1. 自作の関数デコレーターに使う方法

2. 自作の基底クラスに使う方法

3. 自作のメタクラスに使う方法

from typing import TypeVar, dataclass_transform
from orm import Integer, String

T = TypeVar("T")

@dataclass_transform()
def create_model(cls: type[T]) -> type[T]:
    # クラスの型アノテーションを元にフィールドを追加
    for key, value in cls.__annotations__.items():
        if value is str:
            setattr(cls, key, String())
        elif value is int:
            setattr(cls, key, Integer())
    return cls

from my_orm import create_model
from orm import Base

@create_model
class Book(Base):
    title: str
    price: int

book = Book(
    title="Python実践レシピ",
    # priceは整数型なのでこれは間違っている
    price="定価2,970円（本体2,700円＋税10%）",
)

def dataclass_transform(
    *,
    eq_default: bool = True,
    order_default: bool = False,
    kw_only_default: bool = False,
    field_specifiers: tuple[type[Any] | Callable[..., Any], ...] = (),
    **kwargs: Any,
) -> Callable[[T], T]:
    def decorator(cls_or_fn):
        cls_or_fn.__dataclass_transform__ = {
            "eq_default": eq_default,
            "order_default": order_default,
            "kw_only_default": kw_only_default,
            "field_specifiers": field_specifiers,
            "kwargs": kwargs,
        }
        return cls_or_fn
    return decorator

• Pyright(1.1.328)

• Mypy(1.6.1)

• Pyre(0.9.18)

• pytype(2023.9.27)

• attrs(23.1.0)

• Pydantic(2.4.2)

• SQLAlchemy(2.0.21)

• Django内蔵のO/Rマッパー(4.2.5)

import attr

@attr.define
class Book:
    title: str
    price: int

from pydantic import BaseModel

class Book(BaseModel):
    title: str
    price: int

from sqlalchemy.orm import (DeclarativeBase, Mapped, MappedAsDataclass,
                            mapped_column)

class Base(DeclarativeBase):
    pass

class Book(MappedAsDataclass, Base):
    __tablename__ = "book"
    id: Mapped[int] = mapped_column(init=False, primary_key=True)
    title: Mapped[str]
    price: Mapped[int]

from sqlalchemy.orm import Mapped, mapped_column, registry

reg = registry()

@reg.mapped_as_dataclass(unsafe_hash=True)
class Book:
    __tablename__ = "book"

    id: Mapped[int] = mapped_column(init=False, primary_key=True)
    title: Mapped[str]
    price: Mapped[int]

import attr
from sqlalchemy import Column, Integer, String, Table
from sqlalchemy.orm import Mapped, registry

mapper_registry = registry()

@attr.define(slots=False)
class Book:
    id: Mapped[int] = attr.ib(init=False)
    title: Mapped[str]
    price: Mapped[int]
# ↓まだ続きがある

# ↑前の続き
book = Table(
    "book",
    mapper_registry.metadata,
    Column("id", Integer, autoincrement=True, primary_key=True),
    Column("title", String(50)),
    Column("price", Integer),
)

mapper_registry.map_imperatively(Book, book)

• PEP 681登場以前、「データクラス風ライブラリ」では、初期化処理に関する型チェックを行うことができなかった

• PEP 681でこれらのライブラリでもデータクラスのような型チェックをできる

• 2023年10月27日現在、PEP 681対応を謳っている型チェッカーはPyrightのみ。他の型チェッカーがんばれ！

• attrs、Pydantic、SQLAlchemyはPEP 681に対応している。Djangoも対応してほしい😢