Skip to content
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.

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

intersphinx: Handle the case where intersphinx_cache_limit is negative #12514

Merged
merged 2 commits into from
Jul 31, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
4 changes: 4 additions & 0 deletions CHANGES.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,5 +16,9 @@ Features added
Bugs fixed
----------

* #12514: intersphinx: fix the meaning of a negative value for
:confval:`intersphinx_cache_limit`.
Patch by Shengyu Zhang.

Testing
-------
5 changes: 4 additions & 1 deletion sphinx/ext/intersphinx/_load.py
Original file line number Diff line number Diff line change
Expand Up @@ -201,7 +201,10 @@ def _fetch_inventory_group(
config: Config,
srcdir: Path,
) -> bool:
cache_time = now - config.intersphinx_cache_limit * 86400
if config.intersphinx_cache_limit < 0:
cache_time = now - config.intersphinx_cache_limit * 86400
else:
cache_time = 0

updated = False
failures = []
Expand Down
39 changes: 38 additions & 1 deletion tests/test_extensions/test_ext_intersphinx.py
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
from __future__ import annotations

import http.server
import time
from typing import TYPE_CHECKING
from unittest import mock

Expand All @@ -19,7 +20,13 @@
validate_intersphinx_mapping,
)
from sphinx.ext.intersphinx import setup as intersphinx_setup
from sphinx.ext.intersphinx._load import _fetch_inventory, _get_safe_url, _strip_basic_auth
from sphinx.ext.intersphinx._load import (
_fetch_inventory,
_fetch_inventory_group,
_get_safe_url,
_strip_basic_auth,
)
from sphinx.ext.intersphinx._shared import _IntersphinxProject
from sphinx.util.console import strip_colors

from tests.test_util.intersphinx_data import (
Expand Down Expand Up @@ -665,3 +672,33 @@ def test_intersphinx_role(app):

# explicit title
assert html.format('index.html#foons') in content


if TYPE_CHECKING:
from sphinx.ext.intersphinx._shared import InventoryCacheEntry


def test_intersphinx_cache_limit(app):
url = 'https://example.org/'
app.config.intersphinx_cache_limit = -1
app.config.intersphinx_mapping = {
'inv': (url, None),
}
# load the inventory and check if it's done correctly
intersphinx_cache: dict[str, InventoryCacheEntry] = {
url: ('', 0, {}), # 0 is a timestamp, make sure the entry is expired
}
validate_intersphinx_mapping(app, app.config)
load_mappings(app)

now = int(time.time())
for name, (uri, locations) in app.config.intersphinx_mapping.values():
project = _IntersphinxProject(name=name, target_uri=uri, locations=locations)
# no need to read from remote
assert not _fetch_inventory_group(
project=project,
cache=intersphinx_cache,
now=now,
config=app.config,
srcdir=app.srcdir,
)