fix: Improve type annotations in SignatureVerifier

[BHSPitMonkey]

Summary

Receive headers as abstract/immutable collections.abc.Mapping instead of Dict to more accurately declare compatibility with dict-like objects (common for holding headers in HTTP frameworks), and mark timestamp/signature args as Optional in is_valid to reflect reality and fix the typechecker errors in is_valid_request.

Testing

These changes only touch type annotations which have no runtime effects; The only expectation here is that type checks pass.

Category

• 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 (Documents)
• /tutorial (PythOnBoardingBot tutorial)
• tests/integration_tests (Automated tests for this library)

Requirements

• 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.

[salesforce-cla]

Thanks for the contribution! Before we can merge this, we need @BHSPitMonkey to sign the Salesforce Inc. Contributor License Agreement.

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 83.99%. Comparing base (0cb9728) to head (bdb6cac).
⚠️ Report is 1 commits behind head on main.
✅ All tests successful. No failed tests found.

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #1845   +/-   ##
=======================================
  Coverage   83.99%   83.99%           
=======================================
  Files         117      117           
  Lines       13252    13253    +1     
=======================================
+ Hits        11131    11132    +1     
  Misses       2121     2121           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[WilliamBergamin]

Hi @BHSPitMonkey thanks for opening this PR 🙏

Love seeing those # type: ignore go away!
Changes seem solid but aren't compatible with python 3.7 and 3.8, I left a comment on how to potentially address it, once resolved we should be good to merge

[WilliamBergamin]

For python 3.7 and 3.8 this Mapping type is not importable from collections.abc causing

slack_sdk/signature/__init__.py:30: in SignatureVerifier
    headers: Mapping[str, str],
E   TypeError: 'ABCMeta' object is not subscriptable

Importing Mapping as follows should fix the issue 🤔

from typing import TYPE_CHECKING,  Dict, Optional, Union

if TYPE_CHECKING:
    from collections.abc import Mapping
else:
    Mapping = Dict

[WilliamBergamin]

If we go this route, it might be a good idea to also include a comment about how this is for python 3.7 and 3.8 backwards compatibility

[BHSPitMonkey]

Argh, old Pythons strike again! But I like your proposed solution - Will push it with a comment shortly.

[WilliamBergamin]

🥇