feat(models): add markdown block by zimeg · Pull Request #1748 · slackapi/python-slack-sdk · GitHub
Skip to content

feat(models): add markdown block #1748

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
zimeg merged 1 commit into from
Sep 23, 2025
Merged

feat(models): add markdown block #1748

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions slack_sdk/models/blocks/__init__.py
View file
Open in desktop
43 changes: 42 additions & 1 deletion slack_sdk/models/blocks/blocks.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
import copy
import logging
import warnings
from typing import Dict, Sequence, Optional, Set, Union, Any, List
from typing import Any, Dict, List, Optional, Sequence, Set, Union

from slack_sdk.models import show_unknown_key_warning
from slack_sdk.models.basic_objects import (
Expand Down Expand Up @@ -87,6 +87,8 @@ def parse(cls, block: Union[dict, "Block"]) -> Optional["Block"]:
return CallBlock(**block)
elif type == HeaderBlock.type:
return HeaderBlock(**block)
elif type == MarkdownBlock.type:
return MarkdownBlock(**block)
elif type == VideoBlock.type:
return VideoBlock(**block)
elif type == RichTextBlock.type:
Expand Down Expand Up @@ -523,6 +525,45 @@ def _validate_alt_text_length(self):
return self.text is None or len(self.text.text) <= self.text_max_length


class MarkdownBlock(Block):
type = "markdown"
text_max_length = 12000

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

def __init__(
self,
*,
text: str,
block_id: Optional[str] = None,
**others: dict,
):
"""Displays formatted markdown.
https://docs.slack.dev/reference/block-kit/blocks/markdown-block/

Args:
block_id: A string acting as a unique identifier for a block. If not specified, one will be generated.
Maximum length for this field is 255 characters.
block_id should be unique for each message and each iteration of a message.
If a message is updated, use a new block_id.
text (required): The standard markdown-formatted text. Limit 12,000 characters max.
"""
super().__init__(type=self.type, block_id=block_id)
show_unknown_key_warning(self, others)

self.text = text

@JsonValidator("text attribute must be specified")
def _validate_text(self):
return self.text != ""

@JsonValidator(f"text attribute cannot exceed {text_max_length} characters")
def _validate_alt_text_length(self):
return len(self.text) <= self.text_max_length


class VideoBlock(Block):
type = "video"
title_max_length = 200
Expand Down
36 changes: 35 additions & 1 deletion tests/slack_sdk/models/test_blocks.py
View file
Open in desktop