PubSubClient

Bases: Subscribe

Synchronous Redis Publish/Subscribe Client.

Supports channel subscription, unsubscription, pattern-based subscriptions, and listening for incoming messages synchronously.

Source code in pyredis/client/pubsub.py

class PubSubClient(commands.Subscribe):
    """
    Synchronous Redis Publish/Subscribe Client.

    Supports channel subscription, unsubscription, pattern-based subscriptions,
    and listening for incoming messages synchronously.
    """

    def __init__(self, **kwargs):
        """
        Initialize the PubSubClient connection.

        Args:
            **kwargs: Connection options forwarded to Connection.
        """
        self._conn = pyredis.client.Connection(**kwargs)

    def close(self):
        """Close the underlying connection."""
        self._conn.close()

    @property
    def closed(self):
        """Flag indicating if the connection is closed."""
        return self._conn.closed

    def write(self, *args):
        """
        Write a command to the underlying connection.

        Args:
            *args: Command name and arguments.
        """
        return self._conn.write(*args)

    def get(self):
        """
        Read the next message/response from the connection.

        Returns:
            The message or response read from Redis.
        """
        return self._conn.read(close_on_timeout=False)

closed property

Flag indicating if the connection is closed.

__init__(**kwargs)

Initialize the PubSubClient connection.

Parameters:

Name	Type	Description	Default
**kwargs		Connection options forwarded to Connection.	{}

Source code in pyredis/client/pubsub.py

def __init__(self, **kwargs):
    """
    Initialize the PubSubClient connection.

    Args:
        **kwargs: Connection options forwarded to Connection.
    """
    self._conn = pyredis.client.Connection(**kwargs)

close()

Close the underlying connection.

Source code in pyredis/client/pubsub.py

def close(self):
    """Close the underlying connection."""
    self._conn.close()

get()

Read the next message/response from the connection.

Returns:

Type	Description
	The message or response read from Redis.

Source code in pyredis/client/pubsub.py

def get(self):
    """
    Read the next message/response from the connection.

    Returns:
        The message or response read from Redis.
    """
    return self._conn.read(close_on_timeout=False)

psubscribe(*args)

Source code in pyredis/commands/subscribe.py

def psubscribe(self, *args):
    return self.write(
        *[b"PSUBSCRIBE", *args]
    )

punsubscribe(*args)

Source code in pyredis/commands/subscribe.py

def punsubscribe(self, *args):
    return self.write(
        *[b"PUNSUBSCRIBE", *args]
    )

subscribe(*args)

Source code in pyredis/commands/subscribe.py

def subscribe(self, *args):
    return self.write(
        *[b"SUBSCRIBE", *args]
    )

unsubscribe(*args)

Source code in pyredis/commands/subscribe.py

def unsubscribe(self, *args):
    return self.write(
        *[b"UNSUBSCRIBE", *args]
    )

write(*args)

Write a command to the underlying connection.

Parameters:

Name	Type	Description	Default
*args		Command name and arguments.	()

Source code in pyredis/client/pubsub.py

def write(self, *args):
    """
    Write a command to the underlying connection.

    Args:
        *args: Command name and arguments.
    """
    return self._conn.write(*args)