Skip to content

Commit

Permalink
List -> Sequence and import cleanup
Browse files Browse the repository at this point in the history
  • Loading branch information
tribble committed Aug 2, 2024
1 parent edb2f65 commit 22d961c
Show file tree
Hide file tree
Showing 14 changed files with 40 additions and 43 deletions.
18 changes: 9 additions & 9 deletions workos/audit_logs.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
from typing import List, Optional, Protocol
from typing import Optional, Protocol, Sequence

import workos
from workos.resources.audit_logs import AuditLogEvent, AuditLogExport
Expand All @@ -23,10 +23,10 @@ def create_export(
organization_id: str,
range_start: str,
range_end: str,
actions: Optional[List[str]] = None,
targets: Optional[List[str]] = None,
actor_names: Optional[List[str]] = None,
actor_ids: Optional[List[str]] = None,
actions: Optional[Sequence[str]] = None,
targets: Optional[Sequence[str]] = None,
actor_names: Optional[Sequence[str]] = None,
actor_ids: Optional[Sequence[str]] = None,
) -> AuditLogExport: ...

def get_export(self, audit_log_export_id: str) -> AuditLogExport: ...
Expand Down Expand Up @@ -73,10 +73,10 @@ def create_export(
organization_id: str,
range_start: str,
range_end: str,
actions: Optional[List[str]] = None,
targets: Optional[List[str]] = None,
actor_names: Optional[List[str]] = None,
actor_ids: Optional[List[str]] = None,
actions: Optional[Sequence[str]] = None,
targets: Optional[Sequence[str]] = None,
actor_names: Optional[Sequence[str]] = None,
actor_ids: Optional[Sequence[str]] = None,
) -> AuditLogExport:
"""Trigger the creation of an export of audit logs.
Expand Down
10 changes: 5 additions & 5 deletions workos/events.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
from typing import List, Optional, Protocol, Union
from typing import Optional, Protocol, Sequence, Union

import workos
from workos.typing.sync_or_async import SyncOrAsync
Expand All @@ -16,7 +16,7 @@


class EventsListFilters(ListArgs, total=False):
events: List[EventType]
events: Sequence[EventType]
organization_id: Optional[str]
range_start: Optional[str]
range_end: Optional[str]
Expand All @@ -31,7 +31,7 @@ class EventsListFilters(ListArgs, total=False):
class EventsModule(Protocol):
def list_events(
self,
events: List[EventType],
events: Sequence[EventType],
limit: int = DEFAULT_LIST_RESPONSE_LIMIT,
organization_id: Optional[str] = None,
after: Optional[str] = None,
Expand All @@ -51,7 +51,7 @@ def __init__(self, http_client: SyncHTTPClient):

def list_events(
self,
events: List[EventType],
events: Sequence[EventType],
limit: int = DEFAULT_LIST_RESPONSE_LIMIT,
organization_id: Optional[str] = None,
after: Optional[str] = None,
Expand Down Expand Up @@ -105,7 +105,7 @@ def __init__(self, http_client: AsyncHTTPClient):

async def list_events(
self,
events: List[EventType],
events: Sequence[EventType],
limit: int = DEFAULT_LIST_RESPONSE_LIMIT,
organization_id: Optional[str] = None,
after: Optional[str] = None,
Expand Down
12 changes: 6 additions & 6 deletions workos/organizations.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
from typing import List, Literal, Optional, Protocol, Sequence
from typing import Literal, Optional, Protocol, Sequence
from typing_extensions import TypedDict
import workos
from workos.utils.http_client import SyncHTTPClient
Expand All @@ -25,13 +25,13 @@ class DomainDataInput(TypedDict):


class OrganizationListFilters(ListArgs, total=False):
domains: Optional[List[str]]
domains: Optional[Sequence[str]]


class OrganizationsModule(Protocol):
def list_organizations(
self,
domains: Optional[List[str]] = None,
domains: Optional[Sequence[str]] = None,
limit: int = DEFAULT_LIST_RESPONSE_LIMIT,
before: Optional[str] = None,
after: Optional[str] = None,
Expand All @@ -45,15 +45,15 @@ def get_organization_by_lookup_key(self, lookup_key: str) -> Organization: ...
def create_organization(
self,
name: str,
domain_data: Optional[List[DomainDataInput]] = None,
domain_data: Optional[Sequence[DomainDataInput]] = None,
idempotency_key: Optional[str] = None,
) -> Organization: ...

def update_organization(
self,
organization_id: str,
name: str,
domain_data: Optional[List[DomainDataInput]] = None,
domain_data: Optional[Sequence[DomainDataInput]] = None,
) -> Organization: ...

def delete_organization(self, organization_id: str) -> None: ...
Expand All @@ -69,7 +69,7 @@ def __init__(self, http_client: SyncHTTPClient):

def list_organizations(
self,
domains: Optional[List[str]] = None,
domains: Optional[Sequence[str]] = None,
limit: int = DEFAULT_LIST_RESPONSE_LIMIT,
before: Optional[str] = None,
after: Optional[str] = None,
Expand Down
2 changes: 1 addition & 1 deletion workos/portal.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
from typing import Literal, Optional, Protocol, TypeGuard, get_args
from typing import Literal, Optional, Protocol
import workos
from workos.resources.portal import PortalLink
from workos.utils.http_client import SyncHTTPClient
Expand Down
4 changes: 2 additions & 2 deletions workos/resources/audit_logs.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
from typing import List, Literal, Optional, TypedDict
from typing import Literal, Optional, Sequence, TypedDict
from typing_extensions import NotRequired

from workos.resources.workos_model import WorkOSModel
Expand Down Expand Up @@ -47,6 +47,6 @@ class AuditLogEvent(TypedDict):
version: NotRequired[int]
occurred_at: str # ISO-8601 datetime of when an event occurred
actor: AuditLogEventActor
targets: List[AuditLogEventTarget]
targets: Sequence[AuditLogEventTarget]
context: AuditLogEventContext
metadata: NotRequired[dict]
4 changes: 2 additions & 2 deletions workos/resources/directory_sync.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
from typing import List, Optional, Literal
from typing import Optional, Literal, Sequence
from workos.resources.workos_model import WorkOSModel
from workos.types.directory_sync.directory_state import DirectoryState
from workos.types.directory_sync.directory_user import DirectoryUser
Expand Down Expand Up @@ -59,4 +59,4 @@ class DirectoryGroup(WorkOSModel):
class DirectoryUserWithGroups(DirectoryUser):
"""Representation of a Directory User as returned by WorkOS through the Directory Sync feature."""

groups: List[DirectoryGroup]
groups: Sequence[DirectoryGroup]
6 changes: 3 additions & 3 deletions workos/resources/list.py
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@
AsyncIterator,
Awaitable,
Dict,
List,
Literal,
Sequence,
TypeVar,
Generic,
Callable,
Expand Down Expand Up @@ -57,7 +57,7 @@ class ListMetadata(ListAfterMetadata):

class ListPage(WorkOSModel, Generic[ListableResource]):
object: Literal["list"]
data: List[ListableResource]
data: Sequence[ListableResource]
list_metadata: ListMetadata


Expand All @@ -76,7 +76,7 @@ class BaseWorkOsListResource(
Generic[ListableResource, ListAndFilterParams, ListMetadataType],
):
object: Literal["list"]
data: List[ListableResource]
data: Sequence[ListableResource]
list_metadata: ListMetadataType

list_method: Callable = Field(exclude=True)
Expand Down
4 changes: 1 addition & 3 deletions workos/resources/organizations.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
from typing import Literal, Optional
from typing_extensions import TypedDict
from workos.resources.workos_model import WorkOSModel
from typing import Optional
from workos.types.organizations.organization_common import OrganizationCommon


Expand Down
1 change: 0 additions & 1 deletion workos/resources/portal.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
from typing import Literal
from workos.resources.workos_model import WorkOSModel


Expand Down
6 changes: 3 additions & 3 deletions workos/resources/sso.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
from typing import List, Literal, Union
from typing import Literal, Sequence, Union

from workos.resources.workos_model import WorkOSModel
from workos.types.sso.connection import Connection
Expand All @@ -18,7 +18,7 @@ class Profile(WorkOSModel):
first_name: Union[str, None]
last_name: Union[str, None]
idp_id: str
groups: Union[List[str], None]
groups: Union[Sequence[str], None]
raw_attributes: dict


Expand All @@ -38,7 +38,7 @@ class ConnectionDomain(WorkOSModel):
class ConnectionWithDomains(Connection):
"""Representation of a Connection Response as returned by WorkOS through the SSO feature."""

domains: List[ConnectionDomain]
domains: Sequence[ConnectionDomain]


SsoProviderType = Literal[
Expand Down
4 changes: 2 additions & 2 deletions workos/types/directory_sync/directory_user.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
from typing import List, Literal, Optional
from typing import Literal, Optional, Sequence

from workos.resources.workos_model import WorkOSModel

Expand All @@ -25,7 +25,7 @@ class DirectoryUser(WorkOSModel):
first_name: Optional[str] = None
last_name: Optional[str] = None
job_title: Optional[str] = None
emails: List[DirectoryUserEmail]
emails: Sequence[DirectoryUserEmail]
username: Optional[str] = None
state: DirectoryUserState
custom_attributes: dict
Expand Down
4 changes: 2 additions & 2 deletions workos/types/events/directory_payload_with_legacy_fields.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
from typing import List, Literal
from typing import Literal, Sequence
from workos.resources.workos_model import WorkOSModel
from workos.types.events.directory_payload import DirectoryPayload

Expand All @@ -10,5 +10,5 @@ class MinimalOrganizationDomain(WorkOSModel):


class DirectoryPayloadWithLegacyFields(DirectoryPayload):
domains: List[MinimalOrganizationDomain]
domains: Sequence[MinimalOrganizationDomain]
external_key: str
4 changes: 2 additions & 2 deletions workos/types/organizations/organization_common.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
from typing import Literal, List
from typing import Literal, Sequence
from workos.resources.workos_model import WorkOSModel
from workos.types.organizations.organization_domain import OrganizationDomain

Expand All @@ -7,6 +7,6 @@ class OrganizationCommon(WorkOSModel):
id: str
object: Literal["organization"]
name: str
domains: List[OrganizationDomain]
domains: Sequence[OrganizationDomain]
created_at: str
updated_at: str
4 changes: 2 additions & 2 deletions workos/types/roles/role.py
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
from typing import List, Literal, Optional
from typing import Literal, Optional, Sequence
from workos.resources.workos_model import WorkOSModel


class Role(WorkOSModel):
object: Literal["role"]
slug: str
permissions: Optional[List[str]] = None
permissions: Optional[Sequence[str]] = None

0 comments on commit 22d961c

Please sign in to comment.