Merge pull request #138 from binary-butterfly/more-strict-mypy-rules

Enable more strict mypy rules

Author: binaryDiv

pyproject.toml

@@ -19,8 +19,21 @@ explicit_package_bases = true
 strict = true
 
 # Enable further checks that are not included in strict mode
+disallow_any_unimported = true
+strict_equality_for_none = true
+warn_unreachable = true
 enable_error_code = [
     "deprecated",
+    "explicit-override",
+    "ignore-without-code",
+    # TODO: Maybe enable this is in the future (when we have the mypy plugin)
+    # "mutable-override",
+    "possibly-undefined",
+    "redundant-expr",
+    "redundant-self",
+    "truthy-bool",
+    "truthy-iterable",
+    "unused-awaitable",
 ]
 
 [[tool.mypy.overrides]]

src/validataclass/dataclasses/defaults.py

@@ -10,7 +10,7 @@
 from copy import deepcopy
 from typing import Any, Generic, TypeVar
 
-from typing_extensions import Never, Self
+from typing_extensions import Never, Self, override
 
 from validataclass.helpers import UnsetValue, UnsetValueType
 
@@ -35,9 +35,11 @@ class BaseDefault(Generic[T_Default], ABC):
     See also: `Default`, `DefaultFactory()`, `DefaultUnset`, `NoDefault`
     """
 
+    @override
     def __repr__(self) -> str:
         return type(self).__name__
 
+    @override
     def __eq__(self, other: Any) -> bool:
         return NotImplemented
 
@@ -79,9 +81,11 @@ def __init__(self, value: T_Default):
         # If copying the value resulted in the identical object, no factory is needed
         self._needs_factory = self._value is not value
 
+    @override
     def __repr__(self) -> str:
         return f'{type(self).__name__}({self._value!r})'
 
+    @override
     def __eq__(self, other: Any) -> bool:
         # Only handle this if self is of the same type as other OR self is a subclass of other.
         # In other words, don't handle this if other is a completely different type or more specialized than self.
@@ -90,6 +94,7 @@ def __eq__(self, other: Any) -> bool:
             return isinstance(other, Default) and bool(self._value == other._value)
         return NotImplemented
 
+    @override
     def __hash__(self) -> int:
         return hash(self._value)
 
@@ -105,12 +110,14 @@ def __call__(self) -> Self:
             return self
         raise TypeError(f"'{type(self).__name__}' object is not callable")
 
+    @override
     def get_value(self) -> T_Default:
         """
         Get actual default value.
         """
         return deepcopy(self._value)
 
+    @override
     def needs_factory(self) -> bool:
         """
         Return True if a dataclass `default_factory` is needed for this default object, for example if the value is a
@@ -144,9 +151,11 @@ class DefaultFactory(BaseDefault[T_Default]):
     def __init__(self, factory: Callable[[], T_Default]):
         self._factory = factory
 
+    @override
     def __repr__(self) -> str:
         return f'{type(self).__name__}({self._factory!r})'
 
+    @override
     def __eq__(self, other: Any) -> bool:
         # Only handle this if self is of the same type as other OR self is a subclass of other.
         # In other words, don't handle this if other is a completely different type or more specialized than self.
@@ -155,15 +164,18 @@ def __eq__(self, other: Any) -> bool:
             return isinstance(other, DefaultFactory) and bool(self._factory == other._factory)
         return NotImplemented
 
+    @override
     def __hash__(self) -> int:
         return hash(self._factory)
 
+    @override
     def get_value(self) -> T_Default:
         """
         Get an actual default value by calling the factory function.
         """
         return self._factory()
 
+    @override
     def needs_factory(self) -> bool:
         """
         Return True if a dataclass `default_factory` is needed for this default object.
@@ -185,18 +197,22 @@ class _NoDefault(BaseDefault[Never]):
     A validataclass field with `NoDefault` is equivalent to a validataclass field without specified default.
     """
 
+    @override
     def __repr__(self) -> str:
         return 'NoDefault'
 
+    @override
     def __eq__(self, other: Any) -> bool:
         # Nothing is equal to NoDefault except itself
         return self is other
 
     __hash__ = BaseDefault.__hash__
 
+    @override
     def get_value(self) -> Never:
         raise ValueError('No default value specified!')
 
+    @override
     def needs_factory(self) -> bool:
         raise NotImplementedError('NoDefault can be used neither as a value nor as a factory.')
 
@@ -212,5 +228,5 @@ def __call__(self) -> Self:
 
 # Create sentinel object NoDefault, redefine __new__ to always return the same instance, and delete temporary class
 NoDefault = _NoDefault()
-_NoDefault.__new__ = lambda cls: NoDefault  # type: ignore
+_NoDefault.__new__ = lambda cls: NoDefault  # type: ignore[assignment, method-assign, return-value]
 del _NoDefault

src/validataclass/exceptions/base_exceptions.py

@@ -6,6 +6,8 @@
 
 from typing import Any
 
+from typing_extensions import override
+
 __all__ = [
     'ValidationError',
 ]
@@ -38,10 +40,12 @@ def __init__(self, *, code: str | None = None, reason: str | None = None, **kwar
             self.reason = reason
         self.extra_data = {key: value for key, value in kwargs.items() if value is not None}
 
+    @override
     def __repr__(self) -> str:
-        params_string = ', '.join(f'{key}={value}' for key, value in self._get_repr_dict().items() if value is not None)
+        params_string = ', '.join(f'{key}={value}' for key, value in self._get_repr_dict().items())
         return f'{type(self).__name__}({params_string})'
 
+    @override
     def __str__(self) -> str:
         return self.__repr__()
 

src/validataclass/exceptions/common_exceptions.py

@@ -6,6 +6,8 @@
 
 from typing import Any
 
+from typing_extensions import override
+
 from .base_exceptions import ValidationError
 
 __all__ = [
@@ -69,6 +71,7 @@ def add_expected_type(self, new_type: type | str) -> None:
         if new_type not in self.expected_types:
             self.expected_types.append(new_type)
 
+    @override
     def to_dict(self) -> dict[str, Any]:
         base_dict = super().to_dict()
         self.expected_types.sort()

src/validataclass/exceptions/dataclass_exceptions.py

@@ -6,6 +6,8 @@
 
 from typing import Any
 
+from typing_extensions import override
+
 from .base_exceptions import ValidationError
 
 __all__ = [
@@ -74,6 +76,7 @@ def __init__(
             assert all(isinstance(error, ValidationError) for error in field_errors.values())
             self.field_errors = field_errors
 
+    @override
     def _get_repr_dict(self) -> dict[str, str]:
         base_dict = super()._get_repr_dict()
 
@@ -84,6 +87,7 @@ def _get_repr_dict(self) -> dict[str, str]:
 
         return base_dict
 
+    @override
     def to_dict(self) -> dict[str, Any]:
         base_dict = super().to_dict()
 

src/validataclass/exceptions/dict_exceptions.py

@@ -6,6 +6,8 @@
 
 from typing import Any
 
+from typing_extensions import override
+
 from .base_exceptions import ValidationError
 
 __all__ = [
@@ -33,13 +35,15 @@ def __init__(self, *, field_errors: dict[str, ValidationError], **kwargs: Any):
         assert all(isinstance(error, ValidationError) for error in field_errors.values())
         self.field_errors = field_errors
 
+    @override
     def _get_repr_dict(self) -> dict[str, str]:
         base_dict = super()._get_repr_dict()
         return {
             **base_dict,
             'field_errors': repr(self.field_errors),
         }
 
+    @override
     def to_dict(self) -> dict[str, Any]:
         base_dict = super().to_dict()
         return {

src/validataclass/exceptions/list_exceptions.py

@@ -6,6 +6,8 @@
 
 from typing import Any
 
+from typing_extensions import override
+
 from .base_exceptions import ValidationError
 
 __all__ = [
@@ -32,13 +34,15 @@ def __init__(self, *, item_errors: dict[int, ValidationError], **kwargs: Any):
         assert all(isinstance(error, ValidationError) for error in item_errors.values())
         self.item_errors = item_errors
 
+    @override
     def _get_repr_dict(self) -> dict[str, str]:
         base_dict = super()._get_repr_dict()
         return {
             **base_dict,
             'item_errors': repr(self.item_errors),
         }
 
+    @override
     def to_dict(self) -> dict[str, Any]:
         base_dict = super().to_dict()
         return {

src/validataclass/helpers/datetime_range.py

@@ -9,6 +9,8 @@
 from datetime import datetime, timedelta, timezone, tzinfo
 from typing import TypeAlias
 
+from typing_extensions import override
+
 __all__ = [
     'BaseDateTimeRange',
     'DateTimeRange',
@@ -101,9 +103,11 @@ def __init__(
         self.lower_boundary = lower_boundary
         self.upper_boundary = upper_boundary
 
+    @override
     def __repr__(self) -> str:
         return f'{type(self).__name__}(lower_boundary={self.lower_boundary!r}, upper_boundary={self.upper_boundary!r})'
 
+    @override
     def contains_datetime(self, dt: datetime, local_timezone: tzinfo | None = None) -> bool:
         """
         Returns `True` if the datetime is contained in the datetime range.
@@ -117,6 +121,7 @@ def contains_datetime(self, dt: datetime, local_timezone: tzinfo | None = None)
         # Note: These comparisons will raise TypeErrors when mixing datetimes with and without timezones
         return (lower_datetime is None or dt >= lower_datetime) and (upper_datetime is None or dt <= upper_datetime)
 
+    @override
     def to_dict(self, local_timezone: tzinfo | None = None) -> dict[str, str]:
         """
         Returns a dictionary with string representations of the range boundaries, suitable for the `DateTimeRangeError`
@@ -204,12 +209,14 @@ def __init__(
         self.offset_minus = offset_minus
         self.offset_plus = offset_plus
 
+    @override
     def __repr__(self) -> str:
         return (
             f'{type(self).__name__}(pivot={self.pivot!r}, offset_minus={self.offset_minus!r}, '
             f'offset_plus={self.offset_plus!r})'
         )
 
+    @override
     def contains_datetime(self, dt: datetime, local_timezone: tzinfo | None = None) -> bool:
         """
         Returns `True` if the datetime is contained in the datetime range.
@@ -223,6 +230,7 @@ def contains_datetime(self, dt: datetime, local_timezone: tzinfo | None = None)
         # Note: These comparisons will raise TypeErrors when mixing datetimes with and without timezones
         return lower_datetime <= dt <= upper_datetime
 
+    @override
     def to_dict(self, local_timezone: tzinfo | None = None) -> dict[str, str]:
         """
         Returns a dictionary with string representations of the range boundaries (calculating `lower_datetime` and

src/validataclass/helpers/unset_value.py

@@ -6,7 +6,7 @@
 
 from typing import TypeAlias, TypeVar
 
-from typing_extensions import Self
+from typing_extensions import Self, override
 
 __all__ = [
     'UnsetValue',
@@ -33,9 +33,11 @@ class UnsetValueType:
     def __call__(self) -> Self:
         return self
 
+    @override
     def __repr__(self) -> str:
         return 'UnsetValue'
 
+    @override
     def __str__(self) -> str:
         return '<UnsetValue>'
 
@@ -48,7 +50,7 @@ def __bool__(self) -> bool:
 
 # Create sentinel object and redefine __new__ so that the object cannot be cloned
 UnsetValue = UnsetValueType()
-UnsetValueType.__new__ = lambda cls: UnsetValue  # type: ignore
+UnsetValueType.__new__ = lambda cls: UnsetValue  # type: ignore[assignment, method-assign, return-value]
 
 # Type alias OptionalUnset[T] for fields with DefaultUnset: Allows either the type T or UnsetValue
 OptionalUnset: TypeAlias = T | UnsetValueType

src/validataclass/validators/allow_empty_string.py

@@ -7,7 +7,7 @@
 from copy import deepcopy
 from typing import Any, overload
 
-from typing_extensions import Generic, TypeVar
+from typing_extensions import Generic, TypeVar, override
 
 from validataclass.exceptions import InvalidTypeError
 from .validator import Validator
@@ -79,6 +79,7 @@ def __init__(self, validator: Validator[T_WrappedValidated], *, default: Any = '
         self.wrapped_validator = validator
         self.default_value = default
 
+    @override
     def validate(self, input_data: Any, **kwargs: Any) -> T_WrappedValidated | T_EmptyStringDefault:
         """
         Validates input data.