Skip to content

Unsubscribable class

Bases: ABC

An abstract base class representing an object that can be unsubscribed from a subscribed source.

Source code in pyventus/core/subscriptions/unsubscribable.py 
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
class Unsubscribable(ABC):
    """An abstract base class representing an object that can be unsubscribed from a subscribed source."""

    # Allow subclasses to define __slots__
    __slots__ = ()

    @abstractmethod
    def unsubscribe(self) -> bool:
        """
        Release or clean up any resources associated with the subscribed source.

        :return: `True` if the unsubscribe operation was successful; `False` if it was already unsubscribed.
        :raises Exception: Any exception raised during the unsubscription process.
        """
        pass

Functions

unsubscribe abstractmethod 

unsubscribe() -> bool

Release or clean up any resources associated with the subscribed source.

RETURNS DESCRIPTION
bool

True if the unsubscribe operation was successful; False if it was already unsubscribed.
RAISES DESCRIPTION
Exception

Any exception raised during the unsubscription process.
Source code in pyventus/core/subscriptions/unsubscribable.py 
10
11
12
13
14
15
16
17
18
@abstractmethod
def unsubscribe(self) -> bool:
    """
    Release or clean up any resources associated with the subscribed source.

    :return: `True` if the unsubscribe operation was successful; `False` if it was already unsubscribed.
    :raises Exception: Any exception raised during the unsubscription process.
    """
    pass