MouseTools 4.2.0__tar.gz → 4.3.0__tar.gz

{mousetools-4.2.0 → mousetools-4.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: mousetools
-Version: 4.2.0
+Version: 4.3.0
 Summary: An unofficial Python wrapper for Disney's API
 Author: Scott Caratozzolo
 License-Expression: MIT

{mousetools-4.2.0 → mousetools-4.3.0}/mousetools/channels/__init__.py

@@ -1,11 +1,62 @@
+import logging
 import typing
 from datetime import datetime, timedelta
 from enum import Enum
 
+from dateutil.parser import isoparse
+
 from mousetools.channels.enums import DestinationTimezones, DLRCouchbaseChannels, WDWCouchbaseChannels
 from mousetools.enums import DestinationShort, EntityType
 from mousetools.mixins.couchbase import CouchbaseMixin
 
+logger = logging.getLogger(__name__)
+
+
+class CouchbaseChildChannel(CouchbaseMixin):
+    def __init__(self, channel_id: str, lazy_load: bool = True):
+        if isinstance(channel_id, Enum):
+            channel_id = channel_id.value
+
+        self.channel_id: str = channel_id
+        self.entity_id: str = channel_id.rsplit(".", 1)[-1]
+
+        self._destination_short: DestinationShort = self.channel_id.split(".")[0]
+        self._tz: DestinationTimezones = (
+            DestinationTimezones.WALT_DISNEY_WORLD
+            if self._destination_short == DestinationShort.WALT_DISNEY_WORLD
+            else DestinationTimezones.DISNEYLAND_RESORT
+        )
+        self._refresh_interval: timedelta = timedelta(minutes=30)
+        self._cb_data: typing.Optional[dict] = None
+        self._cb_data_pull_time: datetime = datetime.now(tz=self._tz.value)
+        if not lazy_load:
+            self.refresh()
+
+    def refresh(self) -> None:
+        """Pulls initial data if none exists or if it is older than the refresh interval"""
+        if self._cb_data is None or datetime.now(tz=self._tz.value) - self.last_update > self._refresh_interval:
+            self._cb_data = self.get_channel_data(self.channel_id)
+            self._cb_data_pull_time = datetime.now(tz=self._tz.value)
+
+    @property
+    def last_update(self) -> datetime:
+        """
+        The last time the data was updated.
+
+        Returns:
+            (datetime): The last time the entity's data was updated, or None if no such data exists.
+        """
+        if self._cb_data is None:
+            self._cb_data = self.get_channel_data(self.channel_id)
+
+        try:
+            dt = isoparse(self._cb_data["lastUpdate"])
+            dt = dt.replace(tzinfo=self._tz.value)
+            return dt
+        except (KeyError, TypeError, ValueError):
+            logger.debug("No last updated found for %s", self.channel_id)
+            return self._cb_data_pull_time
+
 
 class CouchbaseChannel(CouchbaseMixin):
     def __init__(self, channel_id: typing.Union[WDWCouchbaseChannels, DLRCouchbaseChannels], lazy_load: bool = True):

{mousetools-4.2.0 → mousetools-4.3.0}/mousetools/channels/calendar/__init__.py

@@ -1,21 +1,17 @@
 import logging
 import typing
-from datetime import datetime, timedelta
-from enum import Enum
 from zoneinfo import ZoneInfo
 
 from dateutil.parser import isoparse
 
-from mousetools.channels import CouchbaseChannel
-from mousetools.channels.enums import CouchbaseChannels, DestinationTimezones
+from mousetools.channels import CouchbaseChannel, CouchbaseChildChannel
+from mousetools.channels.enums import CouchbaseChannels
 from mousetools.decorators import disney_property
-from mousetools.enums import DestinationShort
-from mousetools.mixins.couchbase import CouchbaseMixin
 
 logger = logging.getLogger(__name__)
 
 
-class CalendarChildChannel(CouchbaseMixin):
+class CalendarChildChannel(CouchbaseChildChannel):
     def __init__(
         self,
         channel_id: str,
@@ -26,34 +22,11 @@ class CalendarChildChannel(CouchbaseMixin):
             channel_id (str): Calendar Channel ID
             lazy_load (bool, optional): If True, will not pull data until a method or property is called. Defaults to True.
         """
-        if isinstance(channel_id, Enum):
-            channel_id = channel_id.value
-
-        self.channel_id: str = channel_id
-        self.entity_id: str = channel_id.rsplit(".", 1)[-1]
-
-        self._destination_short: DestinationShort = self.channel_id.split(".")[0]
-        self._tz: DestinationTimezones = (
-            DestinationTimezones.WALT_DISNEY_WORLD
-            if self._destination_short == DestinationShort.WALT_DISNEY_WORLD
-            else DestinationTimezones.DISNEYLAND_RESORT
-        )
-        self._refresh_interval: timedelta = timedelta(minutes=30)
-
-        self._cb_data: typing.Optional[dict] = None
-        self._cb_data_pull_time: datetime = datetime.now(tz=self._tz.value)
-        if not lazy_load:
-            self.refresh()
+        super().__init__(channel_id, lazy_load=lazy_load)
 
     def __repr__(self):
         return f"{self.__class__.__name__}(channel_id='{self.channel_id}')"
 
-    def refresh(self) -> None:
-        """Pulls initial data if none exists or if it is older than the refresh interval"""
-        if self._cb_data is None or datetime.now(tz=self._tz.value) - self.last_update > self._refresh_interval:
-            self._cb_data = self.get_channel_data(self.channel_id)
-            self._cb_data_pull_time = datetime.now(tz=self._tz.value)
-
     @disney_property()
     def calendar_id(self) -> typing.Optional[str]:
         """The ID of the calendar
@@ -63,24 +36,6 @@ class CalendarChildChannel(CouchbaseMixin):
         """
         return self._cb_data["id"]
 
-    @property
-    def last_update(self) -> datetime:
-        """The last time the data was updated.
-
-        Returns:
-            (datetime): The last time the entity's data was updated, or None if no such data exists.
-        """
-        if self._cb_data is None:
-            self._cb_data = self.get_channel_data(self.channel_id)
-
-        try:
-            dt = isoparse(self._cb_data["lastUpdate"])
-            dt = dt.replace(tzinfo=self._tz.value)
-            return dt
-        except (KeyError, ValueError, TypeError):
-            logger.debug("No last updated found for %s", self.channel_id)
-            return self._cb_data_pull_time
-
     @disney_property()
     def all_closed(self) -> typing.Optional[list[dict]]:
         """The list of closed facilities.

{mousetools-4.2.0 → mousetools-4.3.0}/mousetools/channels/characters/__init__.py

@@ -1,20 +1,16 @@
 import logging
-from datetime import datetime, timedelta
-from enum import Enum
 from typing import Optional
 
 from dateutil.parser import isoparse
 
-from mousetools.channels import CouchbaseChannel
-from mousetools.channels.enums import CouchbaseChannels, DestinationTimezones
+from mousetools.channels import CouchbaseChannel, CouchbaseChildChannel
+from mousetools.channels.enums import CouchbaseChannels
 from mousetools.decorators import disney_property
-from mousetools.enums import DestinationShort
-from mousetools.mixins.couchbase import CouchbaseMixin
 
 logger = logging.getLogger(__name__)
 
 
-class CharactersChildChannel(CouchbaseMixin):
+class CharactersChildChannel(CouchbaseChildChannel):
     def __init__(
         self,
         channel_id: str,
@@ -25,52 +21,11 @@ class CharactersChildChannel(CouchbaseMixin):
             channel_id (str): Forecasted Wait Times Channel ID
             lazy_load (bool, optional): If True, will not pull data until a method or property is called. Defaults to True.
         """
-        if isinstance(channel_id, Enum):
-            channel_id = channel_id.value
-
-        self.channel_id: str = channel_id
-        self.entity_id: str = channel_id.rsplit(".", 1)[-1]
-
-        self._destination_short: DestinationShort = self.channel_id.split(".")[0]
-        self._tz: DestinationTimezones = (
-            DestinationTimezones.WALT_DISNEY_WORLD
-            if self._destination_short == DestinationShort.WALT_DISNEY_WORLD
-            else DestinationTimezones.DISNEYLAND_RESORT
-        )
-        self._refresh_interval: timedelta = timedelta(minutes=30)
-
-        self._cb_data: Optional[dict] = None
-        self._cb_data_pull_time: Optional[datetime] = datetime.now(tz=self._tz.value)
-        if not lazy_load:
-            self.refresh()
+        super().__init__(channel_id, lazy_load=lazy_load)
 
     def __repr__(self):
         return f"{self.__class__.__name__}(channel_id='{self.channel_id}')"
 
-    def refresh(self) -> None:
-        """Pulls initial data if none exists or if it is older than the refresh interval"""
-        if self._cb_data is None or datetime.now(tz=self._tz.value) - self.last_update > self._refresh_interval:
-            self._cb_data = self.get_channel_data(self.channel_id)
-            self._cb_data_pull_time = datetime.now(tz=self._tz.value)
-
-    @property
-    def last_update(self) -> datetime:
-        """The last time the data was updated.
-
-        Returns:
-            (datetime): The last time the entity's data was updated, or None if no such data exists.
-        """
-        if self._cb_data is None:
-            self._cb_data = self.get_channel_data(self.channel_id)
-
-        try:
-            dt = isoparse(self._cb_data["lastUpdate"])
-            dt = dt.replace(tzinfo=self._tz.value)
-            return dt
-        except (KeyError, TypeError, ValueError):
-            logger.debug("No last updated found for %s", self.channel_id)
-            return self._cb_data_pull_time
-
     @disney_property()
     def name(self) -> Optional[str]:
         """The name of the entity.

{mousetools-4.2.0 → mousetools-4.3.0}/mousetools/channels/facilities/__init__.py

@@ -2,18 +2,15 @@ import logging
 import os
 import typing
 from datetime import datetime, time, timedelta
-from enum import Enum
 from zoneinfo import ZoneInfo
 
 import httpx
-from dateutil.parser import isoparse
 
 from mousetools.api.menu import Menus
-from mousetools.channels import CouchbaseChannel
+from mousetools.channels import CouchbaseChannel, CouchbaseChildChannel
 from mousetools.channels.calendar import CalendarChildChannel
 from mousetools.channels.enums import (
     CouchbaseChannels,
-    DestinationTimezones,
     DLRCouchbaseChannels,
     WDWCouchbaseChannels,
 )
@@ -21,12 +18,11 @@ from mousetools.channels.facilitystatus import FacilityStatusChildChannel
 from mousetools.channels.forecastedwaittimes import ForecastedWaitTimesChildChannel
 from mousetools.decorators import disney_property
 from mousetools.enums import DestinationShort, EntityType
-from mousetools.mixins.couchbase import CouchbaseMixin
 
 logger = logging.getLogger(__name__)
 
 
-class FacilityChildChannel(CouchbaseMixin):
+class FacilityChildChannel(CouchbaseChildChannel):
     """Base class for all Facility Child Channels. Subclasses like Attraction, Restaurant, Entertainment, etc. extend this class.
 
     Example:
@@ -51,27 +47,12 @@ class FacilityChildChannel(CouchbaseMixin):
             channel_id (str): Facility Channel ID
             lazy_load (bool, optional): If True, will not pull data until a method or property is called. Defaults to True.
         """
-        if isinstance(channel_id, Enum):
-            channel_id = channel_id.value
+        super().__init__(channel_id, lazy_load=lazy_load)
 
-        self.channel_id: str = channel_id
-        self.entity_id: str = channel_id.rsplit(".", 1)[-1]
-
-        self._destination_short: DestinationShort = self.channel_id.split(".")[0]
-        self._tz: DestinationTimezones = (
-            DestinationTimezones.WALT_DISNEY_WORLD
-            if self._destination_short == DestinationShort.WALT_DISNEY_WORLD
-            else DestinationTimezones.DISNEYLAND_RESORT
-        )
         self._refresh_interval: timedelta = timedelta(
             hours=12
         )  # properties are rarely updated, no need to spam the API
 
-        self._cb_data: typing.Optional[dict] = None
-        self._cb_data_pull_time: datetime = datetime.now(tz=self._tz.value)
-        if not lazy_load:
-            self.refresh()
-
         self._today_calendar: typing.Optional[CalendarChildChannel] = None
 
     def refresh(self) -> None:
@@ -392,30 +373,6 @@ class FacilityChildChannel(CouchbaseMixin):
 
         return FacilityStatusChildChannel(facility_status_channel_id)
 
-    @property
-    def last_update(self) -> datetime:
-        """
-        The last time the data was updated.
-
-        Returns:
-            (datetime): The last time the entity's data was updated, or None if no such data exists.
-        """
-        if self._cb_data is None:
-            self._cb_data = self.get_channel_data(self.channel_id)
-
-        try:
-            tz = (
-                DestinationTimezones.WALT_DISNEY_WORLD
-                if "wdw" in self.channel_id
-                else DestinationTimezones.DISNEYLAND_RESORT
-            )
-            dt = isoparse(self._cb_data["lastUpdate"])
-            dt = dt.replace(tzinfo=tz.value)
-            return dt
-        except (KeyError, TypeError, ValueError):
-            logger.debug("No last updated found for %s", self.channel_id)
-            return self._cb_data_pull_time
-
     @disney_property()
     def sponsor_name(self) -> typing.Optional[str]:
         """The sponsor name of the entity.

{mousetools-4.2.0 → mousetools-4.3.0}/mousetools/channels/facilitystatus/__init__.py

@@ -1,45 +1,25 @@
 import logging
 import typing
-from datetime import datetime, timedelta
+from datetime import datetime
 
 from dateutil.parser import isoparse
 
-from mousetools.channels import CouchbaseChannel
-from mousetools.channels.enums import CouchbaseChannels, DestinationTimezones
+from mousetools.channels import CouchbaseChannel, CouchbaseChildChannel
+from mousetools.channels.enums import CouchbaseChannels
 from mousetools.decorators import disney_property
-from mousetools.enums import DestinationShort, EntityType
-from mousetools.mixins.couchbase import CouchbaseMixin
+from mousetools.enums import EntityType
 
 logger = logging.getLogger(__name__)
 
 
-class FacilityStatusChildChannel(CouchbaseMixin):
+class FacilityStatusChildChannel(CouchbaseChildChannel):
     def __init__(self, channel_id: str, lazy_load: bool = True):
         """
         Args:
             channel_id (typing.Union[WDWCouchbaseChannels, DLRCouchbaseChannels]): Channel ID from the enum
             lazy_load (bool, optional): If True, will not pull data until a method or property is called. Defaults to True.
         """
-        self.channel_id = channel_id
-
-        self._destination_short: DestinationShort = channel_id.split(".")[0]
-        self._tz: DestinationTimezones = (
-            DestinationTimezones.WALT_DISNEY_WORLD
-            if self._destination_short == DestinationShort.WALT_DISNEY_WORLD
-            else DestinationTimezones.DISNEYLAND_RESORT
-        )
-        self._refresh_interval: timedelta = timedelta(minutes=10)
-        self._cb_data: typing.Optional[dict] = None
-        self._cb_data_pull_time: datetime = datetime.now(tz=self._tz.value)
-
-        if not lazy_load:
-            self.refresh()
-
-    def refresh(self) -> None:
-        """Pulls initial data if none exists or if it is older than the refresh interval"""
-        if self._cb_data is None or datetime.now(tz=self._tz.value) - self.last_update > self._refresh_interval:
-            self._cb_data = self.get_channel_data(self.channel_id)
-            self._cb_data_pull_time = datetime.now(tz=self._tz.value)
+        super().__init__(channel_id, lazy_load=lazy_load)
 
     def get_status(self) -> typing.Optional[str]:
         """Get the operating status of the facility
@@ -69,24 +49,6 @@ class FacilityStatusChildChannel(CouchbaseMixin):
             logger.debug("No wait time found for %s", self.channel_id)
             return None
 
-    @property
-    def last_update(self) -> datetime:
-        """The last time the data was updated.
-
-        Returns:
-            (datetime): The last time the entity's data was updated, or None if no such data exists.
-        """
-        if self._cb_data is None:
-            self._cb_data = self.get_channel_data(self.channel_id)
-
-        try:
-            dt = isoparse(self._cb_data["lastUpdate"])
-            dt = dt.replace(tzinfo=self._tz.value)
-            return dt
-        except (KeyError, TypeError, ValueError):
-            logger.debug("No last updated found for %s", self.channel_id)
-            return self._cb_data_pull_time
-
     @disney_property()
     def fast_pass_available(self) -> typing.Optional[bool]:
         return self._cb_data["fastPassAvailable"]
@@ -157,6 +119,25 @@ class FacilityStatusChannel(CouchbaseChannel):
                 channels.append(FacilityStatusChildChannel(i["id"]))
         return channels
 
+    def get_all_statuses(self) -> dict[str, dict[str, typing.Any]]:
+        """Get all statuses for the channel
+
+        Returns:
+            (dict[str, dict[str, typing.Any]]): A dictionary of all statuses for the channel
+        """
+        logger.info("Getting all children statuses for %s", self.channel_id)
+        children = self.get_children_channels()
+        logger.debug("Got %d children for %s", len(children), self.channel_id)
+
+        statuses = {}
+        for child in children:
+            tmp = {}
+            tmp["status"] = child.get_status()
+            tmp["wait_time"] = child.get_wait_time()
+            statuses[child.entity_id] = tmp
+
+        return statuses
+
     def get_children_attractions(self) -> list[AttractionFacilityStatusChild]:  # type: ignore
         """Get AttractionFacilityStatusChild Children of a Facility
 

{mousetools-4.2.0 → mousetools-4.3.0}/mousetools/channels/forecastedwaittimes/__init__.py

@@ -1,19 +1,14 @@
 import logging
-import typing
-from datetime import datetime, timedelta
-from enum import Enum
 
 from dateutil.parser import isoparse
 
-from mousetools.channels import CouchbaseChannel
-from mousetools.channels.enums import CouchbaseChannels, DestinationTimezones
-from mousetools.enums import DestinationShort
-from mousetools.mixins.couchbase import CouchbaseMixin
+from mousetools.channels import CouchbaseChannel, CouchbaseChildChannel
+from mousetools.channels.enums import CouchbaseChannels
 
 logger = logging.getLogger(__name__)
 
 
-class ForecastedWaitTimesChildChannel(CouchbaseMixin):
+class ForecastedWaitTimesChildChannel(CouchbaseChildChannel):
     def __init__(
         self,
         channel_id: str,
@@ -24,52 +19,11 @@ class ForecastedWaitTimesChildChannel(CouchbaseMixin):
             channel_id (str): Forecasted Wait Times Channel ID
             lazy_load (bool, optional): If True, will not pull data until a method or property is called. Defaults to True.
         """
-        if isinstance(channel_id, Enum):
-            channel_id = channel_id.value
-
-        self.channel_id: str = channel_id
-        self.entity_id: str = channel_id.rsplit(".", 1)[-1]
-
-        self._destination_short: DestinationShort = self.channel_id.split(".")[0]
-        self._tz: DestinationTimezones = (
-            DestinationTimezones.WALT_DISNEY_WORLD
-            if self._destination_short == DestinationShort.WALT_DISNEY_WORLD
-            else DestinationTimezones.DISNEYLAND_RESORT
-        )
-        self._refresh_interval: timedelta = timedelta(minutes=30)
-
-        self._cb_data: typing.Optional[dict] = None
-        self._cb_data_pull_time: datetime = datetime.now(tz=self._tz.value)
-        if not lazy_load:
-            self.refresh()
+        super().__init__(channel_id, lazy_load=lazy_load)
 
     def __repr__(self):
         return f"{self.__class__.__name__}(channel_id='{self.channel_id}')"
 
-    def refresh(self) -> None:
-        """Pulls initial data if none exists or if it is older than the refresh interval"""
-        if self._cb_data is None or datetime.now(tz=self._tz.value) - self.last_update > self._refresh_interval:
-            self._cb_data = self.get_channel_data(self.channel_id)
-            self._cb_data_pull_time = datetime.now(tz=self._tz.value)
-
-    @property
-    def last_update(self) -> datetime:
-        """The last time the data was updated.
-
-        Returns:
-            (datetime): The last time the entity's data was updated, or None if no such data exists.
-        """
-        if self._cb_data is None:
-            self._cb_data = self.get_channel_data(self.channel_id)
-
-        try:
-            dt = isoparse(self._cb_data["lastUpdate"])
-            dt = dt.replace(tzinfo=self._tz.value)
-            return dt
-        except (KeyError, TypeError, ValueError):
-            logger.debug("No last updated found for %s", self.channel_id)
-            return self._cb_data_pull_time
-
     def get_forecast(self) -> list[dict]:
         """Returns a list of forecasted wait times sorted by timestamp
 

{mousetools-4.2.0 → mousetools-4.3.0}/mousetools/mixins/couchbase.py

@@ -11,7 +11,7 @@ logger = logging.getLogger(__name__)
 
 
 class CouchbaseMixin:
-    _couchbase_url = "https://" + auth_obj._environments["syncGatewayUrl"].split("//")[1]
+    _couchbase_url = "https://" + auth_obj._environments["syncGatewayUrl"].split("//")[1].rstrip("/")
     _headers: dict = auth_obj.get_couchbase_headers()
 
     def get_channel_data(self, channel_name: str) -> typing.Union[dict, None]:

{mousetools-4.2.0 → mousetools-4.3.0}/mousetools.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: mousetools
-Version: 4.2.0
+Version: 4.3.0
 Summary: An unofficial Python wrapper for Disney's API
 Author: Scott Caratozzolo
 License-Expression: MIT

{mousetools-4.2.0 → mousetools-4.3.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "mousetools"
-version = "4.2.0"
+version = "4.3.0"
 authors = [{name = "Scott Caratozzolo"}]
 description = "An unofficial Python wrapper for Disney's API"
 readme = "README.md"