mirror of
https://github.com/sphinx-doc/sphinx.git
synced 2025-02-25 18:55:22 -06:00
c66d3e85d1
* flake8-builtins ('A')
* flake8-blind-except ('BLE')
* flake8-copyright ('CPY')
* eradicate ('ERA')
* flake8-boolean-trap ('FBT')
* flake8-fixme ('FIX')
* flake8-implicit-str-concat ('ISC')
* pep8-naming ('N')
* flake8-use-pathlib ('PTH')
* flake8-self ('SLF')
* tryceratops ('TRY')
111 lines
3.4 KiB
Python
111 lines
3.4 KiB
Python
"""Tests util functions."""
|
|
|
|
from __future__ import annotations
|
|
|
|
import pytest
|
|
|
|
from sphinx.util import logging
|
|
from sphinx.util.console import strip_colors
|
|
from sphinx.util.display import (
|
|
SkipProgressMessage,
|
|
display_chunk,
|
|
progress_message,
|
|
status_iterator,
|
|
)
|
|
|
|
|
|
def test_display_chunk():
|
|
assert display_chunk('hello') == 'hello'
|
|
assert display_chunk(['hello']) == 'hello'
|
|
assert display_chunk(['hello', 'sphinx', 'world']) == 'hello .. world'
|
|
assert display_chunk(('hello',)) == 'hello'
|
|
assert display_chunk(('hello', 'sphinx', 'world')) == 'hello .. world'
|
|
|
|
|
|
@pytest.mark.sphinx('dummy', testroot='root')
|
|
def test_status_iterator_length_0(app):
|
|
logging.setup(app, app.status, app.warning)
|
|
|
|
# test for status_iterator (length=0)
|
|
app.status.seek(0)
|
|
app.status.truncate(0)
|
|
yields = list(status_iterator(['hello', 'sphinx', 'world'], 'testing ... '))
|
|
output = strip_colors(app.status.getvalue())
|
|
assert 'testing ... hello sphinx world \n' in output
|
|
assert yields == ['hello', 'sphinx', 'world']
|
|
|
|
|
|
@pytest.mark.sphinx('dummy', testroot='root')
|
|
def test_status_iterator_verbosity_0(app, monkeypatch):
|
|
monkeypatch.setenv('FORCE_COLOR', '1')
|
|
logging.setup(app, app.status, app.warning)
|
|
|
|
# test for status_iterator (verbosity=0)
|
|
app.status.seek(0)
|
|
app.status.truncate(0)
|
|
yields = status_iterator(
|
|
['hello', 'sphinx', 'world'], 'testing ... ', length=3, verbosity=0
|
|
)
|
|
assert list(yields) == ['hello', 'sphinx', 'world']
|
|
output = strip_colors(app.status.getvalue())
|
|
assert 'testing ... [ 33%] hello\r' in output
|
|
assert 'testing ... [ 67%] sphinx\r' in output
|
|
assert 'testing ... [100%] world\r\n' in output
|
|
|
|
|
|
@pytest.mark.sphinx('dummy', testroot='root')
|
|
def test_status_iterator_verbosity_1(app, monkeypatch):
|
|
monkeypatch.setenv('FORCE_COLOR', '1')
|
|
logging.setup(app, app.status, app.warning)
|
|
|
|
# test for status_iterator (verbosity=1)
|
|
app.status.seek(0)
|
|
app.status.truncate(0)
|
|
yields = status_iterator(
|
|
['hello', 'sphinx', 'world'], 'testing ... ', length=3, verbosity=1
|
|
)
|
|
assert list(yields) == ['hello', 'sphinx', 'world']
|
|
output = strip_colors(app.status.getvalue())
|
|
assert 'testing ... [ 33%] hello\n' in output
|
|
assert 'testing ... [ 67%] sphinx\n' in output
|
|
assert 'testing ... [100%] world\n\n' in output
|
|
|
|
|
|
@pytest.mark.sphinx('html', testroot='root')
|
|
def test_progress_message(app):
|
|
logging.setup(app, app.status, app.warning)
|
|
logger = logging.getLogger(__name__)
|
|
|
|
# standard case
|
|
with progress_message('testing'):
|
|
logger.info('blah ', nonl=True)
|
|
|
|
output = strip_colors(app.status.getvalue())
|
|
assert 'testing... blah done\n' in output
|
|
|
|
# skipping case
|
|
with progress_message('testing'):
|
|
raise SkipProgressMessage('Reason: %s', 'error') # NoQA: EM101,TRY003
|
|
|
|
output = strip_colors(app.status.getvalue())
|
|
assert 'testing... skipped\nReason: error\n' in output
|
|
|
|
# error case
|
|
try:
|
|
with progress_message('testing'):
|
|
raise RuntimeError # NoQA: TRY301
|
|
except Exception:
|
|
pass
|
|
|
|
output = strip_colors(app.status.getvalue())
|
|
assert 'testing... failed\n' in output
|
|
|
|
# decorator
|
|
@progress_message('testing')
|
|
def func():
|
|
logger.info('in func ', nonl=True)
|
|
|
|
func()
|
|
output = strip_colors(app.status.getvalue())
|
|
assert 'testing... in func done\n' in output
|