MouseTools 4.0.3__tar.gz → 4.1.1__tar.gz

{mousetools-4.0.3 → mousetools-4.1.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: mousetools
-Version: 4.0.3
+Version: 4.1.1
 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.3 → mousetools-4.1.1}/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.0.3 → mousetools-4.1.1}/mousetools/api/menu.py

@@ -1,6 +1,11 @@
 import typing
+from datetime import datetime, timedelta
+from zoneinfo import ZoneInfo
+
+from dateutil.parser import isoparse
 
 from mousetools.auth import auth_obj
+from mousetools.decorators import disney_property, json_property
 from mousetools.mixins.disney import DisneyAPIMixin
 
 # menus -> menu -> menugroups -> menuitems
@@ -14,7 +19,7 @@ class MenuItem:
     def __repr__(self) -> str:
         return f"MenuItem(entity_id={self.entity_id}, parent_resturant_id={self._parent_restaurant_id})"
 
-    @property
+    @json_property
     def entity_id(self) -> typing.Optional[str]:
         """
         The entity id of the menu item.
@@ -22,12 +27,9 @@ class MenuItem:
         Returns:
             (typing.Optional[str]): The entity id of the menu item.
         """
-        try:
-            return self._raw_item_data["id"]
-        except KeyError:
-            return None
+        return self._raw_item_data["id"]
 
-    @property
+    @json_property
     def pc_short_name(self) -> typing.Optional[str]:
         """
         The short name of the menu item.
@@ -35,12 +37,9 @@ class MenuItem:
         Returns:
             (typing.Optional[str]): The short name of the menu item.
         """
-        try:
-            return self._raw_item_data["names"]["PCShort"]
-        except KeyError:
-            return None
+        return self._raw_item_data["names"]["PCShort"]
 
-    @property
+    @json_property
     def pc_long_name(self) -> typing.Optional[str]:
         """
         The long name of the menu item.
@@ -48,12 +47,9 @@ class MenuItem:
         Returns:
             (typing.Optional[str]): The long name of the menu item.
         """
-        try:
-            return self._raw_item_data["names"]["PCLong"]
-        except KeyError:
-            return None
+        return self._raw_item_data["names"]["PCLong"]
 
-    @property
+    @json_property
     def mobile_short_name(self) -> typing.Optional[str]:
         """
         The short name of the menu item.
@@ -61,12 +57,9 @@ class MenuItem:
         Returns:
             (typing.Optional[str]): The short name of the menu item.
         """
-        try:
-            return self._raw_item_data["names"]["MobileShort"]
-        except KeyError:
-            return None
+        return self._raw_item_data["names"]["MobileShort"]
 
-    @property
+    @json_property
     def mobile_long_name(self) -> typing.Optional[str]:
         """
         The long name of the menu item.
@@ -74,12 +67,9 @@ class MenuItem:
         Returns:
             (typing.Optional[str]): The long name of the menu item.
         """
-        try:
-            return self._raw_item_data["names"]["MobileLong"]
-        except KeyError:
-            return None
+        return self._raw_item_data["names"]["MobileLong"]
 
-    @property
+    @json_property
     def mickey_check(self) -> typing.Optional[bool]:
         """
         Whether the menu item is mickey check.
@@ -87,12 +77,9 @@ class MenuItem:
         Returns:
             (typing.Optional[bool]): Whether the menu item is mickey check.
         """
-        try:
-            return self._raw_item_data["mickeyCheck"]
-        except KeyError:
-            return None
+        return self._raw_item_data["mickeyCheck"]
 
-    @property
+    @json_property
     def pc_long_description(self) -> typing.Optional[str]:
         """
         The long description of the menu item.
@@ -100,12 +87,9 @@ class MenuItem:
         Returns:
             (typing.Optional[str]): The long description of the menu item.
         """
-        try:
-            return self._raw_item_data["descriptions"]["PCLong"]["text"]
-        except KeyError:
-            return None
+        return self._raw_item_data["descriptions"]["PCLong"]["text"]
 
-    @property
+    @json_property
     def mobile_short_description(self) -> typing.Optional[str]:
         """
         The short description of the menu item.
@@ -113,12 +97,9 @@ class MenuItem:
         Returns:
             (typing.Optional[str]): The short description of the menu item.
         """
-        try:
-            return self._raw_item_data["descriptions"]["MobileShort"]["text"]
-        except KeyError:
-            return None
+        return self._raw_item_data["descriptions"]["MobileShort"]["text"]
 
-    @property
+    @json_property
     def default_selection(self) -> typing.Optional[bool]:
         """
         Whether the menu item is the default selection.
@@ -126,12 +107,9 @@ class MenuItem:
         Returns:
             (typing.Optional[bool]): Whether the menu item is the default selection.
         """
-        try:
-            return self._raw_item_data["defaultSelection"]
-        except KeyError:
-            return None
+        return self._raw_item_data["defaultSelection"]
 
-    @property
+    @json_property
     def prices(self) -> typing.Optional[dict]:
         """
         The prices of the menu item.
@@ -139,12 +117,9 @@ class MenuItem:
         Returns:
             (typing.Optional[dict]): The prices of the menu item.
         """
-        try:
-            return self._raw_item_data["prices"]
-        except KeyError:
-            return None
+        return self._raw_item_data["prices"]
 
-    @property
+    @json_property
     def per_serving_without_tax(self) -> typing.Optional[float]:
         """
         The per serving without tax of the menu item.
@@ -152,10 +127,7 @@ class MenuItem:
         Returns:
             (typing.Optional[float]): The per serving without tax of the menu item.
         """
-        try:
-            return self._raw_item_data["prices"]["PerServing"]["withoutTax"]
-        except KeyError:
-            return None
+        return self._raw_item_data["prices"]["PerServing"]["withoutTax"]
 
 
 class MenuGroup:
@@ -166,7 +138,7 @@ class MenuGroup:
     def __str__(self) -> str:
         return f"MenuGroup(menu_group_type={self.menu_group_type}, parent_restaurant_id={self._parent_restaurant_id})"
 
-    @property
+    @json_property
     def menu_group_type(self) -> typing.Optional[str]:
         """
         The type of the menu group.
@@ -174,12 +146,9 @@ class MenuGroup:
         Returns:
             (typing.Optional[str]): The type of the menu group.
         """
-        try:
-            return self._raw_menu_group_data["menuGroupType"]
-        except KeyError:
-            return None
+        return self._raw_menu_group_data["menuGroupType"]
 
-    @property
+    @json_property
     def multiple_price_types(self) -> typing.Optional[bool]:
         """
         Whether the menu group has multiple price types.
@@ -187,12 +156,9 @@ class MenuGroup:
         Returns:
             (typing.Optional[bool]): Whether the menu group has multiple price types.
         """
-        try:
-            return self._raw_menu_group_data["multiplePriceTypes"]
-        except KeyError:
-            return None
+        return self._raw_menu_group_data["multiplePriceTypes"]
 
-    @property
+    @json_property
     def mickey_check_items(self) -> typing.Optional[bool]:
         """
         Whether the menu group has mickey check items.
@@ -200,12 +166,9 @@ class MenuGroup:
         Returns:
             (typing.Optional[bool]): Whether the menu group has mickey check items.
         """
-        try:
-            return self._raw_menu_group_data["mickeyCheckItems"]
-        except KeyError:
-            return None
+        return self._raw_menu_group_data["mickeyCheckItems"]
 
-    @property
+    @json_property
     def names(self) -> typing.Optional[dict]:
         """
         The names of the menu group.
@@ -213,12 +176,9 @@ class MenuGroup:
         Returns:
             (typing.Optional[dict]): The names of the menu group.
         """
-        try:
-            return self._raw_menu_group_data["names"]
-        except KeyError:
-            return None
+        return self._raw_menu_group_data["names"]
 
-    @property
+    @json_property
     def pc_short_name(self) -> typing.Optional[str]:
         """
         The short name of the menu group.
@@ -226,12 +186,9 @@ class MenuGroup:
         Returns:
             (typing.Optional[str]): The short name of the menu group.
         """
-        try:
-            return self._raw_menu_group_data["names"]["PCShort"]
-        except KeyError:
-            return None
+        return self._raw_menu_group_data["names"]["PCShort"]
 
-    @property
+    @json_property
     def pc_long_name(self) -> typing.Optional[str]:
         """
         The long name of the menu group.
@@ -239,12 +196,9 @@ class MenuGroup:
         Returns:
             (typing.Optional[str]): The long name of the menu group.
         """
-        try:
-            return self._raw_menu_group_data["names"]["PCLong"]
-        except KeyError:
-            return None
+        return self._raw_menu_group_data["names"]["PCLong"]
 
-    @property
+    @json_property
     def mobile_short_name(self) -> typing.Optional[str]:
         """
         The short name of the menu group.
@@ -252,12 +206,9 @@ class MenuGroup:
         Returns:
             (typing.Optional[str]): The short name of the menu group.
         """
-        try:
-            return self._raw_menu_group_data["names"]["MobileShort"]
-        except KeyError:
-            return None
+        return self._raw_menu_group_data["names"]["MobileShort"]
 
-    @property
+    @json_property
     def mobile_long_name(self) -> typing.Optional[str]:
         """
         The long name of the menu group.
@@ -265,10 +216,7 @@ class MenuGroup:
         Returns:
             (typing.Optional[str]): The long name of the menu group.
         """
-        try:
-            return self._raw_menu_group_data["names"]["MobileLong"]
-        except KeyError:
-            return None
+        return self._raw_menu_group_data["names"]["MobileLong"]
 
     @property
     def menu_items(self) -> typing.Optional[list[MenuItem]]:
@@ -292,7 +240,7 @@ class Menu:
     def __str__(self):
         return f"Menu(entity_id={self.entity_id}, menu_type={self.menu_type}, parent_restaurant_id={self._parent_restaurant_id})"
 
-    @property
+    @json_property
     def entity_id(self) -> typing.Optional[str]:
         """
         The entity id of the menu.
@@ -300,12 +248,9 @@ class Menu:
         Returns:
             (typing.Optional[str]): The entity id of the menu.
         """
-        try:
-            return self._raw_menu_data["id"]
-        except KeyError:
-            return None
+        return self._raw_menu_data["id"]
 
-    @property
+    @json_property
     def menu_type(self) -> typing.Optional[str]:
         """
         The type of the menu.
@@ -313,12 +258,9 @@ class Menu:
         Returns:
             (typing.Optional[str]): The type of the menu.
         """
-        try:
-            return self._raw_menu_data["menuType"]
-        except KeyError:
-            return None
+        return self._raw_menu_data["menuType"]
 
-    @property
+    @json_property
     def localized_menu_type(self) -> typing.Optional[str]:
         """
         The localized type of the menu.
@@ -326,12 +268,9 @@ class Menu:
         Returns:
             (typing.Optional[str]): The localized type of the menu.
         """
-        try:
-            return self._raw_menu_data["localizedMenuType"]
-        except KeyError:
-            return None
+        return self._raw_menu_data["localizedMenuType"]
 
-    @property
+    @json_property
     def experience_type(self) -> typing.Optional[str]:
         """
         The experience type of the menu.
@@ -339,12 +278,9 @@ class Menu:
         Returns:
             (typing.Optional[str]): The experience type of the menu.
         """
-        try:
-            return self._raw_menu_data["experienceType"]
-        except KeyError:
-            return None
+        return self._raw_menu_data["experienceType"]
 
-    @property
+    @json_property
     def service_style(self) -> typing.Optional[str]:
         """
         The service style of the menu.
@@ -352,12 +288,9 @@ class Menu:
         Returns:
             (typing.Optional[str]): The service style of the menu.
         """
-        try:
-            return self._raw_menu_data["serviceStyle"]
-        except KeyError:
-            return None
+        return self._raw_menu_data["serviceStyle"]
 
-    @property
+    @json_property
     def primary_cuisine_type(self) -> typing.Optional[str]:
         """
         The primary cuisine type of the menu.
@@ -365,12 +298,9 @@ class Menu:
         Returns:
             (typing.Optional[str]): The primary cuisine type of the menu.
         """
-        try:
-            return self._raw_menu_data["primaryCuisineType"]
-        except KeyError:
-            return None
+        return self._raw_menu_data["primaryCuisineType"]
 
-    @property
+    @json_property
     def secondary_cuisine_type(self) -> typing.Optional[str]:
         """
         The secondary cuisine type of the menu.
@@ -378,10 +308,7 @@ class Menu:
         Returns:
             (typing.Optional[str]): The secondary cuisine type of the menu.
         """
-        try:
-            return self._raw_menu_data["secondaryCuisineType"]
-        except KeyError:
-            return None
+        return self._raw_menu_data["secondaryCuisineType"]
 
     @property
     def menu_groups(self) -> list[MenuGroup]:
@@ -406,10 +333,15 @@ class Menus(DisneyAPIMixin):
         self.entity_id = restaurant_channel_id.rsplit(".", 1)[-1]
         self._menu_service_url = f"{self._menu_service_base}/{self.entity_id}"
 
-        if lazy_load:
-            self.disney_data: typing.Optional[dict] = None
-        else:
-            self.disney_data = self.get_disney_data(self.entity_id)
+        self._refresh_interval: timedelta = timedelta(
+            hours=12
+        )  # properties are rarely updated, no need to spam the API
+        self._tz = ZoneInfo("UTC")
+
+        self._disney_data: typing.Optional[dict] = None
+        self._disney_data_pull_time: typing.Optional[datetime] = datetime.now(tz=self._tz)
+        if not lazy_load:
+            self.refresh()
 
     def __str__(self):
         return f"Menus(entity_id={self.entity_id})"
@@ -417,7 +349,13 @@ class Menus(DisneyAPIMixin):
     def __repr__(self):
         return f"Menus(restaurant_channel_id={self.entity_id})"
 
-    @property
+    def refresh(self) -> None:
+        """Pulls initial data if none exists or if it is older than the refresh interval"""
+        if self._disney_data is None or datetime.now(tz=self._tz) - self.last_refresh > self._refresh_interval:
+            self._disney_data = self.get_disney_data(self._menu_service_url)
+            self._disney_data_pull_time = datetime.now(tz=self._tz)
+
+    @disney_property(default_value=[])
     def menus(self) -> list[Menu]:
         """
         Returns a list of all the menus associated with this entity.
@@ -425,9 +363,52 @@ class Menus(DisneyAPIMixin):
         Returns:
             (list[Menu]): List of Menu objects that are associated with this entity.
         """
-        if self.disney_data is None:
-            self.disney_data = self.get_disney_data(self._menu_service_url)
+
+        return [Menu(i, self.entity_id) for i in self._disney_data["menus"]]
+
+    @disney_property()
+    def facility_name(self) -> typing.Optional[str]:
+        """
+        The name of the facility.
+
+        Returns:
+            (typing.Optional[str]): The name of the facility.
+        """
+        return self._disney_data["facilityName"]
+
+    @disney_property()
+    def ancestor_location_park_resort(self) -> typing.Optional[str]:
+        """
+        The name of the ancestor location.
+
+        Returns:
+            (typing.Optional[str]): The name of the ancestor location.
+        """
+        return self._disney_data["ancestorLocationParkResort"]
+
+    @disney_property()
+    def ancestor_location_land_area(self) -> typing.Optional[str]:
+        """
+        The name of the ancestor location.
+
+        Returns:
+            (typing.Optional[str]): The name of the ancestor location.
+        """
+        return self._disney_data["ancestorLocationLandArea"]
+
+    @property
+    def last_refresh(self) -> typing.Optional[datetime]:
+        """
+        The last time the menus were refreshed.
+
+        Returns:
+            (typing.Optional[datetime]): The last time the menus were refreshed.
+        """
+        if self._disney_data is None:
+            self._disney_data = self.get_disney_data(self.entity_id)
         try:
-            return [Menu(i, self.entity_id) for i in self.disney_data["menus"]]
-        except KeyError:
-            return []
+            refresh_time = isoparse(self._disney_data["lastRefresh"])
+            refresh_time = refresh_time.replace(tzinfo=self._tz)
+            return refresh_time
+        except (KeyError, TypeError, ValueError):
+            return self._disney_data_pull_time

mousetools-4.1.1/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.3 → mousetools-4.1.1}/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, EntityType
 from mousetools.mixins.couchbase import CouchbaseMixin
 
 
@@ -43,6 +44,15 @@ class CouchbaseChannel(CouchbaseMixin):
 
         return [i["id"] for i in self._cb_data["results"]]
 
+    def _get_children_objects_helper(self, class_obj, entity_type: EntityType) -> list:
+        self.refresh()
+        channels = []
+        check_for = f"entitytype={entity_type.value}".lower()
+        for i in self._cb_data["results"]:
+            if check_for == i["id"].rsplit(";")[-1].lower():
+                channels.append(class_obj(i["id"]))
+        return channels
+
     def __repr__(self):
         return f"{self.__class__.__name__}(channel_id='{self.channel_id}')"