- Fixed comments and whitespace

This commit is contained in:
Ross Stewart
2025-09-08 13:10:45 +01:00
parent cc3ab62abe
commit 338ede40c0
3 changed files with 15 additions and 14 deletions

View File

@@ -43,7 +43,7 @@ logger.addHandler(handler)
# #
logger.info('AskNavidrome 0.6!') logger.info('AskNavidrome 0.6!')
logger.debug('Getting configutration from the environment...') logger.debug('Getting configuration from the environment...')
try: try:
if 'NAVI_SKILL_ID' in os.environ: if 'NAVI_SKILL_ID' in os.environ:
@@ -175,7 +175,7 @@ if 'NAVI_DEBUG' in os.environ:
logger.setLevel(logging.WARNING) logger.setLevel(logging.WARNING)
logger.warning('Log level set to WARNING') logger.warning('Log level set to WARNING')
# Create a sharable queue than can be updated by multiple threads to enable larger playlists # Create a shareable queue than can be updated by multiple threads to enable larger playlists
# to be returned in the back ground avoiding the Amazon 8 second timeout # to be returned in the back ground avoiding the Amazon 8 second timeout
BaseManager.register('MediaQueue', queue.MediaQueue) BaseManager.register('MediaQueue', queue.MediaQueue)
manager = BaseManager() manager = BaseManager()
@@ -184,7 +184,7 @@ play_queue = manager.MediaQueue()
logger.debug('MediaQueue object created...') logger.debug('MediaQueue object created...')
# Variable to store the additional thread used to populate large playlists # Variable to store the additional thread used to populate large playlists
# this is used to avoid concurency issues if there is an attempt to load multiple playlists # this is used to avoid concurrency issues if there is an attempt to load multiple playlists
# at the same time. # at the same time.
backgroundProcess = None backgroundProcess = None
@@ -534,6 +534,7 @@ class NaviSonicPlayPlaylist(AbstractRequestHandler):
controller.enqueue_songs(connection, play_queue, [song_id_list[0], song_id_list[1]]) # When generating the playlist return the first two tracks. controller.enqueue_songs(connection, play_queue, [song_id_list[0], song_id_list[1]]) # When generating the playlist return the first two tracks.
backgroundProcess = Process(target=queueWorkerThread, args=(connection, play_queue, song_id_list[2:])) # Create a thread to enqueue the remaining tracks backgroundProcess = Process(target=queueWorkerThread, args=(connection, play_queue, song_id_list[2:])) # Create a thread to enqueue the remaining tracks
backgroundProcess.start() # Start the additional thread backgroundProcess.start() # Start the additional thread
speech = 'Playing playlist ' + str(playlist.value) speech = 'Playing playlist ' + str(playlist.value)
logger.info(speech) logger.info(speech)
card = {'title': 'AskNavidrome', card = {'title': 'AskNavidrome',
@@ -550,9 +551,9 @@ def queueWorkerThread(connection, play_queue, song_id_list):
logger.debug('Finished playlist processing!') logger.debug('Finished playlist processing!')
class NaviSonicPlayMusicByGenre(AbstractRequestHandler): class NaviSonicPlayMusicByGenre(AbstractRequestHandler):
""" Play songs from the given genere """ Play songs from the given genre
50 tracks from the given genere are shuffled and played 50 tracks from the given genre are shuffled and played
""" """
def can_handle(self, handler_input: HandlerInput) -> bool: def can_handle(self, handler_input: HandlerInput) -> bool:
@@ -929,7 +930,7 @@ class PreviousPlaybackHandler(AbstractRequestHandler):
def handle(self, handler_input: HandlerInput) -> Response: def handle(self, handler_input: HandlerInput) -> Response:
logger.debug('In PreviousPlaybackHandler') logger.debug('In PreviousPlaybackHandler')
track_details = play_queue.get_prevous_track() track_details = play_queue.get_previous_track()
# Set the offset to 0 as we are skipping we want to start at the beginning # Set the offset to 0 as we are skipping we want to start at the beginning
track_details.offset = 0 track_details.offset = 0
@@ -1111,7 +1112,7 @@ if navidrome_log_level == 3:
def view_history(): def view_history():
"""View the contents of play_queue.history """View the contents of play_queue.history
Creates a tabulated page contining the contents of the play_queue.history deque. Creates a tabulated page containing the contents of the play_queue.history deque.
""" """
current_track = play_queue.get_current_track() current_track = play_queue.get_current_track()
@@ -1123,7 +1124,7 @@ if navidrome_log_level == 3:
def view_buffer(): def view_buffer():
"""View the contents of play_queue.buffer """View the contents of play_queue.buffer
Creates a tabulated page contining the contents of the play_queue.buffer deque. Creates a tabulated page containing the contents of the play_queue.buffer deque.
""" """
current_track = play_queue.get_current_track() current_track = play_queue.get_current_track()

View File

@@ -188,7 +188,7 @@ class MediaQueue:
return self.current_track return self.current_track
def get_prevous_track(self) -> Track: def get_previous_track(self) -> Track:
"""Get the previous track """Get the previous track
Get the last track added to the history deque and Get the last track added to the history deque and
@@ -198,7 +198,7 @@ class MediaQueue:
:rtype: Track :rtype: Track
""" """
self.logger.debug('In get_prevous_track()') self.logger.debug('In get_previous_track()')
# Return the current track to the queue # Return the current track to the queue
self.queue.appendleft(self.current_track) self.queue.appendleft(self.current_track)
@@ -258,7 +258,7 @@ class MediaQueue:
return len(self.history) return len(self.history)
def sync(self) -> None: def sync(self) -> None:
"""Syncronise the buffer with the queue """Synchronise the buffer with the queue
Overwrite the buffer with the current queue. Overwrite the buffer with the current queue.
This is useful when pausing or stopping to ensure This is useful when pausing or stopping to ensure

View File

@@ -16,7 +16,7 @@ class SubsonicConnection:
:param str server_url: The URL of the Subsonic API compatible media server :param str server_url: The URL of the Subsonic API compatible media server
:param str user: Username to authenticate against the API :param str user: Username to authenticate against the API
:param str passwd: Password to authenticate against the API :param str passwd: Password to authenticate against the API
:param int port: Port the Subsonic compatibe server is listening on :param int port: Port the Subsonic compatible server is listening on
:param str api_location: Path to the API, this is appended to server_url :param str api_location: Path to the API, this is appended to server_url
:param str api_version: The version of the Subsonic API that is in use :param str api_version: The version of the Subsonic API that is in use
:return: None :return: None
@@ -284,7 +284,7 @@ class SubsonicConnection:
def build_song_list_from_genre(self, genre: str, count: int) -> Union[list, None]: def build_song_list_from_genre(self, genre: str, count: int) -> Union[list, None]:
"""Build a shuffled list songs of songs from the given genre. """Build a shuffled list songs of songs from the given genre.
:param str genre: The genre, acceptible values are with the getGenres Subsonic API call. :param str genre: The genre, acceptable values are with the getGenres Subsonic API call.
:param int count: The number of songs to return :param int count: The number of songs to return
:return: A list of song IDs or None if no tracks are found. :return: A list of song IDs or None if no tracks are found.
:rtype: list | None :rtype: list | None
@@ -292,7 +292,7 @@ class SubsonicConnection:
self.logger.debug('In function build_song_list_from_genre()') self.logger.debug('In function build_song_list_from_genre()')
# Note the use of title() to captalise the first letter of each word in the genre # Note the use of title() to capitalise the first letter of each word in the genre
# without this the genres do not match the strings returned by the API. # without this the genres do not match the strings returned by the API.
self.logger.debug(f'Searching for {genre.title()} music') self.logger.debug(f'Searching for {genre.title()} music')
songs_from_genre = self.conn.getSongsByGenre(genre.title(), count).get('songsByGenre').get('song') songs_from_genre = self.conn.getSongsByGenre(genre.title(), count).get('songsByGenre').get('song')