readthedocs / sphinx-notfound-page

Create a custom 404 page with absolute URLs hardcoded

https://sphinx-notfound-page.readthedocs.io/

MIT License

48 stars 31 forks source link

1.0.0: pytest fails with sphinx 7.2.x #229

Open kloczek opened 4 months ago

kloczek commented 4 months ago

Looks like test suite fails in 6 units

Here is pytest output:

```console + PYTHONPATH=/home/tkloczko/rpmbuild/BUILDROOT/python-sphinx-notfound-page-1.0.0-4.fc36.x86_64/usr/lib64/python3.9/site-packages:/home/tkloczko/rpmbuild/BUILDROOT/python-sphinx-notfound-page-1.0.0-4.fc36.x86_64/usr/lib/python3.9/site-packages + /usr/bin/pytest -ra -m 'not network' ============================= test session starts ============================== platform linux -- Python 3.9.18, pytest-8.1.1, pluggy-1.4.0 rootdir: /home/tkloczko/rpmbuild/BUILD/sphinx-notfound-page-1.0.0 configfile: pytest.ini collected 20 items tests/test_urls.py ..F..FF.F...F.F..... [100%] =================================== FAILURES =================================== ____________________________ test_default_settings _____________________________ app = status = <_io.StringIO object at 0x7f77be8fe280> warning = <_io.StringIO object at 0x7f77be8fe1f0> @pytest.mark.sphinx(srcdir=srcdir) def test_default_settings(app, status, warning): app.build() path = app.outdir / '404.html' assert path.exists() content = open(path).read() if sphinx.version_info < (6, 0): cssclass = "shortcut " else: cssclass = "" chunks = [ '

Page not found

', "Unfortunately we couldn't find the content you were looking for.", 'Page not found — Python documentation', # favicon and logo f'', '

', # sidebar URLs '

Python

', '

\n\n \n\n \n \n' tests/test_urls.py:83: AssertionError --------------------------- Captured stdout teardown --------------------------- # testroot: root # builder: html # srcdir: /home/tkloczko/rpmbuild/BUILD/sphinx-notfound-page-1.0.0/tests/examples/default # outdir: /home/tkloczko/rpmbuild/BUILD/sphinx-notfound-page-1.0.0/tests/examples/default/_build/html # status: Running Sphinx v7.2.6 building [mo]: targets for 0 po files that are out of date writing output... building [html]: targets for 3 source files that are out of date updating environment: [new config] 3 added, 0 changed, 0 removed reading sources... [100%] index looking for now-outdated files... none found pickling environment... done checking consistency... done preparing documents... done copying assets... copying static files... done copying extra files... done done writing output... [100%] index generating indices... genindex done writing additional pages... search done dumping search index in English (code: en)... done dumping object inventory... done build succeeded. The HTML pages are in tests/examples/default/_build/html. # warning: ___________________________ test_urls_prefix_setting ___________________________ app = status = <_io.StringIO object at 0x7f77be821040> warning = <_io.StringIO object at 0x7f77be7f3af0> @pytest.mark.sphinx( srcdir=srcdir, confoverrides={ 'notfound_urls_prefix': '/language/version/', }, ) def test_urls_prefix_setting(app, status, warning): app.build() path = app.outdir / '404.html' assert path.exists() content = open(path).read() if sphinx.version_info < (6, 0): cssclass = "shortcut " else: cssclass = "" chunks = [ # sidebar URLs '

Python

', '', '

Documentation overview

\n\n \n\n \n \n' tests/test_urls.py:154: AssertionError --------------------------- Captured stdout teardown --------------------------- # testroot: root # builder: html # srcdir: /home/tkloczko/rpmbuild/BUILD/sphinx-notfound-page-1.0.0/tests/examples/default # outdir: /home/tkloczko/rpmbuild/BUILD/sphinx-notfound-page-1.0.0/tests/examples/default/_build/html # status: Running Sphinx v7.2.6 building [mo]: targets for 0 po files that are out of date writing output... building [html]: targets for 3 source files that are out of date updating environment: [new config] 3 added, 0 changed, 0 removed reading sources... [100%] index looking for now-outdated files... none found pickling environment... done checking consistency... done preparing documents... done copying assets... copying static files... done copying extra files... done done writing output... [100%] index generating indices... genindex done writing additional pages... search done dumping search index in English (code: en)... done dumping object inventory... done build succeeded. The HTML pages are in tests/examples/default/_build/html. # warning: ________________________ test_urls_prefix_setting_none _________________________ app = status = <_io.StringIO object at 0x7f77be772430> warning = <_io.StringIO object at 0x7f77be772040> @pytest.mark.sphinx( srcdir=srcdir, confoverrides={ 'notfound_urls_prefix': None, }, ) def test_urls_prefix_setting_none(app, status, warning): app.build() path = app.outdir / '404.html' assert path.exists() content = open(path).read() if sphinx.version_info < (6, 0): cssclass = "shortcut " else: cssclass = "" chunks = [ # sidebar URLs '

Python

', '', '

Documentation overview

status = <_io.StringIO object at 0x7f77be643e50> warning = <_io.StringIO object at 0x7f77be643dc0> @pytest.mark.sphinx( srcdir=rstsrcdir, confoverrides={ 'version': '2.5.1', }, ) def test_custom_404_rst_source(app, status, warning): app.build() path = app.outdir / '404.html' assert path.exists() content = open(path).read() chunks = [ # custom 404.rst file content 'Oh, oh - Page not found — Python documentation', '

This is a custom 404.rst file.

', '

This file should be rendered instead of the default one.

', "

Variables Sphinx substitution should be allowed here.\nExample, version: 2.5.1.

", # sidebar URLs '

Python

', '', '

Documentation overview

status = <_io.StringIO object at 0x7f77bfb40e50> warning = <_io.StringIO object at 0x7f77bfb409d0> @pytest.mark.sphinx( srcdir=srcdir, buildername='dirhtml', ) def test_urls_for_dirhtml_builder(app, status, warning): app.build() path = app.outdir / '404' / 'index.html' assert path.exists() content = open(path).read() chunks = [ # sidebar URLs '', '

Chapter

', # resources _get_css_html_link_tag('en', 'latest', 'alabaster.css'), _get_css_html_link_tag('en', 'latest', 'pygments.css'), '', ] for chunk in chunks: > assert chunk in content E assert '' in '\n\n\n \n \n Alabaster 0.7.16\n \n \n\n \n\n \n \n' tests/test_urls.py:359: AssertionError --------------------------- Captured stdout teardown --------------------------- # testroot: root # builder: dirhtml # srcdir: /home/tkloczko/rpmbuild/BUILD/sphinx-notfound-page-1.0.0/tests/examples/default # outdir: /home/tkloczko/rpmbuild/BUILD/sphinx-notfound-page-1.0.0/tests/examples/default/_build/dirhtml # status: Running Sphinx v7.2.6 building [mo]: targets for 0 po files that are out of date writing output... building [dirhtml]: targets for 3 source files that are out of date updating environment: [new config] 3 added, 0 changed, 0 removed reading sources... [100%] index looking for now-outdated files... none found pickling environment... done checking consistency... done preparing documents... done copying assets... copying static files... done copying extra files... done done writing output... [100%] index generating indices... genindex done writing additional pages... search done dumping search index in English (code: en)... done dumping object inventory... done build succeeded. The HTML pages are in tests/examples/default/_build/dirhtml. # warning: ______________________ test_toctree_urls_notfound_default ______________________ app = status = <_io.StringIO object at 0x7f77be9114c0> warning = <_io.StringIO object at 0x7f77be911160> @pytest.mark.sphinx( srcdir=srcdir, confoverrides={ 'notfound_urls_prefix': '/ja/default/', }, ) def test_toctree_urls_notfound_default(app, status, warning): app.build() path = app.outdir / '404.html' assert path.exists() content = open(path).read() chunks = [ # sidebar URLs '', '

Chapter

', # resources _get_css_html_link_tag('ja', 'default', 'alabaster.css'), _get_css_html_link_tag('ja', 'default', 'pygments.css'), '', ] for chunk in chunks: > assert chunk in content E assert '' in '\n\n\n \n \n Alabaster 0.7.16\n \n \n\n \n\n \n \n' tests/test_urls.py:410: AssertionError --------------------------- Captured stdout teardown --------------------------- # testroot: root # builder: html # srcdir: /home/tkloczko/rpmbuild/BUILD/sphinx-notfound-page-1.0.0/tests/examples/default # outdir: /home/tkloczko/rpmbuild/BUILD/sphinx-notfound-page-1.0.0/tests/examples/default/_build/html # status: Running Sphinx v7.2.6 building [mo]: targets for 0 po files that are out of date writing output... building [html]: targets for 3 source files that are out of date updating environment: [new config] 3 added, 0 changed, 0 removed reading sources... [100%] index looking for now-outdated files... none found pickling environment... done checking consistency... done preparing documents... done copying assets... copying static files... done copying extra files... done done writing output... [100%] index generating indices... genindex done writing additional pages... search done dumping search index in English (code: en)... done dumping object inventory... done build succeeded. The HTML pages are in tests/examples/default/_build/html. # warning: =========================== short test summary info ============================ FAILED tests/test_urls.py::test_default_settings - assert '

kloczek commented 1 month ago

Looks like 1.0.1 solved the issue

+ PYTHONPATH=/home/tkloczko/rpmbuild/BUILDROOT/python-sphinx-notfound-page-1.0.1-2.fc37.x86_64/usr/lib64/python3.10/site-packages:/home/tkloczko/rpmbuild/BUILDROOT/python-sphinx-notfound-page-1.0.1-2.fc37.x86_64/usr/lib/python3.10/site-packages
+ /usr/bin/pytest -ra -m 'not network'
==================================================================================== test session starts ====================================================================================
platform linux -- Python 3.10.14, pytest-8.1.1, pluggy-1.4.0
rootdir: /home/tkloczko/rpmbuild/BUILD/sphinx-notfound-page-1.0.1
configfile: pytest.ini
plugins: anyio-4.3.0, forked-1.6.0, localserver-0.8.1, asyncio-0.23.7
asyncio: mode=strict
collected 21 items

tests/test_urls.py .....................                                                                                                                                              [100%]

===================================================================================== warnings summary ======================================================================================
tests/test_urls.py: 80 warnings
  /home/tkloczko/rpmbuild/BUILD/sphinx-notfound-page-1.0.1/notfound/extension.py:269: RemovedInSphinx90Warning: The '_Opt' object tuple interface is deprecated, use attribute access instead for 'default', 'rebuild', and 'valid_types'.
    default, rebuild, types = app.config.values.get('notfound_urls_prefix')

-- Docs: https://docs.pytest.org/en/stable/how-to/capture-warnings.html
============================================================================== 21 passed, 80 warnings in 5.37s ==============================================================================

Only remaining thing is pytest warning.

humitos commented 1 month ago

Only remaining thing is pytest warning.

Tracked in #234