Skip to content

Fix #1209 Add __all__ to __init__.py#1210

Merged
seratch merged 2 commits intoslackapi:mainfrom
seratch:issue-1209
May 18, 2022
Merged

Fix #1209 Add __all__ to __init__.py#1210
seratch merged 2 commits intoslackapi:mainfrom
seratch:issue-1209

Conversation

@seratch
Copy link
Copy Markdown
Contributor

@seratch seratch commented May 13, 2022

Summary

This pull request resolves #1209 by adding __all__ to __init__.py files.

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.socket_mode (Socket Mode client)
  • slack_sdk.signature (Request Signature Verifier)
  • slack_sdk.oauth (OAuth Flow Utilities)
  • slack_sdk.models (UI component builders)
  • slack_sdk.scim (SCIM API client)
  • slack_sdk.audit_logs (Audit Logs API client)
  • slack_sdk.rtm_v2 (RTM client)
  • /docs-src (Documents, have you run ./scripts/docs.sh?)
  • /docs-src-v2 (Documents, have you run ./scripts/docs-v2.sh?)
  • /tutorial (PythOnBoardingBot tutorial)
  • tests/integration_tests (Automated tests for this library)

Requirements (place an x in each [ ])

  • I've read and understood the Contributing Guidelines and have done my best effort to follow them.
  • I've read and agree to the Code of Conduct.
  • I've run python3 -m venv .venv && source .venv/bin/activate && ./scripts/run_validation.sh after making the changes.

@seratch seratch self-assigned this May 13, 2022
@seratch seratch added this to the 3.16.2 milestone May 13, 2022
@seratch seratch mentioned this pull request May 13, 2022
Closed
1 task
@codecov
Copy link
Copy Markdown

codecov bot commented May 13, 2022 •
edited
Loading

Codecov Report

Merging #1210 (828c25d) into main (5019f65) will decrease coverage by 0.01%.
The diff coverage is 98.56%.

@@            Coverage Diff             @@
##             main    #1210      +/-   ##
==========================================
- Coverage   86.55%   86.53%   -0.02%     
==========================================
  Files         111      111              
  Lines       10912    10934      +22     
==========================================
+ Hits         9445     9462      +17     
- Misses       1467     1472       +5
Impacted Files Coverage Δ
slack_sdk/oauth/installation_store/models/bot.py 93.33% <ø> (ø)
slack_sdk/scim/async_client.py 0.00% <0.00%> (ø)
slack_sdk/web/async_base_client.py 98.33% <ø> (ø)
slack_sdk/__init__.py 100.00% <100.00%> (ø)
slack_sdk/audit_logs/__init__.py 100.00% <100.00%> (ø)
slack_sdk/audit_logs/async_client.py 100.00% <100.00%> (ø)
slack_sdk/audit_logs/v1/logs.py 99.42% <100.00%> (ø)
slack_sdk/http_retry/__init__.py 100.00% <100.00%> (ø)
slack_sdk/http_retry/async_handler.py 96.15% <100.00%> (+0.15%) ⬆️
slack_sdk/models/__init__.py 100.00% <100.00%> (ø)
... and 18 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 5019f65...828c25d. Read the comment docs.

@seratch
Copy link
Copy Markdown
Contributor Author

seratch commented May 13, 2022

In this pull request, I've fixed many mypy warnings too. That being said, it does not mean that we will use mypy for this project itself. We already use flake8 and pytype. These tools have been helping us to keep the quality at a high enough level. Spending more time for satisfying mypy is not the direction where we would like to head.

mwbrooks
mwbrooks approved these changes May 15, 2022
View reviewed changes
Copy link
Copy Markdown
Member

@mwbrooks mwbrooks left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good @seratch! Is there a way that we want to test that __all__ include the correct imports?

@seratch
Copy link
Copy Markdown
Contributor Author

seratch commented May 15, 2022

@mwbrooks

Is there a way that we want to test that all include the correct imports?

Good question! There is no way to write unit tests for it, but flake8 (linter) detects missing items if there is any.

@mwbrooks
Copy link
Copy Markdown
Member

mwbrooks commented May 15, 2022

Cool, at least flake8 will help ensure we add them going forward!

@seratch seratch merged commit b7f838b into slackapi:main May 18, 2022
@seratch seratch deleted the issue-1209 branch May 18, 2022 00:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@mwbrooks mwbrooks mwbrooks approved these changes

Assignees

@seratch seratch

Labels

audit-logs-client enhancement M-T: A feature request for new functionality oauth rtm-client scim-client socket-mode Version: 3x web-client

Projects

None yet

Milestone

3.16.2

Development

Successfully merging this pull request may close these issues.

mypy strict mode doesn't play well with less-specific slack_sdk.model imports

2 participants

@seratch @mwbrooks