starred/librespot-python-kokarare1212

Fork 0

mirror of https://github.com/kokarare1212/librespot-python.git synced 2026-04-25 08:35:49 +03:00

[GH-ISSUE #141] [BUG] Memory Leak #21

New issue

Closed

opened 2026-02-27 08:11:28 +03:00 by kerem · 8 comments

kerem commented

2026-02-27 08:11:28 +03:00

Owner

Originally created by @owlwang on GitHub (Jul 15, 2022).
Original GitHub issue: https://github.com/kokarare1212/librespot-python/issues/141

Hi, thank you for making this very useful project, it's really awesome.

I'm experiencing a suspected memory leak during my use.

When load a large batch of songs, I can see the memory usage slowly growing.

I'd like to ask you if there are any areas I can look at to help locate a fix for this memory leak?

My environment is Ubuntu 20 and python 3.8.

sample code:


import sys

from librespot.core import Session
from librespot.metadata import TrackId
from librespot.audio.decoders import AudioQuality, VorbisOnlyAudioQuality

account_user = ''
account_passwd = ''
session = Session.Builder().user_pass(account_user, account_passwd).create()


def load_data_from_spotify(track_id):
    spotify_track_id = TrackId.from_uri('spotify:track:' + track_id)
    stream = session.content_feeder().load(spotify_track_id, VorbisOnlyAudioQuality(AudioQuality.NORMAL), False, None)
    audio_buffer = stream.input_stream.stream().read()

    # dosomething

Originally created by @owlwang on GitHub (Jul 15, 2022). Original GitHub issue: https://github.com/kokarare1212/librespot-python/issues/141 Hi, thank you for making this very useful project, it's really awesome. I'm experiencing a suspected memory leak during my use. When load a large batch of songs, I can see the memory usage slowly growing. I'd like to ask you if there are any areas I can look at to help locate a fix for this memory leak? My environment is Ubuntu 20 and python 3.8. sample code: ```python import sys from librespot.core import Session from librespot.metadata import TrackId from librespot.audio.decoders import AudioQuality, VorbisOnlyAudioQuality account_user = '' account_passwd = '' session = Session.Builder().user_pass(account_user, account_passwd).create() def load_data_from_spotify(track_id): spotify_track_id = TrackId.from_uri('spotify:track:' + track_id) stream = session.content_feeder().load(spotify_track_id, VorbisOnlyAudioQuality(AudioQuality.NORMAL), False, None) audio_buffer = stream.input_stream.stream().read() # dosomething ```

kerem

2026-02-27 08:11:28 +03:00

closed this issue
added the
bug
label

kerem commented

2026-02-27 08:11:28 +03:00

Author

Owner

@kokarare1212 commented on GitHub (Jul 15, 2022):

Side note:

We DO NOT encourage piracy and DO NOT support any form of downloader/recorder designed with the help of this repository and in general anything that goes against the Spotify ToS.

@kokarare1212 commented on GitHub (Jul 15, 2022): Side note: > We DO NOT encourage piracy and DO NOT support any form of downloader/recorder designed with the help of this repository and in general anything that goes against the Spotify ToS.

kerem commented

2026-02-27 08:11:28 +03:00

Author

Owner

@owlwang commented on GitHub (Jul 15, 2022):

Okay.

@owlwang commented on GitHub (Jul 15, 2022): Okay.

kerem commented

2026-02-27 08:11:28 +03:00

Author

Owner

@owlwang commented on GitHub (Jul 21, 2022):

Hi, @kokarare1212
Hope you can notice this issue.
I've located the memory leak.
Python's GC doesn't seem to recycle the used buffer, so every time a song is loaded it stays in memory permanently.

Temporary solution

Add a method to clear the buffer in the InternalStream class

  class InternalStream(AbsChunkedInputStream):
         streamer: CdnManager.Streamer
+        def clear_buffer(self):
+            del self.streamer.buffer

Call the clear_buffer() method in the close method of the AbsChunkedInputStream class

 def close(self) -> None:
+    self.closed = True
     self.clear_buffer()
     with self.wait_lock:
         self.wait_lock.notify_all()

Then after each read(), call close() method.

def load_data_from_spotify(track_id):
    spotify_track_id = TrackId.from_uri('spotify:track:' + track_id)
    stream = session.content_feeder().load(spotify_track_id, VorbisOnlyAudioQuality(AudioQuality.NORMAL), False, None)
    input_stream = stream.input_stream.stream()
    audio_buffer = input_stream.read()
    # dosomething
    input_stream.close() # must add this, to clear buffer

Hope you can fix this problem in main branch code.

@owlwang commented on GitHub (Jul 21, 2022): Hi, @kokarare1212 Hope you can notice this issue. I've located the memory leak. Python's GC doesn't seem to recycle the used buffer, so every time a song is loaded it stays in memory permanently. ## Temporary solution Add a method to clear the buffer in the **InternalStream** class ```python class InternalStream(AbsChunkedInputStream): streamer: CdnManager.Streamer + def clear_buffer(self): + del self.streamer.buffer ``` Call the clear_buffer() method in the close method of the **AbsChunkedInputStream** class ```python def close(self) -> None: + self.closed = True self.clear_buffer() with self.wait_lock: self.wait_lock.notify_all() ``` Then after each read(), call close() method. ```python def load_data_from_spotify(track_id): spotify_track_id = TrackId.from_uri('spotify:track:' + track_id) stream = session.content_feeder().load(spotify_track_id, VorbisOnlyAudioQuality(AudioQuality.NORMAL), False, None) input_stream = stream.input_stream.stream() audio_buffer = input_stream.read() # dosomething input_stream.close() # must add this, to clear buffer ``` Hope you can fix this problem in main branch code.

kerem commented

2026-02-27 08:11:28 +03:00

Author

Owner

@kokarare1212 commented on GitHub (Jul 21, 2022):

Yes, that is because the buffer has not been released.

@kokarare1212 commented on GitHub (Jul 21, 2022): Yes, that is because the buffer has not been released.

kerem commented

2026-02-27 08:11:28 +03:00

Author

Owner

@owlwang commented on GitHub (Jul 21, 2022):

Thanks for your work!

@owlwang commented on GitHub (Jul 21, 2022): Thanks for your work!

kerem commented

2026-02-27 08:11:28 +03:00

Author

Owner

@staniel359 commented on GitHub (Aug 30, 2022):

@kokarare1212 When will these changes be released?

@staniel359 commented on GitHub (Aug 30, 2022): @kokarare1212 When will these changes be released?

kerem commented

2026-02-27 08:11:28 +03:00

Author

Owner

@kokarare1212 commented on GitHub (Aug 30, 2022):

OK, I have published.
https://github.com/kokarare1212/librespot-python/releases/tag/v0.0.6

@kokarare1212 commented on GitHub (Aug 30, 2022): OK, I have published. https://github.com/kokarare1212/librespot-python/releases/tag/v0.0.6

kerem commented

2026-02-27 08:11:28 +03:00

Author

Owner

@staniel359 commented on GitHub (Aug 31, 2022):

@kokarare1212 Thank you.

@staniel359 commented on GitHub (Aug 31, 2022): @kokarare1212 Thank you.

kerem referenced this issue

2026-02-27 08:11:50 +03:00

[PR #21] [CLOSED] Restyle Format code with yapf #82