Skip to content

Releases: slackapi/python-slack-sdk

version 3.11.0

14 Sep 08:12
@seratch seratch
v3.11.0
f123db1

Choose a tag to compare

View all tags
version 3.11.0

Changes

Contributors

seratch, filmaj, and 2 other contributors
Loading

version 3.11.0rc1

09 Sep 16:02
@seratch seratch
v3.11.0rc1
a3d6006

Choose a tag to compare

View all tags
version 3.11.0rc1 Pre-release
Pre-release

Refer to v3.11.0 release notes

Loading

version 3.10.1

26 Aug 12:51
@seratch seratch
v3.10.1
4fec036

Choose a tag to compare

View all tags
version 3.10.1

Changes

  • #1106 Fix WebClient#files_upload does not send channels since v3.10.0 - Thanks @seratch

Contributors

seratch
Loading

version 3.10.0

26 Aug 00:27
@seratch seratch
v3.10.0
2d85e98

Choose a tag to compare

View all tags
version 3.10.0

New Features

All argument supports in WebClient / AsyncWebClient

Since this version, all the methods in WebClient / AsyncWebClient have not only required arguments but also all possible ones in the method signature for better developer experience. Refer to the pull request enabling this #1099 for details.

Easier way to test if a key exists in a Web API response

Now that SlackResponse / AsyncSlackResponse now have __contains__ method, you can test if a key exists in WebClient responses. Refer to the pull request enabling this #1104 for details.

token = "xoxb-"
response = WebClient(token).auth_test()
"error" in response  # True / False

Changes

Contributors

seratch, uroboro, and 2 other contributors
Loading

version 3.9.1

17 Aug 11:07
@seratch seratch
v3.9.1
e15975b

Choose a tag to compare

View all tags
version 3.9.1

Changes

Contributors

seratch and y-adachi-00one
Loading

version 3.9.0

13 Aug 12:32
@seratch seratch
v3.9.0
daff025

Choose a tag to compare

View all tags
version 3.9.0

New Features

Sign in with Slack (OpenID Connect)

Sign in with Slack helps users log into your service using their Slack profile. The platform feature was recently upgraded to be compatible with the standard OpenID Connect specification. With this version of slack-sdk, implementing the auth flow is much easier.

When you create a new Slack app, set the following user scopes:

oauth_config:
  redirect_urls:
    - https://{your-domain}/slack/oauth_redirect
  scopes:
    user:
      - openid   # required
      - email    # optional
      - profile  # optional

Check the Flask example in the repository. It does the following:

  • Build the OpenID Connect comaptible authorize URL
    • slack_sdk.oauth.OpenIDConnectAuthorizeUrlGenerator helps you easily do this
    • OAuthStateStore is still available for generating state parameter value (it's available for nonce management too)
  • WebClient can perform openid.connect.token API calls with given code parameter

If you want to know the way with asyncio, check the Sanic app example in the same directory.

Built-in Retry Handlers

This version introduces a built-in retry functionalities to the following API clients:

  • slack_sdk.web.WebClient
  • slack_sdk.webhook.WebhookClient
  • slack_sdk.audit_logs.AuditLogsClient
  • slack_sdk.scim.SCIMClient
  • slack_sdk.web.async_client.AsyncWebClient (aiohttp/asyncio compatible)
  • slack_sdk.webhook.async_client.AsyncWebhookClient (aiohttp/asyncio compatible)
  • slack_sdk.audit_logs.async_client.AsyncAuditLogsClient (aiohttp/asyncio compatible)
  • slack_sdk.scim.async_client.AsyncSCIMClient (aiohttp/asyncio compatible)

With the default settings, only slack_sdk.http_retry.builtin_handlers.ConnectionErrorRetryHandler (AsyncConnectionErrorRetryHandler for asyncio clients) with its default configuratio (=only one retry in the manner of exponential backoff and jitter) is enabled in the above clients. The retry handler retries if an API client encounters a connectivity-related failure (e.g., Connection reset by peer).

import os
from slack_sdk.web import WebClient

# Only ConnectionErrorRetryHandler is enabled
client = WebClient(token=os.environ["SLACK_BOT_TOKEN"])

Another built-in retry handler is the one that handles rate limited errors.

# --------------------------------
# Use the built-in handlers
# --------------------------------

client = WebClient(token=os.environ["SLACK_BOT_TOKEN"])

# This handler does retries when HTTP status 429 is returned
from slack_sdk.http_retry.builtin_handlers import RateLimitErrorRetryHandler
rate_limit_handler = RateLimitErrorRetryHandler(max_retry_count=1)
# Enable rate limited error retries as well
cient.retry_handlers.append(rate_limit_handler)

Creating your own ones is also quite simple. Defining a new class that inherits slack_sdk.http_retry.RetryHandler and implements required methods (internals of can_retry / prepare_for_next_retry). Check the built-in ones' source code for learning how to properly implement.

# --------------------------------
# Create your own one
# --------------------------------

import socket
from typing import Optional
from slack_sdk.http_retry import (RetryHandler, RetryState, HttpRequest, HttpResponse)
from slack_sdk.http_retry.builtin_interval_calculators import (
    BackoffRetryIntervalCalculator,
)
from slack_sdk.http_retry.jitter import RandomJitter

class MyRetryHandler(RetryHandler):
    def _can_retry(
        self,
        *,
        state: RetryState,
        request: HttpRequest,
        response: Optional[HttpResponse] = None,
        error: Optional[Exception] = None
    ) -> bool:
        # [Errno 104] Connection reset by peer
        return (
            error is not None and isinstance(error, socket.error) and error.errno == 104
        )

# Customize the settings
my_handler = MyRetryHandler(
    max_retry_count=2,  # retry twice at maximum; the default is 1
    interval_calculator=BackoffRetryIntervalCalculator(  # exponential backoff and jitter is the default
        backoff_factor=1.0,  # 1, 2, 4, 8, 16 seconds later ...
        jitter=RandomJitter(),  # will add 0.0 -- 1.0 second to the backoff duration
    ),
)

client = WebClient(
    token=os.environ["SLACK_BOT_TOKEN"],
    retry_handlers=[rate_limit_handler, my_handler],
)

For asyncio apps, Async prefixed corresponding modules are available. All the methods in those methods are async/await compatible. Check the source code and tests for more details.

Changes

Contributors

seratch, filmaj, and 6 other contributors
Loading

version 3.9.0rc2

13 Aug 02:59
@seratch seratch
v3.9.0rc2
561a42f

Choose a tag to compare

View all tags
version 3.9.0rc2 Pre-release
Pre-release

Refer to the v3.9.0 release note

Loading

version 3.9.0rc1

07 Aug 03:51
@seratch seratch
v3.9.0rc1
cbafdd1

Choose a tag to compare

View all tags
version 3.9.0rc1 Pre-release
Pre-release

Refer to the v3.9.0 release note

Loading

version 3.8.0

15 Jul 22:59
@seratch seratch
v3.8.0
8bbb5d4
This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
GPG key ID: 4AEE18F83AFDEB23
Expired
Verified
Learn about vigilant mode.

Choose a tag to compare

View all tags
version 3.8.0

New Features

Token Rotation Support

This version includes the token rotation feature support for better security. Refer to the API document for the general information about the feature.

How to enable token rotation with this SDK

Apart from the column additions for the feature (specifically, refresh token + expiration date time) and the corresponding changes in your app code, no significant code is needed. Checking the example apps using Flask, Sanic in this directory can be helpful to learn what to do.

In a nutshell, you can call the following rotate_tokens method before handling every single incoming request from Slack. As long as your InstallationStore support the token rotation patterns, the code below should work as-is.

from slack_sdk.oauth.token_rotation import TokenRotator
from slack_sdk.oauth.installation_store import FileInstallationStore

# This instance can be singleton; thread-safe
token_rotator = TokenRotator(
    # These are required for refreshing tokens
    client_id=client_id,
    client_secret=client_secret,
)
# Your own InstallationStore here
installation_store = FileInstallationStore()

def rotate_tokens(
    enterprise_id: Optional[str] = None,
    team_id: Optional[str] = None,
    user_id: Optional[str] = None,
    is_enterprise_install: Optional[bool] = None,
):
    installation = installation_store.find_installation(
        enterprise_id=enterprise_id,
        team_id=team_id,
        user_id=user_id,
        is_enterprise_install=is_enterprise_install,
    )
    if installation is not None:
        # If rotation does not occur, refreshed_installation is None
        refreshed_installation = token_rotator.perform_token_rotation(installation=installation)
        if refreshed_installation is not None:
            # Save the new access token for the following processes
            installation_store.save(refreshed_installation)

Migration guide for SQLAlchemyInstallationStore users

If your app uses the built-in SQLAlchemyInstallationStore for managing Slack app installations, adding the following database columns is required for this version upgrade. Refer to the code to check the complete ones.

Also, since this version, all the table columns for string data have their max length for better compatibility with MySQL. We recommend setting the same ones for your models.

slack_installations
  • Column("bot_refresh_token", String(200)),
  • Column("bot_token_expires_at", DateTime),
  • Column("user_refresh_token", String(200)),
  • Column("user_token_expires_at", DateTime),
slack_bots
  • Column("bot_refresh_token", String(200)),
  • Column("bot_token_expires_at", DateTime),

Changes

  • #1060 Add token rotation feature support - Thanks @seratch
  • #1040 Set max length for string columns in SQLAlchemy models for MySQL compatibility - Thanks @tattee
  • #1047 Make WebhookClient (sync/async) #send method accept link unfurl params - Thanks @srajiang
  • #1061 WebClient's paginated response iterator does not work for admin.conversations.search API - Thanks @seratch
  • #1054 #1053 conversations_invite() fails with "error: no_user" - Thanks @seratch @noperator
  • #1044 Updates PythOnBoardingBot tutorial sample to use bolt-python - Thanks @srajiang
  • #1048 Update command in maintainers guide - Thanks @srajiang
Loading

version 3.7.0

16 Jun 02:26
@seratch seratch
v3.7.0
0a3166c

Choose a tag to compare

View all tags
version 3.7.0

Changes

Loading