test_checks.py

from array import array
from datetime import date
from decimal import Decimal
from enum import Enum
from fractions import Fraction
from random import Random
from xml.etree.ElementTree import Element

import pytest
from typing_extensions import TypedDict as TypingExtensionsTypedDict

from slotscheck.checks import has_slotless_base, has_slots, slots_overlap

try:
    from typing import TypedDict
except ImportError:
    TypedDict = TypingExtensionsTypedDict


class HasSlots:
    __slots__ = ("a", "b")


class GoodInherit(HasSlots):
    __slots__ = ["c", "d", "e"]


class BadOverlaps(GoodInherit):
    __slots__ = {"a": "some docstring", "f": "bla"}


class NoSlotsInherits(HasSlots):
    pass


class BadInherit(Random):
    __slots__ = ()


class BadInheritAndOverlap(NoSlotsInherits):
    __slots__ = ["z", "b", "a"]


class ChildOfBadClass(BadInheritAndOverlap):
    pass


class _RestrictiveMeta(type):
    def __setattr__(self, name, value) -> None:
        raise TypeError("BOOM!")


class _UnsettableClass(metaclass=_RestrictiveMeta):
    pass


class OneStringSlot(HasSlots):
    __slots__ = "baz"


class ArrayInherit(array):
    __slots__ = ()


class FooMeta(type):
    __slots__ = ()


class Foo(metaclass=FooMeta):
    __slots__ = ()


class MyDict(TypedDict):
    foo: str


class MyTypingExtensionsTypedDict(TypingExtensionsTypedDict):
    bla: int


class TestHasSlots:
    @pytest.mark.parametrize(
        "klass",
        [type, dict, date, float, Decimal, Element, array],
    )
    def test_not_purepython(self, klass):
        assert has_slots(klass)

    def test_typeddict(self):
        assert has_slots(MyDict)

    def test_typing_extensions_typeddict(self):
        assert has_slots(MyTypingExtensionsTypedDict)

    @pytest.mark.parametrize(
        "klass",
        [
            Fraction,
            HasSlots,
            GoodInherit,
            BadInherit,
            BadOverlaps,
            OneStringSlot,
            ArrayInherit,
            Foo,
            FooMeta,
        ],
    )
    def test_slots(self, klass):
        assert has_slots(klass)

    @pytest.mark.parametrize(
        "klass",
        [
            Random,
            Enum,
            NoSlotsInherits,
            ChildOfBadClass,
            RuntimeError,
            KeyboardInterrupt,
        ],
    )
    def test_no_slots(self, klass):
        assert not has_slots(klass)

    def test_immutable_class(self):
        assert not has_slots(_UnsettableClass)


class TestSlotsOverlap:
    @pytest.mark.parametrize(
        "klass",
        [type, dict, date, float, Decimal, AssertionError, RuntimeError],
    )
    def test_not_purepython(self, klass):
        assert not slots_overlap(klass)

    @pytest.mark.parametrize(
        "klass",
        [
            Fraction,
            HasSlots,
            GoodInherit,
            BadInherit,
            OneStringSlot,
            Foo,
            FooMeta,
            ArrayInherit,
        ],
    )
    def test_slots_ok(self, klass):
        assert not slots_overlap(klass)

    @pytest.mark.parametrize("klass", [BadOverlaps, BadInheritAndOverlap])
    def test_slots_not_ok(self, klass):
        assert slots_overlap(klass)

    @pytest.mark.parametrize(
        "klass", [Random, Enum, NoSlotsInherits, ChildOfBadClass]
    )
    def test_no_slots(self, klass):
        assert not slots_overlap(klass)


class TestHasSlotlessBase:
    @pytest.mark.parametrize(
        "klass",
        [type, dict, date, float, Decimal],
    )
    def test_not_purepython(self, klass):
        assert not has_slotless_base(klass)

    @pytest.mark.parametrize(
        "klass", [Fraction, HasSlots, GoodInherit, BadOverlaps, OneStringSlot]
    )
    def test_slots_ok(self, klass):
        assert not has_slotless_base(klass)

    @pytest.mark.parametrize(
        "klass",
        [BadInherit, BadInheritAndOverlap, AssertionError, RuntimeError],
    )
    def test_slots_not_ok(self, klass):
        assert has_slotless_base(klass)

    @pytest.mark.parametrize("klass", [Enum, NoSlotsInherits, ChildOfBadClass])
    def test_no_slots(self, klass):
        assert not has_slotless_base(klass)