music-assistant-client 1.0.0__tar.gz

music_assistant_client-1.0.0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

music_assistant_client-1.0.0/PKG-INFO

@@ -0,0 +1,27 @@
+Metadata-Version: 2.1
+Name: music_assistant_client
+Version: 1.0.0
+Summary: Music Assistant Base Models
+Author-email: The Music Assistant Authors <music_assistant@users.noreply.github.com>
+License: Apache-2.0
+Platform: any
+Classifier: Environment :: Console
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: aiohttp>3.10
+Requires-Dist: music_assistant_models==1.0.0
+Provides-Extra: test
+Requires-Dist: codespell==2.3.0; extra == "test"
+Requires-Dist: isort==5.13.2; extra == "test"
+Requires-Dist: mypy==1.13.0; extra == "test"
+Requires-Dist: pre-commit==4.0.1; extra == "test"
+Requires-Dist: pre-commit-hooks==5.0.0; extra == "test"
+Requires-Dist: tomli==2.0.2; extra == "test"
+Requires-Dist: ruff==0.7.1; extra == "test"
+
+# Music Assistant Client
+
+Python client to interact with the Music Assistant Server API

music_assistant_client-1.0.0/README.md

@@ -0,0 +1,3 @@
+# Music Assistant Client
+
+Python client to interact with the Music Assistant Server API

music_assistant_client-1.0.0/music_assistant_client/__init__.py

@@ -0,0 +1,3 @@
+"""Music Assistant Client: Manage a Music Assistant server remotely."""
+
+from .client import MusicAssistantClient  # noqa: F401

music_assistant_client-1.0.0/music_assistant_client/client.py

@@ -0,0 +1,396 @@
+"""Music Assistant Client: Manage a Music Assistant server remotely."""
+
+from __future__ import annotations
+
+import asyncio
+import logging
+import urllib.parse
+import uuid
+from collections.abc import Callable, Coroutine
+from typing import TYPE_CHECKING, Any, Self
+
+from music_assistant_models.api import (
+    CommandMessage,
+    ErrorResultMessage,
+    EventMessage,
+    ResultMessageBase,
+    ServerInfoMessage,
+    SuccessResultMessage,
+    parse_message,
+)
+from music_assistant_models.enums import EventType, ImageType
+from music_assistant_models.errors import ERROR_MAP
+from music_assistant_models.event import MassEvent
+from music_assistant_models.provider import ProviderInstance, ProviderManifest
+
+from .config import Config
+from .connection import WebsocketsConnection
+from .constants import API_SCHEMA_VERSION
+from .exceptions import ConnectionClosed, InvalidServerVersion, InvalidState
+from .music import Music
+from .player_queues import PlayerQueues
+from .players import Players
+
+if TYPE_CHECKING:
+    from types import TracebackType
+
+    from aiohttp import ClientSession
+    from music_assistant_models.media_items import ItemMapping, MediaItemImage, MediaItemType
+    from music_assistant_models.queue_item import QueueItem
+
+EventCallBackType = Callable[[MassEvent], Coroutine[Any, Any, None] | None]
+EventSubscriptionType = tuple[
+    EventCallBackType, tuple[EventType, ...] | None, tuple[str, ...] | None
+]
+
+
+class MusicAssistantClient:
+    """Manage a Music Assistant server remotely."""
+
+    def __init__(self, server_url: str, aiohttp_session: ClientSession | None) -> None:
+        """Initialize the Music Assistant client."""
+        self.server_url = server_url
+        self.connection = WebsocketsConnection(server_url, aiohttp_session)
+        self.logger = logging.getLogger(__package__)
+        self._result_futures: dict[str | int, asyncio.Future[Any]] = {}
+        self._subscribers: list[EventSubscriptionType] = []
+        self._stop_called: bool = False
+        self._loop: asyncio.AbstractEventLoop | None = None
+        self._config = Config(self)
+        self._players = Players(self)
+        self._player_queues = PlayerQueues(self)
+        self._music = Music(self)
+        # below items are retrieved after connect
+        self._server_info: ServerInfoMessage | None = None
+        self._provider_manifests: dict[str, ProviderManifest] = {}
+        self._providers: dict[str, ProviderInstance] = {}
+
+    @property
+    def server_info(self) -> ServerInfoMessage | None:
+        """Return info of the server we're currently connected to."""
+        return self._server_info
+
+    @property
+    def providers(self) -> list[ProviderInstance]:
+        """Return all loaded/running Providers (instances)."""
+        return list(self._providers.values())
+
+    @property
+    def provider_manifests(self) -> list[ProviderManifest]:
+        """Return all Provider manifests."""
+        return list(self._provider_manifests.values())
+
+    @property
+    def config(self) -> Config:
+        """Return Config handler."""
+        return self._config
+
+    @property
+    def players(self) -> Players:
+        """Return Players handler."""
+        return self._players
+
+    @property
+    def player_queues(self) -> PlayerQueues:
+        """Return PlayerQueues handler."""
+        return self._player_queues
+
+    @property
+    def music(self) -> Music:
+        """Return Music handler."""
+        return self._music
+
+    def get_provider_manifest(self, domain: str) -> ProviderManifest:
+        """Return Provider manifests of single provider(domain)."""
+        return self._provider_manifests[domain]
+
+    def get_provider(
+        self, provider_instance_or_domain: str, return_unavailable: bool = False
+    ) -> ProviderInstance | None:
+        """Return provider by instance id or domain."""
+        # lookup by instance_id first
+        if prov := self._providers.get(provider_instance_or_domain):
+            if return_unavailable or prov.available:
+                return prov
+            if not prov.is_streaming_provider:
+                # no need to lookup other instances because this provider has unique data
+                return None
+            provider_instance_or_domain = prov.domain
+        # fallback to match on domain
+        # note that this can be tricky if the provider has multiple instances
+        # and has unique data (e.g. filesystem)
+        for prov in self._providers.values():
+            if prov.domain != provider_instance_or_domain:
+                continue
+            if return_unavailable or prov.available:
+                return prov
+        self.logger.debug("Provider %s is not available", provider_instance_or_domain)
+        return None
+
+    def get_image_url(self, image: MediaItemImage, size: int = 0) -> str:
+        """Get (proxied) URL for MediaItemImage."""
+        assert self.server_info
+        if image.remotely_accessible and not size:
+            return image.path
+        if image.remotely_accessible and size:
+            # get url to resized image(thumb) from weserv service
+            return (
+                f"https://images.weserv.nl/?url={urllib.parse.quote(image.path)}"
+                f"&w=${size}&h=${size}&fit=cover&a=attention"
+            )
+        # return imageproxy url for images that need to be resolved
+        # the original path is double encoded
+        encoded_url = urllib.parse.quote(urllib.parse.quote(image.path))
+        return (
+            f"{self.server_info.base_url}/imageproxy?path={encoded_url}"
+            f"&provider={image.provider}&size={size}"
+        )
+
+    def get_media_item_image_url(
+        self,
+        item: MediaItemType | ItemMapping | QueueItem,
+        type: ImageType = ImageType.THUMB,  # noqa: A002
+        size: int = 0,
+    ) -> str | None:
+        """Get image URL for MediaItem, QueueItem or ItemMapping."""
+        # handle queueitem with media_item attribute
+        if (media_item := getattr(item, "media_item", None)) and (
+            img := self.music.get_media_item_image(media_item, type)
+        ):
+            return self.get_image_url(img, size)
+        if img := self.music.get_media_item_image(item, type):
+            return self.get_image_url(img, size)
+        return None
+
+    def subscribe(
+        self,
+        cb_func: EventCallBackType,
+        event_filter: EventType | tuple[EventType, ...] | None = None,
+        id_filter: str | tuple[str, ...] | None = None,
+    ) -> Callable[[], None]:
+        """Add callback to event listeners.
+
+        Returns function to remove the listener.
+            :param cb_func: callback function or coroutine
+            :param event_filter: Optionally only listen for these events
+            :param id_filter: Optionally only listen for these id's (player_id, queue_id, uri)
+        """
+        if isinstance(event_filter, EventType):
+            event_filter = (event_filter,)
+        if isinstance(id_filter, str):
+            id_filter = (id_filter,)
+        listener = (cb_func, event_filter, id_filter)
+        self._subscribers.append(listener)
+
+        def remove_listener() -> None:
+            self._subscribers.remove(listener)
+
+        return remove_listener
+
+    async def connect(self) -> None:
+        """Connect to the remote Music Assistant Server."""
+        self._loop = asyncio.get_running_loop()
+        if self.connection.connected:
+            # already connected
+            return
+        # NOTE: connect will raise when connecting failed
+        result = await self.connection.connect()
+        info = ServerInfoMessage.from_dict(result)
+
+        # basic check for server schema version compatibility
+        if info.min_supported_schema_version > API_SCHEMA_VERSION:
+            # our schema version is too low and can't be handled by the server anymore.
+            await self.connection.disconnect()
+            msg = (
+                f"Schema version is incompatible: {info.schema_version}, "
+                f"the server requires at least {info.min_supported_schema_version} "
+                " - update the Music Assistant client to a more "
+                "recent version or downgrade the server."
+            )
+            raise InvalidServerVersion(msg)
+
+        self._server_info = info
+
+        self.logger.info(
+            "Connected to Music Assistant Server %s, Version %s, Schema Version %s",
+            info.server_id,
+            info.server_version,
+            info.schema_version,
+        )
+
+    async def send_command(
+        self,
+        command: str,
+        require_schema: int | None = None,
+        **kwargs: Any,
+    ) -> Any:
+        """Send a command and get a response."""
+        if not self.connection.connected or not self._loop:
+            msg = "Not connected"
+            raise InvalidState(msg)
+
+        if (
+            require_schema is not None
+            and self.server_info is not None
+            and require_schema > self.server_info.schema_version
+        ):
+            msg = (
+                "Command not available due to incompatible server version. Update the Music "
+                f"Assistant Server to a version that supports at least api schema {require_schema}."
+            )
+            raise InvalidServerVersion(msg)
+
+        command_message = CommandMessage(
+            message_id=uuid.uuid4().hex,
+            command=command,
+            args=kwargs,
+        )
+        future: asyncio.Future[Any] = self._loop.create_future()
+        self._result_futures[command_message.message_id] = future
+        await self.connection.send_message(command_message.to_dict())
+        try:
+            return await future
+        finally:
+            self._result_futures.pop(command_message.message_id)
+
+    async def send_command_no_wait(
+        self,
+        command: str,
+        require_schema: int | None = None,
+        **kwargs: Any,
+    ) -> None:
+        """Send a command without waiting for the response."""
+        if not self.server_info:
+            msg = "Not connected"
+            raise InvalidState(msg)
+
+        if require_schema is not None and require_schema > self.server_info.schema_version:
+            msg = (
+                "Command not available due to incompatible server version. Update the Music "
+                f"Assistant Server to a version that supports at least api schema {require_schema}."
+            )
+            raise InvalidServerVersion(msg)
+        command_message = CommandMessage(
+            message_id=uuid.uuid4().hex,
+            command=command,
+            args=kwargs,
+        )
+        await self.connection.send_message(command_message.to_dict())
+
+    async def start_listening(self, init_ready: asyncio.Event | None = None) -> None:
+        """Connect (if needed) and start listening to incoming messages from the server."""
+        await self.connect()
+
+        # fetch initial state
+        # we do this in a separate task to not block reading messages
+        async def fetch_initial_state() -> None:
+            self._providers = {
+                x["instance_id"]: ProviderInstance.from_dict(x)
+                for x in await self.send_command("providers")
+            }
+            self._provider_manifests = {
+                x["domain"]: ProviderManifest.from_dict(x)
+                for x in await self.send_command("providers/manifests")
+            }
+            await self._player_queues.fetch_state()
+            await self._players.fetch_state()
+
+            if init_ready is not None:
+                init_ready.set()
+
+        fetch_state_task = asyncio.create_task(fetch_initial_state())
+
+        try:
+            # keep reading incoming messages
+            while not self._stop_called:
+                msg = await self.connection.receive_message()
+                self._handle_incoming_message(msg)
+        except ConnectionClosed:
+            pass
+        finally:
+            fetch_state_task.cancel()
+            await self.disconnect()
+
+    async def disconnect(self) -> None:
+        """Disconnect the client and cleanup."""
+        self._stop_called = True
+        # cancel all command-tasks awaiting a result
+        for future in self._result_futures.values():
+            future.cancel()
+        await self.connection.disconnect()
+
+    def _handle_incoming_message(self, raw: dict[str, Any]) -> None:
+        """
+        Handle incoming message.
+
+        Run all async tasks in a wrapper to log appropriately.
+        """
+        msg = parse_message(raw)
+        # handle result message
+        if isinstance(msg, ResultMessageBase):
+            future = self._result_futures.get(msg.message_id)
+
+            if future is None:
+                # no listener for this result
+                return
+            if isinstance(msg, SuccessResultMessage):
+                future.set_result(msg.result)
+                return
+            if isinstance(msg, ErrorResultMessage):
+                exc = ERROR_MAP[msg.error_code]
+                future.set_exception(exc(msg.details))
+                return
+
+        # handle EventMessage
+        if isinstance(msg, EventMessage):
+            self.logger.debug("Received event: %s", msg)
+            self._handle_event(msg)
+            return
+
+        # Log anything we can't handle here
+        self.logger.debug(
+            "Received message with unknown type '%s': %s",
+            type(msg),
+            msg,
+        )
+
+    def _handle_event(self, event: MassEvent) -> None:
+        """Forward event to subscribers."""
+        if self._stop_called:
+            return
+
+        assert self._loop
+
+        if event.event == EventType.PROVIDERS_UPDATED:
+            self._providers = {x["instance_id"]: ProviderInstance.from_dict(x) for x in event.data}
+
+        for cb_func, event_filter, id_filter in self._subscribers:
+            if not (event_filter is None or event.event in event_filter):
+                continue
+            if not (id_filter is None or event.object_id in id_filter):
+                continue
+            if asyncio.iscoroutinefunction(cb_func):
+                asyncio.run_coroutine_threadsafe(cb_func(event), self._loop)
+            else:
+                self._loop.call_soon_threadsafe(cb_func, event)
+
+    async def __aenter__(self) -> Self:
+        """Initialize and connect the connection to the Music Assistant Server."""
+        await self.connect()
+        return self
+
+    async def __aexit__(
+        self,
+        exc_type: type[BaseException] | None,
+        exc_val: BaseException | None,
+        exc_tb: TracebackType | None,
+    ) -> bool | None:
+        """Exit context manager."""
+        await self.disconnect()
+        return None
+
+    def __repr__(self) -> str:
+        """Return the representation."""
+        conn_type = self.connection.__class__.__name__
+        prefix = "" if self.connection.connected else "not "
+        return f"{type(self).__name__}(connection={conn_type}, {prefix}connected)"