otsuvalidator 1.1.2.312__tar.gz → 2.0.2__tar.gz

{otsuvalidator-1.1.2.312 → otsuvalidator-2.0.2}/PKG-INFO

@@ -1,143 +1,113 @@
-Metadata-Version: 2.4
-Name: otsuvalidator
-Version: 1.1.2.312
-Summary: 単体でもディスクリプタとしても使用できるバリデータライブラリ
-Home-page: https://github.com/Otsuhachi/OtsuValidator
-Author: Otsuhachi
-Author-email: agequodagis.tufuiegoeris@gmail.com
-License: MIT License
-        
-        Copyright (c) 2021 Otsuhachi
-        
-        Permission is hereby granted, free of charge, to any person obtaining a copy
-        of this software and associated documentation files (the "Software"), to deal
-        in the Software without restriction, including without limitation the rights
-        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-        copies of the Software, and to permit persons to whom the Software is
-        furnished to do so, subject to the following conditions:
-        
-        The above copyright notice and this permission notice shall be included in all
-        copies or substantial portions of the Software.
-        
-        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-        SOFTWARE.
-        
-Keywords: Python validator descriptor converter
-Requires-Python: >=3.12
-Description-Content-Type: text/markdown
-License-File: LICENSE.txt
-Dynamic: author
-Dynamic: author-email
-Dynamic: description
-Dynamic: description-content-type
-Dynamic: home-page
-Dynamic: keywords
-Dynamic: license
-Dynamic: license-file
-Dynamic: requires-python
-Dynamic: summary
-
-- [概要](#概要)
-  - [インストール](#インストール)
-  - [モジュール](#モジュール)
-    - [basesモジュールのクラス](#basesモジュールのクラス)
-    - [validatorsモジュールのクラス](#validatorsモジュールのクラス)
-    - [convertersモジュールのクラス](#convertersモジュールのクラス)
-  - [継承規則](#継承規則)
-    - [Validator継承規則](#validator継承規則)
-    - [VContainer継承規則](#vcontainer継承規則)
-    - [Converter継承規則](#converter継承規則)
-
----
-# 概要
-
-このライブラリは、値の正常性を検証するバリデータ群と、検証前に型変換を試みるコンバータ群を提供するユーティリティです。  
-ディスクリプタとしてクラス属性に使用することで不適切な値の代入を防止できるほか、単独の関数・オブジェクトとして値を検証・変換することも可能です。
-
----
-## インストール
-
-**インストール**
-```bash
-pip install otsuvalidator
-```
-
-**アップデート**
-```bash
-pip install -U otsuvalidator
-```
-
-**アンインストール**
-```bash
-pip uninstall otsuvalidator
-```
-
-## モジュール
-本ライブラリは主に以下の3つのモジュールで構成されています。
-
-モジュール名|概要
-:--:|:--:
-`bases`|バリデータ・コンバータの基底クラスを定義。自作のバリデータを作成する際に使用します。
-`validators`|値の検証のみを行うバリデータ群が定義されています。
-`converters`|型変換を試みた上で検証を行うコンバータ群が定義されています。
-
-
-### basesモジュールのクラス
-- `Validator`: すべてのバリデータおよびコンバータの基底クラス。
-- `VContainer`: コンテナ（リストや辞書など）用バリデータの基底クラス。要素が可変なオブジェクトを検証する際に使用します。
-- `Converter`: コンバータの基底クラス。
-- `VChain`: バリデータ・コンバータの連結をサポートします。
-
-### validatorsモジュールのクラス
-※破線されたクラスは非推奨です。
-クラス|概要|期待する型
-:--:|:--:|:--:
-VBool|真偽値オブジェクトか検証|bool
-VChoice|規定の選択肢の中から1つが選択されているか検証|Any
-VNumerical / ~~VNumber~~|適切な数値か検証|int / float
-VFloat|適切な浮動小数点数か検証|float
-VInt|適切な整数か検証|int
-VPath|適切なパスか検証|pathlib.Path
-VString|適切な文字列か検証|str
-~~VRegex~~|適切な正規表現か検証。`VString(pattern=...)`に合併。|str
-VDict|適切な構造の辞書か検証|dict
-VList|適切なリストか検証|list
-VTuple|適切なタプルか検証|tuple
-VTimedelta|適切なtimedelta型か検証|datetime.timedelta
-
-### convertersモジュールのクラス
-※破線されたクラスは非推奨です。
-クラス|概要
-:--:|:--:
-CBool|Yes / Noとして解釈できる値に対し`bool`型への変換を試みて検証
-CNumerical / ~~CNumber~~|`int` / `float`型への自動変換を試みて検証
-CFloat|`float`型への自動変換を試みて検証
-CInt|`int`型への自動変換を試みて検証
-CPath|`pathlib.Path`型への自動変換を試みて検証
-CString|`str`型への返還を試みて検証
-CTimedelta|`datetime.timedelta`型への自動変換を試みて検証
-
-## 継承規則
-自作のバリデータやコンバータを正しく定義するための規則です。
-
-### 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)`で検証して返します。
+Metadata-Version: 2.5
+Name: otsuvalidator
+Version: 2.0.2
+Summary: 単体でもディスクリプタとしても使用できるバリデータライブラリ
+Author-email: Otsuhachi <agequodagis.tufuiegoeris@gmail.com>
+License: MIT License
+License-File: LICENSE.txt
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.13
+Description-Content-Type: text/markdown
+
+- [概要](#概要)
+  - [インストール](#インストール)
+  - [モジュール](#モジュール)
+    - [basesモジュールのクラス](#basesモジュールのクラス)
+    - [validatorsモジュールのクラス](#validatorsモジュールのクラス)
+    - [convertersモジュールのクラス](#convertersモジュールのクラス)
+  - [継承規則](#継承規則)
+    - [Validator継承規則](#validator継承規則)
+    - [VContainer継承規則](#vcontainer継承規則)
+    - [Converter継承規則](#converter継承規則)
+
+---
+# 概要
+
+このライブラリは、値の正常性を検証するバリデータ群と、検証前に型変換を試みるコンバータ群を提供するユーティリティです。  
+ディスクリプタとしてクラス属性に使用することで不適切な値の代入を防止できるほか、単独の関数・オブジェクトとして値を検証・変換することも可能です。
+
+---
+## インストール
+
+**インストール**
+```bash
+pip install otsuvalidator
+```
+
+**アップデート**
+```bash
+pip install -U otsuvalidator
+```
+
+**アンインストール**
+```bash
+pip uninstall otsuvalidator
+```
+
+## モジュール
+本ライブラリは主に以下の3つのモジュールで構成されています。
+
+モジュール名|概要
+:--:|:--:
+`bases`|バリデータ・コンバータの基底クラスを定義。自作のバリデータを作成する際に使用します。
+`validators`|値の検証のみを行うバリデータ群が定義されています。
+`converters`|型変換を試みた上で検証を行うコンバータ群が定義されています。
+
+
+### basesモジュールのクラス
+- `Validator`: すべてのバリデータおよびコンバータの基底クラス。
+- `VContainer`: コンテナ（リストや辞書など）用バリデータの基底クラス。要素が可変なオブジェクトを検証する際に使用します。
+- `Converter`: コンバータの基底クラス。
+- `VChain`: バリデータ・コンバータの連結をサポートします。
+
+### validatorsモジュールのクラス
+※破線されたクラスは非推奨です。
+クラス|概要|期待する型
+:--:|:--:|:--:
+VBool|真偽値オブジェクトか検証|bool
+VChoice|規定の選択肢の中から1つが選択されているか検証|Any
+VNumerical / ~~VNumber~~|適切な数値か検証|int / float
+VFloat|適切な浮動小数点数か検証|float
+VInt|適切な整数か検証|int
+VPath|適切なパスか検証|pathlib.Path
+VString|適切な文字列か検証|str
+~~VRegex~~|適切な正規表現か検証。`VString(pattern=...)`に合併。|str
+VDict|適切な構造の辞書か検証|dict
+VList|適切なリストか検証|list
+VTuple|適切なタプルか検証|tuple
+VTimedelta|適切なtimedelta型か検証|datetime.timedelta
+
+### convertersモジュールのクラス
+※破線されたクラスは非推奨です。
+クラス|概要
+:--:|:--:
+CBool|Yes / Noとして解釈できる値に対し`bool`型への変換を試みて検証
+CNumerical / ~~CNumber~~|`int` / `float`型への自動変換を試みて検証
+CFloat|`float`型への自動変換を試みて検証
+CInt|`int`型への自動変換を試みて検証
+CPath|`pathlib.Path`型への自動変換を試みて検証
+CString|`str`型への返還を試みて検証
+CTimedelta|`datetime.timedelta`型への自動変換を試みて検証
+
+## 継承規則
+自作のバリデータやコンバータを正しく定義するための規則です。
+
+### 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)`で検証して返します。

otsuvalidator-2.0.2/Pipfile

@@ -0,0 +1,15 @@
+[[source]]
+url = "https://pypi.org/simple"
+verify_ssl = true
+name = "pypi"
+
+[packages]
+
+[dev-packages]
+
+[requires]
+python_version = "3.13"
+
+[scripts]
+reset = "pwsh -Command Remove-Item .venv -Force -Recurse && py -m pipenv update -d"
+test = "pwsh -Command pipenv run py -m unittest discover -s tests -p \"test_*.py\" -v"

otsuvalidator-2.0.2/Pipfile.lock

@@ -0,0 +1,20 @@
+{
+    "_meta": {
+        "hash": {
+            "sha256": "494d5b4f482f0ef471f49afe28f00ec1a2ff75da2ce65060d8cabaeb3da2f100"
+        },
+        "pipfile-spec": 6,
+        "requires": {
+            "python_version": "3.13"
+        },
+        "sources": [
+            {
+                "name": "pypi",
+                "url": "https://pypi.org/simple",
+                "verify_ssl": true
+            }
+        ]
+    },
+    "default": {},
+    "develop": {}
+}

{otsuvalidator-1.1.2.312 → otsuvalidator-2.0.2}/otsuvalidator/__init__.py

@@ -1,33 +1,4 @@
-__VERSION__ = "1.1.2.312"
-
-
-__all__ = (
-    "CBool",
-    "CFloat",
-    "CInt",
-    "CNumerical",
-    "CPath",
-    "CString",
-    "CTimedelta",
-    "VAny",
-    "VBool",
-    "VChain",
-    "VChoice",
-    "VDict",
-    "VFloat",
-    "VInt",
-    "VList",
-    "VNone",
-    "VNumerical",
-    "VPath",
-    "VRange",
-    "VSequence",
-    "VString",
-    "VTimedelta",
-    "VTuple",
-    "VType",
-)
-
+import logging
 
 from .bases import VChain
 from .converters import (
@@ -57,3 +28,35 @@ from .validators import (
     VTuple,
     VType,
 )
+
+__all__ = [
+    "CBool",
+    "CFloat",
+    "CInt",
+    "CNumerical",
+    "CPath",
+    "CString",
+    "CTimedelta",
+    "VAny",
+    "VBool",
+    "VChain",
+    "VChoice",
+    "VDict",
+    "VFloat",
+    "VInt",
+    "VList",
+    "VNone",
+    "VNumerical",
+    "VPath",
+    "VRange",
+    "VSequence",
+    "VString",
+    "VTimedelta",
+    "VTuple",
+    "VType",
+]
+
+
+logging.getLogger(__name__).addHandler(logging.NullHandler())
+
+__version__ = "2.0.2"

{otsuvalidator-1.1.2.312 → otsuvalidator-2.0.2}/otsuvalidator/bases.py

@@ -1,13 +1,16 @@
-__all__ = (
+import logging
+from abc import ABC, abstractmethod
+from typing import Any, Literal, Self, overload
+
+__all__ = [
     "Converter",
     "VChain",
     "VContainer",
     "Validator",
-)
+]
 
 
-from abc import ABC, abstractmethod
-from typing import Any, Literal, Self, overload
+logger = logging.getLogger(__name__)
 
 
 class Validator[OutT](ABC):
@@ -104,6 +107,7 @@ class VChain[OutT](Validator[OutT]):
                 except Exception as ex:
                     exceptions.append(ex)
             if not passed:
+                logger.error(f"全てのバリデータでの検証に失敗しました: {value}")
                 raise ValueError(*exceptions)
         return current_value
 

{otsuvalidator-1.1.2.312 → otsuvalidator-2.0.2}/otsuvalidator/converters.py

@@ -1,4 +1,15 @@
-__all__ = (
+import logging
+import re
+import warnings
+from collections.abc import Callable
+from datetime import timedelta
+from pathlib import Path
+from typing import Any, Literal, override
+
+from .bases import Converter
+from .validators import VBool, VNumerical, VPath, VString, VTimedelta
+
+__all__ = [
     "CBool",
     "CFloat",
     "CInt",
@@ -7,18 +18,10 @@ __all__ = (
     "CPath",
     "CString",
     "CTimedelta",
-)
+]
 
 
-import re
-import warnings
-from collections.abc import Callable
-from datetime import timedelta
-from pathlib import Path
-from typing import Any, Literal, override
-
-from .bases import Converter
-from .validators import VBool, VNumerical, VPath, VString, VTimedelta
+logger = logging.getLogger(__name__)
 
 
 class CBool(VBool, Converter[Any, bool]):
@@ -86,27 +89,31 @@ class CBool(VBool, Converter[Any, bool]):
             elif tmp_value in (no := ("false", "no", "n", "0", "0.0")):
                 tmp_value = False  # type: ignore
             else:
-                msg = f"{yes}または{no}のいずれかである必要があります。\n{tmp_value=}"
-                raise ValueError(msg)
+                msg = "クラス定義の検証に失敗しました"
+                logger.error(f"{msg}: {value}\n\tTrue: {yes}\n\tFalse: {no}")
+                raise ValueError(f"{msg}。")
         elif tv is int:
             if tmp_value == 1:
                 tmp_value = True  # type: ignore
             elif tmp_value == 0:
                 tmp_value = False  # type: ignore
             else:
-                msg = f"1または0である必要があります。\n{tmp_value=}"
-                raise ValueError(msg)
+                msg = "1または0である必要があります"
+                logger.error(f"{msg}: {tmp_value}")
+                raise ValueError(f"{msg}。")
         elif tv is float:
             if tmp_value == 1.0:
                 tmp_value = True  # type: ignore
             elif tmp_value == 0.0:
                 tmp_value = False  # type: ignore
             else:
-                msg = f"1.0または0.0である必要があります。\n{tmp_value=}"
-                raise ValueError(msg)
+                msg = "1.0または0.0である必要があります"
+                logger.error(f"{msg}: {tmp_value}")
+                raise ValueError(f"{msg}。")
         else:
-            msg = f"Yes/Noとして解釈できる必要があります。\n{tmp_value=}"
-            raise TypeError(msg)
+            msg = "Yes/Noとして解釈できる必要があります"
+            logger.error(f"{msg}: {tmp_value}")
+            raise TypeError(f"{msg}。")
         return super().validate(tmp_value)
 
 
@@ -143,12 +150,14 @@ class CNumerical[OutT: float | int](VNumerical[OutT], Converter[Any, OutT]):
                 if t_type is not float:
                     converted = t_type(tmp_value)
                 if converted != tmp_value:
-                    msg = f"変換後の数値が元の数値と等価ではありません。{value} != {converted}"
-                    raise ValueError(msg)
+                    msg = "変換後の数値が元の数値と等価ではありません"
+                    logger.error(f"{msg}: {value} -> {tmp_value}")
+                    raise ValueError(f"{msg}。")
         except (TypeError, ValueError):
             type_name = t_type.__name__ if t_type else "number"
-            msg = f"'{self.public_name}'を{type_name}に変換できませんでした: {value!r}。"
-            raise ValueError(msg) from None
+            msg = f"`{self.public_name}`を`{type_name}型`に変換できませんでした"
+            logger.exception(f"{msg}: {value!r}")
+            raise ValueError(f"{msg}。") from None
         return super().validate(converted)
 
 
@@ -214,8 +223,9 @@ class CPath(VPath, Converter[str | Path, Path]):
         try:
             converted = Path(value)
         except (TypeError, ValueError):
-            msg = f"'{self.public_name}'をpathlib.Pathオブジェクトに変換できませんでした: {value!r}。"
-            raise TypeError(msg) from None
+            msg = f"`{self.public_name}`を`pathlib.Path`オブジェクトに変換できませんでした"
+            logger.exception(f"{msg}: {value!r}")
+            raise TypeError(f"{msg}。") from None
         return super().validate(converted)
 
 
@@ -231,8 +241,9 @@ class CString(VString, Converter[Any, str]):
             try:
                 tmp_value = str(tmp_value)
             except Exception:
-                msg = f"'{self.public_name}'はstr型に変換可能な値である必要があります: {tmp_value!r}。"
-                raise TypeError(msg) from None
+                msg = f"`{self.public_name}`は`str型`に変換可能な値である必要があります"
+                logger.exception(f"{msg}: {tmp_value!r}")
+                raise TypeError(f"{msg}。") from None
         return super().validate(tmp_value)
 
 
@@ -257,8 +268,9 @@ class CTimedelta(VTimedelta, Converter[Any, timedelta]):
             if f is not None:
                 tmp_value = f(tmp_value)
         except Exception:
-            msg = f"'{self.public_name}'はtimedelta型に変換可能な値である必要があります: {tmp_value!r}。"
-            raise TypeError(msg) from None
+            msg = f"`{self.public_name}`は`timedelta型`に変換可能な値である必要があります"
+            logger.exception(f"{msg}: {tmp_value!r}")
+            raise TypeError(f"{msg}") from None
         return super().validate(tmp_value)
 
     def __try_convert_container(self, value: list | tuple) -> timedelta:
@@ -279,5 +291,6 @@ class CTimedelta(VTimedelta, Converter[Any, timedelta]):
                 v = int(v)
                 d[k] = v
             return self.__try_convert_dict(d)
-        msg = f"'{value}'をtimedelta型に変換できませんでした。"
-        raise ValueError(msg)
+        msg = "timedelta型に変換できませんでした"
+        logger.error(f"{msg}: `{value!r}`")
+        raise ValueError(f"{msg}。")