Events TypedDict typing #283

ameesha · 2024-07-11T12:41:09Z

Description

Documentation

Does this require changes to the WorkOS Docs? E.g. the API Reference or code snippets need updates.

[ ] Yes

If yes, link a related docs PR and add a docs maintainer as a reviewer. Their approval is required.

ameesha · 2024-07-11T14:49:14Z

workos/event_objects/directory.py

+    def construct_from_response(cls, response: dict):
+        instance = cls()
+        for k, v in response.items():
+            if k == "domains":


not sure if there's a better way than to explicitly add a check against the key so it doesn't all just become nested dicts

In terms of a quick implementation, this will work.

However, this also feels like we are reinventing the wheel. It's object deserialization based on a schema. This is a solved problem and there are a number of libraries that would do this for us like Marshmallow ... and pydantic, typeguard, typical, or pytypes

@jonatascastro12 or @PaulAsjes Do you have thoughts on ☝️ ?

Yeah... I can see the limitations now. Nested objects are complicated and for having TypedDicts we need to repeat the attributes. I'm considering pydantic which is widely used. Here's what I got:

from pydantic import BaseModel from typing import TypedDict, List, Optional, Literal from enum import Enum class DirectoryType(Enum): AZURE_SCIM_v2 = "azure scim v2.0" BAMBOO_HR = "bamboohr" BREATHE_HR = "breathe hr" CEZANNE_HR = "cezanne hr" CYBERARK_SCIM_v2 = "cyperark scim v2.0" FOURTH_HR = "fourth hr" GENERIC_SCIM_v2 = "generic scim v2.0" GOOGLE = "gsuite directory" HIBOB = "hibob" JUMPCLOUD_SCIM_v2 = "jump cloud scim v2.0" OKTA_SCIM_v2 = "okta scim v2.0" ONELOGIN_SCIM_v2 = "onelogin scim v2.0" PEOPLE_HR = "people hr" PERSONIO = "personio" PINGFEDERATE_SCIM_v2 = "pingfederate scim v2.0" RIPPLING_SCIM_v2 = "rippling v2.0" SFTP = "sftp" SFTP_WORKDAY = "sftp workday" WORKDAY = "workday" class DirectoryState(Enum): ACTIVE = "active" DELETING = "deleting" class DirectoryEventData(BaseModel): id: str name: str type: DirectoryType state: DirectoryState organization_id: str created_at: str updated_at: str object: Literal["directory"] response = { "id": "Test", "name": "Test", "type": "gsuite directory", "state": "active", "organization_id": "org_123", "created_at": "2020-12-30T10:00:00Z", "updated_at": "2020-12-30T10:00:00Z", "object": "directory", } obj = DirectoryEventData.parse_obj(response) print(obj) directory = DirectoryEventData.parse_obj(obj) print(directory) another = DirectoryEventData(**directory.model_dump()) print(another)

hmm in that the "state" is still just a string directory from the json reqponse, as opposed to the enum type (which would be DirectoryState.Active) no?

@jonatascastro12 can you paste what the output of these lines is? (I think it'll directly answer ameesha's question)

obj = DirectoryEventData.parse_obj(response) print(obj) directory = DirectoryEventData.parse_obj(obj) print(directory) another = DirectoryEventData(**directory.model_dump()) print(another)

The output. Those enums come typed as expected 👍 .

id='Test' name='Test' type=<DirectoryType.GOOGLE: 'gsuite directory'> state=<DirectoryState.ACTIVE: 'active'> domains=[OrganizationDomain(id='Test', domain='Test', object='organization_domain')] organization_id='org_123' created_at='2020-12-30T10:00:00Z' updated_at='2020-12-30T10:00:00Z' object='directory' id='Test' name='Test' type=<DirectoryType.GOOGLE: 'gsuite directory'> state=<DirectoryState.ACTIVE: 'active'> domains=[OrganizationDomain(id='Test', domain='Test', object='organization_domain')] organization_id='org_123' created_at='2020-12-30T10:00:00Z' updated_at='2020-12-30T10:00:00Z' object='directory' id='Test' name='Test' type=<DirectoryType.GOOGLE: 'gsuite directory'> state=<DirectoryState.ACTIVE: 'active'> domains=[OrganizationDomain(id='Test', domain='Test', object='organization_domain')] organization_id='org_123' created_at='2020-12-30T10:00:00Z' updated_at='2020-12-30T10:00:00Z' object='directory'

Those are 3 equal objects. I just wanted to show ways that you can initialize, either with the same object, a dictionary or key arguments.

workos/event_objects/directory.py

tribble

Are the dsync.group.user_added and dsync.group.user_removed events coming in a follow PR?

Does this require changes to the WorkOS Docs?

Since we have not changed the API resource types, not yet. But when we do, then yes I think we will need to.

tribble · 2024-07-11T18:10:25Z

workos/event_objects/directory.py

+class OrganizationDomain(TypedDict):
+    id: str
+    domain: str
+
+
+class WorkOSOrganizationDomain:


Should these also have object: Literal["organization_domain"]?

ooh missed that, will add

workos/event_objects/directory.py

tribble · 2024-07-11T18:25:00Z

workos/event_objects/directory.py

+class WorkOSDirectoryActivatedEvent:
+    event: Literal["dsync.activated"] = "dsync.activated"
+    id: str
+    created_at: str
+    data: WorkOSDirectoryEventWithLegacyFields
+
+    @classmethod
+    def construct_from_response(cls, response: dict):
+        instance = cls()
+        for k, v in response.items():
+            if k == "data":
+                setattr(
+                    instance,
+                    k,
+                    WorkOSDirectoryEventWithLegacyFields.construct_from_response(v),
+                )
+            else:
+                setattr(instance, k, v)
+
+        return instance
+
+    def to_dict(self) -> DirectoryActivatedEvent:
+        return self.__dict__
+
+    def __str__(self):
+        return f"{self.__class__.__name__} {self.to_dict()}"


Maybe this refactor can come later, but every single Event we define will have...

event: Literal[EVENT_NAME_LITERAL] = EVENT_NAME_LITERAL id: str created_at: str data: EVENT_DATA_CLASS

Can we have a single WorkOSEvent base class that's parameterized with the two bits of data that actually change? I think the actual implementation of the class looks the same across all events.

workos/event_objects/directory_group.py

workos/event_objects/directory_user.py

ameesha · 2024-07-11T18:54:59Z

Are the dsync.group.user_added and dsync.group.user_removed events coming in a follow PR?

Does this require changes to the WorkOS Docs?

Since we have not changed the API resource types, not yet. But when we do, then yes I think we will need to.

i hadn't done them all, just cause i wanted to make sure how i'm typing it is correct. let me switch this to a draft to make that clear. i'll add the membership stuff in a commit

tribble · 2024-07-11T19:13:15Z

i'll add the membership stuff in a commit

I'm totally cool with the membership stuff being part of this PR or a later one. It's on your radar. That's all that matters.

typeddict directory

4227a52

ameesha requested a review from a team as a code owner July 11, 2024 12:41

ameesha requested a review from alisherry July 11, 2024 12:41

ameesha added 3 commits July 11, 2024 09:44

object and dict typing

326eacb

group, user, and role

cc42b80

fmt

a9cf948

ameesha commented Jul 11, 2024

View reviewed changes

ameesha requested review from tribble, jonatascastro12 and mattgd and removed request for alisherry July 11, 2024 16:42

jonatascastro12 reviewed Jul 11, 2024

View reviewed changes

workos/event_objects/directory.py Outdated Show resolved Hide resolved

tribble reviewed Jul 11, 2024

View reviewed changes

ameesha marked this pull request as draft July 11, 2024 18:56

comments

81d8160

add membership events

6e521ca

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Events TypedDict typing #283

Events TypedDict typing #283

ameesha commented Jul 11, 2024

ameesha Jul 11, 2024

tribble Jul 11, 2024 •

edited

Loading

tribble Jul 11, 2024

jonatascastro12 Jul 11, 2024

ameesha Jul 11, 2024

tribble Jul 11, 2024 •

edited

Loading

jonatascastro12 Jul 12, 2024

jonatascastro12 Jul 12, 2024

tribble left a comment

tribble Jul 11, 2024

ameesha Jul 11, 2024

tribble Jul 11, 2024 •

edited

Loading

ameesha commented Jul 11, 2024 •

edited

Loading

tribble commented Jul 11, 2024

Events TypedDict typing #283

Are you sure you want to change the base?

Events TypedDict typing #283

Conversation

ameesha commented Jul 11, 2024

Description

Documentation

Choose a reason for hiding this comment

tribble Jul 11, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

tribble Jul 11, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

tribble left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

tribble Jul 11, 2024 • edited Loading

Choose a reason for hiding this comment

ameesha commented Jul 11, 2024 • edited Loading

tribble commented Jul 11, 2024

tribble Jul 11, 2024 •

edited

Loading

tribble Jul 11, 2024 •

edited

Loading

tribble Jul 11, 2024 •

edited

Loading

ameesha commented Jul 11, 2024 •

edited

Loading