feat(methods): add chat.postMessage example by zimeg · Pull Request #132 · slack-samples/bolt-python-examples

zimeg · 2026-07-14T23:48:08Z

Summary

Adds a methods/ chat.postMessage example to the Bolt for Python examples — the first entry in a new methods/ showcase of individual Slack Web API method calls with the slack_sdk WebClient.

src/chat/chat_post_message.py reads a token from the environment, initializes a WebClient, and calls chat_postMessage.
The example is a flat, top-to-bottom script with a manifest.json requesting only chat:write.
methods/README.md documents the family and links the implementation; the top-level README lists the new showcase.

The example is validated in CI by ruff (lint/format) and mypy — slack_sdk's typed keyword arguments catch wrong types, missing required args, and misspelled arguments at check time.

Testing

From methods/:

export SLACK_TOKEN="xoxb-..."
slack install --environment local
python -m src.chat.chat_post_message

Confirm the message posts to the configured channel.

Supersedes the runtime-test / mock-server exploration in #131 (closed).

🤖 Generated with Claude Code

Add a methods/ chat.postMessage example verified by ruff + mypy, with no runtime test. slack_sdk's chat_postMessage has typed keyword arguments, so mypy catches wrong types, missing required args, and misspelled arguments (e.g. chnnel -> "Missing named argument channel") without a mock server. This is an alternative to the mock-server runtime-test approach for side-by-side comparison. Co-Authored-By: Claude <svc-devxp-claude@slack-corp.com>

Add methods to the CI matrix and treat pytest exit code 5 ("no tests collected") as success, so the type-check-only methods example (which has no tests) passes CI while still running ruff and mypy. Real test failures (exit 1) still fail the build. Co-Authored-By: Claude <svc-devxp-claude@slack-corp.com>

Match the runtime branch: add a chat manifest.json requesting only chat:write, move the scope out of the README into the manifest, and use the method's exact docs description. Co-Authored-By: Claude <svc-devxp-claude@slack-corp.com>

zimeg · 2026-07-31T06:15:08Z

+          # Exit code 5 = "no tests collected" (e.g. type-check-only showcases); treat as success.
+          pytest -v || [ $? -eq 5 ]


🧪 https://docs.pytest.org/en/7.1.x/reference/exit-codes.html

Mirror the bolt-js-examples methods README: tighten the intro, add a 'Making a request' walkthrough, and rename 'What's on display' to 'What's on call'. Adapt the run flow to Python — the walkthrough runs from the package root (cd methods) so 'python -m src.chat.chat_post_message' resolves.

Flatten the example into a top-level script matching the bolt-js counterpart: read the token, initialize the client, call the method. Drops the example01() wrapper, __main__ block, and the now-unused SlackResponse import.

# Conflicts: # .github/workflows/test.yml

The CI 'Run tests' step invokes pytest, but methods only pinned mypy, ruff, and slack_sdk — so pytest failed with 'command not found' (exit 127), which the '|| [ $? -eq 5 ]' no-tests guard doesn't catch. Install pytest (matching block-kit's pin) so it runs, collects no tests, and exits 5 — which the guard treats as success.

Revert adding pytest to methods requirements; instead gate the pytest invocation on a tests/ directory. methods is type-check-only and ships no tests, so pytest was failing with 'command not found'. Guarding on [ -d tests ] skips it cleanly for methods while still running tests (and surfacing real failures) for showcases that have them.

Match the methods entry to its README: 'An interface for querying information from and enacting change in a Slack workspace' rather than the outdated 'Individual Slack Web API method calls' phrasing.

The example reads one variable (SLACK_TOKEN), so 'an environment variable' is more accurate than the plural.

zimeg

👁️‍🗨️ A neartime is arrived!

zimeg · 2026-08-12T05:33:04Z

+{
+  "display_information": {
+    "name": "Slack API Methods",
+    "description": "Example implementations to call \"chat\" methods"


🗣️ note: We prefer method names in description to avoid character limits.

zimeg · 2026-08-12T05:33:34Z

@@ -0,0 +1,21 @@
+# Methods
+
+An interface for querying information from and enacting change in a Slack workspace.


🤓 note: Most wording is gathered from docs upstream if found.

Co-authored-by: Eden Zimbelman <zim@o526.net>

srtaalej

⭐ working great thank you for this change 💟

zimeg and others added 3 commits July 14, 2026 16:47

zimeg commented Jul 31, 2026

View reviewed changes

zimeg mentioned this pull request Aug 10, 2026

feat(methods): add chat.postMessage example #131

Closed

zimeg added 3 commits August 11, 2026 20:33

refactor(methods): inline the chat.postMessage example

682a665

Flatten the example into a top-level script matching the bolt-js counterpart: read the token, initialize the client, call the method. Drops the example01() wrapper, __main__ block, and the now-unused SlackResponse import.

Merge remote-tracking branch 'origin/main' into methods-typecheck-only

7baceaf

# Conflicts: # .github/workflows/test.yml

zimeg changed the title ~~feat(methods): add chat.postMessage example (typecheck-only)~~ feat(methods): add chat.postMessage example Aug 12, 2026

zimeg added 3 commits August 11, 2026 22:16

docs: align methods description in the examples list

9e9205f

Match the methods entry to its README: 'An interface for querying information from and enacting change in a Slack workspace' rather than the outdated 'Individual Slack Web API method calls' phrasing.

zimeg added new PR only - a new app is being introduced python Pull requests that update python code labels Aug 12, 2026

zimeg self-assigned this Aug 12, 2026

zimeg added the documentation Improvements or additions to documentation label Aug 12, 2026

zimeg added 2 commits August 11, 2026 22:27

docs: cli steps

17053e7

docs(methods): correct token comment to singular

b3f1dc5

The example reads one variable (SLACK_TOKEN), so 'an environment variable' is more accurate than the plural.

zimeg commented Aug 12, 2026

View reviewed changes

style: removing comments from output

de7af48

Co-authored-by: Eden Zimbelman <zim@o526.net>

zimeg marked this pull request as ready for review August 12, 2026 05:35

zimeg requested a review from a team as a code owner August 12, 2026 05:35

Merge branch 'main' into methods-typecheck-only

802cac2

srtaalej approved these changes Aug 12, 2026

View reviewed changes

Navigation Menu

Uh oh!

feat(methods): add chat.postMessage example - #132

feat(methods): add chat.postMessage example#132
zimeg wants to merge 13 commits into
mainfrom
methods-typecheck-only

zimeg commented Jul 14, 2026 •

edited

Loading

Uh oh!

zimeg Jul 31, 2026

Uh oh!

zimeg left a comment

Uh oh!

Uh oh!

zimeg Aug 12, 2026

Uh oh!

zimeg Aug 12, 2026

Uh oh!

srtaalej left a comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

		# Exit code 5 = "no tests collected" (e.g. type-check-only showcases); treat as success.
		pytest -v \|\| [ $? -eq 5 ]

		@@ -0,0 +1,21 @@
		# Methods

		An interface for querying information from and enacting change in a Slack workspace.

Uh oh!

Conversation

zimeg commented Jul 14, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Testing

Uh oh!

zimeg Jul 31, 2026

Choose a reason for hiding this comment

Uh oh!

zimeg left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

zimeg Aug 12, 2026

Choose a reason for hiding this comment

Uh oh!

zimeg Aug 12, 2026

Choose a reason for hiding this comment

Uh oh!

srtaalej left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

zimeg commented Jul 14, 2026 •

edited

Loading