Crate objects

@dataclass

class ProgressContainer(
    current: int, total: int
)

Expand source code

@dataclass(frozen=True)
class ProgressContainer:
    current: int
    total: int

    @overload
    def percents(self, *, allow_float: Literal[False]) -> int:
        ...

    @overload
    def percents(self, *, allow_float: Literal[True]) -> float:
        ...

    def percents(self, *, allow_float: bool = False) -> Union[int, float]:
        initial = (self.current / self.total) * 100
        if allow_float:
            return initial

        return int(initial)

class ProgressContainer

• current (int) - Current progress value.
• total (int) - Needed progress value.

def percents(
    self, *, allow_float: bool = False,
) -> Union[int, float]:

def percents

Returns percentage of current progress ((current/total) * 100).

• allow_float (bool) - If True, will return float, otherwise - int. Default: False.

@dataclass

class ProgressbarContainer(
    length: int
    progress: ProgressContainer
    bar: AbstractBaseContainerMixin[_AbcSectorT_co] = field(repr=False)
)

Expand source code

@dataclass(frozen=True, order=True)
class ProgressbarContainer(Comparable, Sized, Generic[_AbcSectorT_co]):
    """``dataclass``
    Class that represents progressbar state.

    Parameters:
    -----------
    length: :class:`int`
        Length of progress bar.

    state: :class:`ProgressContainer`
        Progress state.

    bar: :class:`AbstractSeqBasedContainerMixin[_AbcSectorT_co]`
        Progress bar container.
    """

    length: int
    state: ProgressContainer
    bar: AbstractSeqBasedContainerMixin[_AbcSectorT_co] = field(repr=False)

    def __eq__(self, other: Any) -> bool:
        if isinstance(other, ProgressbarContainer):
            return self.state.current == other.state.current and self.state.total == other.state.total

        return NotImplemented

    def __hash__(self) -> int:
        return hash((self.state.current, self.state.total))

    def __len__(self) -> int:
        return len(self.bar)

    @overload
    def __getitem__(
        self,
        item: int,
    ) -> _AbcSectorT_co:
        ...

    @overload
    def __getitem__(
        self,
        item: slice,
    ) -> Iterable[_AbcSectorT_co]:
        ...

    def __getitem__(
        self,
        item: Union[int, slice],
    ) -> Union[_AbcSectorT_co, Iterable[_AbcSectorT_co]]:
        return self.bar[item]

class ProgressbarContainer

• length (int) - Length of progress bar.
• progress (ProgressContainer) - Progress container object.
• bar (AbstractBaseContainerMixin[_AbcSectorT_co]) - Container that stores progressbar sectors. Default: dataclass.field(repr=False).

class SectorContainer()

Expand source code

@dataclass
class SectorContainer(AbstractSeqBasedContainerMixin[_AbcSectorT_co]):
    """``dataclass``
    Simple implementation of sequence-based Sector container.
    """

    def __post_init__(self) -> None:
        self._storage: List[_AbcSectorT_co] = []

    def __repr__(self) -> str:
        return "".join(s.name for s in self._storage)

    def __len__(self) -> int:
        return len(self._storage)

    @overload
    def __getitem__(
        self,
        item: int,
    ) -> _AbcSectorT_co:
        ...

    @overload
    def __getitem__(
        self,
        item: slice,
    ) -> Iterable[_AbcSectorT_co]:
        ...

    def __getitem__(
        self,
        item: Union[int, slice],
    ) -> Union[Iterable[_AbcSectorT_co], _AbcSectorT_co]:
        return self._storage[item]

    def put(self, item: AbstractSectorMixin) -> None:
        self._storage.append(cast(_AbcSectorT_co, item))

    @property
    def view(self) -> List[_AbcSectorT_co]:
        return self._storage

def put(self, item: AbstractSectorMixin) -> None:

def put

Puts item to storage.

• item (AbstractSectorMixin) - Any Sector object.

def finalize(self) -> None:

def finalize

Method that used in __exit__.

@property
def view(self) -> List[_AbcSectorT_co]:

@property view

Returns iterator over sectors.