[GH-ISSUE #221] Session hangs indefinitely #174

New issue

Closed

opened 2026-02-27 22:08:26 +03:00 by kerem · 5 comments

kerem commented 2026-02-27 22:08:26 +03:00

Owner

Copy link

Originally created by @colbeyhair on GitHub (Aug 20, 2021).
Original GitHub issue: https://github.com/sigma67/ytmusicapi/issues/221

I have found that while using this API in programs that run for a long time, the program will sometimes hang up indefinitely (for several days at least).

When the program hangs up, sending a ctrl+c sigkill results in a traceback showing that the program was in the middle of a session request, specifically in the get_playlists() method. (Unfortunately I lost the traceback and cannot copy it here).

The requests documentation page recommends passing a timeout parameter to all session instances to avoid such an indefinite hangup: https://docs.python-requests.org/en/master/user/quickstart/#timeouts

Such a parameter is not passed when the requests.Session() is initialized here: https://github.com/sigma67/ytmusicapi/blob/master/ytmusicapi/ytmusic.py#L62

I think that adding a timeout of a few seconds should allow the program to timeout when appropriate and avoid hangups. Perhaps the timeout can be a parameter passed when instantiating ytmusic if adjustability is desired.

Originally created by @colbeyhair on GitHub (Aug 20, 2021). Original GitHub issue: https://github.com/sigma67/ytmusicapi/issues/221 I have found that while using this API in programs that run for a long time, the program will sometimes hang up indefinitely (for several days at least). When the program hangs up, sending a ctrl+c sigkill results in a traceback showing that the program was in the middle of a session request, specifically in the `get_playlists()` method. (Unfortunately I lost the traceback and cannot copy it here). The requests documentation page recommends passing a timeout parameter to all session instances to avoid such an indefinite hangup: https://docs.python-requests.org/en/master/user/quickstart/#timeouts Such a parameter is not passed when the `requests.Session()` is initialized here: https://github.com/sigma67/ytmusicapi/blob/master/ytmusicapi/ytmusic.py#L62 I think that adding a timeout of a few seconds should allow the program to timeout when appropriate and avoid hangups. Perhaps the timeout can be a parameter passed when instantiating ytmusic if adjustability is desired.

kerem closed this issue 2026-02-27 22:08:26 +03:00

kerem commented 2026-02-27 22:08:27 +03:00

Author

Owner

Copy link

@sigma67 commented on GitHub (Aug 20, 2021):

Good point, I didn't have this issue yet so I never noticed. The primary concern that could be affected negatively by a timeout would be upload_song, but that currently doesn't use the session anyway.

Since the primary concern is to avoid rare indefinite hangups, we could set a conservative value. Do you think 30 seconds is appropriate? I don't think we need to make it a parameter if it only happens rarely. Besides, it is already possible to pass a requests Session object as the requests_session parameter, which is then used by ytmusicapi.

Additionally, requests doesn't really support timeouts on a session level, you need to modify the session object like this: https://github.com/psf/requests/issues/2011#issuecomment-490050252

s = requests.Session()
s.request = functools.partial(s.request, timeout=3)
# this should now timeout
s.get('https://httpbin.org/delay/6')

<!-- gh-comment-id:902549490 --> @sigma67 commented on GitHub (Aug 20, 2021): Good point, I didn't have this issue yet so I never noticed. The primary concern that could be affected negatively by a timeout would be `upload_song`, but that currently doesn't use the session anyway. Since the primary concern is to avoid rare indefinite hangups, we could set a conservative value. Do you think 30 seconds is appropriate? I don't think we need to make it a parameter if it only happens rarely. Besides, it is already possible to pass a requests Session object as the `requests_session` parameter, which is then used by ytmusicapi. Additionally, requests doesn't really support timeouts on a session level, you need to modify the session object like this: https://github.com/psf/requests/issues/2011#issuecomment-490050252 ```python s = requests.Session() s.request = functools.partial(s.request, timeout=3) # this should now timeout s.get('https://httpbin.org/delay/6')

kerem commented 2026-02-27 22:08:27 +03:00

Author

Owner

Copy link

@colbeyhair commented on GitHub (Aug 20, 2021):

I agree! A conservative value makes sense to avoid the hangups, and since it is only to keep a program moving in rare cases, a long timeout seems reasonable as a default value.

However, I think it would be very useful to have a timeout argument in the ytmusic constructor. If it happens that I have a bad internet connection and I get timeouts frequently, it could be very useful to pass a parameter from my user code so I can set the timeout as short as possible without interfering with normal request operations. That way, my program wouldn't have to wait a full 30s before raising exception for me to try again.

Having any timeout, even hard-coded, would fix the issue I'm observing. Having a variable timeout would just be "nice to have"

<!-- gh-comment-id:902796384 --> @colbeyhair commented on GitHub (Aug 20, 2021): I agree! A conservative value makes sense to avoid the hangups, and since it is only to keep a program moving in rare cases, a long timeout seems reasonable as a default value. However, I think it would be very useful to have a timeout argument in the ytmusic constructor. If it happens that I have a bad internet connection and I get timeouts frequently, it could be very useful to pass a parameter from my user code so I can set the timeout as short as possible without interfering with normal request operations. That way, my program wouldn't have to wait a full 30s before raising exception for me to try again. Having any timeout, even hard-coded, would fix the issue I'm observing. Having a variable timeout would just be "nice to have"

kerem commented 2026-02-27 22:08:27 +03:00

Author

Owner

Copy link

@sigma67 commented on GitHub (Aug 20, 2021):

Setting a timeout is possible right now, it's a two-liner (which is what I was trying to say above). Here's an example for a 3 second timeout, feel free to try it out:

s = requests.Session()
s.request = functools.partial(s.request, timeout=3)

ytm = YTMusic(session=s)

See also the docs

I think that should cover the variable timeout part.

<!-- gh-comment-id:902967079 --> @sigma67 commented on GitHub (Aug 20, 2021): Setting a timeout is possible right now, it's a two-liner (which is what I was trying to say above). Here's an example for a 3 second timeout, feel free to try it out: ```python s = requests.Session() s.request = functools.partial(s.request, timeout=3) ytm = YTMusic(session=s) ``` [See also the docs](https://ytmusicapi.readthedocs.io/en/latest/reference.html?highlight=session#ytmusicapi.YTMusic.__init__) I think that should cover the variable timeout part.

kerem commented 2026-02-27 22:08:27 +03:00

Author

Owner

Copy link

@colbeyhair commented on GitHub (Aug 22, 2021):

Thanks for the suggestion, sigma! I have tried the above recommendation (with a change to the YTMusic argument to avoid a kwarg typo):

s = requests.Session()
s.request = partial(s.request, timeout=10)
ytmusic = YTMusic(auth="youtube_auth_1.json", requests_session=s)

It took me a while to get back to you because I wanted to try your solution pretty thoroughly. I was able to capture the following exception and traceback when the session inevitably timed out:

Traceback (most recent call last):
  File "<redacted>/venv/lib/python3.7/site-packages/urllib3/connectionpool.py", line 445, in _make_request
    six.raise_from(e, None)
  File "<string>", line 3, in raise_from
  File "<redacted>/venv/lib/python3.7/site-packages/urllib3/connectionpool.py", line 440, in _make_request
    httplib_response = conn.getresponse()
  File "/usr/lib/python3.7/http/client.py", line 1352, in getresponse
    response.begin()
  File "/usr/lib/python3.7/http/client.py", line 310, in begin
    version, status, reason = self._read_status()
  File "/usr/lib/python3.7/http/client.py", line 271, in _read_status
    line = str(self.fp.readline(_MAXLINE + 1), "iso-8859-1")
  File "/usr/lib/python3.7/socket.py", line 589, in readinto
    return self._sock.recv_into(b)
  File "/usr/lib/python3.7/ssl.py", line 1052, in recv_into
    return self.read(nbytes, buffer)
  File "/usr/lib/python3.7/ssl.py", line 911, in read
    return self._sslobj.read(len, buffer)
socket.timeout: The read operation timed out

During handling of the above exception, another exception occurred:

Traceback (most recent call last):
  File "<redacted>/venv/lib/python3.7/site-packages/requests/adapters.py", line 449, in send
    timeout=timeout
  File "<redacted>/venv/lib/python3.7/site-packages/urllib3/connectionpool.py", line 756, in urlopen
    method, url, error=e, _pool=self, _stacktrace=sys.exc_info()[2]
  File "<redacted>/venv/lib/python3.7/site-packages/urllib3/util/retry.py", line 532, in increment
    raise six.reraise(type(error), error, _stacktrace)
  File "<redacted>/venv/lib/python3.7/site-packages/urllib3/packages/six.py", line 770, in reraise
    raise value
  File "<redacted>/venv/lib/python3.7/site-packages/urllib3/connectionpool.py", line 706, in urlopen
    chunked=chunked,
  File "<redacted>/venv/lib/python3.7/site-packages/urllib3/connectionpool.py", line 447, in _make_request
    self._raise_timeout(err=e, url=url, timeout_value=read_timeout)
  File "<redacted>/venv/lib/python3.7/site-packages/urllib3/connectionpool.py", line 337, in _raise_timeout
    self, url, "Read timed out. (read timeout=%s)" % timeout_value
urllib3.exceptions.ReadTimeoutError: HTTPSConnectionPool(host='music.youtube.com', port=443): Read timed out. (read timeout=10)

During handling of the above exception, another exception occurred:

Traceback (most recent call last):
  File "create_new_playlists.py", line 192, in <module>
    create_new_music_playlists(date_to_generate = args.d)
  File "create_new_playlists.py", line 81, in create_new_music_playlists
    song_log_file_name=songs_log_fname_youtube,
  File "<redacted>/youtube_music_playlist.py", line 263, in create_youtube_music_playlist
    add_album_to_playlist(playlist_id, album_object, ytmusic)
  File "<redacted>/youtube_music_playlist.py", line 108, in add_album_to_playlist
    ytmusic.get_playlist(playlist_id, limit=PLAYLIST_LENGTH_TARGET), song_ids
  File "<redacted>/venv/lib/python3.7/site-packages/ytmusicapi/mixins/playlists.py", line 114, in get_playlist
    parse_func))
  File "<redacted>/venv/lib/python3.7/site-packages/ytmusicapi/parsers/utils.py", line 59, in get_continuations
    response = request_func(additionalParams)
  File "<redacted>/venv/lib/python3.7/site-packages/ytmusicapi/mixins/playlists.py", line 109, in <lambda>
    endpoint, body, additionalParams)
  File "<redacted>/venv/lib/python3.7/site-packages/ytmusicapi/ytmusic.py", line 128, in _send_request
    proxies=self.proxies)
  File "<redacted>/venv/lib/python3.7/site-packages/requests/sessions.py", line 590, in post
    return self.request('POST', url, data=data, json=json, **kwargs)
  File "<redacted>/venv/lib/python3.7/site-packages/requests/sessions.py", line 542, in request
    resp = self.send(prep, **send_kwargs)
  File "<redacted>/venv/lib/python3.7/site-packages/requests/sessions.py", line 655, in send
    r = adapter.send(request, **kwargs)
  File "<redacted>/venv/lib/python3.7/site-packages/requests/adapters.py", line 529, in send
    raise ReadTimeout(e, request=request)
requests.exceptions.ReadTimeout: HTTPSConnectionPool(host='music.youtube.com', port=443): Read timed out. (read timeout=10)

I am able to successfully handle this exception:

for item in my_list:
    item_complete = False
    while not item_complete:
        try:
            function_that_uses_ytm()
            item_complete = True

        except requests.exceptions.ReadTimeout as e:
            # log the timeout occurrences so I can see how often they happen
            with open("timeout_log.txt", 'a') as fout:
                fout.write(str(datetime.now()))

<!-- gh-comment-id:903330389 --> @colbeyhair commented on GitHub (Aug 22, 2021): Thanks for the suggestion, sigma! I have tried the above recommendation (with a change to the YTMusic argument to avoid a kwarg typo): ```python s = requests.Session() s.request = partial(s.request, timeout=10) ytmusic = YTMusic(auth="youtube_auth_1.json", requests_session=s) ``` It took me a while to get back to you because I wanted to try your solution pretty thoroughly. I was able to capture the following exception and traceback when the session inevitably timed out: ``` Traceback (most recent call last): File "<redacted>/venv/lib/python3.7/site-packages/urllib3/connectionpool.py", line 445, in _make_request six.raise_from(e, None) File "<string>", line 3, in raise_from File "<redacted>/venv/lib/python3.7/site-packages/urllib3/connectionpool.py", line 440, in _make_request httplib_response = conn.getresponse() File "/usr/lib/python3.7/http/client.py", line 1352, in getresponse response.begin() File "/usr/lib/python3.7/http/client.py", line 310, in begin version, status, reason = self._read_status() File "/usr/lib/python3.7/http/client.py", line 271, in _read_status line = str(self.fp.readline(_MAXLINE + 1), "iso-8859-1") File "/usr/lib/python3.7/socket.py", line 589, in readinto return self._sock.recv_into(b) File "/usr/lib/python3.7/ssl.py", line 1052, in recv_into return self.read(nbytes, buffer) File "/usr/lib/python3.7/ssl.py", line 911, in read return self._sslobj.read(len, buffer) socket.timeout: The read operation timed out During handling of the above exception, another exception occurred: Traceback (most recent call last): File "<redacted>/venv/lib/python3.7/site-packages/requests/adapters.py", line 449, in send timeout=timeout File "<redacted>/venv/lib/python3.7/site-packages/urllib3/connectionpool.py", line 756, in urlopen method, url, error=e, _pool=self, _stacktrace=sys.exc_info()[2] File "<redacted>/venv/lib/python3.7/site-packages/urllib3/util/retry.py", line 532, in increment raise six.reraise(type(error), error, _stacktrace) File "<redacted>/venv/lib/python3.7/site-packages/urllib3/packages/six.py", line 770, in reraise raise value File "<redacted>/venv/lib/python3.7/site-packages/urllib3/connectionpool.py", line 706, in urlopen chunked=chunked, File "<redacted>/venv/lib/python3.7/site-packages/urllib3/connectionpool.py", line 447, in _make_request self._raise_timeout(err=e, url=url, timeout_value=read_timeout) File "<redacted>/venv/lib/python3.7/site-packages/urllib3/connectionpool.py", line 337, in _raise_timeout self, url, "Read timed out. (read timeout=%s)" % timeout_value urllib3.exceptions.ReadTimeoutError: HTTPSConnectionPool(host='music.youtube.com', port=443): Read timed out. (read timeout=10) During handling of the above exception, another exception occurred: Traceback (most recent call last): File "create_new_playlists.py", line 192, in <module> create_new_music_playlists(date_to_generate = args.d) File "create_new_playlists.py", line 81, in create_new_music_playlists song_log_file_name=songs_log_fname_youtube, File "<redacted>/youtube_music_playlist.py", line 263, in create_youtube_music_playlist add_album_to_playlist(playlist_id, album_object, ytmusic) File "<redacted>/youtube_music_playlist.py", line 108, in add_album_to_playlist ytmusic.get_playlist(playlist_id, limit=PLAYLIST_LENGTH_TARGET), song_ids File "<redacted>/venv/lib/python3.7/site-packages/ytmusicapi/mixins/playlists.py", line 114, in get_playlist parse_func)) File "<redacted>/venv/lib/python3.7/site-packages/ytmusicapi/parsers/utils.py", line 59, in get_continuations response = request_func(additionalParams) File "<redacted>/venv/lib/python3.7/site-packages/ytmusicapi/mixins/playlists.py", line 109, in <lambda> endpoint, body, additionalParams) File "<redacted>/venv/lib/python3.7/site-packages/ytmusicapi/ytmusic.py", line 128, in _send_request proxies=self.proxies) File "<redacted>/venv/lib/python3.7/site-packages/requests/sessions.py", line 590, in post return self.request('POST', url, data=data, json=json, **kwargs) File "<redacted>/venv/lib/python3.7/site-packages/requests/sessions.py", line 542, in request resp = self.send(prep, **send_kwargs) File "<redacted>/venv/lib/python3.7/site-packages/requests/sessions.py", line 655, in send r = adapter.send(request, **kwargs) File "<redacted>/venv/lib/python3.7/site-packages/requests/adapters.py", line 529, in send raise ReadTimeout(e, request=request) requests.exceptions.ReadTimeout: HTTPSConnectionPool(host='music.youtube.com', port=443): Read timed out. (read timeout=10) ``` I am able to successfully handle this exception: ```python for item in my_list: item_complete = False while not item_complete: try: function_that_uses_ytm() item_complete = True except requests.exceptions.ReadTimeout as e: # log the timeout occurrences so I can see how often they happen with open("timeout_log.txt", 'a') as fout: fout.write(str(datetime.now())) ```

kerem commented 2026-02-27 22:08:27 +03:00

Author

Owner

Copy link

@sigma67 commented on GitHub (Aug 26, 2021):

That's great, thanks for the detailed feedback. Will add some documentation and the default timeout.

<!-- gh-comment-id:906592378 --> @sigma67 commented on GitHub (Aug 26, 2021): That's great, thanks for the detailed feedback. Will add some documentation and the default timeout.

kerem referenced this issue 2026-02-27 23:01:31 +03:00

[PR #174] [CLOSED] Switch youtube /browse endpoint with /search #571

Sign in to join this conversation.

No Branch/Tag specified

Branches Tags

main

fix-yt-dlp-link

restore-codecov-cat

unify-coverage-workflow

sigma67-security-md

rewrite-workflow

dep/update-pdm-lock

remove-2025-explore-test

get-explore-fix-top-episodes-duration

update-linters

fix-ci-pipeline

fix-827

remove-oauth-account-tests

fix-tests

fix-799

fix-remaining-tests

v2

niquests

3-10-typed

fix-758

fix-743

fix-734-continuations

add-oauthcredentials-import-doc

ytmusic-auth-refactor

fix-720

fix-721

fix-713

fix-703

add-test-analytics

update-oauth-docs

feat-670

heinrich26-patch-1

fix-675

fix-get-history

fix-648

fix-641

refactor-use-pathlib

fix-647

fix-642

fix-640

fix-633

feat-628

fix-625

models

introduce-exception-classes

improve-coverage

pytest-retry

fix-588

fix-587

fix-582

fix-569

fix-get-playlist-562

get-artist-shows

get-podcast-playlist

fix-get-album-544

library-podcasts

get-episode-progress

fix-548

brand-account-setup

album-data-mining

jcbirdwell-album-data-mining

album-data-mining-fixes

get-podcast

artist-albums-continuations

1.11.5

1.11.4

1.11.3

1.11.2

1.11.1

1.11.0

1.11.0rc1

1.10.3

1.10.2

1.10.1

1.10.0

1.9.1

1.9.0

1.8.2

1.8.1

1.8.0

1.7.5

1.7.4

1.7.3

1.7.2

1.7.1

1.7.0

1.6.0

1.5.4

1.5.3

1.5.2

1.5.1

1.5.0

1.4.2

1.4.1

1.4.0

1.3.2

1.3.1

1.3.0

1.2.1

1.2.0

1.1.1

1.1.0

1.0.2

1.0.1

1.0.0

0.25.2

0.25.1

0.25.0

0.24.1

0.24.0

0.23.0

0.22.0

0.21.0

0.20.0

0.19.5

0.19.4

0.19.3

0.19.2

0.19.1

0.19.0

0.18.0

0.17.3

0.17.2

0.17.1

0.17.0

0.16.0

0.15.1

0.15.0

0.14.3

0.14.2

0.14.1

0.14.0

0.13.1

0.13.0

0.12.2

0.12.1

0.12.0

0.11.0

0.10.2

0.10.1

0.10.0

0.9.2

0.9.1

0.9.0

0.8.1

0.8.0

0.7.1

0.7.0

0.6.1

0.6.0

0.5.2

0.5.1

0.5.0

0.4.3

0.4.2

8cc1986

0.4.1

1ac614e

Labels

Clear labels   

a/b

  

bug

  

documentation

  

enhancement

  

good first issue

  

help wanted

  

invalid

  

pull-request

Mirrored from GitHub Pull Request

  

question

  

wontfix

  

yt-error

  

yt-update

No labels

a/b

bug

documentation

enhancement

good first issue

help wanted

invalid

pull-request

question

wontfix

yt-error

yt-update

Milestone

Clear milestone

No items

No milestone

Projects

Clear projects

No items

No project

Assignees

Clear assignees

No assignees

1 participant

Notifications

Subscribe

Due date

The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference

starred/ytmusicapi#174

No description provided.