• 概要
  • インストール
  • モジュール
    • basesモジュールのクラス
    • validatorsモジュールのクラス
    • convertersモジュールのクラス
  • 継承規則
    • Validator継承規則
    • VContainer継承規則
    • Converter継承規則

概要

このライブラリは、値の正常性を検証するバリデータ群と、検証前に型変換を試みるコンバータ群を提供するユーティリティです。
ディスクリプタとしてクラス属性に使用することで不適切な値の代入を防止できるほか、単独の関数・オブジェクトとして値を検証・変換することも可能です。

インストール

インストール

pip install otsuvalidator

アップデート

pip install -U otsuvalidator

アンインストール

pip uninstall otsuvalidator

モジュール

本ライブラリは主に以下の3つのモジュールで構成されています。

basesモジュールのクラス

• Validator: すべてのバリデータおよびコンバータの基底クラス。
• VContainer: コンテナ（リストや辞書など）用バリデータの基底クラス。要素が可変なオブジェクトを検証する際に使用します。
• Converter: コンバータの基底クラス。
• VChain: バリデータ・コンバータの連結をサポートします。

validatorsモジュールのクラス

※破線されたクラスは非推奨です。

convertersモジュールのクラス

※破線されたクラスは非推奨です。

継承規則

自作のバリデータやコンバータを正しく定義するための規則です。

Validator継承規則

1. 命名: クラス名はV{検証したいクラス名}とします（例: VString）。
2. 継承: Validatorクラスを継承します。
3. 定義: validateメソッドを定義し、検証が成功した場合は受け取ったvalueを返します。
4. 変換: validate内でvalueの型変換を行ってはいけません（変換を行う場合はConverterを使用）。

VContainer継承規則

1. 命名: クラス名はV{検証したいクラス名}とします（例: VList）。
2. 継承: VContainerクラスを継承します。
3. 定義: validateメソッドを定義し、検証通過時はvalueを返します。中身の各要素への検証規則を設定します。
4. 変換: コンテナ自体の型変換は行いません。ただし要素に対してはオプション設定に応じます。

Converter継承規則

1. 命名: C{変換検証したいクラス名}とします（例: CInt）。
2. 継承: （対象クラスのバリデータ, Converter）の順で多重継承します。
3. 定義: validate内で型変換を行い、return super().validate(value)で検証して返します。