Add schedule endpoint and models (#211)

* Replace if statement with if expression

* Simplify conditional into return statement

* Inline variable that is immediately returned

* Comparison moved to the right
Use set when checking membership of a collection of literals

* Inline variable that is immediately returned

* remove none from dict.get returns none by default

* Replace if statement with if expression
Replace multiple comparisons of same variable with `in` operator
Remove redundant conditional

* Merge nested if conditions
Remove none from dict.get returns none by default

* Lift code into else after jump in control flow, Merge else clause's nested if statement into elif
Remove redundant pass statements
Simplify logical expression

* Inline variable that is immediately returned

* Merge nested if conditions
Inline variable that is immediately returned

* Merge nested if conditions

* Swap if/else branches, Remove unnecessary else after guard condition

* Replace unneeded comprehension with generator

* added fetch_channel to client

* formatting

* remove typehint of User

* Added fetch_follow method
Removed for loop for fetch_channel

* Update README.rst

Added myself....just because

* fix remove_cog

* Fixed remove_cog

* changed from list to set

* Moved fetch_follow to user from client
Fixed black formatting to 120

* Added ChannelInfo class in models
Changed fetch_channel to return the ChannelInfo object

* Removed except from remove_cog
Issue was in unload_module
Missing .items() for callsbacks
Missing .__name__ for comparison

* fixed reload_module

* added created_at to User class

* Routine fix where after task run completion
iterations would set to 0 and run infinitely.

* Add typehint for PartialUser in fetch_follow

* Removed duplicate fetch_channel
Updated docstring fetch_channel

* Changed badges to a property
returns a dict

* change to more obvious wording

* fetch duplicate fetch_channel
update docstring

* added founder to is_subscriber

* Update websocket to fix chatters
Correct some typos
Update badges docstring
Fix eventsub BanData key

* reverted changes to ChannelBanData model

* changed payload key to is_permanent for ChannelBanData

* Added Schedule models
Added user method fetch_schedule
Added associated API calls
Added explicit detail in fetch_channel docstring

* forgot to merge

* Revert "changed payload key to is_permanent for ChannelBanData"

This reverts commit ba16c04.

* Revert "forgot to merge"

This reverts commit 7b16588.

* Revert "Added Schedule models"

This reverts commit ea6f7bf.

* trying to fix my own repo

* add

* Added Schedule models
Added user method fetch_schedule
Added associated API calls
Added explicit detail in fetch_channel docstring

* added back in newlines from formatting

* change to list comp

* black formatting

* change raise to ValueError and move above comp

* changed segment_ids to list

* update docstring

* update docstring

* Changed start_time to datetime object
Internal conversion to RFC3339
Changed utc_offset to int and convert to str later

* adding modify stream to match master

* adding back in schedule

Author: chillymosh

twitchio/client.py

@@ -397,7 +397,7 @@ async def fetch_clips(self, ids: List[str]):
         return [models.Clip(self._http, d) for d in data]
 
     async def fetch_channel(self, broadcaster: str):
-        """Retrieve a channel from the API.
+        """Retrieve channel information from the API.
 
         Parameters
         -----------

twitchio/http.py

@@ -766,6 +766,45 @@ async def patch_channel(
             Route("PATCH", "channels", query=[("broadcaster_id", broadcaster_id)], body=body, token=token)
         )
 
+    async def get_channel_schedule(
+        self,
+        broadcaster_id: str,
+        segment_ids: List[str] = None,
+        start_time: datetime.datetime = None,
+        utc_offset: int = None,
+        first: int = 20,
+    ):
+
+        if first is not None and (first > 25 or first < 1):
+            raise ValueError("The parameter 'first' was malformed: the value must be less than or equal to 25")
+        if segment_ids is not None and len(segment_ids) > 100:
+            raise ValueError("segment_id can only have 100 entries")
+
+        if start_time:
+            start_time = start_time.strftime("%Y-%m-%dT%H:%M:%SZ")
+
+        if utc_offset:
+            utc_offset = str(utc_offset)
+
+        q = [
+            x
+            for x in [
+                ("broadcaster_id", broadcaster_id),
+                ("first", first),
+                ("start_time", start_time),
+                ("utc_offset", utc_offset),
+            ]
+            if x[1] is not None
+        ]
+
+        if segment_ids:
+            for id in segment_ids:
+                q.append(
+                    ("id", id),
+                )
+
+        return await self.request(Route("GET", "schedule", query=q), paginate=False, full_body=True)
+
     async def get_channel_subscriptions(self, token: str, broadcaster_id: str, user_ids: List[str] = None):
         q = [("broadcaster_id", broadcaster_id)]
         if user_ids:

twitchio/models.py

@@ -612,7 +612,7 @@ def __init__(self, http: "TwitchHTTP", data: dict):
         self.locked_at = self._parse_time(data, "locked_at")
 
     def _parse_time(self, data, field) -> Optional["Datetime"]:
-        if field not in data or data[field] == None:
+        if field not in data or data[field] is None:
             return None
 
         time = data[field].split(".")[0]
@@ -654,3 +654,58 @@ def colour(self) -> str:
 
     def __repr__(self):
         return f"<PredictionOutcome outcome_id={self.outcome_id} title={self.title} channel_points={self.channel_points} color={self.color}>"
+
+class Schedule:
+
+    __slots__ = ("segments", "user", "vacation")
+
+    def __init__(self, http: "TwitchHTTP", data: dict):
+        self.segments = [ScheduleSegment(d) for d in data["data"]["segments"]]
+        self.user = PartialUser(http, data["data"]["broadcaster_id"], data["data"]["broadcaster_login"])
+        self.vacation = ScheduleVacation(data["data"]["vacation"]) if data["data"]["vacation"] else None
+
+    def __repr__(self):
+        return f"<Schedule segments={self.segments} user={self.user} vacation={self.vacation}>"
+
+
+class ScheduleSegment:
+
+    __slots__ = ("id", "start_time", "end_time", "title", "canceled_until", "category", "is_recurring")
+
+    def __init__(self, data: dict):
+        self.id: str = data["id"]
+        self.start_time = datetime.datetime.strptime(data["start_time"], "%Y-%m-%dT%H:%M:%SZ")
+        self.end_time = datetime.datetime.strptime(data["end_time"], "%Y-%m-%dT%H:%M:%SZ")
+        self.title: str = data["title"]
+        self.canceled_until = (
+            datetime.datetime.strptime(data["canceled_until"], "%Y-%m-%dT%H:%M:%SZ") if data["canceled_until"] else None
+        )
+        self.category = ScheduleCategory(data["category"]) if data["category"] else None
+        self.is_recurring: bool = data["is_recurring"]
+
+    def __repr__(self):
+        return f"<Segment id={self.id} start_time={self.start_time} end_time={self.end_time} title={self.title} canceled_until={self.canceled_until} category={self.category} is_recurring={self.is_recurring}>"
+
+
+class ScheduleCategory:
+
+    __slots__ = ("id", "name")
+
+    def __init__(self, data: dict):
+        self.id: str = data["id"]
+        self.name: str = data["name"]
+
+    def __repr__(self):
+        return f"<ScheduleCategory id={self.id} name={self.name}>"
+
+
+class ScheduleVacation:
+
+    __slots__ = ("start_time", "end_time")
+
+    def __init__(self, data: dict):
+        self.start_time = datetime.datetime.strptime(data["start_time"], "%Y-%m-%dT%H:%M:%SZ")
+        self.end_time = datetime.datetime.strptime(data["end_time"], "%Y-%m-%dT%H:%M:%SZ")
+
+    def __repr__(self):
+        return f"<ScheduleVacation start_time={self.start_time} end_time={self.end_time}>"

twitchio/user.py

@@ -604,7 +604,7 @@ async def fetch_videos(self, period="all", sort="time", type="all", language=Non
         --------
             List[:class:`twitchio.Video`]
         """
-        from models import Video
+        from .models import Video
 
         data = await self._http.get_videos(user_id=str(self.id), period=period, sort=sort, type=type, language=language)
         return [Video(self._http, x, self) for x in data]
@@ -696,7 +696,6 @@ async def create_prediction(
     async def modify_stream(self, token: str, game_id: int = None, language: str = None, title: str = None):
         """|coro|
         Modify stream information
-
         Parameters
         -----------
         token: :class:`str`
@@ -716,6 +715,40 @@ async def modify_stream(self, token: str, game_id: int = None, language: str = N
             title=title,
         )
 
+    async def fetch_schedule(
+        self,
+        segment_ids: List[str] = None,
+        start_time: datetime.datetime = None,
+        utc_offset: int = None,
+        first: int = 20,
+    ):
+        """|coro|
+        Fetches the schedule of a streamer
+        Parameters
+        -----------
+        segment_ids: Optional[List[:class:`str`]]
+            List of segment IDs of the stream schedule to return. Maximum: 100
+        start_time: Optional[:class:`datetime.datetime`]
+            A datetime object to start returning stream segments from. If not specified, the current date and time is used.
+        utc_offset: Optional[:class:`int`]
+            A timezone offset for the requester specified in minutes. +4 hours from GMT would be `240`
+        first: Optional[:class:`int`]
+            Maximum number of stream segments to return. Maximum: 25. Default: 20.
+        Returns
+        --------
+            :class:`twitchio.Schedule`
+        """
+        from .models import Schedule
+
+        data = await self._http.get_channel_schedule(
+            broadcaster_id=str(self.id),
+            segment_ids=segment_ids,
+            start_time=start_time,
+            utc_offset=utc_offset,
+            first=first,
+        )
+
+        return Schedule(self._http, data)
 
 class BitLeaderboardUser(PartialUser):