[PBE-1321] support campaign endpoints #155

kanat · 2024-02-10T00:41:26Z

Submit a pull request

CLA

I have signed the Stream CLA (required).
The code changes follow best practices
Code changes are tested (add some information if not applicable)

Description of the pull request

github-actions · 2024-02-10T00:41:51Z

stream_chat/base/client.py

+from typing import Any, Awaitable, Dict, Iterable, List, TypeVar, Union, Optional
+
+from stream_chat.types.campaign import CampaignData, QueryCampaignsOptions
+from stream_chat.types.segment import SegmentType, SegmentData, QuerySegmentsOptions, UpdateSegmentData


[black] _{reported by reviewdog 🐶}

Suggested change

from stream_chat.types.segment import SegmentType, SegmentData, QuerySegmentsOptions, UpdateSegmentData

from stream_chat.types.segment import (

SegmentType,

SegmentData,

QuerySegmentsOptions,

UpdateSegmentData,

)

github-actions · 2024-02-10T00:41:51Z

stream_chat/base/client.py

@@ -920,7 +923,7 @@ def list_roles(self) -> Union[StreamResponse, Awaitable[StreamResponse]]:

    @abc.abstractmethod
    def create_segment(
-        self, segment: Dict
+        self, segment_type: SegmentType, segment_id: str, segment_name: str, data: SegmentData


[black] _{reported by reviewdog 🐶}

Suggested change

self, segment_type: SegmentType, segment_id: str, segment_name: str, data: SegmentData

self,

segment_type: SegmentType,

segment_id: str,

segment_name: str,

data: SegmentData,

github-actions · 2024-02-10T00:41:51Z

stream_chat/client.py

@@ -6,6 +6,9 @@
 from urllib.parse import urlparse
 from urllib.request import Request, urlopen

+from stream_chat.types.campaign import QueryCampaignsOptions, CampaignData
+from stream_chat.types.segment import SegmentType, QuerySegmentsOptions, UpdateSegmentData


[black] _{reported by reviewdog 🐶}

Suggested change

from stream_chat.types.segment import SegmentType, QuerySegmentsOptions, UpdateSegmentData

from stream_chat.types.segment import (

SegmentType,

QuerySegmentsOptions,

UpdateSegmentData,

)

github-actions · 2024-02-10T00:41:51Z

stream_chat/client.py

+    def create_segment(self, segment_type: SegmentType, segment_id: str, name: str, data: Dict) -> StreamResponse:
+        return self.post("segments", data={"type": segment_type.value, "id": segment_id, "name": name, "data": data})

-    def query_segments(self, **params: Any) -> StreamResponse:
-        return self.get("segments", params={"payload": json.dumps(params)})
+    def query_segments(self, filter_conditions: Dict, options: QuerySegmentsOptions) -> StreamResponse:


[black] _{reported by reviewdog 🐶}

Suggested change

def create_segment(self, segment_type: SegmentType, segment_id: str, name: str, data: Dict) -> StreamResponse:

return self.post("segments", data={"type": segment_type.value, "id": segment_id, "name": name, "data": data})

def query_segments(self, **params: Any) -> StreamResponse:

return self.get("segments", params={"payload": json.dumps(params)})

def query_segments(self, filter_conditions: Dict, options: QuerySegmentsOptions) -> StreamResponse:

def create_segment(

self, segment_type: SegmentType, segment_id: str, name: str, data: Dict

) -> StreamResponse:

return self.post(

"segments",

data={

"type": segment_type.value,

"id": segment_id,

"name": name,

"data": data,

},

)

def query_segments(

self, filter_conditions: Dict, options: QuerySegmentsOptions

) -> StreamResponse:

github-actions · 2024-02-10T00:41:51Z

stream_chat/client.py


-    def update_segment(self, segment_id: str, data: Dict) -> StreamResponse:
-        return self.put(f"segments/{segment_id}", data={"segment": data})
+    def update_segment(self, segment_id: str, data: UpdateSegmentData) -> StreamResponse:


[black] _{reported by reviewdog 🐶}

Suggested change

def update_segment(self, segment_id: str, data: UpdateSegmentData) -> StreamResponse:

def update_segment(

self, segment_id: str, data: UpdateSegmentData

) -> StreamResponse:

github-actions · 2024-02-10T00:41:52Z

stream_chat/async_chat/client.py


-    async def update_segment(self, segment_id: str, data: Dict) -> StreamResponse:
-        return await self.put(f"segments/{segment_id}", data={"segment": data})
+    async def update_segment(self, segment_id: str, data: UpdateSegmentData) -> StreamResponse:


[black] _{reported by reviewdog 🐶}

Suggested change

async def update_segment(self, segment_id: str, data: UpdateSegmentData) -> StreamResponse:

async def update_segment(

self, segment_id: str, data: UpdateSegmentData

) -> StreamResponse:

github-actions · 2024-02-10T00:41:52Z

stream_chat/async_chat/client.py


-    async def query_campaigns(self, **params: Any) -> StreamResponse:
-        return await self.get("campaigns", params={"payload": json.dumps(params)})
+    async def query_campaigns(self, filter_conditions: Dict[str, Any], options: QueryCampaignsOptions = None) -> StreamResponse:


[black] _{reported by reviewdog 🐶}

Suggested change

async def query_campaigns(self, filter_conditions: Dict[str, Any], options: QueryCampaignsOptions = None) -> StreamResponse:

async def query_campaigns(

self, filter_conditions: Dict[str, Any], options: QueryCampaignsOptions = None

) -> StreamResponse:

github-actions · 2024-02-10T00:41:52Z

stream_chat/async_chat/client.py


-    async def update_campaign(self, campaign_id: str, data: Dict) -> StreamResponse:
-        return await self.put(f"campaigns/{campaign_id}", data={"campaign": data})
+    async def update_campaign(self, campaign_id: str, params: CampaignData) -> StreamResponse:


[black] _{reported by reviewdog 🐶}

Suggested change

async def update_campaign(self, campaign_id: str, params: CampaignData) -> StreamResponse:

async def update_campaign(

self, campaign_id: str, params: CampaignData

) -> StreamResponse:

github-actions · 2024-02-10T00:41:52Z

stream_chat/types/base.py

+
+
+


[black] _{reported by reviewdog 🐶}

Suggested change

github-actions · 2024-02-10T00:41:52Z

stream_chat/types/campaign.py

+
+
+
+
+


[black] _{reported by reviewdog 🐶}

Suggested change

github-actions · 2024-02-10T00:41:54Z

stream_chat/async_chat/client.py

@@ -16,6 +16,9 @@
 )
 from urllib.parse import urlparse

+from stream_chat.types.campaign import CampaignData, QueryCampaignsOptions
+from stream_chat.types.segment import SegmentType, SegmentData, QuerySegmentsOptions, UpdateSegmentData


📝 [flake8] <1> _{reported by reviewdog 🐶}
isort found an import in the wrong position

github-actions · 2024-02-10T00:41:55Z

stream_chat/async_chat/client.py

@@ -16,6 +16,9 @@
 )
 from urllib.parse import urlparse

+from stream_chat.types.campaign import CampaignData, QueryCampaignsOptions
+from stream_chat.types.segment import SegmentType, SegmentData, QuerySegmentsOptions, UpdateSegmentData
+


📝 [flake8] <5> _{reported by reviewdog 🐶}
isort found an unexpected missing import

github-actions · 2024-02-10T00:41:55Z

stream_chat/async_chat/client.py

@@ -16,6 +16,9 @@
 )
 from urllib.parse import urlparse

+from stream_chat.types.campaign import CampaignData, QueryCampaignsOptions
+from stream_chat.types.segment import SegmentType, SegmentData, QuerySegmentsOptions, UpdateSegmentData
+


📝 [flake8] <5> _{reported by reviewdog 🐶}
isort found an unexpected missing import

github-actions · 2024-02-10T00:41:55Z

stream_chat/async_chat/client.py

@@ -16,6 +16,9 @@
 )
 from urllib.parse import urlparse

+from stream_chat.types.campaign import CampaignData, QueryCampaignsOptions
+from stream_chat.types.segment import SegmentType, SegmentData, QuerySegmentsOptions, UpdateSegmentData
+


📝 [flake8] <5> _{reported by reviewdog 🐶}
isort found an unexpected missing import

github-actions · 2024-02-10T00:41:55Z

stream_chat/async_chat/client.py

@@ -16,6 +16,9 @@
 )
 from urllib.parse import urlparse

+from stream_chat.types.campaign import CampaignData, QueryCampaignsOptions
+from stream_chat.types.segment import SegmentType, SegmentData, QuerySegmentsOptions, UpdateSegmentData
+


📝 [flake8] <5> _{reported by reviewdog 🐶}
isort found an unexpected missing import

github-actions · 2024-02-10T00:41:56Z

stream_chat/types/campaign.py

@@ -0,0 +1,29 @@
+from typing import List, Optional, TypedDict, Dict


📝 [flake8] <1> _{reported by reviewdog 🐶}
isort found an import in the wrong position

github-actions · 2024-02-10T00:41:56Z

stream_chat/types/campaign.py

@@ -0,0 +1,29 @@
+from typing import List, Optional, TypedDict, Dict
+


📝 [flake8] <5> _{reported by reviewdog 🐶}
isort found an unexpected missing import

github-actions · 2024-02-10T00:41:56Z

stream_chat/types/campaign.py

+
+
+
+


⚠️ [flake8] <391> _{reported by reviewdog 🐶}
blank line at end of file

github-actions · 2024-02-10T00:41:56Z

stream_chat/types/segment.py

@@ -0,0 +1,22 @@
+from enum import Enum
+from typing import TypedDict, Optional, Dict, List


📝 [flake8] <1> _{reported by reviewdog 🐶}
isort found an import in the wrong position

github-actions · 2024-02-10T00:41:56Z

stream_chat/types/segment.py

@@ -0,0 +1,22 @@
+from enum import Enum
+from typing import TypedDict, Optional, Dict, List
+


📝 [flake8] <5> _{reported by reviewdog 🐶}
isort found an unexpected missing import

github-actions · 2024-02-10T00:42:04Z

stream_chat/client.py

@@ -518,26 +521,28 @@ def delete_role(self, name: str) -> StreamResponse:
    def list_roles(self) -> StreamResponse:
        return self.get("roles")

-    def create_segment(self, segment: Dict) -> StreamResponse:
-        return self.post("segments", data={"segment": segment})
+    def create_segment(self, segment_type: SegmentType, segment_id: str, name: str, data: Dict) -> StreamResponse:


🚫 [mypy] _{reported by reviewdog 🐶}
Argument 4 of "create_segment" is incompatible with supertype "StreamChatInterface"; supertype defines the argument type as "SegmentData" [override]

github-actions · 2024-02-10T00:42:04Z

stream_chat/client.py

@@ -518,26 +521,28 @@ def delete_role(self, name: str) -> StreamResponse:
    def list_roles(self) -> StreamResponse:
        return self.get("roles")

-    def create_segment(self, segment: Dict) -> StreamResponse:
-        return self.post("segments", data={"segment": segment})
+    def create_segment(self, segment_type: SegmentType, segment_id: str, name: str, data: Dict) -> StreamResponse:


📝 [mypy] _{reported by reviewdog 🐶}
This violates the Liskov substitution principle

github-actions · 2024-02-10T00:42:04Z

stream_chat/client.py

@@ -518,26 +521,28 @@ def delete_role(self, name: str) -> StreamResponse:
    def list_roles(self) -> StreamResponse:
        return self.get("roles")

-    def create_segment(self, segment: Dict) -> StreamResponse:
-        return self.post("segments", data={"segment": segment})
+    def create_segment(self, segment_type: SegmentType, segment_id: str, name: str, data: Dict) -> StreamResponse:


📝 [mypy] _{reported by reviewdog 🐶}
See https://mypy.readthedocs.io/en/stable/common_issues.html#incompatible-overrides

github-actions · 2024-02-13T04:12:29Z

stream_chat/base/segment.py

+        pass
+
+    @abc.abstractmethod
+    def update(self, data: UpdateSegmentData) -> Union[StreamResponse, Awaitable[StreamResponse]]:


[black] _{reported by reviewdog 🐶}

Suggested change

def update(self, data: UpdateSegmentData) -> Union[StreamResponse, Awaitable[StreamResponse]]:

def update(

self, data: UpdateSegmentData

) -> Union[StreamResponse, Awaitable[StreamResponse]]:

github-actions · 2024-02-13T04:12:29Z

stream_chat/campaign.py

+class Campaign(CampaignInterface):
+
+    def create(self) -> StreamResponse:
+        state = self.client.create_campaign(campaign_id=self.campaign_id, data=self.data)


[black] _{reported by reviewdog 🐶}

Suggested change

state = self.client.create_campaign(campaign_id=self.campaign_id, data=self.data)

state = self.client.create_campaign(

campaign_id=self.campaign_id, data=self.data

)

github-actions · 2024-02-13T04:12:29Z

stream_chat/segment.py

+            segment_type=self.segment_type,
+            segment_id=self.segment_id,
+            segment_name=self.segment_name,
+            data=self.data


[black] _{reported by reviewdog 🐶}

Suggested change

data=self.data

data=self.data,

github-actions · 2024-02-13T04:12:30Z

stream_chat/segment.py

+            },
+            options={
+                "limit": 1,
+            }


[black] _{reported by reviewdog 🐶}

Suggested change

}

},

github-actions · 2024-02-13T04:12:30Z

stream_chat/segment.py

+        return self.client.update_segment(
+            segment_id=self.segment_id,
+            data=data
+        )


[black] _{reported by reviewdog 🐶}

Suggested change

return self.client.update_segment(

segment_id=self.segment_id,

data=data

)

return self.client.update_segment(segment_id=self.segment_id, data=data)

github-actions · 2024-02-13T04:12:30Z

stream_chat/client.py


    def delete_segment(self, segment_id: str) -> StreamResponse:
        return self.delete(f"segments/{segment_id}")

-    def create_campaign(self, campaign: Dict) -> StreamResponse:
-        return self.post("campaigns", data={"campaign": campaign})
+    def campaign(self, campaign_id: Optional[str] = None, data: CampaignData = None) -> Campaign:


[black] _{reported by reviewdog 🐶}

Suggested change

def campaign(self, campaign_id: Optional[str] = None, data: CampaignData = None) -> Campaign:

def campaign(

self, campaign_id: Optional[str] = None, data: CampaignData = None

) -> Campaign:

github-actions · 2024-02-13T04:12:30Z

stream_chat/client.py

+    def campaign(self, campaign_id: Optional[str] = None, data: CampaignData = None) -> Campaign:
+        return Campaign(client=self, campaign_id=campaign_id, data=data)
+
+    def create_campaign(self, campaign_id: Optional[str] = None, data: CampaignData = None) -> StreamResponse:


[black] _{reported by reviewdog 🐶}

Suggested change

def create_campaign(self, campaign_id: Optional[str] = None, data: CampaignData = None) -> StreamResponse:

def create_campaign(

self, campaign_id: Optional[str] = None, data: CampaignData = None

) -> StreamResponse:

github-actions · 2024-02-13T04:12:31Z

stream_chat/client.py

+    def query_campaigns(self, filter_conditions: Dict[str, Any],
+                        options: QueryCampaignsOptions = None) -> StreamResponse:


[black] _{reported by reviewdog 🐶}

Suggested change

def query_campaigns(self, filter_conditions: Dict[str, Any],

options: QueryCampaignsOptions = None) -> StreamResponse:

def query_campaigns(

self, filter_conditions: Dict[str, Any], options: QueryCampaignsOptions = None

) -> StreamResponse:

github-actions · 2024-02-13T04:12:31Z

stream_chat/client.py

-    def schedule_campaign(
-        self, campaign_id: str, scheduled_for: int = None
+    def start_campaign(
+            self, campaign_id: str, scheduled_for: Optional[datetime.datetime] = None


[black] _{reported by reviewdog 🐶}

Suggested change

self, campaign_id: str, scheduled_for: Optional[datetime.datetime] = None

self, campaign_id: str, scheduled_for: Optional[datetime.datetime] = None

github-actions · 2024-02-13T04:12:31Z

stream_chat/types/stream_response.py

@@ -65,3 +65,7 @@ def headers(self) -> Dict[str, Any]:
    def status_code(self) -> int:
        """Returns the HTTP status code of the response."""
        return self.__status_code
+
+    def is_ok(self) -> bool:
+        """Returns True if the status code is in the 200 range. """


[black] _{reported by reviewdog 🐶}

Suggested change

"""Returns True if the status code is in the 200 range. """

"""Returns True if the status code is in the 200 range."""

github-actions · 2024-02-13T04:12:34Z

stream_chat/base/campaign.py

@@ -0,0 +1,42 @@
+import abc
+from typing import Awaitable, Dict, List, Union, Optional


📝 [flake8] <1> _{reported by reviewdog 🐶}
isort found an import in the wrong position

github-actions · 2024-02-13T04:12:34Z

stream_chat/base/campaign.py

@@ -0,0 +1,42 @@
+import abc
+from typing import Awaitable, Dict, List, Union, Optional


[flake8] <401> _{reported by reviewdog 🐶}
'typing.Dict' imported but unused

github-actions · 2024-02-13T04:12:34Z

stream_chat/base/campaign.py

@@ -0,0 +1,42 @@
+import abc
+from typing import Awaitable, Dict, List, Union, Optional


[flake8] <401> _{reported by reviewdog 🐶}
'typing.List' imported but unused

github-actions · 2024-02-13T04:12:34Z

stream_chat/base/campaign.py

@@ -0,0 +1,42 @@
+import abc
+from typing import Awaitable, Dict, List, Union, Optional
+


📝 [flake8] <5> _{reported by reviewdog 🐶}
isort found an unexpected missing import

github-actions · 2024-02-13T04:12:34Z

stream_chat/base/client.py

@@ -918,9 +924,20 @@ def list_roles(self) -> Union[StreamResponse, Awaitable[StreamResponse]]:
        """
        pass

+    def segment(self, segment_type: SegmentType, segment_id: str, segment_name: str) -> TSegment:


[flake8] <27> _{reported by reviewdog 🐶}
segment is an empty method in an abstract base class, but has no abstract decorator. Consider adding @AbstractMethod.

github-actions · 2024-02-13T04:12:35Z

stream_chat/base/segment.py

+
+from stream_chat.base.client import StreamChatInterface
+from stream_chat.types.segment import SegmentType, SegmentData, UpdateSegmentData
+from stream_chat.types.stream_response import StreamResponse


📝 [flake8] <5> _{reported by reviewdog 🐶}
isort found an unexpected missing import

github-actions · 2024-02-13T04:12:35Z

stream_chat/client.py

@@ -2,16 +2,20 @@
 import json
 import sys
 import warnings
-from typing import Any, Callable, Dict, Iterable, List, Union
+from typing import Any, Callable, Dict, Iterable, List, Union, Optional


📝 [flake8] <1> _{reported by reviewdog 🐶}
isort found an import in the wrong position

github-actions · 2024-02-13T04:12:35Z

stream_chat/client.py

+from stream_chat.campaign import Campaign
+from stream_chat.segment import Segment
+from stream_chat.types.campaign import QueryCampaignsOptions, CampaignData
+from stream_chat.types.segment import SegmentType, QuerySegmentsOptions, UpdateSegmentData, SegmentData


📝 [flake8] <1> _{reported by reviewdog 🐶}
isort found an import in the wrong position

github-actions · 2024-02-13T04:12:35Z

stream_chat/tests/test_campaign.py

+        assert "name" in created["campaign"]
+
+        client.delete_segment(segment_id=segment_id)
+


⚠️ [flake8] <391> _{reported by reviewdog 🐶}
blank line at end of file

github-actions · 2024-02-13T04:12:35Z

stream_chat/tests/test_segment.py

+
+        deleted = segment.delete()
+        assert deleted.is_ok()
+


⚠️ [flake8] <391> _{reported by reviewdog 🐶}
blank line at end of file

github-actions

Remaining comments which cannot be posted as a review comment to avoid GitHub Rate Limit

mypy

stream_chat/client.py|551 col 28| Expected:
stream_chat/client.py|551 col 28| def getitem(self, str, /) -> str
stream_chat/client.py|551 col 28| Got:
stream_chat/client.py|551 col 28| def getitem(self, str, /) -> object
stream_chat/async_chat/client.py|556 col 5| Signature of "create_campaign" incompatible with supertype "StreamChatInterface" [override]
stream_chat/async_chat/client.py|556 col 5| Superclass:
stream_chat/async_chat/client.py|556 col 5| def create_campaign(self, campaign_id: str | None, data: CampaignData | None) -> StreamResponse | Awaitable[StreamResponse]
stream_chat/async_chat/client.py|556 col 5| Subclass:
stream_chat/async_chat/client.py|556 col 5| def create_campaign(self, params: CampaignData) -> Coroutine[Any, Any, StreamResponse]

github-actions · 2024-02-13T04:12:43Z

stream_chat/base/client.py

@@ -918,9 +924,20 @@ def list_roles(self) -> Union[StreamResponse, Awaitable[StreamResponse]]:
        """
        pass

+    def segment(self, segment_type: SegmentType, segment_id: str, segment_name: str) -> TSegment:


🚫 [mypy] _{reported by reviewdog 🐶}
A function returning TypeVar should receive at least one argument containing the same TypeVar [type-var]

github-actions · 2024-02-13T04:12:43Z

stream_chat/base/client.py

@@ -954,9 +971,28 @@
        """
        pass

+    def campaign(self, campaign_id: Optional[str]):


🚫 [mypy] _{reported by reviewdog 🐶}
Function is missing a return type annotation [no-untyped-def]

github-actions · 2024-02-13T04:12:43Z

stream_chat/segment.py

+            data=self.data
+        )
+
+        if self.segment_id is None and state.is_ok() and "segment" in state:


🚫 [mypy] _{reported by reviewdog 🐶}
Item "Awaitable[StreamResponse]" of "StreamResponse | Awaitable[StreamResponse]" has no attribute "is_ok" [union-attr]

github-actions · 2024-02-13T04:12:44Z

stream_chat/segment.py

+            data=self.data
+        )
+
+        if self.segment_id is None and state.is_ok() and "segment" in state:


📝 [mypy] _{reported by reviewdog 🐶}
Maybe you forgot to use "await"?

github-actions · 2024-02-13T04:12:44Z

stream_chat/segment.py

+            data=self.data
+        )
+
+        if self.segment_id is None and state.is_ok() and "segment" in state:


🚫 [mypy] _{reported by reviewdog 🐶}
Unsupported right operand type for in ("StreamResponse | Awaitable[StreamResponse]") [operator]

github-actions · 2024-02-13T04:12:45Z

stream_chat/client.py

+        return Segment(client=self, segment_type=segment_type, segment_id=segment_id, segment_name=segment_name,
+                       data=data)
+
+    def create_segment(self, segment_type: SegmentType, segment_id: Optional[str] = None,


📝 [mypy] _{reported by reviewdog 🐶}
def create_segment(self, segment_type: SegmentType, segment_id: str, segment_name: str, data: SegmentData) -> StreamResponse | Awaitable[StreamResponse]

github-actions · 2024-02-13T04:12:45Z

stream_chat/client.py

+        return Segment(client=self, segment_type=segment_type, segment_id=segment_id, segment_name=segment_name,
+                       data=data)
+
+    def create_segment(self, segment_type: SegmentType, segment_id: Optional[str] = None,


📝 [mypy] _{reported by reviewdog 🐶}
Subclass:

github-actions · 2024-02-13T04:12:45Z

stream_chat/client.py

+        return Segment(client=self, segment_type=segment_type, segment_id=segment_id, segment_name=segment_name,
+                       data=data)
+
+    def create_segment(self, segment_type: SegmentType, segment_id: Optional[str] = None,


📝 [mypy] _{reported by reviewdog 🐶}
def create_segment(self, segment_type: SegmentType, segment_id: str | None = ..., segment_name: str | None = ..., data: dict[Any, Any] = ...) -> StreamResponse

github-actions · 2024-02-13T04:12:45Z

stream_chat/client.py

+    def create_campaign(self, campaign_id: Optional[str] = None, data: CampaignData = None) -> StreamResponse:
+        payload = {"id": campaign_id}
+        if data is not None:
+            payload.update(data)


🚫 [mypy] _{reported by reviewdog 🐶}
Argument 1 to "update" of "MutableMapping" has incompatible type "CampaignData"; expected "SupportsKeysAndGetItem[str, str]" [arg-type]

github-actions · 2024-02-13T04:12:45Z

stream_chat/client.py

+    def create_campaign(self, campaign_id: Optional[str] = None, data: CampaignData = None) -> StreamResponse:
+        payload = {"id": campaign_id}
+        if data is not None:
+            payload.update(data)


📝 [mypy] _{reported by reviewdog 🐶}
Following member(s) of "CampaignData" have conflicts:

github-actions · 2024-02-14T03:57:41Z

stream_chat/base/campaign.py

+        pass
+
+    @abc.abstractmethod
+    def update(self, data: CampaignData) -> Union[StreamResponse, Awaitable[StreamResponse]]:


[black] _{reported by reviewdog 🐶}

Suggested change

def update(self, data: CampaignData) -> Union[StreamResponse, Awaitable[StreamResponse]]:

def update(

self, data: CampaignData

) -> Union[StreamResponse, Awaitable[StreamResponse]]:

github-actions · 2024-02-14T03:57:41Z

stream_chat/base/campaign.py

+        pass
+
+    @abc.abstractmethod
+    def start(self, scheduled_for: Optional[Union[str, datetime.datetime]] = None) -> Union[StreamResponse, Awaitable[StreamResponse]]:


[black] _{reported by reviewdog 🐶}

Suggested change

def start(self, scheduled_for: Optional[Union[str, datetime.datetime]] = None) -> Union[StreamResponse, Awaitable[StreamResponse]]:

def start(

self, scheduled_for: Optional[Union[str, datetime.datetime]] = None

) -> Union[StreamResponse, Awaitable[StreamResponse]]:

github-actions · 2024-02-14T03:57:41Z

stream_chat/campaign.py

+        return self.client.update_campaign(campaign_id=self.campaign_id, data=data)
+
+    def delete(self, **options: Any) -> StreamResponse:
+        return self.client.delete_campaign(campaign_id=self.campaign_id, options=options)


[black] _{reported by reviewdog 🐶}

Suggested change

return self.client.delete_campaign(campaign_id=self.campaign_id, options=options)

return self.client.delete_campaign(

campaign_id=self.campaign_id, options=options

)

github-actions · 2024-02-14T03:57:41Z

stream_chat/campaign.py

+    def start(self, scheduled_for: Optional[Union[str, datetime.datetime]] = None) -> StreamResponse:
+        return self.client.start_campaign(campaign_id=self.campaign_id, scheduled_for=scheduled_for)


[black] _{reported by reviewdog 🐶}

Suggested change

def start(self, scheduled_for: Optional[Union[str, datetime.datetime]] = None) -> StreamResponse:

return self.client.start_campaign(campaign_id=self.campaign_id, scheduled_for=scheduled_for)

def start(

self, scheduled_for: Optional[Union[str, datetime.datetime]] = None

) -> StreamResponse:

return self.client.start_campaign(

campaign_id=self.campaign_id, scheduled_for=scheduled_for

)

github-actions · 2024-02-14T03:57:41Z

stream_chat/base/segment.py

+        pass
+
+    @abc.abstractmethod
+    def update(self, data: SegmentData) -> Union[StreamResponse, Awaitable[StreamResponse]]:


[black] _{reported by reviewdog 🐶}

Suggested change

def update(self, data: SegmentData) -> Union[StreamResponse, Awaitable[StreamResponse]]:

def update(

self, data: SegmentData

) -> Union[StreamResponse, Awaitable[StreamResponse]]:

github-actions · 2024-02-14T03:57:43Z

stream_chat/client.py

+    def segment_target_exists(
+        self, segment_id: str, target_id: str
+    ) -> StreamResponse:


[black] _{reported by reviewdog 🐶}

Suggested change

def segment_target_exists(

self, segment_id: str, target_id: str

) -> StreamResponse:

def segment_target_exists(self, segment_id: str, target_id: str) -> StreamResponse:

github-actions · 2024-02-14T03:57:43Z

stream_chat/client.py

+    def add_segment_targets(
+        self, segment_id: str, target_ids: List[str]
+    ) -> StreamResponse:
+        return self.post(f"segments/{segment_id}/addtargets", data={"targets": target_ids})


[black] _{reported by reviewdog 🐶}

Suggested change

return self.post(f"segments/{segment_id}/addtargets", data={"targets": target_ids})

return self.post(

f"segments/{segment_id}/addtargets", data={"targets": target_ids}

)

github-actions · 2024-02-14T03:57:43Z

stream_chat/client.py

+        return self.post(f"segments/{segment_id}/deletetargets", data={"targets": target_ids})
+
+    def campaign(self, campaign_id: Optional[str] = None, data: CampaignData = None) -> Campaign:


[black] _{reported by reviewdog 🐶}

Suggested change

return self.post(f"segments/{segment_id}/deletetargets", data={"targets": target_ids})

def campaign(self, campaign_id: Optional[str] = None, data: CampaignData = None) -> Campaign:

return self.post(

f"segments/{segment_id}/deletetargets", data={"targets": target_ids}

)

def campaign(

self, campaign_id: Optional[str] = None, data: CampaignData = None

) -> Campaign:

github-actions · 2024-02-14T03:57:43Z

stream_chat/client.py

-    def schedule_campaign(
-        self, campaign_id: str, scheduled_for: int = None
+    def start_campaign(
+            self, campaign_id: str, scheduled_for: Optional[Union[str, datetime.datetime]] = None


[black] _{reported by reviewdog 🐶}

Suggested change

self, campaign_id: str, scheduled_for: Optional[Union[str, datetime.datetime]] = None

self,

campaign_id: str,

scheduled_for: Optional[Union[str, datetime.datetime]] = None,

github-actions · 2024-02-14T03:57:43Z

stream_chat/client.py

+        return self.post(
+            f"campaigns/{campaign_id}/start", data=payload
        )


[black] _{reported by reviewdog 🐶}

Suggested change

return self.post(

f"campaigns/{campaign_id}/start", data=payload

)

return self.post(f"campaigns/{campaign_id}/start", data=payload)

github-actions · 2024-02-14T03:57:48Z

stream_chat/async_chat/client.py

@@ -16,6 +16,9 @@
 )
 from urllib.parse import urlparse

+from stream_chat.types.campaign import CampaignData, QueryCampaignsOptions
+from stream_chat.types.segment import SegmentType, SegmentData, QuerySegmentsOptions


📝 [flake8] <1> _{reported by reviewdog 🐶}
isort found an import in the wrong position

github-actions · 2024-02-14T03:57:48Z

stream_chat/base/client.py

+from typing import Any, Awaitable, Dict, Iterable, List, TypeVar, Union, Optional
+
+from stream_chat.types.campaign import CampaignData, QueryCampaignsOptions
+from stream_chat.types.segment import SegmentType, SegmentData, QuerySegmentsOptions


📝 [flake8] <1> _{reported by reviewdog 🐶}
isort found an import in the wrong position

github-actions · 2024-02-14T03:57:48Z

stream_chat/base/client.py

@@ -918,18 +924,38 @@ def list_roles(self) -> Union[StreamResponse, Awaitable[StreamResponse]]:
        """
        pass

+    def segment(self, segment_type: SegmentType, data: Optional[SegmentData]) -> TSegment:


[flake8] <27> _{reported by reviewdog 🐶}
segment is an empty method in an abstract base class, but has no abstract decorator. Consider adding @AbstractMethod.

github-actions · 2024-02-14T03:57:48Z

stream_chat/base/segment.py

@@ -0,0 +1,48 @@
+import abc
+from typing import Optional, Awaitable, Union, List


📝 [flake8] <1> _{reported by reviewdog 🐶}
isort found an import in the wrong position

github-actions · 2024-02-14T03:57:48Z

stream_chat/base/segment.py

+from typing import Optional, Awaitable, Union, List
+
+from stream_chat.base.client import StreamChatInterface
+from stream_chat.types.segment import SegmentType, SegmentData


📝 [flake8] <1> _{reported by reviewdog 🐶}
isort found an import in the wrong position

github-actions · 2024-02-14T03:57:48Z

stream_chat/client.py

+from stream_chat.campaign import Campaign
+from stream_chat.segment import Segment
+from stream_chat.types.campaign import QueryCampaignsOptions, CampaignData
+from stream_chat.types.segment import SegmentType, QuerySegmentsOptions, SegmentData


📝 [flake8] <1> _{reported by reviewdog 🐶}
isort found an import in the wrong position

github-actions · 2024-02-14T03:57:48Z

stream_chat/client.py

+    def segment(self, segment_type: SegmentType, segment_id: Optional[str] = None, data: Optional[SegmentData] = None) -> Segment:
+        return Segment(client=self, segment_type=segment_type, segment_id=segment_id, data=data)
+
+    def create_segment(self, segment_type: SegmentType, segment_id: Optional[str]=None, data: Optional[SegmentData] = None) -> StreamResponse:


🚫 [flake8] <252> _{reported by reviewdog 🐶}
missing whitespace around parameter equals

github-actions · 2024-02-14T03:57:48Z

stream_chat/client.py

+    def segment(self, segment_type: SegmentType, segment_id: Optional[str] = None, data: Optional[SegmentData] = None) -> Segment:
+        return Segment(client=self, segment_type=segment_type, segment_id=segment_id, data=data)
+
+    def create_segment(self, segment_type: SegmentType, segment_id: Optional[str]=None, data: Optional[SegmentData] = None) -> StreamResponse:


🚫 [flake8] <252> _{reported by reviewdog 🐶}
missing whitespace around parameter equals

github-actions · 2024-02-14T03:57:48Z

stream_chat/tests/test_segment.py

+
+        deleted = segment.delete()
+        assert deleted.is_ok()
+


⚠️ [flake8] <391> _{reported by reviewdog 🐶}
blank line at end of file

github-actions

Remaining comments which cannot be posted as a review comment to avoid GitHub Rate Limit

mypy

github-actions · 2024-02-14T03:57:57Z

stream_chat/base/client.py

@@ -918,18 +924,38 @@ def list_roles(self) -> Union[StreamResponse, Awaitable[StreamResponse]]:
        """
        pass

+    def segment(self, segment_type: SegmentType, data: Optional[SegmentData]) -> TSegment:


🚫 [mypy] _{reported by reviewdog 🐶}
A function returning TypeVar should receive at least one argument containing the same TypeVar [type-var]

github-actions · 2024-02-14T03:57:57Z

stream_chat/segment.py

+        return state
+
+    def get(self) -> StreamResponse:
+        return self.client.get_segment(segment_id=self.segment_id)


🚫 [mypy] _{reported by reviewdog 🐶}
Incompatible return value type (got "StreamResponse | Awaitable[StreamResponse]", expected "StreamResponse") [return-value]

github-actions · 2024-02-14T03:57:57Z

stream_chat/segment.py

+        return self.client.delete_segment(segment_id=self.segment_id)
+
+    def target_exists(self, target_id: str) -> StreamResponse:
+        return self.client.segment_target_exists(segment_id=self.segment_id, target_id=target_id)


🚫 [mypy] _{reported by reviewdog 🐶}
Incompatible return value type (got "StreamResponse | Awaitable[StreamResponse]", expected "StreamResponse") [return-value]

github-actions · 2024-02-14T03:57:57Z

stream_chat/segment.py

+        return self.client.segment_target_exists(segment_id=self.segment_id, target_id=target_id)
+
+    def add_targets(self, target_ids: list) -> StreamResponse:
+        return self.client.add_segment_targets(segment_id=self.segment_id, target_ids=target_ids)


🚫 [mypy] _{reported by reviewdog 🐶}
Incompatible return value type (got "StreamResponse | Awaitable[StreamResponse]", expected "StreamResponse") [return-value]

github-actions · 2024-02-14T03:57:57Z

stream_chat/segment.py

+        return self.client.add_segment_targets(segment_id=self.segment_id, target_ids=target_ids)
+
+    def delete_targets(self, target_ids: list) -> StreamResponse:
+        return self.client.delete_segment_targets(segment_id=self.segment_id, target_ids=target_ids)


🚫 [mypy] _{reported by reviewdog 🐶}
Incompatible return value type (got "StreamResponse | Awaitable[StreamResponse]", expected "StreamResponse") [return-value]

github-actions · 2024-02-14T03:57:59Z

stream_chat/async_chat/client.py

@@ -537,35 +540,37 @@
    async def list_roles(self) -> StreamResponse:
        return await self.get("roles")

-    async def create_segment(self, segment: Dict) -> StreamResponse:
-        return await self.post("segments", data={"segment": segment})
+    async def create_segment(self, segment_type: SegmentType, segment_id: str, segment_name: str, data: SegmentData) -> StreamResponse:


📝 [mypy] _{reported by reviewdog 🐶}
Superclass:

github-actions · 2024-02-14T03:57:59Z

stream_chat/async_chat/client.py

@@ -537,35 +540,37 @@
    async def list_roles(self) -> StreamResponse:
        return await self.get("roles")

-    async def create_segment(self, segment: Dict) -> StreamResponse:
-        return await self.post("segments", data={"segment": segment})
+    async def create_segment(self, segment_type: SegmentType, segment_id: str, segment_name: str, data: SegmentData) -> StreamResponse:


📝 [mypy] _{reported by reviewdog 🐶}
def create_segment(self, segment_type: SegmentType, segment_id: str | None, data: SegmentData | None = ...) -> StreamResponse | Awaitable[StreamResponse]

github-actions · 2024-02-14T03:57:59Z

stream_chat/async_chat/client.py

@@ -537,35 +540,37 @@
    async def list_roles(self) -> StreamResponse:
        return await self.get("roles")

-    async def create_segment(self, segment: Dict) -> StreamResponse:
-        return await self.post("segments", data={"segment": segment})
+    async def create_segment(self, segment_type: SegmentType, segment_id: str, segment_name: str, data: SegmentData) -> StreamResponse:


📝 [mypy] _{reported by reviewdog 🐶}
Subclass:

github-actions · 2024-02-14T03:57:59Z

stream_chat/async_chat/client.py

@@ -537,35 +540,37 @@
    async def list_roles(self) -> StreamResponse:
        return await self.get("roles")

-    async def create_segment(self, segment: Dict) -> StreamResponse:
-        return await self.post("segments", data={"segment": segment})
+    async def create_segment(self, segment_type: SegmentType, segment_id: str, segment_name: str, data: SegmentData) -> StreamResponse:


📝 [mypy] _{reported by reviewdog 🐶}
def create_segment(self, segment_type: SegmentType, segment_id: str, segment_name: str, data: SegmentData) -> Coroutine[Any, Any, StreamResponse]

github-actions · 2024-02-14T03:57:59Z

stream_chat/async_chat/client.py


    async def delete_segment(self, segment_id: str) -> StreamResponse:
        return await self.delete(f"segments/{segment_id}")

-    async def create_campaign(self, campaign: Dict) -> StreamResponse:
-        return await self.post("campaigns", data={"campaign": campaign})
+    async def create_campaign(self, params: CampaignData) -> StreamResponse:


🚫 [mypy] _{reported by reviewdog 🐶}
Signature of "create_campaign" incompatible with supertype "StreamChatInterface" [override]

github-actions · 2024-02-14T04:21:44Z

stream_chat/async_chat/campaign.py

+class Campaign(CampaignInterface):
+
+    async def create(self) -> StreamResponse:
+        state = await self.client.create_campaign(campaign_id=self.campaign_id, data=self.data)


[black] _{reported by reviewdog 🐶}

Suggested change

state = await self.client.create_campaign(campaign_id=self.campaign_id, data=self.data)

state = await self.client.create_campaign(

campaign_id=self.campaign_id, data=self.data

)

github-actions · 2024-02-14T04:21:44Z

stream_chat/async_chat/campaign.py

+        return await self.client.get_campaign(campaign_id=self.campaign_id)
+
+    async def update(self, data: CampaignData) -> StreamResponse:
+        return await self.client.update_campaign(campaign_id=self.campaign_id, data=data)


[black] _{reported by reviewdog 🐶}

Suggested change

return await self.client.update_campaign(campaign_id=self.campaign_id, data=data)

return await self.client.update_campaign(

campaign_id=self.campaign_id, data=data

)

github-actions · 2024-02-14T04:21:44Z

stream_chat/async_chat/campaign.py

+        return await self.client.update_campaign(campaign_id=self.campaign_id, data=data)
+
+    async def delete(self, **options: Any) -> StreamResponse:
+        return await self.client.delete_campaign(campaign_id=self.campaign_id, options=options)


[black] _{reported by reviewdog 🐶}

Suggested change

return await self.client.delete_campaign(campaign_id=self.campaign_id, options=options)

return await self.client.delete_campaign(

campaign_id=self.campaign_id, options=options

)

github-actions · 2024-02-14T04:21:44Z

stream_chat/async_chat/campaign.py

+    async def start(self, scheduled_for: Optional[Union[str, datetime.datetime]] = None) -> StreamResponse:
+        return await self.client.start_campaign(campaign_id=self.campaign_id, scheduled_for=scheduled_for)


[black] _{reported by reviewdog 🐶}

Suggested change

async def start(self, scheduled_for: Optional[Union[str, datetime.datetime]] = None) -> StreamResponse:

return await self.client.start_campaign(campaign_id=self.campaign_id, scheduled_for=scheduled_for)

async def start(

self, scheduled_for: Optional[Union[str, datetime.datetime]] = None

) -> StreamResponse:

return await self.client.start_campaign(

campaign_id=self.campaign_id, scheduled_for=scheduled_for

)

github-actions · 2024-02-14T04:21:45Z

stream_chat/async_chat/segment.py

+            segment_type=self.segment_type,
+            segment_id=self.segment_id,
+            data=self.data


[black] _{reported by reviewdog 🐶}

Suggested change

segment_type=self.segment_type,

segment_id=self.segment_id,

data=self.data

segment_type=self.segment_type, segment_id=self.segment_id, data=self.data

github-actions · 2024-02-14T04:21:45Z

stream_chat/async_chat/client.py


-    async def update_campaign(self, campaign_id: str, data: Dict) -> StreamResponse:
-        return await self.put(f"campaigns/{campaign_id}", data={"campaign": data})
+    async def update_campaign(self, campaign_id: str, data: CampaignData) -> StreamResponse:


[black] _{reported by reviewdog 🐶}

Suggested change

async def update_campaign(self, campaign_id: str, data: CampaignData) -> StreamResponse:

async def update_campaign(

self, campaign_id: str, data: CampaignData

) -> StreamResponse:

github-actions · 2024-02-14T04:21:46Z

stream_chat/async_chat/client.py

-    async def schedule_campaign(
-        self, campaign_id: str, scheduled_for: int = None
+    async def start_campaign(
+            self, campaign_id: str, scheduled_for: Optional[Union[str, datetime.datetime]] = None


[black] _{reported by reviewdog 🐶}

Suggested change

self, campaign_id: str, scheduled_for: Optional[Union[str, datetime.datetime]] = None

self,

campaign_id: str,

scheduled_for: Optional[Union[str, datetime.datetime]] = None,

github-actions · 2024-02-14T04:21:46Z

stream_chat/async_chat/client.py

+        return await self.post(
+            f"campaigns/{campaign_id}/start", data=payload
        )


[black] _{reported by reviewdog 🐶}

Suggested change

return await self.post(

f"campaigns/{campaign_id}/start", data=payload

)

return await self.post(f"campaigns/{campaign_id}/start", data=payload)

github-actions · 2024-02-14T04:21:46Z

stream_chat/tests/async_chat/test_segment.py

+        updated = await segment.update({
+            "name": "updated_name"
+        })


[black] _{reported by reviewdog 🐶}

Suggested change

updated = await segment.update({

"name": "updated_name"

})

updated = await segment.update({"name": "updated_name"})

github-actions · 2024-02-14T04:21:46Z

stream_chat/tests/async_chat/test_segment.py

+
+        deleted = await segment.delete()
+        assert deleted.is_ok()
+


[black] _{reported by reviewdog 🐶}

Suggested change

github-actions · 2024-02-14T04:21:50Z

stream_chat/async_chat/client.py

-    async def create_segment(self, segment: Dict) -> StreamResponse:
-        return await self.post("segments", data={"segment": segment})
+    def segment(self, segment_type: SegmentType, segment_id: Optional[str] = None,
+                      data: Optional[SegmentData] = None) -> Segment:


🚫 [flake8] <127> _{reported by reviewdog 🐶}
continuation line over-indented for visual indent

github-actions · 2024-02-14T04:21:50Z

stream_chat/async_chat/client.py

+        return Segment(client=self, segment_type=segment_type, segment_id=segment_id, data=data)
+
+    async def create_segment(self, segment_type: SegmentType, segment_id: Optional[str] = None,
+                       data: Optional[SegmentData] = None) -> StreamResponse:


🚫 [flake8] <128> _{reported by reviewdog 🐶}
continuation line under-indented for visual indent

github-actions · 2024-02-14T04:21:50Z

stream_chat/async_chat/client.py

-    async def query_campaigns(self, **params: Any) -> StreamResponse:
-        return await self.get("campaigns", params={"payload": json.dumps(params)})
+    async def query_campaigns(self, filter_conditions: Dict[str, Any],
+                        options: QueryCampaignsOptions = None) -> StreamResponse:


🚫 [flake8] <128> _{reported by reviewdog 🐶}
continuation line under-indented for visual indent

github-actions · 2024-02-14T04:21:50Z

stream_chat/base/campaign.py

@@ -0,0 +1,43 @@
+import abc
+import datetime
+from typing import Awaitable, Union, Optional


📝 [flake8] <1> _{reported by reviewdog 🐶}
isort found an import in the wrong position

github-actions · 2024-02-14T04:21:50Z

stream_chat/tests/async_chat/test_segment.py

+
+        deleted = await segment.delete()
+        assert deleted.is_ok()
+


⚠️ [flake8] <391> _{reported by reviewdog 🐶}
blank line at end of file

github-actions · 2024-02-14T04:21:59Z

stream_chat/async_chat/segment.py

+class Segment(SegmentInterface):
+
+    async def create(self) -> StreamResponse:
+        state = await self.client.create_segment(


🚫 [mypy] _{reported by reviewdog 🐶}
Incompatible types in "await" (actual type "StreamResponse | Awaitable[StreamResponse]", expected type "Awaitable[Any]") [misc]

github-actions · 2024-02-14T04:21:59Z

stream_chat/async_chat/segment.py

+        return state
+
+    async def get(self) -> StreamResponse:
+        return await self.client.get_segment(segment_id=self.segment_id)


🚫 [mypy] _{reported by reviewdog 🐶}
Incompatible types in "await" (actual type "StreamResponse | Awaitable[StreamResponse]", expected type "Awaitable[Any]") [misc]

github-actions · 2024-02-14T04:21:59Z

stream_chat/async_chat/segment.py

+        return await self.client.get_segment(segment_id=self.segment_id)
+
+    async def update(self, data: SegmentData) -> StreamResponse:
+        return await self.client.update_segment(


🚫 [mypy] _{reported by reviewdog 🐶}
Incompatible types in "await" (actual type "StreamResponse | Awaitable[StreamResponse]", expected type "Awaitable[Any]") [misc]

github-actions · 2024-02-14T04:21:59Z

stream_chat/async_chat/segment.py

+        )
+
+    async def delete(self) -> StreamResponse:
+        return await self.client.delete_segment(segment_id=self.segment_id)


🚫 [mypy] _{reported by reviewdog 🐶}
Incompatible types in "await" (actual type "StreamResponse | Awaitable[StreamResponse]", expected type "Awaitable[Any]") [misc]

github-actions · 2024-02-14T04:21:59Z

stream_chat/async_chat/segment.py

+        return await self.client.delete_segment(segment_id=self.segment_id)
+
+    async def target_exists(self, target_id: str) -> StreamResponse:
+        return await self.client.segment_target_exists(segment_id=self.segment_id, target_id=target_id)


🚫 [mypy] _{reported by reviewdog 🐶}
Incompatible types in "await" (actual type "StreamResponse | Awaitable[StreamResponse]", expected type "Awaitable[Any]") [misc]

github-actions · 2024-02-14T04:22:01Z

stream_chat/async_chat/client.py

+    async def create_campaign(self, campaign_id: Optional[str] = None, data: CampaignData = None) -> StreamResponse:
+        payload = {"id": campaign_id}
+        if data is not None:
+            payload.update(data)


📝 [mypy] _{reported by reviewdog 🐶}
Following member(s) of "CampaignData" have conflicts:

github-actions · 2024-02-14T04:22:01Z

stream_chat/async_chat/client.py

+    async def create_campaign(self, campaign_id: Optional[str] = None, data: CampaignData = None) -> StreamResponse:
+        payload = {"id": campaign_id}
+        if data is not None:
+            payload.update(data)


📝 [mypy] _{reported by reviewdog 🐶}
Expected:

github-actions · 2024-02-14T04:22:01Z

stream_chat/async_chat/client.py

+    async def create_campaign(self, campaign_id: Optional[str] = None, data: CampaignData = None) -> StreamResponse:
+        payload = {"id": campaign_id}
+        if data is not None:
+            payload.update(data)


📝 [mypy] _{reported by reviewdog 🐶}
def getitem(self, str, /) -> str

github-actions · 2024-02-14T04:22:01Z

stream_chat/async_chat/client.py

+    async def create_campaign(self, campaign_id: Optional[str] = None, data: CampaignData = None) -> StreamResponse:
+        payload = {"id": campaign_id}
+        if data is not None:
+            payload.update(data)


📝 [mypy] _{reported by reviewdog 🐶}
Got:

github-actions · 2024-02-14T04:22:01Z

stream_chat/async_chat/client.py

+    async def create_campaign(self, campaign_id: Optional[str] = None, data: CampaignData = None) -> StreamResponse:
+        payload = {"id": campaign_id}
+        if data is not None:
+            payload.update(data)


📝 [mypy] _{reported by reviewdog 🐶}
def getitem(self, str, /) -> object

github-actions · 2024-02-15T04:46:48Z

stream_chat/async_chat/client.py

+            self, segment_id: str, target_ids: List[str]
+    ) -> StreamResponse:
+        return await self.post(f"segments/{segment_id}/addtargets", data={"target_ids": target_ids})


[black] _{reported by reviewdog 🐶}

Suggested change

self, segment_id: str, target_ids: List[str]

) -> StreamResponse:

return await self.post(f"segments/{segment_id}/addtargets", data={"target_ids": target_ids})

self, segment_id: str, target_ids: List[str]

) -> StreamResponse:

return await self.post(

f"segments/{segment_id}/addtargets", data={"target_ids": target_ids}

)

github-actions · 2024-02-15T04:46:48Z

stream_chat/async_chat/client.py

+            self, segment_id: str, target_ids: List[str]
+    ) -> StreamResponse:
+        return await self.post(f"segments/{segment_id}/deletetargets", data={"target_ids": target_ids})
+
+    def campaign(self, campaign_id: Optional[str] = None, data: CampaignData = None) -> Campaign:


[black] _{reported by reviewdog 🐶}

Suggested change

self, segment_id: str, target_ids: List[str]

) -> StreamResponse:

return await self.post(f"segments/{segment_id}/deletetargets", data={"target_ids": target_ids})

def campaign(self, campaign_id: Optional[str] = None, data: CampaignData = None) -> Campaign:

self, segment_id: str, target_ids: List[str]

) -> StreamResponse:

return await self.post(

f"segments/{segment_id}/deletetargets", data={"target_ids": target_ids}

)

def campaign(

self, campaign_id: Optional[str] = None, data: CampaignData = None

) -> Campaign:

github-actions · 2024-02-15T04:46:48Z

stream_chat/client.py

+    def add_segment_targets(
+        self, segment_id: str, target_ids: List[str]
+    ) -> StreamResponse:
+        return self.post(f"segments/{segment_id}/addtargets", data={"target_ids": target_ids})


[black] _{reported by reviewdog 🐶}

Suggested change

return self.post(f"segments/{segment_id}/addtargets", data={"target_ids": target_ids})

return self.post(

f"segments/{segment_id}/addtargets", data={"target_ids": target_ids}

)

github-actions · 2024-02-15T04:46:49Z

stream_chat/client.py

+        return self.post(f"segments/{segment_id}/deletetargets", data={"target_ids": target_ids})

-    def update_campaign(self, campaign_id: str, data: Dict) -> StreamResponse:
-        return self.put(f"campaigns/{campaign_id}", data={"campaign": data})
+    def campaign(self, campaign_id: Optional[str] = None, data: CampaignData = None) -> Campaign:


[black] _{reported by reviewdog 🐶}

Suggested change

return self.post(f"segments/{segment_id}/deletetargets", data={"target_ids": target_ids})

def update_campaign(self, campaign_id: str, data: Dict) -> StreamResponse:

return self.put(f"campaigns/{campaign_id}", data={"campaign": data})

def campaign(self, campaign_id: Optional[str] = None, data: CampaignData = None) -> Campaign:

return self.post(

f"segments/{segment_id}/deletetargets", data={"target_ids": target_ids}

)

def campaign(

self, campaign_id: Optional[str] = None, data: CampaignData = None

) -> Campaign:

github-actions

Remaining comments which cannot be posted as a review comment to avoid GitHub Rate Limit

black

stream_chat/client.py|529|
stream_chat/client.py|531|
stream_chat/client.py|537|
stream_chat/client.py|577|
stream_chat/client.py|604|
stream_chat/types/base.py|9 col 1|
stream_chat/types/base.py|21 col 1|
stream_chat/types/base.py|34 col 1|
stream_chat/types/campaign.py|15 col 1|
stream_chat/types/campaign.py|27 col 1|
stream_chat/types/campaign.py|51 col 1|
stream_chat/tests/test_segment.py|12|
stream_chat/tests/test_segment.py|29|
stream_chat/tests/test_segment.py|58|
stream_chat/tests/test_segment.py|66|
stream_chat/types/segment.py|15 col 1|
stream_chat/types/segment.py|28 col 1|

github-actions · 2024-02-15T22:08:46Z

stream_chat/async_chat/campaign.py

+
+class Campaign(CampaignInterface):
+
+    async def create(self, campaign_id: Optional[str] = None, data: Optional[CampaignData] = None) -> StreamResponse:


[black] _{reported by reviewdog 🐶}

Suggested change

async def create(self, campaign_id: Optional[str] = None, data: Optional[CampaignData] = None) -> StreamResponse:

async def create(

self, campaign_id: Optional[str] = None, data: Optional[CampaignData] = None

) -> StreamResponse:

github-actions · 2024-02-15T22:08:46Z

stream_chat/async_chat/campaign.py

+        return await self.client.update_campaign(campaign_id=self.campaign_id, data=data)
+
+    async def delete(self, **options: Any) -> StreamResponse:
+        return await self.client.delete_campaign(campaign_id=self.campaign_id, **options)


[black] _{reported by reviewdog 🐶}

Suggested change

return await self.client.delete_campaign(campaign_id=self.campaign_id, **options)

return await self.client.delete_campaign(

campaign_id=self.campaign_id, **options

)

github-actions · 2024-02-15T22:08:46Z

stream_chat/async_chat/segment.py

+from typing import Optional
+
+from stream_chat.base.segment import SegmentInterface
+from stream_chat.types.segment import SegmentData, SegmentDataWithId, QuerySegmentTargetsOptions


[black] _{reported by reviewdog 🐶}

Suggested change

from stream_chat.types.segment import SegmentData, SegmentDataWithId, QuerySegmentTargetsOptions

from stream_chat.types.segment import (

SegmentData,

SegmentDataWithId,

QuerySegmentTargetsOptions,

)

github-actions · 2024-02-15T22:08:46Z

stream_chat/async_chat/segment.py

+
+class Segment(SegmentInterface):
+
+    async def create(self, segment_id: Optional[str] = None, data: Optional[SegmentData] = None) -> StreamResponse:


[black] _{reported by reviewdog 🐶}

Suggested change

async def create(self, segment_id: Optional[str] = None, data: Optional[SegmentData] = None) -> StreamResponse:

async def create(

self, segment_id: Optional[str] = None, data: Optional[SegmentData] = None

) -> StreamResponse:

github-actions · 2024-02-15T22:08:46Z

stream_chat/async_chat/segment.py

+    async def query_targets(self, options: QuerySegmentTargetsOptions) -> StreamResponse:
+        return await self.client.query_segment_targets(segment_id=self.segment_id, options=options)


[black] _{reported by reviewdog 🐶}

Suggested change

async def query_targets(self, options: QuerySegmentTargetsOptions) -> StreamResponse:

return await self.client.query_segment_targets(segment_id=self.segment_id, options=options)

async def query_targets(

self, options: QuerySegmentTargetsOptions

) -> StreamResponse:

return await self.client.query_segment_targets(

segment_id=self.segment_id, options=options

)

github-actions · 2024-02-15T22:08:47Z

stream_chat/tests/async_chat/test_segment.py

+        updated = await segment.update({
+            "name": "updated_name",
+            "description": "updated_description",
+        })


[black] _{reported by reviewdog 🐶}

Suggested change

updated = await segment.update({

"name": "updated_name",

"description": "updated_description",

})

updated = await segment.update(

{

"name": "updated_name",

"description": "updated_description",

}

)

github-actions · 2024-02-15T22:08:47Z

stream_chat/tests/async_chat/test_segment.py

+        query_targets_1 = await segment.query_targets({
+            "limit": 3,
+        })


[black] _{reported by reviewdog 🐶}

Suggested change

query_targets_1 = await segment.query_targets({

"limit": 3,

})

query_targets_1 = await segment.query_targets(

{

"limit": 3,

}

)

github-actions · 2024-02-15T22:08:48Z

stream_chat/tests/async_chat/test_segment.py

+        query_targets_2 = await segment.query_targets({
+            "limit": 3,
+            "next": query_targets_1["next"],
+        })


[black] _{reported by reviewdog 🐶}

Suggested change

query_targets_2 = await segment.query_targets({

"limit": 3,

"next": query_targets_1["next"],

})

query_targets_2 = await segment.query_targets(

{

"limit": 3,

"next": query_targets_1["next"],

}

)

github-actions · 2024-02-15T22:08:48Z

stream_chat/tests/test_campaign.py

+        updated = campaign.update({
+            "message_template": {
+                "text": "{Hello}",
+            },
+            "segment_ids": [segment_id],
+            "sender_id": sender_id,
+            "name": "updated_name",
+        })


[black] _{reported by reviewdog 🐶}

Suggested change

updated = campaign.update({

"message_template": {

"text": "{Hello}",

},

"segment_ids": [segment_id],

"sender_id": sender_id,

"name": "updated_name",

})

updated = campaign.update(

{

"message_template": {

"text": "{Hello}",

},

"segment_ids": [segment_id],

"sender_id": sender_id,

"name": "updated_name",

}

)

github-actions · 2024-02-15T22:08:48Z

stream_chat/client.py

+from stream_chat.campaign import Campaign
+from stream_chat.segment import Segment
+from stream_chat.types.campaign import QueryCampaignsOptions, CampaignData
+from stream_chat.types.segment import SegmentType, QuerySegmentsOptions, SegmentData, QuerySegmentTargetsOptions


[black] _{reported by reviewdog 🐶}

Suggested change

from stream_chat.types.segment import SegmentType, QuerySegmentsOptions, SegmentData, QuerySegmentTargetsOptions

from stream_chat.types.segment import (

SegmentType,

QuerySegmentsOptions,

SegmentData,

QuerySegmentTargetsOptions,

)

github-actions · 2024-02-15T22:08:53Z

stream_chat/async_chat/client.py

+from stream_chat.async_chat.campaign import Campaign
+from stream_chat.async_chat.segment import Segment
+from stream_chat.types.campaign import CampaignData, QueryCampaignsOptions
+from stream_chat.types.segment import SegmentType, SegmentData, QuerySegmentsOptions, QuerySegmentTargetsOptions


📝 [flake8] <1> _{reported by reviewdog 🐶}
isort found an import in the wrong position

github-actions · 2024-02-15T22:08:53Z

stream_chat/async_chat/segment.py

+from typing import Optional
+
+from stream_chat.base.segment import SegmentInterface
+from stream_chat.types.segment import SegmentData, SegmentDataWithId, QuerySegmentTargetsOptions


📝 [flake8] <1> _{reported by reviewdog 🐶}
isort found an import in the wrong position

github-actions · 2024-02-15T22:08:53Z

stream_chat/async_chat/segment.py

+from typing import Optional
+
+from stream_chat.base.segment import SegmentInterface
+from stream_chat.types.segment import SegmentData, SegmentDataWithId, QuerySegmentTargetsOptions


[flake8] <401> _{reported by reviewdog 🐶}
'stream_chat.types.segment.SegmentDataWithId' imported but unused

github-actions · 2024-02-15T22:08:54Z

stream_chat/async_chat/segment.py

+
+from stream_chat.base.segment import SegmentInterface
+from stream_chat.types.segment import SegmentData, SegmentDataWithId, QuerySegmentTargetsOptions
+from stream_chat.types.stream_response import StreamResponse


📝 [flake8] <5> _{reported by reviewdog 🐶}
isort found an unexpected missing import

github-actions · 2024-02-15T22:08:54Z

stream_chat/async_chat/segment.py

+
+from stream_chat.base.segment import SegmentInterface
+from stream_chat.types.segment import SegmentData, SegmentDataWithId, QuerySegmentTargetsOptions
+from stream_chat.types.stream_response import StreamResponse


📝 [flake8] <5> _{reported by reviewdog 🐶}
isort found an unexpected missing import

github-actions · 2024-02-15T22:08:54Z

stream_chat/client.py

+from stream_chat.campaign import Campaign
+from stream_chat.segment import Segment
+from stream_chat.types.campaign import QueryCampaignsOptions, CampaignData
+from stream_chat.types.segment import SegmentType, QuerySegmentsOptions, SegmentData, QuerySegmentTargetsOptions


📝 [flake8] <1> _{reported by reviewdog 🐶}
isort found an import in the wrong position

github-actions · 2024-02-15T22:08:54Z

stream_chat/segment.py

+from typing import Optional
+
+from stream_chat.base.segment import SegmentInterface
+from stream_chat.types.segment import SegmentData, QuerySegmentTargetsOptions


📝 [flake8] <1> _{reported by reviewdog 🐶}
isort found an import in the wrong position

github-actions · 2024-02-15T22:08:54Z

stream_chat/segment.py

+
+from stream_chat.base.segment import SegmentInterface
+from stream_chat.types.segment import SegmentData, QuerySegmentTargetsOptions
+from stream_chat.types.stream_response import StreamResponse


📝 [flake8] <5> _{reported by reviewdog 🐶}
isort found an unexpected missing import

github-actions · 2024-02-15T22:08:54Z

stream_chat/types/base.py

@@ -0,0 +1,36 @@
+from enum import IntEnum
+from typing import TypedDict, Optional


📝 [flake8] <1> _{reported by reviewdog 🐶}
isort found an import in the wrong position

github-actions · 2024-02-15T22:08:54Z

stream_chat/types/campaign.py

@@ -0,0 +1,64 @@
+import datetime
+from typing import List, Optional, TypedDict, Dict, Union


📝 [flake8] <1> _{reported by reviewdog 🐶}
isort found an import in the wrong position

github-actions · 2024-02-15T22:09:04Z

stream_chat/base/client.py

@@ -918,18 +924,39 @@ def list_roles(self) -> Union[StreamResponse, Awaitable[StreamResponse]]:
        """
        pass

+    def segment(
+        self, segment_type: SegmentType, segment_id: Optional[str], data: Optional[SegmentData]
+    ) -> TSegment:


🚫 [mypy] _{reported by reviewdog 🐶}
A function returning TypeVar should receive at least one argument containing the same TypeVar [type-var]

github-actions · 2024-02-15T22:09:04Z

stream_chat/base/client.py

+
+    def campaign(
+        self, campaign_id: Optional[str], data: Optional[CampaignData]
+    ) -> TCampaign:


🚫 [mypy] _{reported by reviewdog 🐶}
A function returning TypeVar should receive at least one argument containing the same TypeVar [type-var]

github-actions · 2024-02-15T22:09:04Z

stream_chat/segment.py

+        return self.client.add_segment_targets(segment_id=self.segment_id, target_ids=target_ids)
+
+    def query_targets(self, options: QuerySegmentTargetsOptions) -> StreamResponse:
+        return self.client.query_segment_targets(segment_id=self.segment_id, options=options)


🚫 [mypy] _{reported by reviewdog 🐶}
Incompatible return value type (got "StreamResponse | Awaitable[StreamResponse]", expected "StreamResponse") [return-value]

github-actions · 2024-02-15T22:09:04Z

stream_chat/campaign.py

+        return self.client.update_campaign(campaign_id=self.campaign_id, data=data)
+
+    def delete(self, **options: Any) -> StreamResponse:
+        return self.client.delete_campaign(campaign_id=self.campaign_id, **options)


🚫 [mypy] _{reported by reviewdog 🐶}
Incompatible return value type (got "StreamResponse | Awaitable[StreamResponse]", expected "StreamResponse") [return-value]

github-actions · 2024-02-15T22:09:04Z

stream_chat/async_chat/segment.py

+        return await self.client.add_segment_targets(segment_id=self.segment_id, target_ids=target_ids)
+
+    async def query_targets(self, options: QuerySegmentTargetsOptions) -> StreamResponse:
+        return await self.client.query_segment_targets(segment_id=self.segment_id, options=options)


🚫 [mypy] _{reported by reviewdog 🐶}
Incompatible types in "await" (actual type "StreamResponse | Awaitable[StreamResponse]", expected type "Awaitable[Any]") [misc]

github-actions · 2024-02-15T22:09:06Z

stream_chat/async_chat/client.py

+    ) -> StreamResponse:
+        return await self.post(f"segments/{segment_id}/deletetargets", data={"target_ids": target_ids})
+
+    def campaign(self, campaign_id: Optional[str] = None, data: CampaignData = None) -> Campaign:


🚫 [mypy] _{reported by reviewdog 🐶}
Signature of "campaign" incompatible with supertype "StreamChatInterface" [override]

github-actions · 2024-02-15T22:09:06Z

stream_chat/async_chat/client.py

+    ) -> StreamResponse:
+        return await self.post(f"segments/{segment_id}/deletetargets", data={"target_ids": target_ids})
+
+    def campaign(self, campaign_id: Optional[str] = None, data: CampaignData = None) -> Campaign:


📝 [mypy] _{reported by reviewdog 🐶}
Superclass:

github-actions · 2024-02-15T22:09:06Z

stream_chat/async_chat/client.py

+    ) -> StreamResponse:
+        return await self.post(f"segments/{segment_id}/deletetargets", data={"target_ids": target_ids})
+
+    def campaign(self, campaign_id: Optional[str] = None, data: CampaignData = None) -> Campaign:


📝 [mypy] _{reported by reviewdog 🐶}
def [TCampaign] campaign(self, campaign_id: str | None, data: CampaignData | None) -> TCampaign

github-actions · 2024-02-15T22:09:06Z

stream_chat/async_chat/client.py

+    ) -> StreamResponse:
+        return await self.post(f"segments/{segment_id}/deletetargets", data={"target_ids": target_ids})
+
+    def campaign(self, campaign_id: Optional[str] = None, data: CampaignData = None) -> Campaign:


📝 [mypy] _{reported by reviewdog 🐶}
Subclass:

github-actions · 2024-02-15T22:09:06Z

stream_chat/async_chat/client.py

+    ) -> StreamResponse:
+        return await self.post(f"segments/{segment_id}/deletetargets", data={"target_ids": target_ids})
+
+    def campaign(self, campaign_id: Optional[str] = None, data: CampaignData = None) -> Campaign:


📝 [mypy] _{reported by reviewdog 🐶}
def campaign(self, campaign_id: str | None = ..., data: CampaignData = ...) -> Campaign

github-actions · 2024-02-15T22:53:59Z

stream_chat/async_chat/segment.py

+from typing import Optional
+
+from stream_chat.base.segment import SegmentInterface
+from stream_chat.types.segment import (


[flake8] <401> _{reported by reviewdog 🐶}
'stream_chat.types.segment.SegmentDataWithId' imported but unused

github-actions · 2024-02-15T22:53:59Z

stream_chat/base/segment.py

+from typing import Awaitable, List, Optional, Union
+
+from stream_chat.base.client import StreamChatInterface
+from stream_chat.types.segment import (


[flake8] <401> _{reported by reviewdog 🐶}
'stream_chat.types.segment.SegmentDataWithId' imported but unused

github-actions · 2024-02-15T22:54:09Z

stream_chat/segment.py

+        return self.client.get_segment(segment_id=self.segment_id)
+
+    def update(self, data: SegmentData) -> StreamResponse:
+        return self.client.update_segment(segment_id=self.segment_id, data=data)


🚫 [mypy] _{reported by reviewdog 🐶}
Incompatible return value type (got "StreamResponse | Awaitable[StreamResponse]", expected "StreamResponse") [return-value]

github-actions · 2024-02-15T22:54:09Z

stream_chat/segment.py

+        return self.client.delete_segment(segment_id=self.segment_id)
+
+    def target_exists(self, target_id: str) -> StreamResponse:
+        return self.client.segment_target_exists(


🚫 [mypy] _{reported by reviewdog 🐶}
Incompatible return value type (got "StreamResponse | Awaitable[StreamResponse]", expected "StreamResponse") [return-value]

github-actions · 2024-02-15T22:54:09Z

stream_chat/segment.py

+        )
+
+    def add_targets(self, target_ids: list) -> StreamResponse:
+        return self.client.add_segment_targets(


🚫 [mypy] _{reported by reviewdog 🐶}
Incompatible return value type (got "StreamResponse | Awaitable[StreamResponse]", expected "StreamResponse") [return-value]

github-actions · 2024-02-15T22:54:09Z

stream_chat/segment.py

+        )
+
+    def query_targets(self, options: QuerySegmentTargetsOptions) -> StreamResponse:
+        return self.client.query_segment_targets(


🚫 [mypy] _{reported by reviewdog 🐶}
Incompatible return value type (got "StreamResponse | Awaitable[StreamResponse]", expected "StreamResponse") [return-value]

github-actions · 2024-02-15T22:54:09Z

stream_chat/segment.py

+        )
+
+    def delete_targets(self, target_ids: list) -> StreamResponse:
+        return self.client.delete_segment_targets(


🚫 [mypy] _{reported by reviewdog 🐶}
Incompatible return value type (got "StreamResponse | Awaitable[StreamResponse]", expected "StreamResponse") [return-value]

github-actions · 2024-02-15T22:54:11Z

stream_chat/async_chat/client.py

        )

-    async def query_recipients(self, **params: Any) -> StreamResponse:
-        return await self.get("recipients", params={"payload": json.dumps(params)})
+    def campaign(


🚫 [mypy] _{reported by reviewdog 🐶}
Signature of "campaign" incompatible with supertype "StreamChatInterface" [override]

github-actions · 2024-02-15T22:54:11Z

stream_chat/async_chat/client.py

        )

-    async def query_recipients(self, **params: Any) -> StreamResponse:
-        return await self.get("recipients", params={"payload": json.dumps(params)})
+    def campaign(


📝 [mypy] _{reported by reviewdog 🐶}
Superclass:

github-actions · 2024-02-15T22:54:11Z

stream_chat/async_chat/client.py

        )

-    async def query_recipients(self, **params: Any) -> StreamResponse:
-        return await self.get("recipients", params={"payload": json.dumps(params)})
+    def campaign(


📝 [mypy] _{reported by reviewdog 🐶}
def [TCampaign] campaign(self, campaign_id: str | None, data: CampaignData | None) -> TCampaign

github-actions · 2024-02-15T22:54:11Z

stream_chat/async_chat/client.py

        )

-    async def query_recipients(self, **params: Any) -> StreamResponse:
-        return await self.get("recipients", params={"payload": json.dumps(params)})
+    def campaign(


📝 [mypy] _{reported by reviewdog 🐶}
Subclass:

github-actions · 2024-02-15T22:54:11Z

stream_chat/async_chat/client.py

        )

-    async def query_recipients(self, **params: Any) -> StreamResponse:
-        return await self.get("recipients", params={"payload": json.dumps(params)})
+    def campaign(


📝 [mypy] _{reported by reviewdog 🐶}
def campaign(self, campaign_id: str | None = ..., data: CampaignData = ...) -> Campaign

github-actions · 2024-02-21T20:24:43Z

stream_chat/base/client.py

+        self,
+        filter_conditions: Optional[Dict[str, Any]] = None,
+        sort: Optional[List[SortParam]] = None,
+        options: Optional[QueryCampaignsOptions] = None


[black] _{reported by reviewdog 🐶}

Suggested change

options: Optional[QueryCampaignsOptions] = None

options: Optional[QueryCampaignsOptions] = None,

github-actions · 2024-02-21T20:24:43Z

stream_chat/tests/async_chat/test_segment.py

+        segment_id = created["segment"]["id"]
+
+        target_ids = [str(uuid.uuid4()) for _ in range(10)]
+        target_added = await client.add_segment_targets(segment_id=segment_id, target_ids=target_ids)


[black] _{reported by reviewdog 🐶}

Suggested change

target_added = await client.add_segment_targets(segment_id=segment_id, target_ids=target_ids)

target_added = await client.add_segment_targets(

segment_id=segment_id, target_ids=target_ids

)

github-actions · 2024-02-21T20:24:43Z

stream_chat/tests/async_chat/test_segment.py

+        target_added = await client.add_segment_targets(segment_id=segment_id, target_ids=target_ids)
+        assert target_added.is_ok()
+
+        query_segments = await client.query_segments(filter_conditions={"id": {"$eq": segment_id}})


[black] _{reported by reviewdog 🐶}

Suggested change

query_segments = await client.query_segments(filter_conditions={"id": {"$eq": segment_id}})

query_segments = await client.query_segments(

filter_conditions={"id": {"$eq": segment_id}}

)

github-actions · 2024-02-21T20:24:43Z

stream_chat/tests/async_chat/test_segment.py

+        assert "segments" in query_segments
+        assert len(query_segments["segments"]) == 1
+
+        target_deleted = await client.remove_segment_targets(segment_id=segment_id, target_ids=target_ids)


[black] _{reported by reviewdog 🐶}

Suggested change

target_deleted = await client.remove_segment_targets(segment_id=segment_id, target_ids=target_ids)

target_deleted = await client.remove_segment_targets(

segment_id=segment_id, target_ids=target_ids

)

github-actions · 2024-02-21T20:24:43Z

stream_chat/tests/async_chat/test_segment.py

+        assert target_deleted.is_ok()
+
+        deleted = await client.delete_segment(segment_id=segment_id)
+        assert deleted.is_ok()


[black] _{reported by reviewdog 🐶}

Suggested change

assert deleted.is_ok()

assert deleted.is_ok()

github-actions · 2024-02-21T20:24:43Z

stream_chat/client.py

+        self,
+        filter_conditions: Optional[Dict[str, Any]] = None,
+        sort: Optional[List[SortParam]] = None,
+        options: Optional[QuerySegmentsOptions] = None


[black] _{reported by reviewdog 🐶}

Suggested change

options: Optional[QuerySegmentsOptions] = None

options: Optional[QuerySegmentsOptions] = None,

github-actions · 2024-02-21T20:24:44Z

stream_chat/client.py

+        self,
+        filter_conditions: Optional[Dict[str, Any]] = None,
+        sort: Optional[List[SortParam]] = None,
+        options: Optional[QueryCampaignsOptions] = None


[black] _{reported by reviewdog 🐶}

Suggested change

options: Optional[QueryCampaignsOptions] = None

options: Optional[QueryCampaignsOptions] = None,

github-actions · 2024-02-21T20:24:44Z

stream_chat/tests/test_segment.py

+        segment_id = created["segment"]["id"]
+
+        target_ids = [str(uuid.uuid4()) for _ in range(10)]
+        target_added = client.add_segment_targets(segment_id=segment_id, target_ids=target_ids)


[black] _{reported by reviewdog 🐶}

Suggested change

target_added = client.add_segment_targets(segment_id=segment_id, target_ids=target_ids)

target_added = client.add_segment_targets(

segment_id=segment_id, target_ids=target_ids

)

github-actions · 2024-02-21T20:24:44Z

stream_chat/tests/test_segment.py

+        target_added = client.add_segment_targets(segment_id=segment_id, target_ids=target_ids)
+        assert target_added.is_ok()
+
+        query_segments = client.query_segments(filter_conditions={"id": {"$eq": segment_id}})


[black] _{reported by reviewdog 🐶}

Suggested change

query_segments = client.query_segments(filter_conditions={"id": {"$eq": segment_id}})

query_segments = client.query_segments(

filter_conditions={"id": {"$eq": segment_id}}

)

github-actions · 2024-02-21T20:24:44Z

stream_chat/tests/test_segment.py

+        assert "segments" in query_segments
+        assert len(query_segments["segments"]) == 1
+
+        target_deleted = client.remove_segment_targets(segment_id=segment_id, target_ids=target_ids)


[black] _{reported by reviewdog 🐶}

Suggested change

target_deleted = client.remove_segment_targets(segment_id=segment_id, target_ids=target_ids)

target_deleted = client.remove_segment_targets(

segment_id=segment_id, target_ids=target_ids

)

github-actions · 2024-02-21T20:24:50Z

stream_chat/async_chat/segment.py

@@ -0,0 +1,66 @@
+from typing import Dict, Optional, List


📝 [flake8] <1> _{reported by reviewdog 🐶}
isort found an import in the wrong position

github-actions · 2024-02-21T20:24:50Z

stream_chat/async_chat/segment.py

@@ -0,0 +1,66 @@
+from typing import Dict, Optional, List
+


📝 [flake8] <5> _{reported by reviewdog 🐶}
isort found an unexpected missing import

github-actions · 2024-02-21T20:24:51Z

stream_chat/segment.py

@@ -0,0 +1,64 @@
+from typing import Dict, Optional, List


📝 [flake8] <1> _{reported by reviewdog 🐶}
isort found an import in the wrong position

github-actions · 2024-02-21T20:24:51Z

stream_chat/segment.py

@@ -0,0 +1,64 @@
+from typing import Dict, Optional, List
+


📝 [flake8] <5> _{reported by reviewdog 🐶}
isort found an unexpected missing import

github-actions · 2024-02-21T20:24:51Z

stream_chat/tests/async_chat/test_segment.py

+        assert target_deleted.is_ok()
+
+        deleted = await client.delete_segment(segment_id=segment_id)
+        assert deleted.is_ok()


⚠️ [flake8] <292> _{reported by reviewdog 🐶}
no newline at end of file

github-actions · 2024-02-21T20:24:51Z

stream_chat/types/campaign.py

@@ -0,0 +1,70 @@
+from typing import Dict, List, Optional, TypedDict
+
+from stream_chat.types.base import Pager, SortParam


[flake8] <401> _{reported by reviewdog 🐶}
'stream_chat.types.base.SortParam' imported but unused

github-actions · 2024-02-21T20:24:51Z

stream_chat/types/segment.py

@@ -0,0 +1,40 @@
+from enum import Enum
+from typing import Dict, List, Optional, TypedDict


[flake8] <401> _{reported by reviewdog 🐶}
'typing.List' imported but unused

github-actions · 2024-02-21T20:24:51Z

stream_chat/types/segment.py

+from enum import Enum
+from typing import Dict, List, Optional, TypedDict
+
+from stream_chat.types.base import Pager, SortParam


[flake8] <401> _{reported by reviewdog 🐶}
'stream_chat.types.base.SortParam' imported but unused

github-actions · 2024-02-21T20:25:02Z

stream_chat/segment.py

+            segment_id=self.segment_id, target_ids=target_ids
+        )
+
+    def query_targets(


🚫 [mypy] _{reported by reviewdog 🐶}
Signature of "query_targets" incompatible with supertype "SegmentInterface" [override]

github-actions · 2024-02-21T20:25:02Z

stream_chat/segment.py

+            segment_id=self.segment_id, target_ids=target_ids
+        )
+
+    def query_targets(


📝 [mypy] _{reported by reviewdog 🐶}
Superclass:

github-actions · 2024-02-21T20:25:02Z

stream_chat/segment.py

+            segment_id=self.segment_id, target_ids=target_ids
+        )
+
+    def query_targets(


📝 [mypy] _{reported by reviewdog 🐶}
def query_targets(self, filter_conditions: dict[Any, Any] | None = ..., options: QuerySegmentTargetsOptions | None = ...) -> StreamResponse | Awaitable[StreamResponse]

github-actions · 2024-02-21T20:25:02Z

stream_chat/segment.py

+            segment_id=self.segment_id, target_ids=target_ids
+        )
+
+    def query_targets(


📝 [mypy] _{reported by reviewdog 🐶}
Subclass:

github-actions · 2024-02-21T20:25:02Z

stream_chat/segment.py

+            segment_id=self.segment_id, target_ids=target_ids
+        )
+
+    def query_targets(


📝 [mypy] _{reported by reviewdog 🐶}
def query_targets(self, filter_conditions: dict[Any, Any] | None = ..., sort: list[SortParam] | None = ..., options: QuerySegmentTargetsOptions | None = ...) -> StreamResponse

github-actions · 2024-02-21T20:25:03Z

stream_chat/client.py

+        if filter_conditions is not None:
+            payload["filter"] = filter_conditions
+        if sort is not None:
+            payload["sort"] = sort


🚫 [mypy] _{reported by reviewdog 🐶}
Incompatible types in assignment (expression has type "list[SortParam]", target has type "dict[str, Any]") [assignment]

github-actions · 2024-02-21T20:25:03Z

stream_chat/client.py

+        if filter_conditions is not None:
+            payload["filter"] = filter_conditions
+        if sort is not None:
+            payload["sort"] = sort


🚫 [mypy] _{reported by reviewdog 🐶}
Incompatible types in assignment (expression has type "list[SortParam]", target has type "dict[str, Any]") [assignment]

github-actions · 2024-02-21T20:25:03Z

stream_chat/async_chat/client.py

+        if filter_conditions is not None:
+            payload["filter"] = filter_conditions
+        if sort is not None:
+            payload["sort"] = sort


🚫 [mypy] _{reported by reviewdog 🐶}
Incompatible types in assignment (expression has type "list[SortParam]", target has type "dict[str, Any]") [assignment]

github-actions · 2024-02-21T20:25:03Z

stream_chat/async_chat/client.py

+        if filter_conditions is not None:
+            payload["filter"] = filter_conditions
+        if sort is not None:
+            payload["sort"] = sort


🚫 [mypy] _{reported by reviewdog 🐶}
Incompatible types in assignment (expression has type "list[SortParam]", target has type "dict[str, Any]") [assignment]

github-actions · 2024-02-21T20:25:03Z

stream_chat/async_chat/client.py

+        if filter_conditions is not None:
+            payload["filter"] = filter_conditions
+        if sort is not None:
+            payload["sort"] = sort


🚫 [mypy] _{reported by reviewdog 🐶}
Incompatible types in assignment (expression has type "list[SortParam]", target has type "dict[str, Any]") [assignment]

kanat · 2024-02-22T19:07:58Z

Will recreate a PR

[PBE-1321] align campaign api with backend impl

7561524

github-actions bot reviewed Feb 10, 2024

View reviewed changes

kanat added 2 commits February 12, 2024 12:50

query_campaigns & query_segments => POST requests

86813fb

[PBE-1321] create resource objects; test segment CRUD

793340c

github-actions bot reviewed Feb 13, 2024

View reviewed changes

[PBE-1321] support sync channel & segment res objects

10fb316

github-actions bot reviewed Feb 14, 2024

View reviewed changes

[PBE-1321] support async layer

cb44fd7

github-actions bot reviewed Feb 14, 2024

View reviewed changes

kanat marked this pull request as ready for review February 14, 2024 04:27

kanat requested a review from gumuz as a code owner February 14, 2024 04:27

[PBE-1321] rename targets to target_ids

79218e1

github-actions bot reviewed Feb 15, 2024

View reviewed changes

[PBE-1321] add targets query support, fix tests

2805561

github-actions bot reviewed Feb 15, 2024

View reviewed changes

[PBE-1321] lint fixes

e1e5043

github-actions bot reviewed Feb 15, 2024

View reviewed changes

kanat added 2 commits February 15, 2024 14:55

[PBE-1321] lint fixes

d3fc4ff

[PBE-1321] lint fixes

2efe8c4

kanat added 6 commits February 15, 2024 15:32

[PBE-1321] return module scope

a04c60a

[PBE-1321] add custom fields

c9de86e

[PBE-1321] align with API

b1d35f2

[PBE-1321] align query_targets

06d1575

[PBE-1321] use SortOrder

1dae3c3

[PBE-1321] align query API

a50ca3d

github-actions bot reviewed Feb 21, 2024

View reviewed changes

kanat added 2 commits February 21, 2024 13:53

[PBE-1321] lint fixes

056a543

[PBE-1321] revert async test init

abe2021

kanat changed the title ~~[PBE-1321] support campaign endpoints (WIP)~~ [PBE-1321] support campaign endpoints Feb 22, 2024

kanat closed this Feb 22, 2024

		@@ -0,0 +1,29 @@
		from typing import List, Optional, TypedDict, Dict

		@@ -0,0 +1,22 @@
		from enum import Enum
		from typing import TypedDict, Optional, Dict, List

		def query_campaigns(self, filter_conditions: Dict[str, Any],
		options: QueryCampaignsOptions = None) -> StreamResponse:

	self, campaign_id: str, scheduled_for: Optional[datetime.datetime] = None
	self, campaign_id: str, scheduled_for: Optional[datetime.datetime] = None

	"""Returns True if the status code is in the 200 range. """
	"""Returns True if the status code is in the 200 range."""

		@@ -0,0 +1,42 @@
		import abc
		from typing import Awaitable, Dict, List, Union, Optional

		assert "name" in created["campaign"]

		client.delete_segment(segment_id=segment_id)

		def start(self, scheduled_for: Optional[Union[str, datetime.datetime]] = None) -> StreamResponse:
		return self.client.start_campaign(campaign_id=self.campaign_id, scheduled_for=scheduled_for)

		return self.post(f"segments/{segment_id}/deletetargets", data={"targets": target_ids})

		def campaign(self, campaign_id: Optional[str] = None, data: CampaignData = None) -> Campaign:

		@@ -0,0 +1,48 @@
		import abc
		from typing import Optional, Awaitable, Union, List

		async def start(self, scheduled_for: Optional[Union[str, datetime.datetime]] = None) -> StreamResponse:
		return await self.client.start_campaign(campaign_id=self.campaign_id, scheduled_for=scheduled_for)


		class Campaign(CampaignInterface):

		async def create(self, campaign_id: Optional[str] = None, data: Optional[CampaignData] = None) -> StreamResponse:


		class Segment(SegmentInterface):

		async def create(self, segment_id: Optional[str] = None, data: Optional[SegmentData] = None) -> StreamResponse:

		async def query_targets(self, options: QuerySegmentTargetsOptions) -> StreamResponse:
		return await self.client.query_segment_targets(segment_id=self.segment_id, options=options)

		@@ -0,0 +1,36 @@
		from enum import IntEnum
		from typing import TypedDict, Optional

		@@ -0,0 +1,64 @@
		import datetime
		from typing import List, Optional, TypedDict, Dict, Union

	options: Optional[QueryCampaignsOptions] = None
	options: Optional[QueryCampaignsOptions] = None,

	options: Optional[QuerySegmentsOptions] = None
	options: Optional[QuerySegmentsOptions] = None,

		@@ -0,0 +1,70 @@
		from typing import Dict, List, Optional, TypedDict

		from stream_chat.types.base import Pager, SortParam

		@@ -0,0 +1,40 @@
		from enum import Enum
		from typing import Dict, List, Optional, TypedDict

[PBE-1321] support campaign endpoints #155

[PBE-1321] support campaign endpoints #155

Conversation

kanat commented Feb 10, 2024

Submit a pull request

CLA

Description of the pull request

github-actions bot Feb 10, 2024

Choose a reason for hiding this comment

github-actions bot Feb 10, 2024

Choose a reason for hiding this comment

github-actions bot Feb 10, 2024

Choose a reason for hiding this comment

github-actions bot Feb 10, 2024

Choose a reason for hiding this comment

github-actions bot Feb 10, 2024

Choose a reason for hiding this comment

github-actions bot Feb 10, 2024

Choose a reason for hiding this comment

github-actions bot Feb 10, 2024

Choose a reason for hiding this comment

github-actions bot Feb 10, 2024

Choose a reason for hiding this comment

github-actions bot Feb 10, 2024

Choose a reason for hiding this comment

github-actions bot Feb 10, 2024

Choose a reason for hiding this comment

github-actions bot Feb 10, 2024

Choose a reason for hiding this comment

github-actions bot Feb 10, 2024

Choose a reason for hiding this comment

github-actions bot Feb 10, 2024

Choose a reason for hiding this comment

github-actions bot Feb 10, 2024

Choose a reason for hiding this comment

github-actions bot Feb 10, 2024

Choose a reason for hiding this comment

github-actions bot Feb 10, 2024

Choose a reason for hiding this comment

github-actions bot Feb 10, 2024

Choose a reason for hiding this comment

github-actions bot Feb 10, 2024

Choose a reason for hiding this comment

github-actions bot Feb 10, 2024

Choose a reason for hiding this comment

github-actions bot Feb 10, 2024

Choose a reason for hiding this comment

github-actions bot Feb 10, 2024

Choose a reason for hiding this comment

github-actions bot Feb 10, 2024

Choose a reason for hiding this comment

github-actions bot Feb 10, 2024

Choose a reason for hiding this comment

github-actions bot Feb 13, 2024

Choose a reason for hiding this comment

github-actions bot Feb 13, 2024

Choose a reason for hiding this comment

github-actions bot Feb 13, 2024

Choose a reason for hiding this comment

github-actions bot Feb 13, 2024

Choose a reason for hiding this comment

github-actions bot Feb 13, 2024

Choose a reason for hiding this comment

github-actions bot Feb 13, 2024

Choose a reason for hiding this comment

github-actions bot Feb 13, 2024

Choose a reason for hiding this comment

github-actions bot Feb 13, 2024

Choose a reason for hiding this comment

github-actions bot Feb 13, 2024

Choose a reason for hiding this comment

github-actions bot Feb 13, 2024

Choose a reason for hiding this comment

github-actions bot Feb 13, 2024

Choose a reason for hiding this comment

github-actions bot Feb 13, 2024

Choose a reason for hiding this comment

github-actions bot Feb 13, 2024

Choose a reason for hiding this comment

github-actions bot Feb 13, 2024