Yuma.M
yura.qrunch.io

Python の attrs で validation をかける

2018/11/24に投稿

Python の attrs が便利すぎて、データ保持用のクラスを作る時なんかは専らコレばっかり使っています。

そんな attrs で入力されるデータに validation をかける方法です。

attrs で入力データをチェック

例えば Pose というクラスに対して、位置を表す position は長さ 3 の配列、向きを表す orientation は長さ 4 の配列(クォータニオン) であることをチェックする場合は以下のように書くことができます。

from attr import attrs, attrib


@attrs
class Pose:
    position = attrib()
    orientation = attrib()

    @position.validator
    def check_position(self, attribute, value):
        if len(value) != 3:
            raise ValueError("position must be a list with size=3")

    @orientation.validator
    def check_orientation(self, attribute, value):
        if len(value) != 4:
            raise ValueError("orientation must be a list with size=4")

正しい値を代入した場合

>>> Pose(position=[0, 1, 2], orientation=[0, 0, 0, 1])
Pose(position=[0, 1, 2], orientation=[0, 0, 0, 1])

不正な値を代入した場合

>>> Pose(position=[0, 1], orientation=[0, 0, 0, 0, 1])
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
  File "<attrs generated init d25cdc317f9cca07dcc37d3210f62862e6055553>", line 5, in __init__
  File "<stdin>", line 8, in check_position
ValueError: position must be a list with size=3

普通の class だと __init__ が肥大化したりしがちですが、これだとスッキリ書けますね!

関連サイト

関連記事

コメントはありません。
ブログを開設

クランチで技術ブログを
始めてみませんか?

この先は、クランチへのアカウント登録、及びログインが必要なページになります。

Markdownの書き方
見出し # 見出し(h1)
## 見出し(h2) , ### 見出し(h3) ...
リスト - 箇条書き
   - タブでインデント
番号付きリスト 1. テキスト
2. テキスト
改行 行末に半角スペース2つ
リンクの挿入 [タイトル](https://xxx.com)
引用 > テキスト
コード挿入 ```cpp:title
code
```
画像の挿入 ![代替テキスト](URL "タイトル")
太字 **テキスト**
斜体 *テキスト*
打消し線 ~~テキスト~~
水平線 ***
技術ブログを開設
ログイン