Try including tests in the coverage data (#500)

* Try including tests in the coverage data

* Combine coverage on 3.12

* Test fixes

* Improve test coverage

* Simplify tests for coverage

Author: Tinche

.github/workflows/main.yml

@@ -20,7 +20,7 @@ jobs:
     steps:
       - uses: "actions/checkout@v3"
 
-      - uses: "actions/setup-python@v4"
+      - uses: "actions/setup-python@v5"
         with:
           python-version: "${{ matrix.python-version }}"
           allow-prereleases: true
@@ -47,10 +47,10 @@ jobs:
     steps:
       - uses: "actions/checkout@v3"
 
-      - uses: "actions/setup-python@v4"
+      - uses: "actions/setup-python@v5"
         with:
           cache: "pip"
-          python-version: "3.11"
+          python-version: "3.12"
 
       - run: "python -Im pip install --upgrade coverage[toml]"
 
@@ -65,7 +65,7 @@ jobs:
           python -Im coverage json
 
           # Report and write to summary.
-          python -Im coverage report | sed 's/^/    /' >> $GITHUB_STEP_SUMMARY
+          python -Im coverage report --skip-covered --skip-empty | sed 's/^/    /' >> $GITHUB_STEP_SUMMARY
 
           export TOTAL=$(python -c "import json;print(json.load(open('coverage.json'))['totals']['percent_covered_display'])")
           echo "total=$TOTAL" >> $GITHUB_ENV
@@ -100,9 +100,9 @@ jobs:
 
     steps:
       - uses: "actions/checkout@v3"
-      - uses: "actions/setup-python@v4"
+      - uses: "actions/setup-python@v5"
         with:
-          python-version: "3.11"
+          python-version: "3.12"
 
       - name: "Install pdm, check-wheel-content, and twine"
         run: "python -m pip install pdm twine check-wheel-contents"

pyproject.toml

@@ -103,14 +103,7 @@ addopts = "-l --benchmark-sort=fullname --benchmark-warmup=true --benchmark-warm
 
 [tool.coverage.run]
 parallel = true
-source_pkgs = ["cattrs"]
-
-[tool.coverage.paths]
-source = [
-   "src",
-   ".tox/*/lib/python*/site-packages",
-   ".tox/pypy*/site-packages",
-]
+source_pkgs = ["cattrs", "tests"]
 
 [tool.coverage.report]
 exclude_also = [

tests/test_converter.py

@@ -127,9 +127,7 @@ def test_forbid_extra_keys(cls_and_vals):
     cl, vals, kwargs = cls_and_vals
     inst = cl(*vals, **kwargs)
     unstructured = converter.unstructure(inst)
-    bad_key = next(iter(unstructured)) + "A" if unstructured else "Hyp"
-    while bad_key in unstructured:
-        bad_key += "A"
+    bad_key = next(iter(unstructured)) + "_" if unstructured else "Hyp"
     unstructured[bad_key] = 1
     with pytest.raises(ClassValidationError) as cve:
         converter.structure(unstructured, cl)
@@ -417,12 +415,8 @@ def test_type_overrides(cl_and_vals):
     unstructured = converter.unstructure(inst)
 
     for field, val in zip(fields(cl), vals):
-        if field.type is int and field.default is not None:
-            if isinstance(field.default, Factory):
-                if not field.default.takes_self and field.default() == val:
-                    assert field.name not in unstructured
-            elif field.default == val:
-                assert field.name not in unstructured
+        if field.type is int and field.default is not None and field.default == val:
+            assert field.name not in unstructured
 
 
 def test_calling_back():

tests/test_converter_inheritance.py

@@ -1,18 +1,18 @@
 import collections
 import typing
 
-import attr
 import pytest
+from attrs import define
 
 from cattrs import BaseConverter
 
 
 def test_inheritance(converter):
-    @attr.define
+    @define
     class A:
         i: int
 
-    @attr.define
+    @define
     class B(A):
         j: int
 
@@ -23,11 +23,11 @@ class B(A):
 def test_gen_hook_priority(converter: BaseConverter):
     """Autogenerated hooks should not take priority over manual hooks."""
 
-    @attr.define
+    @define
     class A:
         i: int
 
-    @attr.define
+    @define
     class B(A):
         pass
 
@@ -51,8 +51,8 @@ def test_inherit_typing(converter: BaseConverter, typing_cls):
     cattrs handles them correctly.
     """
 
-    @attr.define
-    class A(typing_cls):
+    @define
+    class A(typing_cls):  # pragma: nocover
         i: int = 0
 
         def __hash__(self):
@@ -74,8 +74,8 @@ def __reversed__(self):
 def test_inherit_collections_abc(converter: BaseConverter, collections_abc_cls):
     """As extension of test_inherit_typing, check if collections.abc.* work."""
 
-    @attr.define
-    class A(collections_abc_cls):
+    @define
+    class A(collections_abc_cls):  # pragma: nocover
         i: int = 0
 
         def __hash__(self):

tests/test_gen_dict.py

@@ -93,10 +93,9 @@ def test_nodefs_generated_unstructuring_cl(
             else:
                 # The default is a factory, but might take self.
                 if attr.default.takes_self:
-                    if val == attr.default.factory(cl):
-                        assert attr.name not in res
-                    else:
-                        assert attr.name in res
+                    # Our strategies can only produce these for now.
+                    assert val == attr.default.factory(cl)
+                    assert attr.name not in res
                 else:
                     if val == attr.default.factory():
                         assert attr.name not in res
@@ -151,10 +150,7 @@ def test_individual_overrides(converter_cls, cl_and_vals):
                     assert attr.name in res
             else:
                 if attr.default.takes_self:
-                    if val == attr.default.factory(inst):
-                        assert attr.name not in res
-                    else:
-                        assert attr.name in res
+                    assert attr.name not in res
                 else:
                     if val == attr.default.factory():
                         assert attr.name not in res

tests/test_structure_attrs.py

@@ -242,36 +242,19 @@ class ClassWithLiteral:
         converter.structure({"literal_field": 3}, ClassWithLiteral)
 
 
-@pytest.mark.parametrize("converter_type", [BaseConverter, Converter])
-def test_structure_fallback_to_attrib_converters(converter_type):
-    attrib_converter = Mock()
-    attrib_converter.side_effect = lambda val: str(val)
+def test_structure_fallback_to_attrib_converters(converter):
+    """`attrs` converters are called after cattrs processing."""
 
-    def called_after_default_converter(val):
-        if not isinstance(val, int):
-            raise ValueError(
-                "The 'int' conversion should have happened first by the built-in hooks"
-            )
-        return 42
-
-    converter = converter_type()
-    cl = make_class(
-        "HasConverter",
-        {
-            # non-built-in type with custom converter
-            "ip": field(type=Union[IPv4Address, IPv6Address], converter=ip_address),
-            # attribute without type
-            "x": field(converter=attrib_converter),
-            # built-in types converters
-            "z": field(type=int, converter=called_after_default_converter),
-        },
-    )
+    @define
+    class HasConverter:
+        ip: Union[IPv4Address, IPv6Address] = field(converter=ip_address)
+        x = field(converter=lambda v: v + 1)
+        z: int = field(converter=lambda _: 42)
 
-    inst = converter.structure({"ip": "10.0.0.0", "x": 1, "z": "3"}, cl)
+    inst = converter.structure({"ip": "10.0.0.0", "x": 1, "z": "3"}, HasConverter)
 
     assert inst.ip == IPv4Address("10.0.0.0")
-    assert inst.x == "1"
-    attrib_converter.assert_any_call(1)
+    assert inst.x == 2
     assert inst.z == 42
 
 

tests/typeddicts.py

@@ -212,16 +212,11 @@ def simple_typeddicts_with_extra_keys(
 
 
 @composite
-def generic_typeddicts(
-    draw: DrawFn, total: Optional[bool] = None
-) -> Tuple[TypedDictType, dict]:
+def generic_typeddicts(draw: DrawFn, total: bool = True) -> Tuple[TypedDictType, dict]:
     """Generate generic typed dicts.
 
-    :param total: Generate the given totality dicts (default = random)
+    :param total: Generate the given totality dicts
     """
-    if total is None:
-        total = draw(booleans())
-
     attrs = draw(
         lists(
             int_attributes(total)

tests/untyped.py

@@ -16,12 +16,14 @@
     Sequence,
     Set,
     Tuple,
+    Type,
 )
 
 import attr
-from attr import NOTHING, make_class
 from attr._make import _CountingAttr
+from attrs import NOTHING, AttrsInstance, Factory, make_class
 from hypothesis import strategies as st
+from hypothesis.strategies import SearchStrategy
 
 PosArg = Any
 PosArgs = Tuple[PosArg]
@@ -217,9 +219,11 @@ def just_class_with_type(tup):
     return _create_hyp_class(combined_attrs)
 
 
-def just_class_with_type_takes_self(tup):
+def just_class_with_type_takes_self(
+    tup: Tuple[List[Tuple[_CountingAttr, SearchStrategy]], Tuple[Type[AttrsInstance]]]
+) -> SearchStrategy[Tuple[Type[AttrsInstance]]]:
     nested_cl = tup[1][0]
-    default = attr.Factory(lambda _: nested_cl(), takes_self=True)
+    default = Factory(lambda _: nested_cl(), takes_self=True)
     combined_attrs = list(tup[0])
     combined_attrs.append(
         (attr.ib(default=default, type=nested_cl), st.just(nested_cl()))