-
Notifications
You must be signed in to change notification settings - Fork 853
Closed
Labels
Version: 3xenhancementM-T: A feature request for new functionalityM-T: A feature request for new functionalityweb-client
Milestone
Description
As I mentioned at #1017 (comment) , having optional arguments in WebClient method signature would be even more helpful for developers. If we do this, all the methods should be consistent about it.
To: external contributors
If you are interested in working on this, all the things to do this are:
- Modify https://github.com/slackapi/python-slack-sdk/blob/main/slack_sdk/web/client.py to add optional arguments in methods
- The arguments must have their default values (
Noneshould work for most cases) - If the types of the arguments are
(list, Tuple ), do the same with the existing methods - Update the method comments correspondingly
- The arguments must have their default values (
- Make sure https://github.com/slackapi/python-slack-sdk/blob/main/tests/slack_sdk_async/web/test_web_client_coverage.py does not fail due to your changes. If some fail, it means you're breaking backward-compatibility
- No need to update the following API methods as they are deprecated or aren't available anymore
- channels.*
- groups.*
- im.*
- mpim.*
- Run
https://github.com/slackapi/python-slack-sdk/blob/main/scripts/run_validation.shbefore submitting your pull request. Particularly,python setup.py codegensynchronizes your changes to other async/legacy Web API clients.
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)
Requirements
Please read the Contributing guidelines and Code of Conduct before creating this issue or pull request. By submitting, you are agreeing to those rules.
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
Version: 3xenhancementM-T: A feature request for new functionalityM-T: A feature request for new functionalityweb-client