4.0.0 refactoring - finished the tests

Author: InspiredImpact

multibar/__init__.py

@@ -2,27 +2,28 @@
 from .impl import *
 
 __all__ = (
-    "CalculationServiceAware",
+    "AbstractCalculationService",
     "ProgressbarClientAware",
     "ContractAware",
     "ContractCheck",
     "ContractManagerAware",
     "HookSignatureType",
     "HooksAware",
     "ProgressbarAware",
-    "SectorAware",
+    "AbstractSector",
     "SignatureSegmentProtocol",
     "ProgressbarSignatureProtocol",
     "ProgressbarWriterAware",
     "ProgressbarCalculationService",
     "ProgressbarClient",
     "ContractManager",
     "WriteProgressContract",
+    "WRITE_PROGRESS_CONTRACT",
     "Hooks",
     "WRITER_HOOKS",
     "Progressbar",
     "Sector",
-    "Signature",
+    "SimpleSignature",
     "SignatureSegment",
     "ProgressbarWriter",
 )

multibar/api/clients.py

@@ -9,7 +9,7 @@
 from . import hooks as hooks_
 
 if typing.TYPE_CHECKING:
-    from multibar.api import progressbars, sectors
+    from multibar.api import progressbars, sectors, writers
 
 
 class ProgressbarClientAware(abc.ABC):
@@ -20,7 +20,7 @@ def get_progress(
         start_value: int,
         end_value: int,
         /,
-    ) -> typing.Optional[progressbars.ProgressbarAware[sectors.AbstractSector]]:
+    ) -> progressbars.ProgressbarAware[sectors.AbstractSector]:
         ...
 
     @abc.abstractmethod
@@ -32,7 +32,7 @@ def get_progress(
         /,
         *,
         length: int,
-    ) -> typing.Optional[progressbars.ProgressbarAware[sectors.AbstractSector]]:
+    ) -> progressbars.ProgressbarAware[sectors.AbstractSector]:
         ...
 
     @abc.abstractmethod
@@ -43,7 +43,7 @@ def get_progress(
         /,
         *,
         length: int = 20,
-    ) -> typing.Optional[progressbars.ProgressbarAware[sectors.AbstractSector]]:
+    ) -> progressbars.ProgressbarAware[sectors.AbstractSector]:
         ...
 
     @abc.abstractmethod
@@ -63,3 +63,8 @@ def hooks(self) -> hooks_.HooksAware:
     @abc.abstractmethod
     def contract_manager(self) -> contracts.ContractManagerAware:
         ...
+
+    @property
+    @abc.abstractmethod
+    def writer(self) -> writers.ProgressbarWriterAware[sectors.AbstractSector]:
+        ...

multibar/api/contracts.py

@@ -81,6 +81,10 @@ def subscribe(self, contract: ContractAware, /) -> None:
     def terminate(self, contract: ContractAware, /) -> None:
         ...
 
+    @abc.abstractmethod
+    def terminate_all(self) -> None:
+        ...
+
     @abc.abstractmethod
     def set_raise_errors(self, value: bool, /) -> None:
         ...
@@ -89,3 +93,8 @@ def set_raise_errors(self, value: bool, /) -> None:
     @abc.abstractmethod
     def contracts(self) -> list[ContractAware]:
         ...
+
+    @property
+    @abc.abstractmethod
+    def raise_errors(self) -> bool:
+        ...

multibar/api/hooks.py

@@ -20,7 +20,7 @@ class HooksAware(abc.ABC):
     __slots__ = ()
 
     @abc.abstractmethod
-    def __bool__(self) -> bool:
+    def __len__(self) -> int:
         ...
 
     @abc.abstractmethod

multibar/api/progressbars.py

@@ -11,13 +11,27 @@
 
 
 class ProgressbarAware(abc.ABC, typing.Generic[SectorT]):
+    @typing.overload
+    @abc.abstractmethod
+    def __getitem__(self, item: slice) -> typing.Sequence[SectorT]:
+        ...
+
+    @typing.overload
+    @abc.abstractmethod
+    def __getitem__(self, item: int) -> SectorT:
+        ...
+
+    @abc.abstractmethod
+    def __getitem__(self, item: typing.Any) -> typing.Any:
+        ...
+
     @abc.abstractmethod
     def add_sector(self, sector: SectorT, /) -> ProgressbarAware[SectorT]:
         ...
 
     @abc.abstractmethod
     def replace_visual(
-        self, sector_pos: int, new_visual: typing.Union[str, bytes], /
+        self, sector_pos: int, new_visual: str, /
     ) -> ProgressbarAware[SectorT]:
         ...
 

multibar/api/sectors.py

@@ -14,7 +14,7 @@
 class AbstractSector(abc.ABC):
     __slots__ = ("_name", "_is_filled", "_position")
 
-    def __init__(self, name: typing.Union[str, bytes], is_filled: bool, position: int) -> None:
+    def __init__(self, name: str, is_filled: bool, position: int) -> None:
         self._name = name
         self._is_filled = is_filled
         self._position = position
@@ -23,13 +23,13 @@ def __init__(self, name: typing.Union[str, bytes], is_filled: bool, position: in
     def add_to_progressbar(self: SelfT, progressbar: progressbars.ProgressbarAware[SelfT], /) -> SelfT:
         ...
 
-    @property
     @abc.abstractmethod
-    def name(self) -> typing.Union[str, bytes]:
+    def change_name(self, value: str, /) -> AbstractSector:
         ...
 
+    @property
     @abc.abstractmethod
-    def change_name(self, value: typing.Union[str, bytes], /) -> AbstractSector:
+    def name(self) -> str:
         ...
 
     @property

multibar/api/signatures.py

@@ -9,12 +9,11 @@
 @typing.runtime_checkable
 class SignatureSegmentProtocol(typing.Protocol):
     @property
-    def on_filled(self) -> typing.Union[str, bytes]:
-        # TODO: mypy has some problems with typing.AnyStr
+    def on_filled(self) -> str:
         raise NotImplementedError
 
     @property
-    def on_unfilled(self) -> typing.Union[str, bytes]:
+    def on_unfilled(self) -> str:
         raise NotImplementedError
 
 

multibar/errors.py

@@ -3,7 +3,7 @@
 import typing
 
 if typing.TYPE_CHECKING:
-    from .api import contracts
+    from multibar.api import contracts
 
 
 class MultibarError(Exception):
@@ -14,17 +14,21 @@ class ContractError(MultibarError):
     pass
 
 
-class UnsignedContractError(ContractError):
-    pass
-
-
-class TerminatedContractError(ContractError):
+class ContractResponseError(ContractError):
     __slots__ = ("contract_check",)
 
-    def __init__(self, *, check: contracts.ContractCheck) -> None:
+    def __init__(self, check: contracts.ContractCheck, /) -> None:
         self.contract_check = check
         super().__init__(self._process_check())
 
     def _process_check(self) -> str:
         messages = self.contract_check.errors + self.contract_check.warnings
         return " & ".join(messages)
+
+
+class UnsignedContractError(ContractError):
+    pass
+
+
+class TerminatedContractError(ContractResponseError):
+    pass

multibar/impl/__init__.py

@@ -12,11 +12,12 @@
     "ProgressbarClient",
     "ContractManager",
     "WriteProgressContract",
+    "WRITE_PROGRESS_CONTRACT",
     "Hooks",
     "WRITER_HOOKS",
     "Progressbar",
     "Sector",
-    "Signature",
+    "SimpleSignature",
     "SignatureSegment",
     "ProgressbarWriter",
 )

multibar/impl/clients.py

@@ -51,7 +51,7 @@ def get_progress(
         /,
         *,
         length: int = 20,
-    ) -> typing.Optional[abc_progressbars.ProgressbarAware[abc_sectors.AbstractSector]]:
+    ) -> abc_progressbars.ProgressbarAware[abc_sectors.AbstractSector]:
         writer = self._writer
         call_metadata: progress_types.ProgressMetadataType = {
             "calculation_service_cls": writer.calculation_cls,
@@ -86,3 +86,7 @@ def hooks(self) -> abc_hooks.HooksAware:
     @property
     def contract_manager(self) -> abc_contracts.ContractManagerAware:
         return self._contract_manager
+
+    @property
+    def writer(self) -> abc_writers.ProgressbarWriterAware[abc_sectors.AbstractSector]:
+        return self._writer