SWAMPy

✎ CARVE FLESH

EDITING: setters.py

# SPDX-License-Identifier: MIT

"""
Commonly used hooks for on_setattr.
"""

from . import _config
from .exceptions import FrozenAttributeError

def pipe(*setters):
    """
    Run all *setters* and return the return value of the last one.

.. versionadded:: 20.1.0
    """

def wrapped_pipe(instance, attrib, new_value):
        rv = new_value

for setter in setters:
            rv = setter(instance, attrib, rv)

return rv

return wrapped_pipe

def frozen(_, __, ___):
    """
    Prevent an attribute to be modified.

.. versionadded:: 20.1.0
    """
    raise FrozenAttributeError()

def validate(instance, attrib, new_value):
    """
    Run *attrib*'s validator on *new_value* if it has one.

.. versionadded:: 20.1.0
    """
    if _config._run_validators is False:
        return new_value

v = attrib.validator
    if not v:
        return new_value

v(instance, attrib, new_value)

return new_value

def convert(instance, attrib, new_value):
    """
    Run *attrib*'s converter -- if it has one --  on *new_value* and return the
    result.

.. versionadded:: 20.1.0
    """
    c = attrib.converter
    if c:
        return c(new_value)

return new_value

# Sentinel for disabling class-wide *on_setattr* hooks for certain attributes.
# autodata stopped working, so the docstring is inlined in the API docs.
NO_OP = object()

CANCEL

Name	Type	Size	Modified	Actions
↩ ..	DIR	—	—
📁 __pycache__/	DIR	—	2026-03-10 17:34
📄 __init__.py	PY	3.2 KB	2024-02-29 21:44	EDIT
📄 __init__.pyi	PYI	16.6 KB	2024-02-29 21:44	EDIT
📄 _cmp.py	PY	3.9 KB	2024-02-29 21:44	EDIT
📄 _cmp.pyi	PYI	399 B	2024-02-29 21:44	EDIT
📄 _compat.py	PY	2.5 KB	2024-02-29 21:44	EDIT
📄 _config.py	PY	843 B	2024-02-29 21:44	EDIT
📄 _funcs.py	PY	16.8 KB	2024-02-29 21:44	EDIT
📄 _make.py	PY	99.5 KB	2024-02-29 21:44	EDIT
📄 _next_gen.py	PY	6.1 KB	2024-02-29 21:44	EDIT
📄 _typing_compat.pyi	PYI	469 B	2024-02-29 21:44	EDIT
📄 _version_info.py	PY	2.1 KB	2024-02-29 21:44	EDIT
📄 _version_info.pyi	PYI	209 B	2024-02-29 21:44	EDIT
📄 converters.py	PY	3.5 KB	2024-02-29 21:44	EDIT
📄 converters.pyi	PYI	406 B	2024-02-29 21:44	EDIT
📄 exceptions.py	PY	1.9 KB	2024-02-29 21:44	EDIT
📄 exceptions.pyi	PYI	539 B	2024-02-29 21:44	EDIT
📄 filters.py	PY	1.4 KB	2024-02-29 21:44	EDIT
📄 filters.pyi	PYI	225 B	2024-02-29 21:44	EDIT
📄 py.typed	TYPED	0 B	2024-02-29 21:44	EDIT
📄 setters.py	PY	1.4 KB	2024-02-29 21:44	EDIT
📄 setters.pyi	PYI	567 B	2024-02-29 21:44	EDIT
📄 validators.py	PY	19.2 KB	2024-02-29 21:44	EDIT
📄 validators.pyi	PYI	2.5 KB	2024-02-29 21:44	EDIT