validattr 0.0.0__tar.gz

validattr-0.0.0/.github/workflows/python-publish.yml

@@ -0,0 +1,38 @@
+name: Upload Python Package
+
+on:
+  release:
+    types: [published]
+
+permissions:
+  contents: read
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+        with:
+          submodules: recursive
+      - name: Set up Python
+        uses: actions/setup-python@v3
+        with:
+          python-version: "3.12.7"
+      - name: Upgrade pip
+        run: python -m pip install --upgrade pip
+      - name: Install yaml
+        run: python -m pip install pyyaml
+      - name: Install build
+        run: python -m pip install build
+      - name: Install twine
+        run: python -m pip install twine
+      - name: Install cfgtools
+        run: python -m pip install cfgtools
+      - name: Install re-extensions
+        run: python -m pip install re-extensions
+      - name: Build package
+        run: python install.py
+      - name: Publish package
+        run: twine upload dist/* --username __token__ --password ${{ secrets.PYPI_API_TOKEN }}

validattr-0.0.0/.gitignore

@@ -0,0 +1,160 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/

validattr-0.0.0/LICENSE

@@ -0,0 +1,28 @@
+BSD 3-Clause License
+
+Copyright (c) 2023, Chitaoji
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its
+   contributors may be used to endorse or promote products derived from
+   this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

validattr-0.0.0/PKG-INFO

@@ -0,0 +1,42 @@
+Metadata-Version: 2.4
+Name: validattr
+Version: 0.0.0
+Summary: Attribute with validator.
+Project-URL: Documentation, https://github.com/Chitaoji/validattr/blob/main/README.md
+Project-URL: Repository, https://github.com/Chitaoji/validattr/
+Author-email: Chitaoji <2360742040@qq.com>
+Maintainer-email: Chitaoji <2360742040@qq.com>
+License-Expression: BSD-3-Clause
+License-File: LICENSE
+Keywords: config
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+
+# validattr
+Attribute with validator.
+
+## Installation
+```sh
+$ pip install validattr
+```
+
+## Requirements
+```txt
+
+```
+
+## See Also
+### Github repository
+* https://github.com/Chitaoji/validattr/
+
+### PyPI project
+* https://pypi.org/project/validattr/
+
+## License
+This project falls under the BSD 3-Clause License.
+
+## History
+### v0.0.0
+* Initial release.

validattr-0.0.0/README.md

@@ -0,0 +1,26 @@
+# validattr
+Attribute with validator.
+
+## Installation
+```sh
+$ pip install validattr
+```
+
+## Requirements
+```txt
+
+```
+
+## See Also
+### Github repository
+* https://github.com/Chitaoji/validattr/
+
+### PyPI project
+* https://pypi.org/project/validattr/
+
+## License
+This project falls under the BSD 3-Clause License.
+
+## History
+### v0.0.0
+* Initial release.

validattr-0.0.0/install.py

@@ -0,0 +1,107 @@
+"""Install the package."""
+
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
+import os
+import re
+from pathlib import Path
+from typing import Final
+
+import cfgtools as cfg
+from re_extensions import rsplit, word_wrap
+
+here = Path(__file__).parent
+
+# Load the package's meta-data from pyproject.toml.
+f = cfg.read_toml(here / "pyproject.toml")
+project = f["project"].asdict()
+NAME: Final[str] = project["name"]
+SUMMARY: Final[str] = project["description"]
+HOMEPAGE: Final[str] = project["urls"]["Repository"]
+REQUIRES: Final[list[str]] = project["dependencies"]
+SOURCE = "src"
+LICENSE = (here / project["license-files"][0]).read_text().partition("\n")[0]
+VERSION = project["version"]
+
+# Import the README and use it as the long-description.
+readme_path = here / project["readme"]
+if readme_path.exists():
+    long_description = "\n" + readme_path.read_text(encoding="utf-8")
+else:
+    long_description = SUMMARY
+
+
+def _readme2doc(
+    readme: str,
+    name: str = NAME,
+    requires: list[str] = REQUIRES,
+    homepage: str = HOMEPAGE,
+    pkg_license: str = LICENSE,
+) -> tuple[str, str]:
+    doc, rd = "", ""
+    for i, s in enumerate(rsplit("\n## ", readme)):
+        head = re.search(" .*\n", s).group()[1:-1]
+        if i == 0:
+            s = re.sub("^\n# .*", f"\n# {name}", s)
+        elif head == "Requirements":
+            s = re.sub(
+                "```txt.*```",
+                "```txt\n" + "\n".join(requires) + "\n```",
+                s,
+                flags=re.DOTALL,
+            )
+        elif head == "Installation":
+            s = re.sub(
+                "```sh.*```", f"```sh\n$ pip install {name}\n```", s, flags=re.DOTALL
+            )
+        elif head == "See Also":
+            pypipage = f"https://pypi.org/project/{name}/"
+            s = re.sub(
+                "### PyPI project\n.*",
+                f"### PyPI project\n* {pypipage}",
+                re.sub(
+                    "### Github repository\n.*",
+                    f"### Github repository\n* {homepage}",
+                    s,
+                ),
+            )
+        elif head == "License":
+            s = f"\n## License\nThis project falls under the {pkg_license}.\n"
+
+        rd += s
+        if head not in {"Installation", "Requirements", "History"}:
+            doc += s
+    doc = re.sub("<!--html-->.*<!--/html-->", "", doc, flags=re.DOTALL)
+    return word_wrap(doc, maximum=88) + "\n\n", rd
+
+
+def _quote(readme: str) -> str:
+    if "'''" in readme and '"""' in readme:
+        raise ReadmeFormatError("Both \"\"\" and ''' are found in the README")
+    if '"""' in readme:
+        return f"'''{readme}'''"
+    else:
+        return f'"""{readme}"""'
+
+
+def _version(version: str = VERSION) -> str:
+    return f'"""Version file."""\n\n__version__ = "{version}"\n'
+
+
+class ReadmeFormatError(Exception):
+    """Raised when the README has a wrong format."""
+
+
+if __name__ == "__main__":
+    # Import the __init__.py and change the module docstring.
+    init_path = here / SOURCE / NAME / "__init__.py"
+    version_path = here / SOURCE / NAME / "_version.py"
+    module_file = init_path.read_text(encoding="utf-8")
+    new_doc, long_description = _readme2doc(long_description)
+    module_file = re.sub(
+        "^\"\"\".*\"\"\"|^'''.*'''|^", _quote(new_doc), module_file, flags=re.DOTALL
+    )
+    init_path.write_text(module_file, encoding="utf-8")
+    readme_path.write_text(long_description.strip(), encoding="utf-8")
+    version_path.write_text(_version())
+    os.system(f"cd {here} && python -m build")

validattr-0.0.0/pyproject.toml

@@ -0,0 +1,28 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "validattr"
+version = "0.0.0"
+dependencies = []
+requires-python = ">=3.12"
+authors = [
+  {name = "Chitaoji", email = "2360742040@qq.com"},
+]
+maintainers = [
+  {name = "Chitaoji", email = "2360742040@qq.com"}
+]
+description = "Attribute with validator."
+readme = "README.md"
+license = "BSD-3-Clause"
+license-files = ["LICENSE"]
+keywords = ["config"]
+classifiers = [
+  "Programming Language :: Python :: 3",
+  "Programming Language :: Python :: 3.12"
+]
+
+[project.urls]
+Documentation = "https://github.com/Chitaoji/validattr/blob/main/README.md"
+Repository = "https://github.com/Chitaoji/validattr/"

validattr-0.0.0/src/validattr/__init__.py

@@ -0,0 +1,22 @@
+"""
+# validattr
+Attribute with validator.
+
+## See Also
+### Github repository
+* https://github.com/Chitaoji/validattr/
+
+### PyPI project
+* https://pypi.org/project/validattr/
+
+## License
+This project falls under the BSD 3-Clause License.
+
+"""
+
+from . import core
+from ._version import __version__
+from .core import *
+
+__all__: list[str] = []
+__all__.extend(core.__all__)

validattr-0.0.0/src/validattr/_typing.py

@@ -0,0 +1,10 @@
+"""
+Contains typing classes.
+
+NOTE: this module is not intended to be imported at runtime.
+
+"""
+
+import loggings
+
+loggings.warning("this module is not intended to be imported at runtime")

validattr-0.0.0/src/validattr/_version.py

@@ -0,0 +1,3 @@
+"""Version file."""
+
+__version__ = "0.0.0"

validattr-0.0.0/src/validattr/core.py

@@ -0,0 +1,454 @@
+"""
+Contains the core of validattr.
+
+NOTE: this module is private. All functions and objects are available in the main
+`validattr` namespace - use that instead.
+
+"""
+
+from dataclasses import Field, field
+from types import UnionType
+from typing import Any, Callable, Literal, Optional, Union, get_args, get_origin
+
+__all__ = ["attr", "ValidatorError"]
+
+
+def attr(
+    *,
+    default: Any = ...,
+    default_factory: Callable[[], Any] = ...,
+    allowlist: list = ...,
+    denylist: list = ...,
+    validator: Callable[[Any], bool] = ...,
+    lb: Any = ...,
+    ub: Any = ...,
+    init: bool = True,
+    repr: bool = True,
+    hash: Optional[bool] = None,
+    compare: bool = True,
+    kw_only: bool = False,
+) -> Any:
+    """
+    Returns an attribute with validator. This works well with dataclasses.
+
+    Only for dict classes.
+
+    Parameters
+    ----------
+    default : Any, optional
+        Default value, by default Ellipsis.
+    default_factory : Callable[[], Any], optional
+        Callable used to generate a default value lazily, by default Ellipsis.
+    allowlist : list, optional
+        Allowed values, by default Ellipsis.
+    denylist : list, optional
+        Forbidden values, by default Ellipsis.
+    lb : Any, optional
+        Lower bound (inclusive), by default Ellipsis.
+    ub : Any, optional
+        Upper bound (inclusive), by default Ellipsis.
+    validator : Callable[[Any], bool], optional
+        Function for validating the value, by default Ellipsis.
+    init : bool, optional
+        Whether this field should be included as a generated `__init__()`
+        parameter when used with `dataclasses.dataclass`, by default True.
+    repr : bool, optional
+        Whether this field should be included in the generated `__repr__()`
+        output, by default True.
+    hash : Optional[bool], optional
+        Whether this field should be included in generated `__hash__()`.
+        Follows `dataclasses.field` behavior where `None` defers to
+        `compare`, by default None.
+    compare : bool, optional
+        Whether this field should be used in generated comparison methods,
+        by default True.
+    kw_only : bool, optional
+        Whether this field should be marked as keyword-only for
+        `dataclasses.dataclass` generated `__init__()`, by default False.
+
+    Returns
+    -------
+    Any
+        Attribute with validator.
+
+    """
+    descriptor = AttrValidator(
+        default=default,
+        default_factory=default_factory,
+        allowlist=allowlist,
+        denylist=denylist,
+        lb=lb,
+        ub=ub,
+        validator=validator,
+    )
+    if not isinstance(init, bool):
+        raise ValidatorError(
+            f"invalid init type: expected a bool, got {type(init)!r} instead"
+        )
+    if not isinstance(repr, bool):
+        raise ValidatorError(
+            f"invalid repr type: expected a bool, got {type(repr)!r} instead"
+        )
+    if hash is not None and not isinstance(hash, bool):
+        raise ValidatorError(
+            f"invalid hash type: expected a bool or None, got {type(hash)!r} instead"
+        )
+    if not isinstance(compare, bool):
+        raise ValidatorError(
+            f"invalid compare type: expected a bool, got {type(compare)!r} instead"
+        )
+    if not isinstance(kw_only, bool):
+        raise ValidatorError(
+            f"invalid kw_only type: expected a bool, got {type(kw_only)!r} instead"
+        )
+    return _field_with_guard(
+        default=descriptor,
+        init=init,
+        repr=repr,
+        hash=hash,
+        compare=compare,
+        kw_only=kw_only,
+    )
+
+
+class _FieldWithGuard(Field):
+    def __get__(self, instance: object, owner: type | None = None) -> Any:
+        if instance is None:
+            return self
+        return self.default.__get__(instance, owner)
+
+    def __set__(self, instance: object, value: Any) -> None:
+        return self.default.__set__(instance, value)
+
+
+def _field_with_guard(
+    *,
+    default: Any,
+    init: bool,
+    repr: bool,
+    hash: Optional[bool],
+    compare: bool,
+    kw_only: bool,
+) -> Any:
+    base_field = field(
+        default=default,
+        init=init,
+        repr=repr,
+        hash=hash,
+        compare=compare,
+        kw_only=kw_only,
+    )
+    guarded_field = _FieldWithGuard(
+        base_field.default,
+        base_field.default_factory,
+        base_field.init,
+        base_field.repr,
+        base_field.hash,
+        base_field.compare,
+        base_field.metadata,
+        base_field.kw_only,
+    )
+    guarded_field._field_type = base_field._field_type
+    return guarded_field
+
+
+class AttrValidator:
+    """
+    Attribute validator.
+
+    Note that this should NEVER be instantiated directly, but always through the
+    module-level function `attr()`.
+
+    """
+
+    def __init__(
+        self,
+        *,
+        default: Any = ...,
+        default_factory: Callable[[], Any] = ...,
+        allowlist: list = ...,
+        denylist: list = ...,
+        lb: Any = ...,
+        ub: Any = ...,
+        validator: Callable[[Any], bool] = ...,
+    ) -> None:
+        self.default = default
+        if default is not ... and default_factory is not ...:
+            raise ValidatorError(
+                "invalid defaults: default and default_factory cannot both be set"
+            )
+        if default_factory is not ... and not callable(default_factory):
+            raise ValidatorError(
+                "invalid default_factory type: expected a callable, "
+                f"got {type(default_factory)!r} instead"
+            )
+        self.default_factory = default_factory
+        if allowlist is not ... and not isinstance(allowlist, list):
+            raise ValidatorError(
+                f"invalid allowlist type: expected a list, got {type(allowlist)!r} "
+                "instead"
+            )
+        if denylist is not ... and not isinstance(denylist, list):
+            raise ValidatorError(
+                f"invalid denylist type: expected a list, got {type(denylist)!r} "
+                "instead"
+            )
+        self.allowlist = allowlist
+        self.denylist = denylist
+        self.lb = lb
+        self.ub = ub
+        if self.lb is not ... and self.ub is not ... and self.lb > self.ub:
+            raise ValidatorError(
+                f"invalid bounds: lb={self.lb!r} is greater than ub={self.ub!r}"
+            )
+        self.validator = (lambda _: True) if validator is ... else validator
+        self.name: str
+        self.type: type
+
+    def __set_name__(self, cls: type, name: str) -> None:
+        self.name = name
+        self.type = cls.__annotations__[name]
+        self._validate_allowlist(cls)
+        self._validate_default(cls)
+
+    def _validate_default(self, cls: type) -> None:
+        if self.default_factory is not ...:
+            default = self.default_factory()
+            mismatch_reason = isoftype(
+                default,
+                self.type,
+                self.name,
+                path="default_factory() expected",
+            )
+            if mismatch_reason is not None:
+                raise ValidatorError(
+                    f"invalid default_factory return type for {cls.__name__}.{self.name}: "
+                    f"{mismatch_reason}"
+                )
+            self._validate_bounds(cls, default, "default_factory()")
+            self._validate_default_membership(cls, default, "default_factory()")
+            return
+        if self.default is ...:
+            return
+        mismatch_reason = isoftype(self.default, self.type, self.name, path="expected")
+        if mismatch_reason is not None:
+            raise ValidatorError(
+                f"invalid default type for {cls.__name__}.{self.name}: {mismatch_reason}"
+            )
+        self._validate_bounds(cls, self.default, "default")
+        self._validate_default_membership(cls, self.default, "default")
+
+    def _validate_allowlist(self, cls: type) -> None:
+        if self.allowlist is ...:
+            return
+        if not isinstance(self.allowlist, list):
+            raise ValidatorError(
+                f"invalid allowlist type of {cls.__name__}.{self.name}: "
+                f"expected a list, got {type(self.allowlist)!r} instead"
+            )
+        for idx, item in enumerate(self.allowlist):
+            mismatch_reason = isoftype(
+                item,
+                self.type,
+                self.name,
+                path=f"allowlist[{idx}] expected",
+            )
+            if mismatch_reason is not None:
+                raise ValidatorError(
+                    f"invalid allowlist type of {cls.__name__}.{self.name}: "
+                    + mismatch_reason
+                )
+            self._validate_bounds(cls, item, f"allowlist[{idx}]")
+
+    def _validate_default_membership(
+        self, cls: type, value: Any, value_name: str
+    ) -> None:
+        if self.allowlist is not ... and value not in self.allowlist:
+            raise ValidatorError(
+                f"invalid {value_name} value for {cls.__name__}.{self.name}: "
+                f"expected value in {self.allowlist!r}, "
+                f"got {value!r} instead"
+            )
+        if self.denylist is not ... and value in self.denylist:
+            raise ValidatorError(
+                f"invalid {value_name} value for {cls.__name__}.{self.name}: "
+                f"expected value not in {self.denylist!r}, "
+                f"but got {value!r}"
+            )
+
+    def _validate_bounds(self, cls: type, value: Any, value_name: str) -> None:
+        if self.lb is not ... and value < self.lb:
+            raise ValidatorError(
+                f"invalid value for {value_name} of {cls.__name__}.{self.name}: "
+                f"expected value >= {self.lb!r}, got {value!r} instead"
+            )
+        if self.ub is not ... and value > self.ub:
+            raise ValidatorError(
+                f"invalid value for {value_name} of {cls.__name__}.{self.name}: "
+                f"expected value <= {self.ub!r}, got {value!r} instead"
+            )
+
+    def __set__(self, instance: object, value: Any) -> None:
+        if isinstance(value, self.__class__):
+            if self.default is ... and self.default_factory is ...:
+                raise TypeError(
+                    f"{instance.__class__.__name__}.__init__() missing 1 required "
+                    f"positional argument: {self.name!r}"
+                )
+            return
+        mismatch_reason = isoftype(value, self.type, self.name)
+        if mismatch_reason is not None:
+            raise TypeError(
+                f"invalid type for {instance.__class__.__name__}.{self.name}: "
+                + mismatch_reason
+            )
+        if self.allowlist is not ...:
+            if value not in self.allowlist:
+                raise ValueError(
+                    f"invalid value for {instance.__class__.__name__}.{self.name}: "
+                    f"expected value in {self.allowlist!r}, got {value!r} instead"
+                )
+        if self.denylist is not ...:
+            if value in self.denylist:
+                raise ValueError(
+                    f"invalid value for {instance.__class__.__name__}.{self.name}: "
+                    f"expected value not in {self.denylist!r}, but got {value!r}"
+                )
+        if self.lb is not ... and value < self.lb:
+            raise ValueError(
+                f"invalid value for {instance.__class__.__name__}.{self.name}: "
+                f"expected value >= {self.lb!r}, got {value!r} instead"
+            )
+        if self.ub is not ... and value > self.ub:
+            raise ValueError(
+                f"invalid value for {instance.__class__.__name__}.{self.name}: "
+                f"expected value <= {self.ub!r}, got {value!r} instead"
+            )
+        if not self.validator(value):
+            raise ValueError(f"invalid value for {self.name!r}: {value}")
+        instance.__dict__[self.name] = value
+
+    def __get__(self, instance: object, owner: type) -> Any:
+        if not instance:
+            return self
+        if self.name not in instance.__dict__:
+            if self.default_factory is not ...:
+                self.__set__(instance, self.default_factory())
+            elif self.default is ...:
+                raise AttributeError(
+                    f"{owner.__name__!r} object has no attribute {self.name!r}"
+                )
+            else:
+                self.__set__(instance, self.default)
+        return instance.__dict__[self.name]
+
+    def __delete__(self, instance: object) -> None:
+        del instance.__dict__[self.name]
+
+
+def isoftype(
+    value: object, type_hint: type, name: str, path: str = "expected"
+) -> Optional[str]:
+    """
+    Returns a detailed mismatch message when `value` does not satisfy `type_hint`.
+
+    Parameters
+    ----------
+    value : object
+        Value to be checked.
+    type_hint : type
+        Type hint object.
+    name: str
+        Variable name.
+    path : str, optional
+        Human-readable value path used in the error details.
+
+    Returns
+    -------
+    Optional[str]
+        None when the check passes; otherwise a description of the mismatch.
+
+    """
+    origin = get_origin(type_hint)
+    args = get_args(type_hint)
+
+    if type_hint is Any:
+        return None
+
+    if origin is None:
+        if isinstance(value, type_hint):
+            return None
+        return f"{path} {type_hint!r}, got {type(value)!r} instead"
+
+    if origin is Union or origin is UnionType:
+        union_errors = [isoftype(value, arg, name, path) for arg in args]
+        if any(error is None for error in union_errors):
+            return None
+        return f"{path} one of {args}, got {value.__class__!r} instead"
+
+    if origin is Literal:
+        if value in args:
+            return None
+        return f"{path} one of {args!r}, got {value!r} instead"
+
+    if origin is list:
+        (elem_type,) = args
+        if not isinstance(value, list):
+            return f"{path} a list, got {type(value)!r} instead"
+        for idx, elem in enumerate(value):
+            elem_error = isoftype(elem, elem_type, name, f"{name}[{idx}] expected")
+            if elem_error is not None:
+                return elem_error
+        return None
+
+    if origin is tuple:
+        if len(args) == 2 and args[1] is Ellipsis:
+            (elem_type, _) = args
+            if not isinstance(value, tuple):
+                return f"{path} a tuple, got {type(value)!r} instead"
+            for idx, elem in enumerate(value):
+                elem_error = isoftype(elem, elem_type, name, f"{name}[{idx}] expected")
+                if elem_error is not None:
+                    return elem_error
+            return None
+
+        if not isinstance(value, tuple) or len(value) != len(args):
+            return (
+                f"{path} a tuple with {len(args)} elements, got {type(value)!r} with "
+                f"length {len(value) if isinstance(value, tuple) else 'N/A'} instead"
+            )
+        for idx, (elem, elem_type) in enumerate(zip(value, args)):
+            elem_error = isoftype(elem, elem_type, name, f"{name}[{idx}] expected")
+            if elem_error is not None:
+                return elem_error
+        return None
+
+    if origin is dict:
+        key_t, val_t = args
+        if not isinstance(value, dict):
+            return f"{path} a dict, got {type(value)!r} instead"
+        for key, val in value.items():
+            key_error = isoftype(
+                key, key_t, name, f"{name}.keys() element {key!r} expected"
+            )
+            if key_error is not None:
+                return key_error
+            val_error = isoftype(val, val_t, name, f"{name}[{key!r}] expected")
+            if val_error is not None:
+                return val_error
+        return None
+
+    if origin is set:
+        (elem_type,) = args
+        if not isinstance(value, set):
+            return f"{path} a set, got {type(value)!r} instead"
+        for elem in value:
+            elem_error = isoftype(elem, elem_type, name, f"{path} element {elem!r}")
+            if elem_error is not None:
+                return elem_error
+        return None
+
+    raise NotImplementedError(f"Unsupported type hint: {type_hint}")
+
+
+class ValidatorError(RuntimeError): ...

validattr-0.0.0/test.py

@@ -0,0 +1,283 @@
+import unittest
+from dataclasses import dataclass
+from typing import Any, Literal
+
+from src.validattr import ValidatorError, attr
+
+
+class TestAttrWithDataclasses(unittest.TestCase):
+    def test_default_value_is_lazily_applied(self):
+        @dataclass
+        class Config:
+            retries: int = attr(default=3)
+
+        cfg = Config()
+        self.assertEqual(cfg.retries, 3)
+
+    def test_missing_value_without_default_raises(self):
+        @dataclass
+        class Config:
+            retries: int = attr()
+
+        with self.assertRaisesRegex(
+            TypeError,
+            r"Config.__init__\(\) missing 1 required positional argument: 'retries'",
+        ):
+            Config()
+
+    def test_type_validation_for_builtin_and_assignment(self):
+        @dataclass
+        class User:
+            age: int = attr()
+
+        with self.assertRaises(TypeError):
+            User(age="20")
+
+        u = User(age=20)
+        with self.assertRaises(TypeError):
+            u.age = "bad"
+
+    def test_allowlist_and_denylist(self):
+        @dataclass
+        class Role:
+            name: str = attr(allowlist=["admin", "guest"], denylist=["guest"])
+
+        with self.assertRaises(ValueError):
+            Role(name="user")
+
+        with self.assertRaises(ValueError):
+            Role(name="guest")
+
+        obj = Role(name="admin")
+        self.assertEqual(obj.name, "admin")
+
+    def test_bounds_validation(self):
+        @dataclass
+        class RangeCfg:
+            score: int = attr(lb=0, ub=100)
+
+        with self.assertRaises(ValueError):
+            RangeCfg(score=-1)
+
+        with self.assertRaises(ValueError):
+            RangeCfg(score=101)
+
+        self.assertEqual(RangeCfg(score=60).score, 60)
+
+    def test_custom_validator(self):
+        @dataclass
+        class EvenCfg:
+            value: int = attr(validator=lambda x: x % 2 == 0)
+
+        self.assertEqual(EvenCfg(value=10).value, 10)
+        with self.assertRaises(ValueError):
+            EvenCfg(value=11)
+
+    def test_constructor_parameter_validation(self):
+        with self.assertRaises(ValidatorError):
+            attr(allowlist=(1, 2, 3))
+
+        with self.assertRaises(ValidatorError):
+            attr(denylist=(1, 2, 3))
+
+        with self.assertRaises(ValidatorError):
+            attr(lb=10, ub=1)
+
+    def test_allowlist_element_type_check(self):
+        with self.assertRaises(RuntimeError):
+
+            @dataclass
+            class BadAllowlist:
+                value: int = attr(allowlist=[1, "2"])
+
+    def test_denylist_element_type_is_not_checked_on_class_init(self):
+        @dataclass
+        class BadDenylist:
+            value: int = attr(denylist=[1, "2"])
+
+        obj = BadDenylist(value=2)
+        self.assertEqual(obj.value, 2)
+
+    def test_default_type_check_on_class_init(self):
+        with self.assertRaises(RuntimeError):
+
+            @dataclass
+            class BadDefault:
+                value: int = attr(default="1")
+
+    def test_default_bound_check_on_class_init(self):
+        with self.assertRaises(RuntimeError):
+
+            @dataclass
+            class BadDefaultBound:
+                value: int = attr(default=0, lb=1)
+
+    def test_default_allowlist_membership_check_on_class_init(self):
+        with self.assertRaises(RuntimeError):
+
+            @dataclass
+            class BadDefaultAllowlist:
+                value: int = attr(default=3, allowlist=[1, 2])
+
+    def test_default_denylist_membership_check_on_class_init(self):
+        with self.assertRaises(RuntimeError):
+
+            @dataclass
+            class BadDefaultDenylist:
+                value: int = attr(default=2, denylist=[1, 2])
+
+    def test_allowlist_bound_check_on_class_init(self):
+        with self.assertRaises(RuntimeError):
+
+            @dataclass
+            class BadAllowlistBound:
+                value: int = attr(allowlist=[1, 2], ub=1)
+
+    def test_class_level_descriptor_access_and_any_type(self):
+        @dataclass
+        class GenericCfg:
+            payload: Any = attr(default={"ok": True})
+
+        self.assertIsNotNone(GenericCfg.payload)
+        cfg = GenericCfg()
+        cfg.payload = object()
+        self.assertIsNotNone(cfg.payload)
+
+    def test_union_literal_and_collections(self):
+        @dataclass
+        class ComplexCfg:
+            token: int | str = attr()
+            mode: Literal["dev", "prod"] = attr()
+            nums: list[int] = attr()
+            point: tuple[int, int] = attr()
+            tags: tuple[str, ...] = attr(default=("ok",))
+            mapping: dict[str, int] = attr()
+            uniq: set[int] = attr()
+
+        cfg = ComplexCfg(
+            token="a",
+            mode="dev",
+            nums=[1, 2],
+            point=(3, 4),
+            mapping={"x": 1},
+            uniq={1, 2},
+        )
+        self.assertEqual(cfg.tags, ("ok",))
+
+        with self.assertRaises(TypeError):
+            cfg.mode = "qa"
+
+        with self.assertRaises(TypeError):
+            cfg.nums = [1, "2"]
+
+        with self.assertRaises(TypeError):
+            cfg.point = (1, 2, 3)
+
+        with self.assertRaises(TypeError):
+            cfg.mapping = {1: 2}
+
+        with self.assertRaises(TypeError):
+            cfg.uniq = {1, "2"}
+
+    def test_delete_attribute(self):
+        @dataclass
+        class Config:
+            retries: int = attr(default=3)
+
+        cfg = Config()
+        self.assertEqual(cfg.retries, 3)
+        del cfg.retries
+        self.assertEqual(cfg.retries, 3)
+
+    def test_default_factory_produces_per_instance_value(self):
+        @dataclass
+        class Config:
+            payload: list[int] = attr(default_factory=list)
+
+        first = Config()
+        second = Config()
+        first.payload.append(1)
+        self.assertEqual(first.payload, [1])
+        self.assertEqual(second.payload, [])
+
+    def test_default_and_default_factory_cannot_be_set_together(self):
+        with self.assertRaises(ValidatorError):
+            attr(default=1, default_factory=lambda: 1)
+
+    def test_default_factory_type_check_on_class_init(self):
+        with self.assertRaises(RuntimeError):
+
+            @dataclass
+            class BadDefaultFactory:
+                value: int = attr(default_factory=lambda: "1")
+
+    def test_init_false_excludes_parameter_and_keeps_default(self):
+        @dataclass
+        class Config:
+            retries: int = attr(default=3, init=False)
+
+        cfg = Config()
+        self.assertEqual(cfg.retries, 3)
+
+        with self.assertRaises(TypeError):
+            Config(retries=10)
+
+    def test_init_option_must_be_bool(self):
+        with self.assertRaises(ValidatorError):
+            attr(init=1)
+
+    def test_repr_option_controls_dataclass_repr(self):
+        @dataclass
+        class Config:
+            visible: int = attr(default=1)
+            hidden: int = attr(default=2, repr=False)
+
+        config_repr = repr(Config())
+        self.assertIn("visible=1", config_repr)
+        self.assertNotIn("hidden=2", config_repr)
+
+    def test_compare_option_controls_equality(self):
+        @dataclass
+        class Config:
+            stable: int = attr(default=1)
+            volatile: int = attr(default=1, compare=False)
+
+        self.assertEqual(Config(stable=1, volatile=1), Config(stable=1, volatile=2))
+
+    def test_hash_option_controls_hashing(self):
+        @dataclass(unsafe_hash=True)
+        class Config:
+            included: int = attr(default=1, hash=True)
+            skipped: int = attr(default=1, hash=False)
+
+        self.assertEqual(
+            hash(Config(included=1, skipped=1)),
+            hash(Config(included=1, skipped=2)),
+        )
+
+    def test_kw_only_option_requires_keyword_argument(self):
+        @dataclass
+        class Config:
+            positional: int = attr()
+            keyword_only: int = attr(kw_only=True)
+
+        self.assertEqual(Config(1, keyword_only=2).keyword_only, 2)
+        with self.assertRaises(TypeError):
+            Config(1, 2)
+
+    def test_repr_hash_compare_kw_only_options_must_be_bool_or_none(self):
+        with self.assertRaises(ValidatorError):
+            attr(repr=1)
+
+        with self.assertRaises(ValidatorError):
+            attr(hash="bad")
+
+        with self.assertRaises(ValidatorError):
+            attr(compare=1)
+
+        with self.assertRaises(ValidatorError):
+            attr(kw_only=1)
+
+
+if __name__ == "__main__":
+    unittest.main()