MouseTools 4.0.2__tar.gz → 4.1.0__tar.gz

{mousetools-4.0.2 → mousetools-4.1.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: mousetools
-Version: 4.0.2
+Version: 4.1.0
 Summary: An unofficial Python wrapper for Disney's API
 Author: Scott Caratozzolo
 License-Expression: MIT
@@ -25,7 +25,7 @@ Dynamic: license-file
 
 # MouseTools
 
-[![PyPI version](https://badge.fury.io/py/MouseTools.svg)](https://badge.fury.io/py/MouseTools) [![Downloads](https://pepy.tech/badge/mousetools)](https://pepy.tech/project/mousetools)
+![PyPI - Version](https://img.shields.io/pypi/v/mousetools?style=flat-square&logo=python&color=00C106&link=https%3A%2F%2Fpypi.org%2Fproject%2Fmousetools%2F) ![PyPI - Downloads](https://img.shields.io/pypi/dm/mousetools?style=flat-square&color=blue&link=https%3A%2F%2Fpypi.org%2Fproject%2Fmousetools%2F)
 
 
 An unofficial Python wrapper for the Disney API. Data is pulled directly from Disney. This package supports Walt Disney World and Disneyland Resort.
@@ -110,8 +110,30 @@ print(mk.description)
 # "Enter a Land Where Fantasy Reigns"
 ```
 
+There is also a search functionality to help find the channels you want.
+```python
+from mousetools.api.search import Search
+from mousetools.enums import DestinationShort
+
+search = Search(DestinationShort.WALT_DISNEY_WORLD)
+print(search("pirates", max_results=1))
+# [{'channel_id': 'wdw.facilities.1_0.en_us.attraction.80010177;entityType=Attraction',
+#   'entity_id': '80010177;entityType=Attraction',
+#   'name': 'Pirates of the Caribbean',
+#   'search_score': 3507.1604}]
+```
+
 ### License
 This project is distributed under the MIT license. For more information see [LICENSE](https://gitlab.com/caratozzoloxyz/public/MouseTools/-/blob/master/LICENSE?ref_type=heads)
 
 ### Disclaimer
 This project is in no way affiliated with The Walt Disney Company and all use of Disney Services is subject to the [Disney Terms of Use](https://disneytermsofuse.com/).
+
+
+### About Project
+
+<a href='https://ko-fi.com/scaratozzolo' target='_blank'>
+<img src='https://img.shields.io/badge/sponsor-30363D?style=for-the-badge&logo=kofi&logoColor=white&link=https%3A%2F%2Fko-fi.com%2Fscaratozzolo border='0' alt='Support my projects' />
+</a>
+
+MouseTools is a passion project I've been working on since 2018 when I was first learning Python. The package has evolved and been rewritten multiple times as I've become a better developer and as the Disney API has changed. There is a lot of time exploring Disney's API and figuring out how all the pieces work before any code is even written. I work on this project when I have time or when I have an idea for another project that could use this data.

{mousetools-4.0.2 → mousetools-4.1.0}/README.md

@@ -1,6 +1,6 @@
 # MouseTools
 
-[![PyPI version](https://badge.fury.io/py/MouseTools.svg)](https://badge.fury.io/py/MouseTools) [![Downloads](https://pepy.tech/badge/mousetools)](https://pepy.tech/project/mousetools)
+![PyPI - Version](https://img.shields.io/pypi/v/mousetools?style=flat-square&logo=python&color=00C106&link=https%3A%2F%2Fpypi.org%2Fproject%2Fmousetools%2F) ![PyPI - Downloads](https://img.shields.io/pypi/dm/mousetools?style=flat-square&color=blue&link=https%3A%2F%2Fpypi.org%2Fproject%2Fmousetools%2F)
 
 
 An unofficial Python wrapper for the Disney API. Data is pulled directly from Disney. This package supports Walt Disney World and Disneyland Resort.
@@ -85,8 +85,30 @@ print(mk.description)
 # "Enter a Land Where Fantasy Reigns"
 ```
 
+There is also a search functionality to help find the channels you want.
+```python
+from mousetools.api.search import Search
+from mousetools.enums import DestinationShort
+
+search = Search(DestinationShort.WALT_DISNEY_WORLD)
+print(search("pirates", max_results=1))
+# [{'channel_id': 'wdw.facilities.1_0.en_us.attraction.80010177;entityType=Attraction',
+#   'entity_id': '80010177;entityType=Attraction',
+#   'name': 'Pirates of the Caribbean',
+#   'search_score': 3507.1604}]
+```
+
 ### License
 This project is distributed under the MIT license. For more information see [LICENSE](https://gitlab.com/caratozzoloxyz/public/MouseTools/-/blob/master/LICENSE?ref_type=heads)
 
 ### Disclaimer
 This project is in no way affiliated with The Walt Disney Company and all use of Disney Services is subject to the [Disney Terms of Use](https://disneytermsofuse.com/).
+
+
+### About Project
+
+<a href='https://ko-fi.com/scaratozzolo' target='_blank'>
+<img src='https://img.shields.io/badge/sponsor-30363D?style=for-the-badge&logo=kofi&logoColor=white&link=https%3A%2F%2Fko-fi.com%2Fscaratozzolo border='0' alt='Support my projects' />
+</a>
+
+MouseTools is a passion project I've been working on since 2018 when I was first learning Python. The package has evolved and been rewritten multiple times as I've become a better developer and as the Disney API has changed. There is a lot of time exploring Disney's API and figuring out how all the pieces work before any code is even written. I work on this project when I have time or when I have an idea for another project that could use this data.

mousetools-4.1.0/mousetools/api/search.py

@@ -0,0 +1,58 @@
+from typing import Optional, Union
+
+from mousetools.auth import auth_obj
+from mousetools.channels.enums import DLRCouchbaseChannels, WDWCouchbaseChannels
+from mousetools.enums import DestinationShort
+from mousetools.mixins.disney import DisneyAPIMixin
+
+
+class Search(DisneyAPIMixin):
+    _search_service_base = auth_obj._environments["searchServiceUrl"]
+
+    def __init__(self, destination: Union[DestinationShort, str]):
+        """
+        Args:
+            destination (Union[DestinationShort, str]): Search the facilities for this destination
+        """
+        if isinstance(destination, DestinationShort):
+            destination = destination.value
+        self.destination = destination
+        self._facilities_channel = (
+            WDWCouchbaseChannels.FACILITIES.value
+            if destination == DestinationShort.WALT_DISNEY_WORLD
+            else DLRCouchbaseChannels.FACILITIES.value
+        )
+
+    def search(self, query: str, max_results: int = 10) -> Optional[list[dict]]:
+        """Send a request to the search service
+
+        Args:
+            query (str): Search query
+            max_results (int, optional): Maximum number of results to return in the list. Defaults to 10.
+
+        Returns:
+            (Optional[list[dict]]): List of results
+        """
+        api_data = self.get_disney_data(
+            f"{self._search_service_base}/mobileapi/v1/entities/search?q={query}&brand={self.destination}"
+        )
+        our_results = []
+        for i in api_data.get("results", [])[:max_results]:
+            tmp = {}
+            tmp["entity_id"] = i["id"]
+            tmp["name"] = i["title"][0]
+            tmp["search_score"] = i["score"]
+            tmp["channel_id"] = f"{self._facilities_channel}.{i['id'].rsplit('=')[-1].lower()}.{i['id']}"
+            our_results.append(tmp)
+        return our_results
+
+    def __call__(self, *args, **kwargs) -> Optional[list[dict]]:
+        """Call the search function
+
+        Returns:
+            (Optional[list[dict]]): List of results
+        """
+        return self.search(*args, **kwargs)
+
+    def __repr__(self):
+        return f"Search(destination='{self.destination}')"

{mousetools-4.0.2 → mousetools-4.1.0}/mousetools/channels/__init__.py

@@ -2,7 +2,8 @@ import typing
 from datetime import datetime, timedelta
 from enum import Enum
 
-from mousetools.channels.enums import DestinationShort, DestinationTimezones, DLRCouchbaseChannels, WDWCouchbaseChannels
+from mousetools.channels.enums import DestinationTimezones, DLRCouchbaseChannels, WDWCouchbaseChannels
+from mousetools.enums import DestinationShort
 from mousetools.mixins.couchbase import CouchbaseMixin
 
 
@@ -44,4 +45,9 @@ class CouchbaseChannel(CouchbaseMixin):
         return [i["id"] for i in self._cb_data["results"]]
 
     def __repr__(self):
-        return f"{self.__class__.__name__}({self.channel_id})"
+        return f"{self.__class__.__name__}(channel_id='{self.channel_id}')"
+
+    def __eq__(self, other) -> bool:
+        if isinstance(other, CouchbaseChannel):
+            return self.channel_id == other.channel_id
+        return False

mousetools-4.1.0/mousetools/channels/calendar/__init__.py

@@ -0,0 +1,311 @@
+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.enums import DestinationShort
+from mousetools.mixins.couchbase import CouchbaseMixin
+
+logger = logging.getLogger(__name__)
+
+
+class CalendarChildChannel(CouchbaseMixin):
+    def __init__(
+        self,
+        channel_id: str,
+        lazy_load: bool = True,
+    ):
+        """
+        Args:
+            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: typing.Optional[datetime] = datetime.now(tz=self._tz.value)
+        if not lazy_load:
+            self.refresh()
+
+    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 calendar_id(self) -> typing.Optional[str]:
+        """The ID of the calendar
+
+        Returns:
+            (typing.Optional[str]): The ID of the calendar, or None if no such data exists.
+        """
+        self.refresh()
+        try:
+            return self._cb_data["id"]
+        except KeyError:
+            logger.debug("No id found for %s", self.channel_id)
+            return None
+
+    @property
+    def last_update(self) -> typing.Optional[datetime]:
+        """The last time the data was updated.
+
+        Returns:
+            (typing.Optional[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:
+            logger.debug("No last updated found for %s", self.channel_id)
+            return self._cb_data_pull_time
+
+    @property
+    def all_closed(self) -> typing.Optional[list[dict]]:
+        """The list of closed facilities.
+
+        Returns:
+            (typing.Optional[list[dict]]): The list of closed facilities, or None if no such data exists.
+        """
+        self.refresh()
+        try:
+            return self._cb_data["closed"]
+        except KeyError:
+            logger.debug("No closed found for %s", self.channel_id)
+            return None
+
+    @property
+    def all_facility_schedules(self) -> typing.Optional[dict[str, list[dict]]]:
+        """The list of facility schedules.
+
+        Returns:
+            (typing.Optional[dict[str, list[dict]]]): The list of facility schedules, or None if no such data exists.
+        """
+        self.refresh()
+        try:
+            return self._cb_data["facilitySchedules"]
+        except KeyError:
+            logger.debug("No facility schedules found for %s", self.channel_id)
+            return None
+
+    @property
+    def all_meal_periods(self) -> typing.Optional[dict[str, list[dict]]]:
+        """The list of meal periods.
+
+        Returns:
+            (typing.Optional[dict[str, list[dict]]]): The list of meal periods, or None if no such data exists.
+        """
+        self.refresh()
+        try:
+            return self._cb_data["mealPeriods"]
+        except KeyError:
+            logger.debug("No meal periods found for %s", self.channel_id)
+            return None
+
+    @property
+    def all_park_hours(self) -> typing.Optional[list[dict]]:
+        """The list of park hours.
+
+        Returns:
+            (typing.Optional[list[dict]]): The list of park hours, or None if no such data exists.
+        """
+        self.refresh()
+        try:
+            return self._cb_data["parkHours"]
+        except KeyError:
+            logger.debug("No park hours found for %s", self.channel_id)
+            return None
+
+    @property
+    def all_private_events(self) -> typing.Optional[list[dict]]:
+        """The list of private events.
+
+        Returns:
+            (typing.Optional[list[dict]]): The list of private events, or None if no such data exists.
+        """
+        self.refresh()
+        try:
+            return self._cb_data["privateEvents"]
+        except KeyError:
+            logger.debug("No private events found for %s", self.channel_id)
+            return None
+
+    @property
+    def all_refurbishments(self) -> typing.Optional[list[dict]]:
+        """The list of refurbishments.
+
+        Returns:
+            (typing.Optional[list[dict]]): The list of refurbishments, or None if no such data exists.
+        """
+        self.refresh()
+        try:
+            return self._cb_data["refurbishments"]
+        except KeyError:
+            logger.debug("No refurbishments found for %s", self.channel_id)
+            return None
+
+    @property
+    def timezone(self) -> ZoneInfo:
+        """The timezone of the calendar.
+
+        Returns:
+            (ZoneInfo): The timezone of the calendar.
+        """
+        return self._tz.value
+
+    def get_park_hours(self, entity_id: str) -> dict:
+        """Get the park hours for the given entity
+
+        Args:
+            entity_id (str): entity id of the facility
+
+        Returns:
+            dict: park hours broken up into their schedule types (Operating, Early Entry, etc.)
+        """
+        hours = {}
+        if self.all_park_hours:
+            for i in self.all_park_hours:
+                if entity_id in i["facilityId"]:
+                    hours[i["scheduleType"]] = {}
+                    hours[i["scheduleType"]]["start"] = isoparse(i["startTime"]).astimezone(self._tz.value)
+                    hours[i["scheduleType"]]["end"] = isoparse(i["endTime"]).astimezone(self._tz.value)
+        return hours
+
+    def get_meal_periods(self, entity_id: str) -> dict:
+        """Get the meal periods for the given entity
+
+        Args:
+            entity_id (str): entity id of the facility
+
+        Returns:
+            dict: meal periods
+        """
+        periods = {}
+        if self.all_meal_periods:
+            restaurant = self.all_meal_periods.get(entity_id, [])
+            for i in restaurant:
+                meal_period = i["facilityId"]
+                periods[meal_period] = {}
+                periods[meal_period]["start"] = isoparse(i["startTime"]).astimezone(self._tz.value)
+                periods[meal_period]["end"] = isoparse(i["endTime"]).astimezone(self._tz.value)
+                periods[meal_period]["schedule_type"] = i["scheduleType"]
+        return periods
+
+    def get_refurbishment(self, entity_id: str) -> dict:
+        """Get the refurbishment info for the given entity
+
+        Args:
+            entity_id (str): entity id of the facility
+
+        Returns:
+            dict: refurbishments
+        """
+        refurbishments = {}
+        if self.all_refurbishments:
+            for i in self.all_refurbishments:
+                if entity_id in i["facilityId"]:
+                    refurbishments["start"] = isoparse(i["startTime"]).astimezone(self._tz.value)
+                    refurbishments["end"] = isoparse(i["endTime"]).astimezone(self._tz.value)
+        return refurbishments
+
+    def get_closed(self, entity_id: str) -> dict:
+        """Get the closed info for the given entity
+
+        Args:
+            entity_id (str): entity id of the facility
+
+        Returns:
+            dict: closed
+        """
+        closed = {}
+        if self.all_closed:
+            for i in self.all_closed:
+                if entity_id in i["facilityId"]:
+                    closed["start"] = isoparse(i["startTime"]).astimezone(self._tz.value)
+                    closed["end"] = isoparse(i["endTime"]).astimezone(self._tz.value)
+        return closed
+
+    def get_facility_schedule(self, entity_id: str) -> list[dict]:
+        """Get the schedule info for the given entity
+
+        Args:
+            entity_id (str): entity id of the facility
+
+        Returns:
+            (list[dict]): schedules
+        """
+        schedules = []
+        if self.all_facility_schedules:
+            facility = self.all_facility_schedules.get(entity_id, [])
+            for i in facility:
+                tmp = {}
+                tmp["start"] = isoparse(i["startTime"]).astimezone(self._tz.value)
+                tmp["end"] = isoparse(i["endTime"]).astimezone(self._tz.value)
+                tmp["schedule_type"] = i["scheduleType"]
+                schedules.append(tmp)
+        return sorted(schedules, key=lambda i: i["start"])
+
+
+class CalendarChannel(CouchbaseChannel):
+    def __init__(self, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+
+        self.available_calendars = {}
+        self.refresh_calendars()
+
+    def refresh_calendars(self):
+        """Refreshes the available calendars."""
+        available_calendars = {}
+        for i in self.get_children_channels():
+            available_calendars[i.entity_id] = i
+
+        self.available_calendars = available_calendars
+
+    def get_children_channels(self) -> typing.Generator[CalendarChildChannel, None, None]:
+        """Gets a list of children channels for the channel.
+
+        Yields:
+            typing.Generator[CalendarChildChannel, None, None]: A generator of CalendarChildChannel
+        """
+        self.refresh()
+        for i in self._cb_data["results"]:
+            if CouchbaseChannels.CALENDAR in i["id"]:
+                yield CalendarChildChannel(i["id"])
+
+    def get_calendar(self, day: int, month: int) -> typing.Optional[CalendarChildChannel]:
+        """Get the calendar for the given day and month
+
+        Args:
+            day (int): day of the month
+            month (int): month of the year
+
+        Returns:
+            typing.Optional[CalendarChildChannel]: calendar for the given day and month
+        """
+        self.refresh_calendars()
+        return self.available_calendars.get(f"{day:02}-{month:02}", None)

{mousetools-4.0.2 → mousetools-4.1.0}/mousetools/channels/enums.py

@@ -1,10 +1,7 @@
 from enum import Enum
 from zoneinfo import ZoneInfo
 
-
-class DestinationShort(str, Enum):
-    WALT_DISNEY_WORLD = "wdw"
-    DISNEYLAND_RESORT = "dlr"
+from mousetools.enums import DestinationShort
 
 
 class CouchbaseChannels(str, Enum):