Should I report this SphinxParallelError as an user issue?

[goekce]

I have a Sphinx plugin that retrieves image metadata from Wikimedia Commons. I sometimes get the HTTP response 429.

The error message says that I should report this (as it is a user error), but I know that Sphinx's issue list is huge. Should I?

Traceback
=========

      File "/home/venv/lib/python3.13/site-packages/sphinx/util/parallel.py", line 137, in _join_one
        raise SphinxParallelError(*result)
    sphinx.errors.SphinxParallelError: requests.exceptions.HTTPError: 429 Client Error: Too Many Requests for url: https://httpstat.us/429


The full traceback has been saved in:
/tmp/sphinx-err-paaoj_k6.log

To report this error to the developers, please open an issue at <https://github.com/sphinx-doc/sphinx/issues/>. Thanks!
Please also report this if it was a user error, so that a better error message can be provided next time.

[AA-Turner]

This appears to be making a request to a URL that intentionally returns HTTP 429, which then errors with the custom logic in Sphinx for HTTP 429. The extension in question should likely blacklist that domain or otherwise update its logic.

Thank you for asking though, it is indeed not a bug in core Sphinx.

A

[goekce]

I believe there is a minor misunderstanding 🙂. Actually, I put that testing URL on purpose because the error was not easy to trigger. I was getting this error only in a Gitlab CI pipeline, which made requests to Wikimedia Commons API. Gitlab CI servers probably block the requests after ~18. request. (My solution was to retry after 60 seconds if I get 429.)

I was a bit surprised that I got a SphinxParallelError error instead of a direct HTTPError from requests. Then I also saw the notice by Sphinx that I should post this.

I think the actual error is still visible, so I don't think something should be done. If you agree @AA-Turner , I'll tag this answered
🙂.

[AA-Turner]

The ParallelError wraps the original error, because building happens in parallel. Do you have a link to the extension in question, out of interest?

A

[goekce]

https://gitlab.com/fpga-lab/wireless-telemedicine/-/blob/fdbcbc8dc6ba24cfda138718da8d6177b3ae3459/_ext/commons_figure.py