🐛 FIX RemovedInSphinx10Warning for inventory item iteration#1129
Merged
chrisjsewell merged 3 commits intomasterfrom May 7, 2026
Merged
🐛 FIX RemovedInSphinx10Warning for inventory item iteration#1129chrisjsewell merged 3 commits intomasterfrom
RemovedInSphinx10Warning for inventory item iteration#1129chrisjsewell merged 3 commits intomasterfrom
Conversation
Fixes the deprecation warning from Sphinx >= 8.2: ``` RemovedInSphinx10Warning: The iter() interface for _InventoryItem objects is deprecated. Please access the `project_name`, `project_version`, `uri`, and `displayname` attributes directly. ``` The previous code unpacked `_InventoryItem` as a tuple (`project, version, loc, text = data[target]`), which triggers the warning. This uses `hasattr` to detect whether the new attribute-based API is available and falls back to tuple unpacking for older Sphinx versions. This approach is more robust than version checking (cf. #1079 which used `sphinx.__version_info__` — an attribute that doesn't exist; the correct attribute is `sphinx.version_info`). Note: the correct attribute name on `_InventoryItem` is `display_name` (with underscore), despite the warning message saying `displayname`.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fixes the deprecation warning from Sphinx >= 8.2:
The previous code unpacked
_InventoryItemas a tuple (project, version, loc, text = data[target]), which triggers the warning.This uses
hasattrto detect whether the new attribute-based API is available and falls back to tuple unpacking for older Sphinx versions. This approach is more robust than version checking (cf. #1079 which usedsphinx.__version_info__— an attribute that doesn't exist; the correct attribute issphinx.version_info).Note: the correct attribute name on
_InventoryItemisdisplay_name(with underscore), despite the warning message sayingdisplayname.