Cleanup examples (#245)

cleanup the code examples a bit

diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
index 62a12f3fd997bef391143cafe07adbbeb59c819b..ee8700b895ac6296fc730e9dd9df26df60a44f9d 100644 (file)
--- a/.github/workflows/test.yml
+++ b/.github/workflows/test.yml
@@ -29,3 +29,6 @@ jobs:
           pre-commit install-hooks
       - name: Lint/test with pre-commit
         run: pre-commit run --all-files
+      - name: Run pylint on changed files
+        run: |
+          pylint -rn -sn --rcfile=pylintrc --fail-on=I $(git ls-files '*.py')

diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
index 847db351a5a00cce110eb60a6b6c490e48fd89e3..0879b37f10831d66ebea225145c2cf5197cf71d1 100644 (file)
--- a/.pre-commit-config.yaml
+++ b/.pre-commit-config.yaml
@@ -44,4 +44,4 @@ repos:
         language: system
         types: [python]
         args: ["-rn", "-sn", "--rcfile=pylintrc", "--fail-on=I", "--disable=import-error"]
-        exclude: ^examples/|^.venv/|^.vscode/
+        exclude: ^.venv/|^.vscode/

diff --git a/examples/full.py b/examples/full.py
index d01b6f3e17f727a97084b61cd3a847dc61957723..8df915261b6234943aad3d00b5e7589f79be3fa2 100644 (file)
--- a/examples/full.py
+++ b/examples/full.py
@@ -3,20 +3,15 @@ import argparse
 import asyncio
 import logging
 import os
-from sys import path
 
 from aiorun import run
 
-# pylint: disable=wrong-import-position
-from music_assistant.models.player import Player, PlayerState
-
-path.insert(1, os.path.dirname(os.path.dirname(os.path.abspath(__file__))))
-
 from music_assistant.mass import MusicAssistant
-from music_assistant.providers.spotify import SpotifyProvider
+from music_assistant.models.player import Player, PlayerState
+from music_assistant.providers.filesystem import FileSystemProvider
 from music_assistant.providers.qobuz import QobuzProvider
+from music_assistant.providers.spotify import SpotifyProvider
 from music_assistant.providers.tunein import TuneInProvider
-from music_assistant.providers.filesystem import FileSystemProvider
 
 parser = argparse.ArgumentParser(description="MusicAssistant")
 parser.add_argument(
@@ -96,26 +91,28 @@ if args.musicdir:
 
 
 class TestPlayer(Player):
+    """Demonstatration player implementation."""
+
     def __init__(self):
+        """Init."""
         self.player_id = "test"
-        self.is_group = False
         self._attr_name = "Test player"
-        self._attr_powered = False
+        self._attr_powered = True
         self._attr_elapsed_time = 0
-        self._attr_current_url = None
+        self._attr_current_url = ""
         self._attr_state = PlayerState.IDLE
         self._attr_available = True
         self._attr_volume_level = 100
 
     async def play_url(self, url: str) -> None:
         """Play the specified url on the player."""
-        print("play uri: %s" % url)
+        print("play uri called: {url}")
         self._attr_current_url = url
         self.update_state()
 
     async def stop(self) -> None:
         """Send STOP command to player."""
-        print("STOP CALLED")
+        print("stop called")
         self._attr_state = PlayerState.IDLE
         self._attr_current_url = None
         self._attr_elapsed_time = 0
@@ -123,27 +120,27 @@ class TestPlayer(Player):
 
     async def play(self) -> None:
         """Send PLAY/UNPAUSE command to player."""
-        print("PLAY CALLED")
+        print("play called")
         self._attr_state = PlayerState.PLAYING
         self._attr_elapsed_time = 1
         self.update_state()
 
     async def pause(self) -> None:
         """Send PAUSE command to player."""
-        print("PAUSE CALLED")
+        print("pause called")
         self._attr_state = PlayerState.PAUSED
         self.update_state()
 
     async def power(self, powered: bool) -> None:
         """Send POWER command to player."""
-        print("POWER CALLED - %s" % powered)
+        print(f"POWER CALLED - new power: {powered}")
         self._attr_powered = powered
         self._attr_current_url = None
         self.update_state()
 
     async def volume_set(self, volume_level: int) -> None:
         """Send volume level (0..100) command to player."""
-        print("VOLUME SET CALLED - %s" % volume_level)
+        print(f"volume_set called - {volume_level}")
         self._attr_volume_level = volume_level
         self.update_state()
 
@@ -174,10 +171,10 @@ def main():
         test_player = TestPlayer()
         await mass.players.register_player(test_player)
         # try to play some playlist
-        await test_player.queue.set_crossfade_duration(10)
-        await test_player.queue.set_shuffle_enabled(True)
+        await test_player.active_queue.set_crossfade_duration(10)
+        await test_player.active_queue.set_shuffle_enabled(True)
         if len(playlists) > 0:
-            await test_player.queue.play_media(playlists[0].uri)
+            await test_player.active_queue.play_media(playlists[0].uri)
 
     def on_shutdown(loop):
         loop.run_until_complete(mass.stop())

diff --git a/examples/simple.py b/examples/simple.py
index 8f235b2dfe754dea49f8275ff9a246710848c3bb..0e00d6b3192bf22d33a854677f6db7e1c1266a47 100644 (file)
--- a/examples/simple.py
+++ b/examples/simple.py
@@ -3,12 +3,9 @@ import argparse
 import asyncio
 import logging
 import os
-from sys import path
 
 from aiorun import run
 
-path.insert(1, os.path.dirname(os.path.dirname(os.path.abspath(__file__))))
-
 from music_assistant.mass import MusicAssistant
 from music_assistant.providers.spotify import SpotifyProvider