Skip to content
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.

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

Add TypedDict to slack_sdk.models classes #1515

Open
3 of 9 tasks
yassun7010 opened this issue Jun 23, 2024 · 2 comments
Open
3 of 9 tasks

Add TypedDict to slack_sdk.models classes #1515

yassun7010 opened this issue Jun 23, 2024 · 2 comments
Labels
discussion M-T: An issue where more input is needed to reach a decision enhancement M-T: A feature request for new functionality Version: 3x web-client
Milestone

Comments

@yassun7010
Copy link

The Client treats Json-format Request Bodies as dict, but can benefit from completion and static analysis if TypedDict is supported.

Category (place an x in each of the [ ])

  • slack_sdk.web.WebClient (sync/async) (Web API client)
  • slack_sdk.webhook.WebhookClient (sync/async) (Incoming Webhook, response_url sender)
  • slack_sdk.models (UI component builders)
  • slack_sdk.oauth (OAuth Flow Utilities)
  • slack_sdk.socket_mode (Socket Mode client)
  • slack_sdk.audit_logs (Audit Logs API client)
  • slack_sdk.scim (SCIM API client)
  • slack_sdk.rtm (RTM client)
  • slack_sdk.signature (Request Signature Verifier)
@seratch seratch added enhancement M-T: A feature request for new functionality discussion M-T: An issue where more input is needed to reach a decision web-client Version: 3x and removed untriaged labels Jun 24, 2024
@seratch seratch added this to the 4.x milestone Jun 24, 2024
@seratch
Copy link
Member

seratch commented Jun 24, 2024

Hi @yassun7010, thanks for sharing the idea!

TypedDict is a relatively new feature introduced in Python 3.8, and this SDK still supports Python 3.6 and 3.7. We know these older versions are already EOLed, but in reality, many apps need a certain amount of time to upgrade to a newer runtime. Therefore, we don't immediately cut support for those versions.

We may consider dropping support for the old versions starting with the next major release (v4), but we don't plan to bump the major version in the short term. We will keep this issue open as a future enhancement idea. Thanks again for sharing this!

@seratch seratch changed the title Support TypedDict. Add TypedDict to slack_sdk.models classes Jun 24, 2024
@yassun7010
Copy link
Author

@seratch
Thanks for explaining the situation.

Looking forward to the v4 release ;)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
discussion M-T: An issue where more input is needed to reach a decision enhancement M-T: A feature request for new functionality Version: 3x web-client
Projects
None yet
Development

No branches or pull requests

2 participants