feat: Add work objects support #1783

vegeris · 2025-11-06T23:17:08Z

Summary

This PR adds the following support for work objects:

Defines the schema for work object metadata
Updates the inputs for chat.unfurl or chat.postMessage to accept entity metadata
Adds the entity.presentDetails API method

Testing

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.

codecov · 2025-11-06T23:17:56Z

Codecov Report

❌ Patch coverage is 61.60164% with 187 lines in your changes missing coverage. Please review.
✅ Project coverage is 84.29%. Comparing base (47843de) to head (194963a).
✅ All tests successful. No failed tests found.

Files with missing lines	Patch %	Lines
slack_sdk/models/metadata/__init__.py	64.85%	155 Missing ⚠️
slack_sdk/web/async_client.py	16.66%	10 Missing ⚠️
slack_sdk/web/client.py	16.66%	10 Missing ⚠️
slack_sdk/web/legacy_client.py	16.66%	10 Missing ⚠️
slack_sdk/web/internal_utils.py	71.42%	2 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #1783      +/-   ##
==========================================
- Coverage   85.15%   84.29%   -0.86%     
==========================================
  Files         115      115              
  Lines       13069    13547     +478     
==========================================
+ Hits        11129    11420     +291     
- Misses       1940     2127     +187

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

WilliamBergamin

Nice thanks for working on this, it look promising 💯

Left a few comments 📝

For EntityPayload it might be a good idea to add unit tests similar to what is found in tests/slack_sdk/models/test_objects.py, let me know what you think about creating a dedicated unit test file in tests/slack_sdk/models similar to what the other "models" have 🤔

slack_sdk/models/metadata/__init__.py

WilliamBergamin · 2025-11-07T16:34:29Z

slack_sdk/models/metadata/__init__.py

+        # Store entity attributes data with a different internal name to avoid
+        # shadowing the class-level 'attributes' set used for JSON serialization
+        self._entity_attributes = attributes


Nice 💯 yup this makes sense!

slack_sdk/models/metadata/__init__.py

WilliamBergamin · 2025-11-07T17:06:07Z

slack_sdk/web/internal_utils.py

+        if isinstance(obj, EventAndEntityMetadata):
+            return obj.to_dict()
+        if isinstance(obj, EntityMetadata):
+            return obj.to_dict()


WilliamBergamin · 2025-11-07T21:33:38Z

slack_sdk/models/metadata/__init__.py

+    def get_object_attribute(self, key: str):
+        if key == "attributes":
+            return self._entity_attributes
+        else:
+            return getattr(self, key, None)


Nice 💯 🚀

…nto feat-work-objects

vegeris · 2025-11-10T19:47:07Z

tests/slack_sdk/models/test_metadata.py

+                edit=EntityEditSupport(enabled=True, text=EntityEditTextConfig(min_length=5, max_length=100)),
+            ),
+            due_date=EntityTypedField(value="2026-06-06", type="slack#/types/date"),
+            created_by=EntityTypedField(


Debating leaving this as EntityTypedField or adding a 'user' type field for the entity-specific pre-defined fields

For now I would suggest keeping it simple and leaving it as EntityTypedField in the future if we see that a dedicated 'user' type field would be useful we can always add it, until then it provides us with more flexibility 🤔

WilliamBergamin

These changes look great 🚀

I left one comment on the test, let me know what you think

Note: you may need to update from main to get the checks to pass

WilliamBergamin · 2025-11-10T16:20:31Z

slack_sdk/models/basic_objects.py

+    def get_object_attribute(self, key: str):
+        return getattr(self, key, None)
+


WilliamBergamin · 2025-11-10T20:15:06Z

tests/slack_sdk/models/test_metadata.py

+                edit=EntityEditSupport(enabled=True, text=EntityEditTextConfig(min_length=5, max_length=100)),
+            ),
+            due_date=EntityTypedField(value="2026-06-06", type="slack#/types/date"),
+            created_by=EntityTypedField(


For now I would suggest keeping it simple and leaving it as EntityTypedField in the future if we see that a dedicated 'user' type field would be useful we can always add it, until then it provides us with more flexibility 🤔

WilliamBergamin · 2025-11-10T20:17:55Z

tests/slack_sdk/models/test_metadata.py

+class EntityMetadataTests(unittest.TestCase):
+    maxDiff = None
+
+    def test_creation(self):


What do you think about potentially creating more tests that cover more specific cases?

When the tests fail it will make it easier for maintainers to determine what area is the issue originates from

feat: add work objects support

12c78c2

vegeris force-pushed the feat-work-objects branch 2 times, most recently from 0aab530 to 2f3febb Compare November 7, 2025 15:28

update

d7516ce

vegeris force-pushed the feat-work-objects branch from 2f3febb to d7516ce Compare November 7, 2025 15:30

clean up schema

0be9838

WilliamBergamin reviewed Nov 7, 2025

View reviewed changes

vegeris added 3 commits November 7, 2025 14:05

address feedback

7b48524

fix api

f1ca87a

update

53b1353

vegeris force-pushed the feat-work-objects branch from 616c7ad to 53b1353 Compare November 7, 2025 20:11

fix mypy issues

b610b2d

WilliamBergamin reviewed Nov 7, 2025

View reviewed changes

vegeris force-pushed the feat-work-objects branch 4 times, most recently from c091881 to 5fc9652 Compare November 10, 2025 15:19

format, update

586dd3a

vegeris force-pushed the feat-work-objects branch from 5fc9652 to 586dd3a Compare November 10, 2025 15:35

vegeris added 2 commits November 10, 2025 10:40

Merge branch 'main' of https://github.com/slackapi/python-slack-sdk i…

11bafc6

…nto feat-work-objects

wait a minute

bad341a

vegeris marked this pull request as ready for review November 10, 2025 15:43

vegeris marked this pull request as draft November 10, 2025 15:43

vegeris added 3 commits November 10, 2025 14:20

add unit test

42a9423

Merge branch 'main' of https://github.com/slackapi/python-slack-sdk i…

867ba12

…nto feat-work-objects

lint

194963a

vegeris marked this pull request as ready for review November 10, 2025 19:30

vegeris requested a review from WilliamBergamin November 10, 2025 19:30

vegeris commented Nov 10, 2025

View reviewed changes

WilliamBergamin reviewed Nov 10, 2025

View reviewed changes

		def get_object_attribute(self, key: str):
		return getattr(self, key, None)

feat: Add work objects support #1783

Are you sure you want to change the base?

feat: Add work objects support #1783

Uh oh!

Conversation

vegeris commented Nov 6, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Testing

Category

Requirements

Uh oh!

codecov bot commented Nov 6, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

WilliamBergamin left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

WilliamBergamin left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

vegeris commented Nov 6, 2025 •

edited

Loading

codecov bot commented Nov 6, 2025 •

edited

Loading

WilliamBergamin left a comment •

edited

Loading