Skip to content

intersphinx: Reduce log severity for ambiguity detection during inventory loading. #12615

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jul 18, 2024
Merged

intersphinx: Reduce log severity for ambiguity detection during inventory loading. #12615

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6130078
intersphinx: Reduce log severity for ambiguity detection during inven…
jayaddison Jul 18, 2024
8e44fa7
intersphinx: tests: add coverage to ensure that ambiguity log message…
jayaddison Jul 18, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions CHANGES.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@ Bugs fixed
* #12859, #9743, #12609: autosummary: Do not add the package prefix when
generating autosummary directives for modules within a package.
Patch by Adam Turner.
* #12613: Reduce log severity for ambiguity detection during inventory loading.
Patch by James Addison.

Release 7.4.5 (released Jul 16, 2024)
=====================================
Expand Down
4 changes: 2 additions & 2 deletions sphinx/util/inventory.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -172,8 +172,8 @@ def load_v2(
inv_item: InventoryItem = projname, version, location, dispname
invdata.setdefault(type, {})[name] = inv_item
for ambiguity in actual_ambiguities:
logger.warning(__("inventory <%s> contains multiple definitions for %s"),
uri, ambiguity, type='intersphinx', subtype='external')
logger.info(__("inventory <%s> contains multiple definitions for %s"),
uri, ambiguity, type='intersphinx', subtype='external')
return invdata

@classmethod
Expand Down
7 changes: 4 additions & 3 deletions tests/test_util/test_util_inventory.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,12 +49,13 @@ def test_read_inventory_v2_not_having_version():
('foo', '', '/util/foo.html#module-module1', 'Long Module desc')


def test_ambiguous_definition_warning(warning):
def test_ambiguous_definition_warning(status):
f = BytesIO(INVENTORY_V2_AMBIGUOUS_TERMS)
InventoryFile.load(f, '/util', posixpath.join)

assert 'contains multiple definitions for std:term:a' not in warning.getvalue().lower()
assert 'contains multiple definitions for std:term:b' in warning.getvalue().lower()
# was warning-level; reduced to info-level - see https://github.com/sphinx-doc/sphinx/issues/12613
assert 'contains multiple definitions for std:term:a' not in status.getvalue().lower()
assert 'contains multiple definitions for std:term:b' in status.getvalue().lower()


def _write_appconfig(dir, language, prefix=None):
Expand Down