Module slack_sdk.models.messages.chunk

Classes

class Chunk (*, type: str | None = None)
Expand source code 
class Chunk(JsonObject):
    """
    Chunk for streaming messages.

    https://docs.slack.dev/messaging/sending-and-scheduling-messages#text-streaming
    """

    attributes = {"type"}
    logger = logging.getLogger(__name__)

    def __init__(
        self,
        *,
        type: Optional[str] = None,
    ):
        self.type = type

    @classmethod
    def parse(cls, chunk: Union[Dict, "Chunk"]) -> Optional["Chunk"]:
        if chunk is None:
            return None
        elif isinstance(chunk, Chunk):
            return chunk
        else:
            if "type" in chunk:
                type = chunk["type"]
                if type == MarkdownTextChunk.type:
                    return MarkdownTextChunk(**chunk)
                elif type == PlanUpdateChunk.type:
                    return PlanUpdateChunk(**chunk)
                elif type == TaskUpdateChunk.type:
                    return TaskUpdateChunk(**chunk)
                else:
                    cls.logger.warning(f"Unknown chunk detected and skipped ({chunk})")
                    return None
            else:
                cls.logger.warning(f"Unknown chunk detected and skipped ({chunk})")
                return None

Chunk for streaming messages.

https://docs.slack.dev/messaging/sending-and-scheduling-messages#text-streaming

Ancestors

Subclasses

Class variables

var attributes

The type of the None singleton.

var logger

The type of the None singleton.

Static methods

def parse(chunk: Dict | ForwardRef('Chunk')) ‑> Chunk | None

Inherited members

class MarkdownTextChunk (*, text: str, **others: Dict)
Expand source code 
class MarkdownTextChunk(Chunk):
    type = "markdown_text"

    @property
    def attributes(self) -> Set[str]:  # type: ignore[override]
        return super().attributes.union({"text"})

    def __init__(
        self,
        *,
        text: str,
        **others: Dict,
    ):
        """Used for streaming text content with markdown formatting support.

        https://docs.slack.dev/messaging/sending-and-scheduling-messages#text-streaming
        """
        super().__init__(type=self.type)
        show_unknown_key_warning(self, others)

        self.text = text

Chunk for streaming messages.

https://docs.slack.dev/messaging/sending-and-scheduling-messages#text-streaming

Used for streaming text content with markdown formatting support.

https://docs.slack.dev/messaging/sending-and-scheduling-messages#text-streaming

Ancestors

Class variables

var type

The type of the None singleton.

Instance variables

prop attributes : Set[str]
Expand source code 
@property
def attributes(self) -> Set[str]:  # type: ignore[override]
    return super().attributes.union({"text"})

Build an unordered collection of unique elements.

Inherited members

class PlanUpdateChunk (*, title: str, **others: Dict)
Expand source code 
class PlanUpdateChunk(Chunk):
    type = "plan_update"

    @property
    def attributes(self) -> Set[str]:  # type: ignore[override]
        return super().attributes.union({"title"})

    def __init__(
        self,
        *,
        title: str,
        **others: Dict,
    ):
        """Used for displaying an updated title of a plan.

        https://docs.slack.dev/messaging/sending-and-scheduling-messages#text-streaming
        """
        super().__init__(type=self.type)
        show_unknown_key_warning(self, others)

        self.title = title

Chunk for streaming messages.

https://docs.slack.dev/messaging/sending-and-scheduling-messages#text-streaming

Used for displaying an updated title of a plan.

https://docs.slack.dev/messaging/sending-and-scheduling-messages#text-streaming

Ancestors

Class variables

var type

The type of the None singleton.

Instance variables

prop attributes : Set[str]
Expand source code 
@property
def attributes(self) -> Set[str]:  # type: ignore[override]
    return super().attributes.union({"title"})

Build an unordered collection of unique elements.

Inherited members

class TaskUpdateChunk (*,
id: str,
title: str,
status: str,
details: str | None = None,
output: str | None = None,
sources: Sequence[Dict | UrlSourceElement] | None = None,
**others: Dict)
Expand source code 
class TaskUpdateChunk(Chunk):
    type = "task_update"

    @property
    def attributes(self) -> Set[str]:  # type: ignore[override]
        return super().attributes.union(
            {
                "id",
                "title",
                "status",
                "details",
                "output",
                "sources",
            }
        )

    def __init__(
        self,
        *,
        id: str,
        title: str,
        status: str,  # "pending", "in_progress", "complete", "error"
        details: Optional[str] = None,
        output: Optional[str] = None,
        sources: Optional[Sequence[Union[Dict, UrlSourceElement]]] = None,
        **others: Dict,
    ):
        """Used for displaying task progress in a timeline-style UI.

        https://docs.slack.dev/messaging/sending-and-scheduling-messages#text-streaming
        """
        super().__init__(type=self.type)
        show_unknown_key_warning(self, others)

        self.id = id
        self.title = title
        self.status = status
        self.details = details
        self.output = output
        self.sources = sources

Chunk for streaming messages.

https://docs.slack.dev/messaging/sending-and-scheduling-messages#text-streaming

Used for displaying task progress in a timeline-style UI.

https://docs.slack.dev/messaging/sending-and-scheduling-messages#text-streaming

Ancestors

Class variables

var type

The type of the None singleton.

Instance variables

prop attributes : Set[str]
Expand source code 
@property
def attributes(self) -> Set[str]:  # type: ignore[override]
    return super().attributes.union(
        {
            "id",
            "title",
            "status",
            "details",
            "output",
            "sources",
        }
    )

Build an unordered collection of unique elements.

Inherited members