MouseTools 4.5.1__tar.gz → 5.0.0__tar.gz

{mousetools-4.5.1 → mousetools-5.0.0}/PKG-INFO

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

mousetools-5.0.0/mousetools/__init__.py

@@ -0,0 +1,43 @@
+import logging
+
+from mousetools.api.menu import Menu, MenuGroup, MenuItem, Menus
+from mousetools.api.search import Search
+from mousetools.channels import CouchbaseChannel, CouchbaseChildChannel
+from mousetools.channels.calendar import CalendarChannel, CalendarChildChannel
+from mousetools.channels.characters import CharactersChannel, CharactersChildChannel
+from mousetools.channels.facilities import FacilityChannel
+from mousetools.channels.facilitystatus import FacilityStatusChannel, FacilityStatusChildChannel
+from mousetools.channels.forecastedwaittimes import (
+    ForecastedWaitTimesChannel,
+    ForecastedWaitTimesChildChannel,
+)
+from mousetools.channels.manager import ChannelManager
+from mousetools.channels.today import TodayChannel, TodayChildChannel
+from mousetools.enums import DestinationShort, EntityType
+
+logger = logging.getLogger(__name__)
+logger.addHandler(logging.NullHandler())
+
+__all__ = [
+    "CalendarChannel",
+    "CalendarChildChannel",
+    "ChannelManager",
+    "CharactersChannel",
+    "CharactersChildChannel",
+    "CouchbaseChannel",
+    "CouchbaseChildChannel",
+    "DestinationShort",
+    "EntityType",
+    "FacilityChannel",
+    "FacilityStatusChannel",
+    "FacilityStatusChildChannel",
+    "ForecastedWaitTimesChannel",
+    "ForecastedWaitTimesChildChannel",
+    "Menu",
+    "MenuGroup",
+    "MenuItem",
+    "Menus",
+    "Search",
+    "TodayChannel",
+    "TodayChildChannel",
+]

{mousetools-4.5.1/mousetools/mixins → mousetools-5.0.0/mousetools/_internal/http}/couchbase.py

@@ -5,7 +5,7 @@ from typing import Union
 
 import requests
 
-from mousetools.auth import auth_obj
+from mousetools._internal.auth import auth_obj
 
 logger = logging.getLogger(__name__)
 

{mousetools-4.5.1/mousetools/mixins → mousetools-5.0.0/mousetools/_internal/http}/disney.py

@@ -4,7 +4,7 @@ from typing import Union
 
 import requests
 
-from mousetools.auth import auth_obj
+from mousetools._internal.auth import auth_obj
 
 logger = logging.getLogger(__name__)
 

{mousetools-4.5.1 → mousetools-5.0.0}/mousetools/api/menu.py

@@ -5,9 +5,9 @@ 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
+from mousetools._internal.auth import auth_obj
+from mousetools._internal.decorators import disney_property, json_property
+from mousetools._internal.http.disney import DisneyAPIMixin
 
 logger = logging.getLogger(__name__)
 

{mousetools-4.5.1 → mousetools-5.0.0}/mousetools/api/search.py

@@ -1,9 +1,9 @@
 from typing import Optional, Union
 
-from mousetools.auth import auth_obj
+from mousetools._internal.auth import auth_obj
+from mousetools._internal.http.disney import DisneyAPIMixin
 from mousetools.channels.enums import DLRCouchbaseChannels, WDWCouchbaseChannels
 from mousetools.enums import DestinationShort
-from mousetools.mixins.disney import DisneyAPIMixin
 
 
 class Search(DisneyAPIMixin):

mousetools-5.0.0/mousetools/auth.py

@@ -0,0 +1,14 @@
+"""Deprecated. Import from ``mousetools._internal.auth`` instead. Removed in 6.0."""
+
+import warnings
+
+from mousetools._internal.auth import Authentication, auth_obj
+
+warnings.warn(
+    "mousetools.auth is deprecated; import from mousetools._internal.auth "
+    "(internal) or use the top-level mousetools public API. Removed in 6.0.",
+    DeprecationWarning,
+    stacklevel=2,
+)
+
+__all__ = ["Authentication", "auth_obj"]

{mousetools-4.5.1 → mousetools-5.0.0}/mousetools/channels/__init__.py

@@ -5,10 +5,10 @@ from typing import Any, Optional, Union
 
 from dateutil.parser import isoparse
 
+from mousetools._internal.decorators import disney_property
+from mousetools._internal.http.couchbase import CouchbaseMixin
 from mousetools.channels.enums import DestinationTimezones, DLRCouchbaseChannels, WDWCouchbaseChannels
-from mousetools.decorators import disney_property
 from mousetools.enums import DestinationShort, EntityType
-from mousetools.mixins.couchbase import CouchbaseMixin
 
 logger = logging.getLogger(__name__)
 

{mousetools-4.5.1 → mousetools-5.0.0}/mousetools/channels/calendar/__init__.py

@@ -5,9 +5,9 @@ from zoneinfo import ZoneInfo
 
 from dateutil.parser import isoparse
 
+from mousetools._internal.decorators import disney_property
 from mousetools.channels import CouchbaseChannel, CouchbaseChildChannel
 from mousetools.channels.enums import CouchbaseChannels
-from mousetools.decorators import disney_property
 
 logger = logging.getLogger(__name__)
 

{mousetools-4.5.1 → mousetools-5.0.0}/mousetools/channels/characters/__init__.py

@@ -3,9 +3,9 @@ from typing import Optional
 
 from dateutil.parser import isoparse
 
+from mousetools._internal.decorators import disney_property
 from mousetools.channels import CouchbaseChannel, CouchbaseChildChannel
 from mousetools.channels.enums import CouchbaseChannels
-from mousetools.decorators import disney_property
 
 logger = logging.getLogger(__name__)
 

{mousetools-4.5.1 → mousetools-5.0.0}/mousetools/channels/facilities/__init__.py

@@ -6,6 +6,9 @@ from zoneinfo import ZoneInfo
 
 import requests
 
+from mousetools._internal.decorators import disney_property
+
+# tach-ignore(issue 34 - FacilityChildChannel.get_menu coupling to api.menu is pre-existing debt, to be removed by the issue 34 god-class refactor)
 from mousetools.api.menu import Menus
 from mousetools.channels import CouchbaseChannel, CouchbaseChildChannel
 from mousetools.channels.calendar import CalendarChildChannel
@@ -17,7 +20,6 @@ from mousetools.channels.enums import (
 from mousetools.channels.facilitystatus import FacilityStatusChildChannel
 from mousetools.channels.forecastedwaittimes import ForecastedWaitTimesChildChannel
 from mousetools.channels.today import TodayChildChannel
-from mousetools.decorators import disney_property
 from mousetools.enums import DestinationShort, EntityType
 
 logger = logging.getLogger(__name__)

{mousetools-4.5.1 → mousetools-5.0.0}/mousetools/channels/facilitystatus/__init__.py

@@ -4,9 +4,9 @@ from typing import Any, Optional
 
 from dateutil.parser import isoparse
 
+from mousetools._internal.decorators import disney_property
 from mousetools.channels import CouchbaseChannel, CouchbaseChildChannel
 from mousetools.channels.enums import CouchbaseChannels
-from mousetools.decorators import disney_property
 from mousetools.enums import EntityType
 
 logger = logging.getLogger(__name__)

{mousetools-4.5.1 → mousetools-5.0.0}/mousetools/channels/manager.py

@@ -3,8 +3,8 @@ from typing import Optional, Union
 
 from more_itertools import batched
 
+from mousetools._internal.http.couchbase import CouchbaseMixin
 from mousetools.channels import CouchbaseChannel, CouchbaseChildChannel
-from mousetools.mixins.couchbase import CouchbaseMixin
 
 logger = logging.getLogger(__name__)
 

{mousetools-4.5.1 → mousetools-5.0.0}/mousetools/channels/today/__init__.py

@@ -4,8 +4,8 @@ from typing import Optional
 
 from dateutil.parser import isoparse
 
+from mousetools._internal.decorators import disney_property
 from mousetools.channels import CouchbaseChannel, CouchbaseChildChannel
-from mousetools.decorators import disney_property
 from mousetools.enums import EntityType
 
 logger = logging.getLogger(__name__)

mousetools-5.0.0/mousetools/decorators.py

@@ -0,0 +1,13 @@
+"""Deprecated. Import from ``mousetools._internal.decorators`` instead. Removed in 6.0."""
+
+import warnings
+
+from mousetools._internal.decorators import disney_property, json_property
+
+warnings.warn(
+    "mousetools.decorators is deprecated; import from mousetools._internal.decorators. Removed in 6.0.",
+    DeprecationWarning,
+    stacklevel=2,
+)
+
+__all__ = ["disney_property", "json_property"]

mousetools-5.0.0/mousetools/mixins/__init__.py

@@ -0,0 +1 @@
+"""Deprecated. Import from ``mousetools._internal.http`` instead. Removed in 6.0."""

mousetools-5.0.0/mousetools/mixins/couchbase.py

@@ -0,0 +1,13 @@
+"""Deprecated. Import from ``mousetools._internal.http.couchbase`` instead. Removed in 6.0."""
+
+import warnings
+
+from mousetools._internal.http.couchbase import CouchbaseMixin
+
+warnings.warn(
+    "mousetools.mixins.couchbase is deprecated; import from mousetools._internal.http.couchbase. Removed in 6.0.",
+    DeprecationWarning,
+    stacklevel=2,
+)
+
+__all__ = ["CouchbaseMixin"]

mousetools-5.0.0/mousetools/mixins/disney.py

@@ -0,0 +1,13 @@
+"""Deprecated. Import from ``mousetools._internal.http.disney`` instead. Removed in 6.0."""
+
+import warnings
+
+from mousetools._internal.http.disney import DisneyAPIMixin
+
+warnings.warn(
+    "mousetools.mixins.disney is deprecated; import from mousetools._internal.http.disney. Removed in 6.0.",
+    DeprecationWarning,
+    stacklevel=2,
+)
+
+__all__ = ["DisneyAPIMixin"]

{mousetools-4.5.1 → mousetools-5.0.0}/mousetools.egg-info/PKG-INFO

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

{mousetools-4.5.1 → mousetools-5.0.0}/mousetools.egg-info/SOURCES.txt

@@ -5,11 +5,18 @@ mousetools/__init__.py
 mousetools/auth.py
 mousetools/decorators.py
 mousetools/enums.py
+mousetools/py.typed
 mousetools.egg-info/PKG-INFO
 mousetools.egg-info/SOURCES.txt
 mousetools.egg-info/dependency_links.txt
 mousetools.egg-info/requires.txt
 mousetools.egg-info/top_level.txt
+mousetools/_internal/__init__.py
+mousetools/_internal/auth.py
+mousetools/_internal/decorators.py
+mousetools/_internal/http/__init__.py
+mousetools/_internal/http/couchbase.py
+mousetools/_internal/http/disney.py
 mousetools/api/__init__.py
 mousetools/api/menu.py
 mousetools/api/search.py
@@ -27,5 +34,8 @@ mousetools/mixins/__init__.py
 mousetools/mixins/couchbase.py
 mousetools/mixins/disney.py
 mousetools/resources/environments.bin
+tests/test_deprecation_shims.py
+tests/test_internal_layout.py
 tests/test_manager.py
-tests/test_mixins.py
+tests/test_mixins.py
+tests/test_public_api.py

{mousetools-4.5.1 → mousetools-5.0.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "mousetools"
-version = "4.5.1"
+version = "5.0.0"
 authors = [{name = "Scott Caratozzolo"}]
 description = "An unofficial Python wrapper for Disney's API"
 readme = "README.md"
@@ -34,7 +34,6 @@ 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",
@@ -44,6 +43,8 @@ dev-dependencies = [
     "icecream>=2.1.4",
     "pytest-mock>=3.14.0",
     "responses>=0.25.7",
+    "tach>=0.29.0",
+    "pyrefly>=0.16.0",
 ]
 
 [build-system]
@@ -52,7 +53,7 @@ build-backend = "setuptools.build_meta"
 include-package-data = true
 
 [tool.setuptools.package-data]
-"mousetools" = ["resources/*"]
+"mousetools" = ["resources/*", "py.typed"]
 
 [tool.commitizen]
 tag_format = "v$version"
@@ -138,12 +139,8 @@ ignore = [
 ]
 
 
-[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"
+[tool.pyrefly]
+project-includes = ["mousetools"]
+project-excludes = ["mousetools/auth.py", "mousetools/decorators.py", "mousetools/mixins"]
+python-version = "3.9"
+baseline = "pyrefly-baseline.json"

mousetools-5.0.0/tests/test_deprecation_shims.py

@@ -0,0 +1,30 @@
+import pytest
+
+
+def test_auth_shim_warns_and_reexports():
+    with pytest.warns(DeprecationWarning, match="mousetools._internal.auth"):
+        from mousetools.auth import auth_obj
+
+    from mousetools._internal.auth import auth_obj as auth_obj_real
+
+    assert auth_obj is auth_obj_real
+
+
+def test_decorators_shim_warns_and_reexports():
+    with pytest.warns(DeprecationWarning, match="mousetools._internal.decorators"):
+        from mousetools.decorators import disney_property
+
+    from mousetools._internal.decorators import disney_property as disney_property_real
+
+    assert disney_property is disney_property_real
+
+
+def test_mixins_shim_warns_and_reexports():
+    with pytest.warns(DeprecationWarning, match="mousetools._internal.http"):
+        from mousetools.mixins.couchbase import CouchbaseMixin
+
+    from mousetools._internal.http.couchbase import (
+        CouchbaseMixin as couchbase_mixin_real,  # noqa: N813
+    )
+
+    assert CouchbaseMixin is couchbase_mixin_real

mousetools-5.0.0/tests/test_internal_layout.py

@@ -0,0 +1,12 @@
+def test_internal_modules_importable_from_new_paths():
+    from mousetools._internal.auth import Authentication, auth_obj
+    from mousetools._internal.decorators import disney_property, json_property
+    from mousetools._internal.http.couchbase import CouchbaseMixin
+    from mousetools._internal.http.disney import DisneyAPIMixin
+
+    assert auth_obj is not None
+    assert callable(disney_property)
+    assert callable(json_property)
+    assert Authentication is not None
+    assert CouchbaseMixin is not None
+    assert DisneyAPIMixin is not None

mousetools-5.0.0/tests/test_mixins.py

@@ -0,0 +1,73 @@
+import json
+
+import responses
+
+from mousetools._internal.auth import auth_obj
+from mousetools._internal.http.couchbase import CouchbaseMixin
+from mousetools._internal.http.disney import DisneyAPIMixin
+
+_ATTRACTION_ID = "wdw.facilities.1_0.en_us.attraction.80010177;entityType=Attraction"
+_BULK_GET = CouchbaseMixin._couchbase_url + "/_bulk_get"
+_CHANGES = CouchbaseMixin._couchbase_url + "/_changes"
+
+
+@responses.activate
+def test_couchbase_mixin():
+    cb = CouchbaseMixin()
+
+    # _bulk_get returns a multipart-ish text body parsed line-by-line as JSON.
+    # First real-URL call -> a valid document; second -> a not_found error doc (FIFO order).
+    responses.add(
+        responses.POST,
+        _BULK_GET,
+        body=json.dumps({"id": _ATTRACTION_ID, "name": "Pirates of the Caribbean"}),
+        status=200,
+    )
+    responses.add(
+        responses.POST,
+        _BULK_GET,
+        body=json.dumps({"id": "wdw.notreal.1_0", "error": "not_found"}),
+        status=200,
+    )
+    # _changes returns JSON.
+    responses.add(
+        responses.POST,
+        _CHANGES,
+        json={"results": [{"seq": 1, "id": _ATTRACTION_ID, "changes": []}], "last_seq": "1"},
+        status=200,
+    )
+    # An unreachable host returns an HTTP error, which the mixin maps to None.
+    responses.add(responses.POST, "http://notreal.com/_bulk_get", status=404)
+    responses.add(responses.POST, "http://notreal.com/_changes", status=404)
+
+    channel_data = cb.get_channel_data(_ATTRACTION_ID)
+    channel_changes = cb.get_channel_changes("wdw.facilities.1_0.en_us")
+
+    assert channel_data
+    assert channel_data["id"] == _ATTRACTION_ID
+
+    assert channel_changes
+    assert len(channel_changes["results"]) > 0
+
+    channel_data = cb.get_channel_data("wdw.notreal.1_0")
+    assert channel_data.get("error", "") == "not_found"
+
+    cb._couchbase_url = "http://notreal.com"
+    channel_data = cb.get_channel_data(_ATTRACTION_ID)
+    channel_changes = cb.get_channel_changes("wdw.facilities.1_0.en_us", since=3900000)
+    assert channel_data is None
+    assert channel_changes is None
+
+
+def test_disney_mixin():
+    disney = DisneyAPIMixin()
+    data = disney.get_disney_data(
+        f"{auth_obj._environments['serviceMenuUrl']}/diningMenuSvc/orchestration/menus/17936197"
+    )
+
+    assert data
+    assert "menus" in data
+
+    data = disney.get_disney_data("http://notreal.com")
+
+    assert data is None

mousetools-5.0.0/tests/test_public_api.py

@@ -0,0 +1,37 @@
+import importlib
+
+import mousetools
+
+EXPECTED = {
+    "CouchbaseChannel",
+    "CouchbaseChildChannel",
+    "ChannelManager",
+    "FacilityChannel",
+    "FacilityStatusChannel",
+    "FacilityStatusChildChannel",
+    "CalendarChannel",
+    "CalendarChildChannel",
+    "CharactersChannel",
+    "CharactersChildChannel",
+    "TodayChannel",
+    "TodayChildChannel",
+    "ForecastedWaitTimesChannel",
+    "ForecastedWaitTimesChildChannel",
+    "Search",
+    "Menus",
+    "Menu",
+    "MenuGroup",
+    "MenuItem",
+    "DestinationShort",
+    "EntityType",
+}
+
+
+def test_all_matches_expected():
+    assert set(mousetools.__all__) == EXPECTED
+
+
+def test_every_public_name_is_importable():
+    mod = importlib.import_module("mousetools")
+    for name in mod.__all__:
+        assert hasattr(mod, name), f"{name} missing from top-level mousetools"

mousetools-4.5.1/mousetools/__init__.py

@@ -1,4 +0,0 @@
-import logging
-
-logger = logging.getLogger(__name__)
-logger.addHandler(logging.NullHandler())

mousetools-4.5.1/tests/test_mixins.py

@@ -1,37 +0,0 @@
-from mousetools.auth import auth_obj
-from mousetools.mixins.couchbase import CouchbaseMixin
-from mousetools.mixins.disney import DisneyAPIMixin
-
-
-def test_couchbase_mixin():
-    cb = CouchbaseMixin()
-    channel_data = cb.get_channel_data("wdw.facilities.1_0.en_us.attraction.80010177;entityType=Attraction")
-    channel_changes = cb.get_channel_changes("wdw.facilities.1_0.en_us")
-
-    assert channel_data
-
-    assert channel_changes
-    assert len(channel_changes["results"]) > 0
-
-    channel_data = cb.get_channel_data("wdw.notreal.1_0")
-    assert channel_data.get("error", "") == "not_found"
-
-    cb._couchbase_url = "http://notreal.com"
-    channel_data = cb.get_channel_data("wdw.facilities.1_0.en_us.attraction.80010177;entityType=Attraction")
-    channel_changes = cb.get_channel_changes("wdw.facilities.1_0.en_us", since=3900000)
-    assert channel_data is None
-    assert channel_changes is None
-
-
-def test_disney_mixin():
-    disney = DisneyAPIMixin()
-    data = disney.get_disney_data(
-        f"{auth_obj._environments['serviceMenuUrl']}/diningMenuSvc/orchestration/menus/17936197"
-    )
-
-    assert data
-    assert "menus" in data
-
-    data = disney.get_disney_data("http://notreal.com")
-
-    assert data is None