Fix issues with #244

2.22.1

Author: loyada

docs/structures.rst

@@ -966,6 +966,10 @@ Typedpy exposes several global defaults. These can be views as the Typedpy confi
 8. TypedPyDefaults.block_unknown_consts - if set to True, will raise an exception if a Structure class definition contains
    attributes that are not fields, and not Typedpy attributes. It is meant to avoid silly mistakes, like 
    setting "_ignore_nonnes".
+   In case you still want to use your own custom (non-typedpy) attribute in a Structure while block_unknown_consts is on
+   you can either use a method, a property or a class variable with a name that starts with "_custom_attribute_".
+
+
 
 
 

setup.py

@@ -46,9 +46,9 @@
     license="MIT",
     long_description=long_description,
     url="http://github.com/loyada/typedpy",
-    download_url="https://github.com/loyada/typedpy/archive/v2.22.0.tar.gz",
+    download_url="https://github.com/loyada/typedpy/archive/v2.22.1.tar.gz",
     keywords=["testing", "type-safe", "strict", "schema", "validation"],
-    version="2.22.0",
+    version="2.22.1",
 )
 
 # coverage run --source=typedpy/ setup.py test

tests/conftest.py

@@ -48,8 +48,17 @@ def fixture_no_defensive_copy_on_get():
 
 @pytest.fixture(name="block_unknown_consts")
 def fixture_block_unknown_consts():
+    saved = TypedPyDefaults.block_unknown_consts
     TypedPyDefaults.block_unknown_consts = True
     yield
+    TypedPyDefaults.block_unknown_consts = saved
+
+
+@pytest.fixture(name="unblock_unknown_consts")
+def fixture_unblock_unknown_consts():
+    saved = TypedPyDefaults.block_unknown_consts
     TypedPyDefaults.block_unknown_consts = False
+    yield
+    TypedPyDefaults.block_unknown_consts = saved
 
 

tests/test_block_unknown_consts.py

@@ -2,7 +2,7 @@
 from pytest import raises
 
 
-def test_dont_block_unknown_consts():
+def test_dont_block_unknown_consts(unblock_unknown_consts):
     class Foo(Structure):
         a: int
 
@@ -11,6 +11,19 @@ class Foo(Structure):
     # no exception thrown
 
 
+def test_block_unknown_consts_default_config():
+    with raises(ValueError) as excinfo:
+
+        class Foo(Structure):
+            a: int
+
+            _asdasd = True
+
+    assert "attribute _asdasd is not a valid TypedPy attribute." in str(
+        excinfo.value
+    )
+
+
 def test_block_unknown_consts(block_unknown_consts):
     with raises(ValueError) as excinfo:
 

typedpy/serialization/serialization.py

@@ -13,7 +13,7 @@
     wrap_val,
 )
 from typedpy.serialization.versioned_mapping import (
-    VERSION_MAPPING,
+    VERSIONS_MAPPING,
     Versioned,
     convert_dict,
 )
@@ -561,8 +561,8 @@ class reference field. Users are not supposed to use this argument.
     if issubclass(cls, Versioned):
         if not isinstance(the_dict, dict) or "version" not in the_dict:
             raise TypeError("Expected a dictionary with a 'version' value")
-        if getattr(cls, VERSION_MAPPING):
-            versions_mapping = getattr(cls, VERSION_MAPPING)
+        if getattr(cls, VERSIONS_MAPPING):
+            versions_mapping = getattr(cls, VERSIONS_MAPPING)
             input_dict = convert_dict(the_dict, versions_mapping)
 
     if (

typedpy/serialization/versioned_mapping.py

@@ -2,13 +2,11 @@
 
 from typedpy.commons import Constant, deep_get
 from typedpy.structures import Structure
+from typedpy.structures.consts import VERSIONS_MAPPING
 from typedpy.fields import FunctionCall, PositiveInt
 from .mappers import Deleted
 
 
-VERSION_MAPPING = "_versions_mapping"
-
-
 class Versioned(Structure):
     """
     Marks a structure as can be deserialized from multiple versions.
@@ -26,7 +24,7 @@ class Versioned(Structure):
     version: PositiveInt
 
     def __init__(self, *args, **kwargs):
-        versions_mapping = getattr(self, VERSION_MAPPING, [])
+        versions_mapping = getattr(self, VERSIONS_MAPPING, [])
         default_version = len(versions_mapping) + 1
         kwargs["version"] = default_version
         super().__init__(*args, **kwargs)

typedpy/structures/defaults.py

@@ -6,4 +6,4 @@ class TypedPyDefaults:
     uniqueness_features_enabled = False
     defensive_copy_on_get = True
     allow_none_for_optionals = False
-    block_unknown_consts = False
+    block_unknown_consts = True

typedpy/structures/structures.py

@@ -47,7 +47,6 @@
 from .defaults import TypedPyDefaults
 from .type_mapping import convert_basic_types
 
-
 T = typing.TypeVar("T")
 
 _immutable_types = (int, float, str, tuple, bool, enum.Enum)
@@ -659,12 +658,21 @@ def _apply_default_and_update_required_not_to_include_fields_with_defaults(
 
 def _block_invalid_consts(cls_dict):
     annotations = cls_dict.get("__annotations__", {})
+    known_attributes = (
+        annotations.keys()
+        | SPECIAL_ATTRIBUTES
+        | {"_fields", "_fail_fast", "_field_by_name", "_constants"}
+    )
+    ""
     for k, v in cls_dict.items():
-        if k in annotations or k in SPECIAL_ATTRIBUTES or _is_dunder(k) or k.startswith(CUSTOM_ATTRIBUTE_MARKER):
+        if (
+            k in known_attributes
+            or _is_dunder(k)
+            or k.startswith(CUSTOM_ATTRIBUTE_MARKER)
+        ):
             continue
         if isinstance(v, (bool, list, dict)):
-            raise ValueError(f"attribute {k} is not a valid TypedPy attribute. "
-                             f"If it is not a typo, please add an annotation")
+            raise ValueError(f"attribute {k} is not a valid TypedPy attribute.")
 
 
 class StructMeta(type):
@@ -678,7 +686,7 @@ def __prepare__(cls, name, bases):
 
     def __new__(
         cls, name, bases, cls_dict
-    ):  #  pylint: disable=too-many-locals, too-many-branches
+    ):  # pylint: disable=too-many-locals, too-many-branches
         bases_params, bases_required = get_base_info(bases)
         add_annotations_to_class_dict(cls_dict, previous_frame=currentframe().f_back)
         defaults = cls_dict[DEFAULTS]
@@ -1531,8 +1539,7 @@ def from_trusted_data(cls, source_object=None, *, ignore_props=None, **kw):
                 if is_mapping
                 else getattr(source_object, k, None)
                 for k in cls.get_all_fields_by_name()
-                if k not in ignore_props
-                and k not in getattr(cls, "_constants", {})
+                if k not in ignore_props and k not in getattr(cls, "_constants", {})
             }
             kwargs = {**args_from_model, **kw}
         else: