Skip to content

Commit f081136

Browse files
authored
intersphinx: Reduce log severity for ambiguity detection during inventory loading (#12615)
1 parent f59f761 commit f081136

File tree

3 files changed

+17
-5
lines changed

3 files changed

+17
-5
lines changed

CHANGES.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,8 @@ Bugs fixed
77
* #12859, #9743, #12609: autosummary: Do not add the package prefix when
88
generating autosummary directives for modules within a package.
99
Patch by Adam Turner.
10+
* #12613: Reduce log severity for ambiguity detection during inventory loading.
11+
Patch by James Addison.
1012

1113
Release 7.4.5 (released Jul 16, 2024)
1214
=====================================

sphinx/util/inventory.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -172,8 +172,8 @@ def load_v2(
172172
inv_item: InventoryItem = projname, version, location, dispname
173173
invdata.setdefault(type, {})[name] = inv_item
174174
for ambiguity in actual_ambiguities:
175-
logger.warning(__("inventory <%s> contains multiple definitions for %s"),
176-
uri, ambiguity, type='intersphinx', subtype='external')
175+
logger.info(__("inventory <%s> contains multiple definitions for %s"),
176+
uri, ambiguity, type='intersphinx', subtype='external')
177177
return invdata
178178

179179
@classmethod

tests/test_util/test_util_inventory.py

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -49,12 +49,22 @@ def test_read_inventory_v2_not_having_version():
4949
('foo', '', '/util/foo.html#module-module1', 'Long Module desc')
5050

5151

52-
def test_ambiguous_definition_warning(warning):
52+
def test_ambiguous_definition_warning(warning, status):
5353
f = BytesIO(INVENTORY_V2_AMBIGUOUS_TERMS)
5454
InventoryFile.load(f, '/util', posixpath.join)
5555

56-
assert 'contains multiple definitions for std:term:a' not in warning.getvalue().lower()
57-
assert 'contains multiple definitions for std:term:b' in warning.getvalue().lower()
56+
def _multiple_defs_notice_for(entity: str) -> str:
57+
return f'contains multiple definitions for {entity}'
58+
59+
# was warning-level; reduced to info-level - see https://github.com/sphinx-doc/sphinx/issues/12613
60+
mult_defs_a, mult_defs_b = (
61+
_multiple_defs_notice_for('std:term:a'),
62+
_multiple_defs_notice_for('std:term:b'),
63+
)
64+
assert mult_defs_a not in warning.getvalue().lower()
65+
assert mult_defs_a not in status.getvalue().lower()
66+
assert mult_defs_b not in warning.getvalue().lower()
67+
assert mult_defs_b in status.getvalue().lower()
5868

5969

6070
def _write_appconfig(dir, language, prefix=None):

0 commit comments

Comments
 (0)