MouseTools 3.0.0.dev2__tar.gz → 3.1.0.dev2__tar.gz

{mousetools-3.0.0.dev2 → mousetools-3.1.0.dev2/MouseTools.egg-info}/PKG-INFO

@@ -1,9 +1,10 @@
 Metadata-Version: 2.1
 Name: MouseTools
-Version: 3.0.0.dev2
+Version: 3.1.0.dev2
 Summary: An unofficial Python wrapper for Disney's API
 Author: Scott Caratozzolo
 Project-URL: repository, https://gitlab.com/caratozzoloxyz/public/MouseTools
+Project-URL: documentation, https://caratozzoloxyz.gitlab.io/public/MouseTools/
 Classifier: Programming Language :: Python :: 3
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Operating System :: OS Independent

{mousetools-3.0.0.dev2/MouseTools.egg-info → mousetools-3.1.0.dev2}/PKG-INFO

@@ -1,9 +1,10 @@
 Metadata-Version: 2.1
 Name: MouseTools
-Version: 3.0.0.dev2
+Version: 3.1.0.dev2
 Summary: An unofficial Python wrapper for Disney's API
 Author: Scott Caratozzolo
 Project-URL: repository, https://gitlab.com/caratozzoloxyz/public/MouseTools
+Project-URL: documentation, https://caratozzoloxyz.gitlab.io/public/MouseTools/
 Classifier: Programming Language :: Python :: 3
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Operating System :: OS Independent

{mousetools-3.0.0.dev2 → mousetools-3.1.0.dev2}/mousetools/__init__.py

@@ -3,5 +3,5 @@ import logging
 logger = logging.getLogger(__name__)
 logger.addHandler(logging.NullHandler())
 
-__version__ = "3.0.0-dev.2"  # will be set at runtime
+__version__ = "3.1.0-dev.2"  # will be set at runtime
 logger.info(f"MouseTools version: {__version__}")

{mousetools-3.0.0.dev2 → mousetools-3.1.0.dev2}/mousetools/entities/__init__.py

@@ -8,6 +8,7 @@ from mousetools.entities.entertainment_venue import EntertainmentVenue
 from mousetools.entities.event import Event
 from mousetools.entities.guest_services import GuestServices
 from mousetools.entities.land import Land
+from mousetools.entities.menu import Menus
 from mousetools.entities.merchandise_facility import MerchandiseFacility
 from mousetools.entities.park import ThemePark, WaterPark
 from mousetools.entities.point_of_interest import PointOfInterest
@@ -38,4 +39,5 @@ __all__ = [
     "Event",
     "Land",
     "PointOfInterest",
+    "Menus",
 ]

{mousetools-3.0.0.dev2 → mousetools-3.1.0.dev2}/mousetools/entities/base.py

@@ -23,7 +23,7 @@ class EntityBase(DisneyAPIMixin, ThemeParkAPIMixin):
 
         if isinstance(facility_service_entity_type, FacilityServiceEntityTypes):
             facility_service_entity_type = facility_service_entity_type.value
-        self.__facility_service_url = f"{WDPRO_FACILITY_SERVICE_BASE_URL}/{facility_service_entity_type}/{self.entity_id}"
+        self._facility_service_url = f"{WDPRO_FACILITY_SERVICE_BASE_URL}/{facility_service_entity_type}/{self.entity_id}"
 
     @property
     def name(self) -> typing.Optional[str]:
@@ -35,7 +35,7 @@ class EntityBase(DisneyAPIMixin, ThemeParkAPIMixin):
         """
 
         if self.disney_data is None:
-            self.disney_data = self.get_disney_data(self.__facility_service_url)
+            self.disney_data = self.get_disney_data(self._facility_service_url)
         try:
             return self.disney_data["name"]
         except KeyError:
@@ -52,7 +52,7 @@ class EntityBase(DisneyAPIMixin, ThemeParkAPIMixin):
         """
 
         if self.disney_data is None:
-            self.disney_data = self.get_disney_data(self.__facility_service_url)
+            self.disney_data = self.get_disney_data(self._facility_service_url)
         try:
             return self.disney_data["type"]
         except KeyError:
@@ -68,7 +68,7 @@ class EntityBase(DisneyAPIMixin, ThemeParkAPIMixin):
             (typing.Optional[str]): The sub type of entity, or None if it was not found.
         """
         if self.disney_data is None:
-            self.disney_data = self.get_disney_data(self.__facility_service_url)
+            self.disney_data = self.get_disney_data(self._facility_service_url)
         try:
             return self.disney_data["subType"]
         except KeyError:
@@ -84,7 +84,7 @@ class EntityBase(DisneyAPIMixin, ThemeParkAPIMixin):
             (typing.Optional[str]): The url friendly id of the entity, or None if not found.
         """
         if self.disney_data is None:
-            self.disney_data = self.get_disney_data(self.__facility_service_url)
+            self.disney_data = self.get_disney_data(self._facility_service_url)
         try:
             _id = self.disney_data["urlFriendlyId"]
             return _id
@@ -101,21 +101,22 @@ class EntityBase(DisneyAPIMixin, ThemeParkAPIMixin):
             (typing.Optional[dict[str, float]]): A dict with "lat" and "lng" keys containing the coordinates of this entity as floats, or None if no coordinates are found
         """
         if self.disney_data is None:
-            self.disney_data = self.get_disney_data(self.__facility_service_url)
+            self.disney_data = self.get_disney_data(self._facility_service_url)
         try:
             return {
                 "lat": float(
                     self.disney_data["coordinates"]["Guest Entrance"]["gps"][
-                        "lattitude"
+                        "latitude"
                     ]
                 ),
                 "lng": float(
-                    self.disney_data["coordinates"]["Guest entrance"]["gps"][
+                    self.disney_data["coordinates"]["Guest Entrance"]["gps"][
                         "longitude"
                     ]
                 ),
             }
-        except KeyError:
+        except KeyError as e:
+            print(e)
             logger.debug("No coordinates found for %s", self.entity_id)
             return None
 
@@ -129,7 +130,7 @@ class EntityBase(DisneyAPIMixin, ThemeParkAPIMixin):
         """
         # TODO check other ancestors to guess dest if not found
         if self.disney_data is None:
-            self.disney_data = self.get_disney_data(self.__facility_service_url)
+            self.disney_data = self.get_disney_data(self._facility_service_url)
         try:
             return (
                 self.disney_data["links"]["ancestorDestination"]["href"]
@@ -156,7 +157,7 @@ class EntityBase(DisneyAPIMixin, ThemeParkAPIMixin):
             (typing.Optional[str]): Theme park id, or None if no such id is found.
         """
         if self.disney_data is None:
-            self.disney_data = self.get_disney_data(self.__facility_service_url)
+            self.disney_data = self.get_disney_data(self._facility_service_url)
         try:
             return (
                 self.disney_data["links"]["ancestorThemePark"]["href"]
@@ -176,7 +177,7 @@ class EntityBase(DisneyAPIMixin, ThemeParkAPIMixin):
             (typing.Optional[str]): Water park id, or None if no such id is found.
         """
         if self.disney_data is None:
-            self.disney_data = self.get_disney_data(self.__facility_service_url)
+            self.disney_data = self.get_disney_data(self._facility_service_url)
         try:
             return (
                 self.disney_data["links"]["ancestorWaterPark"]["href"]
@@ -197,7 +198,7 @@ class EntityBase(DisneyAPIMixin, ThemeParkAPIMixin):
         """
 
         if self.disney_data is None:
-            self.disney_data = self.get_disney_data(self.__facility_service_url)
+            self.disney_data = self.get_disney_data(self._facility_service_url)
         try:
             return (
                 self.disney_data["links"]["ancestorResort"]["href"]
@@ -217,7 +218,7 @@ class EntityBase(DisneyAPIMixin, ThemeParkAPIMixin):
             (typing.Optional[str]): Land id, or None if no such id is found.
         """
         if self.disney_data is None:
-            self.disney_data = self.get_disney_data(self.__facility_service_url)
+            self.disney_data = self.get_disney_data(self._facility_service_url)
         try:
             return (
                 self.disney_data["links"]["ancestorLand"]["href"]
@@ -237,7 +238,7 @@ class EntityBase(DisneyAPIMixin, ThemeParkAPIMixin):
             (typing.Optional[str]): Resort area id, or None if no such id is found.
         """
         if self.disney_data is None:
-            self.disney_data = self.get_disney_data(self.__facility_service_url)
+            self.disney_data = self.get_disney_data(self._facility_service_url)
         try:
             return (
                 self.disney_data["links"]["ancestorResortArea"]["href"]
@@ -257,7 +258,7 @@ class EntityBase(DisneyAPIMixin, ThemeParkAPIMixin):
             (typing.Optional[str]): Entertainment venue id, or None if no such id is found.
         """
         if self.disney_data is None:
-            self.disney_data = self.get_disney_data(self.__facility_service_url)
+            self.disney_data = self.get_disney_data(self._facility_service_url)
         try:
             return (
                 self.disney_data["links"]["ancestorEntertainmentVenue"]["href"]
@@ -279,7 +280,7 @@ class EntityBase(DisneyAPIMixin, ThemeParkAPIMixin):
             (typing.Optional[str]): Restaurant id, or None if no such id is found.
         """
         if self.disney_data is None:
-            self.disney_data = self.get_disney_data(self.__facility_service_url)
+            self.disney_data = self.get_disney_data(self._facility_service_url)
         try:
             return (
                 self.disney_data["links"]["ancestorRestaurant"]["href"]
@@ -322,7 +323,7 @@ class EntityBase(DisneyAPIMixin, ThemeParkAPIMixin):
     @property
     def duration(self) -> typing.Optional[time]:
         if self.disney_data is None:
-            self.disney_data = self.get_disney_data(self.__facility_service_url)
+            self.disney_data = self.get_disney_data(self._facility_service_url)
         try:
             return time.fromisoformat(
                 ":".join(self.disney_data["duration"].split(":")[:3])
@@ -465,7 +466,7 @@ class EntityBase(DisneyAPIMixin, ThemeParkAPIMixin):
         if isinstance(entity_type, FacilityServiceEntityTypes):
             entity_type = entity_type.value
 
-        children_url = f"{self.__facility_service_url}/{entity_type}"
+        children_url = f"{self._facility_service_url}/{entity_type}"
         data = self.get_disney_data(children_url)
         if data:
             return [

mousetools-3.1.0.dev2/mousetools/entities/menu.py

@@ -0,0 +1,226 @@
+import typing
+
+from mousetools.entities.base import EntityBase
+from mousetools.ids import FacilityServiceEntityTypes
+
+
+class MenuItem:
+    def __init__(self, raw_item_data: dict):
+        self._raw_item_data = raw_item_data
+
+    def __repr__(self) -> str:
+        return f"MenuItem(entity_id={self.entity_id}, name={self.name})"
+
+    @property
+    def entity_id(self) -> typing.Optional[str]:
+        """
+        The entity id of the menu item.
+
+        Returns:
+            (typing.Optional[str]): The entity id of the menu item.
+        """
+        try:
+            return self._raw_item_data["id"]
+        except KeyError:
+            return None
+
+    @property
+    def name(self) -> typing.Optional[str]:
+        """
+        The name of the menu item.
+
+        Returns:
+            (typing.Optional[str]): The name of the menu item.
+        """
+        try:
+            return self._raw_item_data["name"]
+        except KeyError:
+            return None
+
+    @property
+    def type_name(self) -> typing.Optional[str]:
+        """
+        The type of the menu item.
+
+        Returns:
+            (typing.Optional[str]): The type of the menu item.
+        """
+        try:
+            return self._raw_item_data["type"]
+        except KeyError:
+            return None
+
+    @property
+    def price(self) -> typing.Optional[dict]:
+        """
+        The price of the menu item.
+
+        Examples:
+            {'price_qualifier': 'Per Serving', 'price_without_tax': 6.29}
+
+        Returns:
+            (typing.Optional[dict]): The price of the menu item.
+        """
+        try:
+            for i in self._raw_item_data["prices"]:
+                if i["type"] == "Retail":
+                    return {
+                        "price_without_tax": float(
+                            i["priceSpecifications"][0]["priceWithoutTax"]
+                        ),
+                        "price_qualifier": i["priceSpecifications"][0][
+                            "priceQualifier"
+                        ],
+                    }
+        except KeyError:
+            return None
+
+        return None
+
+
+class Menu:
+    def __init__(self, raw_menu_data: dict):
+        self._raw_menu_data = raw_menu_data
+
+    def __repr__(self) -> str:
+        return f"Menu(entity_id={self.entity_id}, name={self.name})"
+
+    @property
+    def entity_id(self) -> typing.Optional[str]:
+        """
+        The entity id of the menu.
+
+        Returns:
+            (typing.Optional[str]): The entity id of the menu.
+        """
+        try:
+            return self._raw_menu_data["id"]
+        except KeyError:
+            return None
+
+    @property
+    def name(self) -> typing.Optional[str]:
+        """
+        The name of the menu.
+
+        Returns:
+            (typing.Optional[str]): The name of the menu.
+        """
+        try:
+            return self._raw_menu_data["name"]
+        except KeyError:
+            return None
+
+    @property
+    def type_name(self) -> typing.Optional[str]:
+        """
+        The type of the menu.
+
+        Returns:
+            (typing.Optional[str]): The type of the menu.
+        """
+        try:
+            return self._raw_menu_data["type"]
+        except KeyError:
+            return None
+
+    @property
+    def menu_items(self) -> list[MenuItem]:
+        """
+        The menu items of the menu.
+
+        Returns:
+            (list[MenuItem]): The menu items of the menu.
+        """
+        try:
+            return [MenuItem(i) for i in self._raw_menu_data["menuItems"]]
+        except KeyError:
+            return []
+
+
+class Menus(EntityBase):
+    """Class for Menu Entities."""
+
+    def __init__(self, entity_id: str):
+        super().__init__(
+            entity_id=entity_id,
+            facility_service_entity_type=FacilityServiceEntityTypes.MENU_ITEMS,
+        )
+
+    @property
+    def price_range(self) -> typing.Optional[str]:
+        """
+        The price range of the menu.
+
+        Examples:
+            "$ ($14.99 and under per adult)"
+
+        Returns:
+            (typing.Optional[str]): Price range of menu desribed in $.
+        """
+        if self.disney_data is None:
+            self.disney_data = self.get_disney_data(self._facility_service_url)
+        try:
+            return self.disney_data["priceRange"]
+        except KeyError:
+            return None
+
+    @property
+    def service_style(self) -> typing.Optional[str]:
+        """
+        The service style of the menu.
+
+        Returns:
+            (typing.Optional[str]): The service style of the menu.
+        """
+        if self.disney_data is None:
+            self.disney_data = self.get_disney_data(self._facility_service_url)
+        try:
+            return self.disney_data["serviceStyle"]
+        except KeyError:
+            return None
+
+    @property
+    def meal_period_type(self) -> typing.Optional[str]:
+        """
+        The meal period type of the menu.
+
+        Returns:
+            (typing.Optional[str]): The meal period type of the menu.
+        """
+        if self.disney_data is None:
+            self.disney_data = self.get_disney_data(self._facility_service_url)
+        try:
+            return self.disney_data["mealPeriodType"]
+        except KeyError:
+            return None
+
+    @property
+    def primary_cuisine_type(self) -> typing.Optional[str]:
+        """
+        The primary cuisine type of the menu.
+
+        Returns:
+            (typing.Optional[str]): The primary cuisine type of the menu.
+        """
+        if self.disney_data is None:
+            self.disney_data = self.get_disney_data(self._facility_service_url)
+        try:
+            return self.disney_data["primaryCuisineType"]
+        except KeyError:
+            return None
+
+    @property
+    def menus(self) -> list[Menu]:
+        """
+        Returns a list of all the menus associated with this entity.
+
+        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._facility_service_url)
+        try:
+            return [Menu(i) for i in self.disney_data["menus"]]
+        except KeyError:
+            return []

mousetools-3.1.0.dev2/mousetools/entities/restaurant.py

@@ -0,0 +1,53 @@
+import logging
+import typing
+
+from mousetools.entities.base import EntityBase
+from mousetools.ids import FacilityServiceEntityTypes
+
+logger = logging.getLogger(__name__)
+
+
+class Restaurant(EntityBase):
+    """Class for Restaurant Entities."""
+
+    def __init__(self, entity_id: str):
+        super().__init__(
+            entity_id=entity_id,
+            facility_service_entity_type=FacilityServiceEntityTypes.RESTAURANTS,
+        )
+
+    @property
+    def service_styles(self) -> typing.Optional[list[str]]:
+        """
+        The service styles offered by the restaurant.
+
+        Returns:
+            (typing.Optional[list[str]]): The service styles offered by the restaurant.
+        """
+        if self.disney_data is None:
+            self.disney_data = self.get_disney_data(self._facility_service_url)
+        try:
+            return self.disney_data["serviceStyles"]
+        except KeyError:
+            logger.debug("No service styles found for %s", self.entity_id)
+            return None
+
+    @property
+    def menu_id(self) -> typing.Optional[str]:
+        """
+        The menu id associated with the restaurant.
+
+        Returns:
+            (typing.Optional[str]): The menu id associated with the restaurant.
+        """
+        if self.disney_data is None:
+            self.disney_data = self.get_disney_data(self._facility_service_url)
+        try:
+            return (
+                self.disney_data["menuItems"][0]["links"]["self"]["href"]
+                .split("?")[0]
+                .split("/")[-1]
+            )
+        except KeyError:
+            logger.debug("No menu id found for %s", self.entity_id)
+            return None

{mousetools-3.0.0.dev2 → mousetools-3.1.0.dev2}/mousetools/mixins/disney.py

@@ -30,8 +30,6 @@ class DisneyAPIMixin:
         logger.info("Sending request to %s", url)
         response = httpx.get(url, headers=auth_obj.get_headers())
         logger.debug("Response status: %s", response.status_code)
-        if response.status_code == httpx._status_codes.codes.NOT_FOUND:
-            raise EntityIDNotFoundError
 
         try:
             response.raise_for_status()
@@ -49,6 +47,8 @@ class DisneyAPIMixin:
             logger.debug("Sending new request to %s", url)
             response = httpx.get(url, headers=auth_obj.get_headers())
             logger.debug("Response status: %s", response.status_code)
+            if response.status_code == httpx._status_codes.codes.NOT_FOUND:
+                raise EntityIDNotFoundError
             response.raise_for_status()
             data = response.json()
 

{mousetools-3.0.0.dev2 → mousetools-3.1.0.dev2}/pyproject.toml

@@ -1,7 +1,3 @@
-[build-system]
-requires = ["setuptools"]
-build-backend = "setuptools.build_meta"
-
 [project]
 name = "MouseTools"
 dynamic = ["version"]
@@ -21,6 +17,23 @@ classifiers = [
 
 [project.urls]
 repository = "https://gitlab.com/caratozzoloxyz/public/MouseTools"
+documentation = "https://caratozzoloxyz.gitlab.io/public/MouseTools/"
+
+[tool.uv]
+dev-dependencies = [
+    "mkdocs>=1.6.1",
+    "mkdocs-material>=9.5.33",
+    "mkdocstrings[python]>=0.25.2",
+    "mypy>=1.11.2",
+    "pre-commit>=3.5.0",
+    "pytest-cov>=5.0.0",
+    "pytest>=8.3.2",
+    "ruff>=0.6.3",
+]
+
+[build-system]
+requires = ["setuptools"]
+build-backend = "setuptools.build_meta"
 
 [tool.setuptools.dynamic]
 version = {attr = "mousetools.__version__"}
@@ -67,49 +80,64 @@ minor_tags = ["feat"]
 patch_tags = ["fix", "perf"]
 default_bump_level = 0
 
-[tool.semantic_release.remote]
-name = "origin"
-type = "gitlab"
-ignore_token_for_push = true
-insecure = false
-token = { env = "GITLAB_TOKEN" }
-
 [tool.semantic_release.publish]
-dist_glob_patterns = ["dist/*"]
 upload_to_vcs_release = false
 
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+
 
 [tool.ruff]
 target-version = "py39"
+line-length = 120
 
 [tool.ruff.lint]
 select = [
-    "F",
-    "E",
-    "W",
-    "I",
-    "N",
+    # flake8-2020
+    "YTT",
+    # flake8-bandit
+    "S",
+    # flake8-bugbear
+    "B",
+    # flake8-builtins
     "A",
+    # flake8-comprehensions
     "C4",
-    "DTZ002", "DTZ003",
-    "G010",
-    "T20",
-    "ERA",
-    "PL",
+    # flake8-debugger
+    "T10",
+    # flake8-simplify
+    "SIM",
+    # isort
+    "I",
+    # mccabe
+    "C90",
+    # pycodestyle
+    "E", "W",
+    # pyflakes
+    "F",
+    # pyupgrade
+    "UP",
+    # ruff
+    "RUF",
 ]
-
 ignore = [
+    # LineTooLong
     "E501",
+    # DoNotAssignLambda
+    "E731",
 ]
 
-[tool.uv]
-dev-dependencies = [
-    "mkdocs>=1.6.1",
-    "mkdocs-material>=9.5.33",
-    "mkdocstrings[python]>=0.25.2",
-    "mypy>=1.11.2",
-    "pre-commit>=3.5.0",
-    "pytest-cov>=5.0.0",
-    "pytest>=8.3.2",
-    "ruff>=0.6.3",
-]
+[tool.ruff.lint.per-file-ignores]
+# Use of `assert` detected
+"**/tests/*" = ["S101"]
+
+
+[tool.mypy]
+python_version = "3.9"
+files = ["mousetools"]
+disallow_untyped_defs = "True"
+disallow_any_unimported = "True"
+no_implicit_optional = "True"
+check_untyped_defs = "True"
+warn_unused_ignores = "True"
+show_error_codes = "True"

{mousetools-3.0.0.dev2 → mousetools-3.1.0.dev2}/tests/test_entities.py

@@ -13,6 +13,7 @@ from mousetools.entities.entertainment_venue import EntertainmentVenue
 from mousetools.entities.event import Event
 from mousetools.entities.guest_services import GuestServices
 from mousetools.entities.land import Land
+from mousetools.entities.menu import Menus
 from mousetools.entities.merchandise_facility import MerchandiseFacility
 from mousetools.entities.park import ThemePark, WaterPark
 from mousetools.entities.point_of_interest import PointOfInterest
@@ -57,6 +58,7 @@ POINT_OF_INTEREST_PARAMS = [
 RESORT_PARAMS = [pytest.param(Resort("80010390"), id="Resort")]
 RESORT_AREA_PARAMS = [pytest.param(ResortArea("80069772"), id="ResortArea")]
 RESTAURANT_PARAMS = [pytest.param(Restaurant("19233597"), id="Restaurant")]
+MENU_PARAMS = [pytest.param(Menus("19256571"), id="Menus")]
 
 TEST_ALL_ENTITIES = pytest.mark.parametrize(
     "entity_obj",
@@ -76,7 +78,8 @@ TEST_ALL_ENTITIES = pytest.mark.parametrize(
     + POINT_OF_INTEREST_PARAMS
     + RESORT_PARAMS
     + RESORT_AREA_PARAMS
-    + RESTAURANT_PARAMS,
+    + RESTAURANT_PARAMS
+    + MENU_PARAMS,
 )
 
 

mousetools-3.0.0.dev2/mousetools/entities/menu.py

@@ -1,12 +0,0 @@
-from mousetools.entities.base import EntityBase
-from mousetools.ids import FacilityServiceEntityTypes
-
-
-class Menu(EntityBase):
-    """Class for Menu Entities."""
-
-    def __init__(self, entity_id: str):
-        super().__init__(
-            entity_id=entity_id,
-            facility_service_entity_type=FacilityServiceEntityTypes.MENU_ITEMS,
-        )

mousetools-3.0.0.dev2/mousetools/entities/restaurant.py

@@ -1,12 +0,0 @@
-from mousetools.entities.base import EntityBase
-from mousetools.ids import FacilityServiceEntityTypes
-
-
-class Restaurant(EntityBase):
-    """Class for Restaurant Entities."""
-
-    def __init__(self, entity_id: str):
-        super().__init__(
-            entity_id=entity_id,
-            facility_service_entity_type=FacilityServiceEntityTypes.RESTAURANTS,
-        )