feat(block-kit): add card block example - #102
Draft
zimeg wants to merge 4 commits into
Draft
Conversation
Add a Block Kit card block example mirroring the official docs example, constructed with the slack_sdk CardBlock type (icon, title, subtitle, hero image, body, and an action button). Includes a test asserting the produced block matches the expected JSON and a README bullet. Docs: https://docs.slack.dev/reference/block-kit/blocks/card-block Co-Authored-By: Claude <svc-devxp-claude@slack-corp.com>
zimeg
added
enhancement
Examples should not carry type-checker suppressions. Remove the # type: ignore[arg-type] on the ImageElement icon/hero_image args. Until slackapi/python-slack-sdk#1937 lands (widening CardBlock.icon / hero_image to accept an image element), mypy reports [arg-type] here by design — the honest signal that slack_sdk mis-types these fields as str. Co-Authored-By: Claude <svc-devxp-claude@slack-corp.com>
Member
Author
|
The example builds → slackapi/python-slack-sdk#1937 widens those params to accept an image element. Once #1937 lands and releases, this PR's mypy step goes green with no code change here. Tracking so it's not merged/forgotten in the red state. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds a Block Kit card block example to the
block-kitshowcase, mirroring the official docs example. The example is constructed using the SDK-providedCardBlocktype (imported fromslack_sdk.models.blocks) with an icon, title, subtitle, hero image, body, and an action button.block-kit/src/blocks/card.py—example01()returning aCardBlockblock-kit/tests/blocks/test_card.py— asserts the produced block deep-equals the expected JSON literalblock-kit/README.md— adds the Card bullet (alphabetical, with docs + implementation links)Docs
https://docs.slack.dev/reference/block-kit/blocks/card-block
The example JSON mirrors the docs page (icon, title "Lumon Industries", subtitle, hero image, body, single action button).
Notes
iconandhero_imageare passed asImageElementinstances (matching the neighboringcarousel.pyexample and the docs JSON, which render image element objects). The installedslack_sdk3.42.0 type stub annotates these params asstr, so a targeted# type: ignore[arg-type]is applied — runtime serialization produces the correct{"type": "image", ...}output, verified by the test.Validation
Ran the repo's CI-equivalent checks for the
block-kitshowcase (Python 3.13,slack_sdk3.42.0):ruff check— passedruff format --diff --check— passed (34 files already formatted)mypy ./**/*.py— passed (no issues in 34 source files)pytest— passed (33 passed, including the newtest_card.py)Co-Authored-By: Claude svc-devxp-claude@slack-corp.com
🤖 Generated with Claude Code