PubSubRouter class¶

def include_router(self, router: "PubSubRouter") -> None:
    """Includes a child router in the current router.

    Args:
        router: The router to include.
    """
    if not (router and isinstance(router, PubSubRouter)):
        raise FastPubSubException(
            f"Your routers must be of type {self.__class__.__name__}"
        )

    if self == router:
        # V2: Create a algorithm to detect cycles on these routers.
        # For now, let us assume that the router is well configured
        # and this is the only error case.
        raise FastPubSubException(
            f"There is a cyclical reference on router {self.prefix}."
        )

    router._add_prefix(self.prefix)
    router._set_project_id(self.project_id)

    for middleware, args, kwargs in self.middlewares:
        router.include_middleware(middleware, *args, **kwargs)

    self.routers.append(router)

@validate_call(
    config=ConfigDict(strict=True, arbitrary_types_allowed=True)
)
def subscriber(
    self,
    alias: str,
    *,
    topic_name: str,
    subscription_name: str,
    project_id: str = "",
    autocreate: bool = True,
    autoupdate: bool = False,
    filter_expression: str = "",
    dead_letter_topic: str = "",
    max_delivery_attempts: int = 5,
    ack_deadline_seconds: int = 60,
    enable_message_ordering: bool = False,
    enable_exactly_once_delivery: bool = False,
    min_backoff_delay_secs: int = 10,
    max_backoff_delay_secs: int = 600,
    max_messages: int = 1000,
    middlewares: Sequence[Middleware] = (),
) -> SubscribedCallable:
    """Decorator to register a function as a subscriber.

    Args:
        alias: A unique name for the subscriber. You can use this alias to
            select which subscription to use on the CLI.
        topic_name: The name of the topic to subscribe to.
        subscription_name: The name of the subscription for the topic.
        project_id: An alternative project id to create a subscription
            and consume messages from. If set the router project id
            will be ignored.
        autocreate: Automatically creates the topic and
            subscription if they do not exists.
        autoupdate: Automatically updates the subscription.
        filter_expression: A filter expression to apply to the
            subscription to filter messages.
        dead_letter_topic: The name of the dead-letter topic.
        max_delivery_attempts: The maximum number of delivery attempts
            before sending the message to the dead-letter.
        ack_deadline_seconds: The acknowledgment deadline in seconds.
        enable_message_ordering: Enables message ordering.
            It can only be set when creating the subscription.
        enable_exactly_once_delivery: Enables exactly-once delivery.
            It can only be set when creating the subscription.
        min_backoff_delay_secs: The minimum backoff delay in seconds.
        max_backoff_delay_secs: The maximum backoff delay in seconds.
        max_messages: The maximum number of messages to fetch from
            the broker at a time.
        middlewares: A sequence of middlewares to apply to the subscriber.
            It is subscriber specific, not application-wide.

    Returns:
        A decorator that registers the function as a subscriber.
    """

    def decorator(func: AsyncDecoratedCallable) -> AsyncDecoratedCallable:
        ensure_async_callable_function(func)

        prefixed_alias = alias
        prefixed_subscription_name = subscription_name

        if self.prefix and isinstance(self.prefix, str):
            prefixed_alias = f"{self.prefix}.{prefixed_alias}"
            prefixed_subscription_name = (
                f"{self.prefix}.{prefixed_subscription_name}"
            )

        if prefixed_alias in self.subscribers:
            raise FastPubSubException(
                f"The alias '{prefixed_alias}' already exists."
                " The alias must be unique among all subscribers"
            )

        dead_letter_policy = None
        if dead_letter_topic:
            dead_letter_policy = DeadLetterPolicy(
                topic_name=dead_letter_topic,
                max_delivery_attempts=max_delivery_attempts,
            )

        retry_policy = MessageRetryPolicy(
            min_backoff_delay_secs=min_backoff_delay_secs,
            max_backoff_delay_secs=max_backoff_delay_secs,
        )

        delivery_policy = MessageDeliveryPolicy(
            filter_expression=filter_expression,
            ack_deadline_seconds=ack_deadline_seconds,
            enable_message_ordering=enable_message_ordering,
            enable_exactly_once_delivery=enable_exactly_once_delivery,
        )

        lifecycle_policy = LifecyclePolicy(
            autocreate=autocreate, autoupdate=autoupdate
        )

        control_flow_policy = MessageControlFlowPolicy(
            max_messages=max_messages,
        )

        subscriber_middlewares = list(middlewares) if middlewares else []
        for middleware in self.middlewares:
            subscriber_middlewares.append(middleware)

        chosen_project_id = project_id or self.project_id
        subscriber = Subscriber(
            func=func,
            topic_name=topic_name,
            subscription_name=prefixed_subscription_name,
            retry_policy=retry_policy,
            delivery_policy=delivery_policy,
            lifecycle_policy=lifecycle_policy,
            control_flow_policy=control_flow_policy,
            dead_letter_policy=dead_letter_policy,
            middlewares=subscriber_middlewares,
            project_id=chosen_project_id,
        )
        self.subscribers[prefixed_alias.lower()] = subscriber
        return func

    return decorator

@validate_call(config=ConfigDict(strict=True))
def publisher(self, topic_name: str, project_id: str = "") -> Publisher:
    """Returns a publisher for the given topic.

    Args:
        topic_name: The name of the topic.
        project_id: An alternative project id to publish messages.
                    If set the router project id will be ignored.

    Returns:
        A publisher for the given topic.
    """
    chosen_project_id = project_id or self.project_id
    publisher = Publisher(
        topic_name=topic_name,
        project_id=chosen_project_id,
        middlewares=self.middlewares,
    )
    self.publishers.add(publisher)
    return publisher

@validate_call(config=ConfigDict(strict=True))
async def publish(
    self,
    topic_name: str,
    data: dict[str, Any] | str | bytes | BaseModel,
    project_id: str = "",
    ordering_key: str = "",
    attributes: dict[str, str] | None = None,
    autocreate: bool = True,
) -> None:
    """Publishes a message to the given topic.

    Args:
        topic_name: The name of the topic.
        data: The message data.
        project_id: An alternative project id to publish messages.
                    If set the router project id will be ignored.
        ordering_key: The ordering key for the message.
        attributes: A dictionary of message attributes.
        autocreate: Automatically creates the topic if it does not exists.
    """
    publisher = self.publisher(
        topic_name=topic_name, project_id=project_id
    )
    await publisher.publish(
        data=data,
        ordering_key=ordering_key,
        attributes=attributes,
        autocreate=autocreate,
    )

@validate_call(config=ConfigDict(strict=True))
def include_middleware(
    self, middleware: type[BaseMiddleware], *args: Any, **kwargs: Any
) -> None:
    """Includes a middleware in the router.

    Args:
        middleware: The middleware to include.
        args: The positional arguments used on middleware instantiation.
        kwargs: The keyword  arguments used on middleware instantiation.
    """
    for publisher in self.publishers:
        publisher.include_middleware(middleware, *args, **kwargs)

    for subscriber in self.subscribers.values():
        subscriber.include_middleware(middleware, *args, **kwargs)

    for router in self.routers:
        router.include_middleware(middleware, *args, **kwargs)

    wrapper_middleware = Middleware(middleware, *args, **kwargs)
    if wrapper_middleware not in self.middlewares:
        self.middlewares.append(wrapper_middleware)