IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2025-02-25 18:55:22 -06:00
Code Issues Packages Projects Releases Wiki Activity

Fix type error in mocking `_fetch_inventory` (#13274)

Browse Source
This commit is contained in:
Adam Turner 2025-01-29 00:04:46 +00:00 committed by GitHub
parent 25d4ae578b
commit 56e52fcdbe
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 12 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
tests/test_extensions/test_ext_intersphinx.py
View File

@ -37,6 +37,12 @@ from tests.test_util.intersphinx_data import (
) )
from tests.utils import http_server from tests.utils import http_server
if TYPE_CHECKING:
from typing import NoReturn
from sphinx.ext.intersphinx._shared import InventoryCacheEntry
from sphinx.util.typing import Inventory
class FakeList(list[str]): class FakeList(list[str]):
def __iter__(self) -> NoReturn: def __iter__(self) -> NoReturn:
@ -739,20 +745,14 @@ def test_intersphinx_role(app):
assert html.format('index.html#foons') in content assert html.format('index.html#foons') in content
if TYPE_CHECKING:
from typing import NoReturn
from sphinx.ext.intersphinx._shared import InventoryCacheEntry
@pytest.mark.sphinx('html', testroot='root') @pytest.mark.sphinx('html', testroot='root')
@pytest.mark.parametrize( @pytest.mark.parametrize(
('cache_limit', 'expected_expired'), ('cache_limit', 'expected_expired'),
[ [
(5, False), (5, False), # cache for 5 days
(1, True), (1, True), # cache for 1 day
(0, True), (0, True), # cache for 0 days
(-1, False), (-1, False), # cache forever
], ],
) )
def test_intersphinx_cache_limit(app, monkeypatch, cache_limit, expected_expired): def test_intersphinx_cache_limit(app, monkeypatch, cache_limit, expected_expired):
@ -775,7 +775,8 @@ def test_intersphinx_cache_limit(app, monkeypatch, cache_limit, expected_expired
# `_fetch_inventory_group` calls `_fetch_inventory`. # `_fetch_inventory_group` calls `_fetch_inventory`.
# We replace it with a mock to test whether it has been called. # We replace it with a mock to test whether it has been called.
# If it has been called, it means the cache had expired. # If it has been called, it means the cache had expired.
mock_fetch_inventory = mock.Mock(return_value=('inv', now, {})) mock_fake_inventory: Inventory = {'std:label': {}} # must be truthy
mock_fetch_inventory = mock.Mock(return_value=mock_fake_inventory)
monkeypatch.setattr( monkeypatch.setattr(
'sphinx.ext.intersphinx._load._fetch_inventory', mock_fetch_inventory 'sphinx.ext.intersphinx._load._fetch_inventory', mock_fetch_inventory
) )