4.0.0 refactoring - mypy fixes

Author: InspiredImpact

multibar/api/calculation_service.py

@@ -1,13 +1,26 @@
-__all__ = ("CalculationServiceAware",)
+from __future__ import annotations
+
+__all__ = ("AbstractCalculationService",)
 
 import abc
 import typing
 
-from .. import iterators
+if typing.TYPE_CHECKING:
+    from multibar import iterators
+
 
+class AbstractCalculationService(abc.ABC):
+    __slots__ = ("_start_value", "_end_value", "_length")
 
-class CalculationServiceAware(abc.ABC):
-    __slots__ = ()
+    def __init__(
+        self,
+        start_value: typing.Union[int, float],
+        end_value: typing.Union[int, float],
+        length: int,
+    ) -> None:
+        self._start_value = start_value
+        self._end_value = end_value
+        self._length = length
 
     @abc.abstractmethod
     def calculate_filled_indexes(self) -> iterators.AbstractIterator[int]:
@@ -27,17 +40,19 @@ def progressbar_length(self) -> int:
     def progress_percents(self) -> float:
         ...
 
-    @property
+    @staticmethod
     @abc.abstractmethod
-    def start_value(self) -> typing.Union[int, float]:
+    def get_progress_percentage(start: typing.Union[int, float], end: typing.Union[int, float], /) -> float:
         ...
 
     @property
-    @abc.abstractmethod
+    def start_value(self) -> typing.Union[int, float]:
+        return self._start_value
+
+    @property
     def end_value(self) -> typing.Union[int, float]:
-        ...
+        return self._end_value
 
-    @staticmethod
-    @abc.abstractmethod
-    def get_progress_percentage(start: int, end: int, /) -> float:
-        ...
+    @property
+    def length_value(self) -> int:
+        return self._length

multibar/api/clients.py

@@ -9,8 +9,7 @@
 from . import hooks as hooks_
 
 if typing.TYPE_CHECKING:
-    from multibar.api import progressbars
-    from multibar.api import sectors
+    from multibar.api import progressbars, sectors
 
 
 class ProgressbarClientAware(abc.ABC):
@@ -21,7 +20,7 @@ def get_progress(
         start_value: int,
         end_value: int,
         /,
-    ) -> typing.Optional[progressbars.ProgressbarAware[sectors.SectorAware]]:
+    ) -> typing.Optional[progressbars.ProgressbarAware[sectors.AbstractSector]]:
         ...
 
     @abc.abstractmethod
@@ -33,7 +32,7 @@ def get_progress(
         /,
         *,
         length: int,
-    ) -> typing.Optional[progressbars.ProgressbarAware[sectors.SectorAware]]:
+    ) -> typing.Optional[progressbars.ProgressbarAware[sectors.AbstractSector]]:
         ...
 
     @abc.abstractmethod
@@ -44,7 +43,7 @@ def get_progress(
         /,
         *,
         length: int = 20,
-    ) -> typing.Optional[progressbars.ProgressbarAware[sectors.SectorAware]]:
+    ) -> typing.Optional[progressbars.ProgressbarAware[sectors.AbstractSector]]:
         ...
 
     @abc.abstractmethod

multibar/api/contracts.py

@@ -1,32 +1,39 @@
 from __future__ import annotations
 
-__all__ = ("ContractAware", "ContractCheck", "ContractManagerAware",)
+__all__ = (
+    "ContractAware",
+    "ContractCheck",
+    "ContractManagerAware",
+)
 
 import abc
-import typing
 import dataclasses
+import typing
+
+from returns.io import IO
 
-from .. import utils
+from multibar import utils
 
 
 @dataclasses.dataclass
 class ContractCheck:
     kept: bool
-    metadata: dict[str, typing.Any] = dataclasses.field(default_factory=dict)
+    metadata: typing.MutableMapping[typing.Any, typing.Any] = dataclasses.field(default_factory=dict)
     warnings: list[str] = dataclasses.field(default_factory=list)
     errors: list[str] = dataclasses.field(default_factory=list)
 
     @classmethod
     def done(
         cls,
-        metadata: typing.Optional[dict[str, typing.Any]] = None,
+        metadata: typing.Optional[typing.MutableMapping[typing.Any, typing.Any]] = None,
     ) -> ContractCheck:
         return cls(kept=True, metadata=utils.none_or({}, metadata))
 
     @classmethod
+    @typing.no_type_check
     def terminated(
         cls,
-        metadata: typing.Optional[dict[str, typing.Any]] = None,
+        metadata: typing.Optional[typing.MutableMapping[typing.Any, typing.Any]] = None,
         warnings: typing.Optional[list[str]] = None,
         errors: typing.Optional[list[str]] = None,
     ) -> ContractCheck:
@@ -46,15 +53,15 @@ def check(self, *args: typing.Any, **kwargs: typing.Any) -> ContractCheck:
         ...
 
     @abc.abstractmethod
-    def render_terminated_contract(self, check: ContractCheck, /, *, raise_errors: bool) -> None:
+    def render_terminated_contract(self, check: ContractCheck, /, *, raise_errors: bool) -> IO[None]:
         ...
 
 
 class ContractManagerAware(abc.ABC):
     __slots__ = ()
 
     @abc.abstractmethod
-    def trigger_contract(
+    def check_contract(
         self,
         contract: ContractAware,
         *args: typing.Any,
@@ -63,7 +70,7 @@ def trigger_contract(
         ...
 
     @abc.abstractmethod
-    def trigger_contracts(self, *args: typing.Any, **kwargs: typing.Any) -> None:
+    def check_contracts(self, *args: typing.Any, **kwargs: typing.Any) -> None:
         ...
 
     @abc.abstractmethod

multibar/api/hooks.py

@@ -1,33 +1,36 @@
 from __future__ import annotations
 
-__all__ = ("HookSignatureType", "HooksAware",)
+__all__ = (
+    "HookSignatureType",
+    "HooksAware",
+)
 
 import abc
 import typing
 
+import typing_extensions
+
 if typing.TYPE_CHECKING:
     from . import clients
 
-HookSignatureType: typing.TypeAlias = typing.Callable[..., typing.Optional[bool]]
+HookSignatureType: typing_extensions.TypeAlias = typing.Callable[..., typing.Optional[bool]]
 
 
 class HooksAware(abc.ABC):
     __slots__ = ()
 
-    def __or__(self, other: typing.Any) -> typing.Any:
-        if not isinstance(other, HooksAware):
-            return NotImplemented
-
-        self.on_error_hooks.extend(other.on_error_hooks)
-        self.post_execution_hooks.extend(other.post_execution_hooks)
-        self.pre_execution_hooks.extend(other.pre_execution_hooks)
-
-        return self
+    @abc.abstractmethod
+    def __bool__(self) -> bool:
+        ...
 
     @abc.abstractmethod
     def add_to_client(self, writer: clients.ProgressbarClientAware, /) -> HooksAware:
         ...
 
+    @abc.abstractmethod
+    def update(self, other: HooksAware, /) -> HooksAware:
+        ...
+
     @abc.abstractmethod
     def add_pre_execution(self, callback: HookSignatureType, /) -> HooksAware:
         ...

multibar/api/progressbars.py

@@ -7,7 +7,7 @@
 
 from . import sectors
 
-SectorT = typing.TypeVar("SectorT", bound=sectors.SectorAware)
+SectorT = typing.TypeVar("SectorT", bound=sectors.AbstractSector)
 
 
 class ProgressbarAware(abc.ABC, typing.Generic[SectorT]):
@@ -16,7 +16,9 @@ def add_sector(self, sector: SectorT, /) -> ProgressbarAware[SectorT]:
         ...
 
     @abc.abstractmethod
-    def replace_visual(self, sector_pos: int, new_visual: str, /) -> ProgressbarAware[SectorT]:
+    def replace_visual(
+        self, sector_pos: int, new_visual: typing.Union[str, bytes], /
+    ) -> ProgressbarAware[SectorT]:
         ...
 
     @property

multibar/api/sectors.py

@@ -1,6 +1,6 @@
 from __future__ import annotations
 
-__all__ = ("SectorAware",)
+__all__ = ("AbstractSector",)
 
 import abc
 import typing
@@ -11,18 +11,25 @@
 SelfT = typing.TypeVar("SelfT", bound="AbstractSector")
 
 
-class SectorAware(abc.ABC):
+class AbstractSector(abc.ABC):
+    __slots__ = ("_name", "_is_filled", "_position")
+
+    def __init__(self, name: typing.Union[str, bytes], is_filled: bool, position: int) -> None:
+        self._name = name
+        self._is_filled = is_filled
+        self._position = position
+
     @abc.abstractmethod
     def add_to_progressbar(self: SelfT, progressbar: progressbars.ProgressbarAware[SelfT], /) -> SelfT:
         ...
 
     @property
     @abc.abstractmethod
-    def name(self) -> typing.AnyStr:
+    def name(self) -> typing.Union[str, bytes]:
         ...
 
     @abc.abstractmethod
-    def change_name(self, value: str, /) -> SectorAware:
+    def change_name(self, value: typing.Union[str, bytes], /) -> AbstractSector:
         ...
 
     @property

multibar/api/signatures.py

@@ -1,16 +1,20 @@
-__all__ = ("SignatureSegmentProtocol", "ProgressbarSignatureProtocol",)
+__all__ = (
+    "SignatureSegmentProtocol",
+    "ProgressbarSignatureProtocol",
+)
 
 import typing
 
 
 @typing.runtime_checkable
 class SignatureSegmentProtocol(typing.Protocol):
     @property
-    def on_filled(self) -> typing.AnyStr:
+    def on_filled(self) -> typing.Union[str, bytes]:
+        # TODO: mypy has some problems with typing.AnyStr
         raise NotImplementedError
 
     @property
-    def on_unfilled(self) -> typing.AnyStr:
+    def on_unfilled(self) -> typing.Union[str, bytes]:
         raise NotImplementedError
 
 

multibar/api/writers.py

@@ -5,12 +5,10 @@
 import abc
 import typing
 
-from . import signatures
-from . import progressbars
-from . import sectors
 from . import calculation_service as math_operations
+from . import progressbars, sectors, signatures
 
-SectorT = typing.TypeVar("SectorT", bound=sectors.SectorAware)
+SectorT = typing.TypeVar("SectorT", bound=sectors.AbstractSector)
 
 
 class ProgressbarWriterAware(abc.ABC, typing.Generic[SectorT]):
@@ -28,7 +26,7 @@ def write(
         start_value: int,
         end_value: int,
         /,
-    ) -> typing.Optional[progressbars.ProgressbarAware[SectorT]]:
+    ) -> progressbars.ProgressbarAware[SectorT]:
         ...
 
     @typing.overload
@@ -40,7 +38,7 @@ def write(
         /,
         *,
         length: int,
-    ) -> typing.Optional[progressbars.ProgressbarAware[SectorT]]:
+    ) -> progressbars.ProgressbarAware[SectorT]:
         ...
 
     @abc.abstractmethod
@@ -51,7 +49,7 @@ def write(
         /,
         *,
         length: int = 20,
-    ) -> typing.Optional[progressbars.ProgressbarAware[SectorT]]:
+    ) -> progressbars.ProgressbarAware[SectorT]:
         ...
 
     @abc.abstractmethod
@@ -72,10 +70,10 @@ def sector_cls(self) -> typing.Type[SectorT]:
 
     @property
     @abc.abstractmethod
-    def progressbar_cls(self) -> typing.Type[progressbars.ProgressbarAware]:
+    def progressbar_cls(self) -> typing.Type[progressbars.ProgressbarAware[SectorT]]:
         ...
 
     @property
     @abc.abstractmethod
-    def calculation_cls(self) -> typing.Type[math_operations.CalculationServiceAware]:
+    def calculation_cls(self) -> typing.Type[math_operations.AbstractCalculationService]:
         ...

multibar/errors.py

@@ -1,4 +1,5 @@
 from __future__ import annotations
+
 import typing
 
 if typing.TYPE_CHECKING:

multibar/impl/calculation_service.py

@@ -6,17 +6,7 @@
 from multibar.api import calculation_service
 
 
-class ProgressbarCalculationService(calculation_service.CalculationServiceAware):
-    def __init__(
-        self,
-        start_value: typing.Union[int, float],
-        end_value: typing.Union[int, float],
-        length: int,
-    ) -> None:
-        self._start_value = start_value
-        self._end_value = end_value
-        self._length = length
-
+class ProgressbarCalculationService(calculation_service.AbstractCalculationService):
     def calculate_filled_indexes(self) -> iterators.AbstractIterator[int]:
         filled_range = range(round(self.progress_percents / (100 / self._length)))
         return iterators.Iterator(iter(filled_range)).indexes()
@@ -43,5 +33,5 @@ def end_value(self) -> typing.Union[int, float]:
         return self._end_value
 
     @staticmethod
-    def get_progress_percentage(start: int, end: int, /) -> float:
+    def get_progress_percentage(start: typing.Union[int, float], end: typing.Union[int, float], /) -> float:
         return (start / end) * 100