mirror of
https://github.com/sphinx-doc/sphinx.git
synced 2025-02-25 18:55:22 -06:00
bade33c7e4
In Python 3, the default encoding of source files is utf-8. The encoding cookie is now unnecessary and redundant so remove it. For more details, see the docs: https://docs.python.org/3/howto/unicode.html#the-string-type > The default encoding for Python source code is UTF-8, so you can > simply include a Unicode character in a string literal ... Includes a fix for the flake8 header checks to stop expecting an encoding cookie.
131 lines
4.5 KiB
Python
131 lines
4.5 KiB
Python
"""
|
||
test_util
|
||
~~~~~~~~~~~~~~~
|
||
|
||
Tests util functions.
|
||
|
||
:copyright: Copyright 2007-2018 by the Sphinx team, see AUTHORS.
|
||
:license: BSD, see LICENSE for details.
|
||
"""
|
||
|
||
import os
|
||
import tempfile
|
||
|
||
import pytest
|
||
from mock import patch
|
||
|
||
import sphinx
|
||
from sphinx.errors import PycodeError
|
||
from sphinx.testing.util import strip_escseq
|
||
from sphinx.util import (
|
||
display_chunk, encode_uri, ensuredir, get_module_source, parselinenos, status_iterator,
|
||
xmlname_checker
|
||
)
|
||
from sphinx.util import logging
|
||
|
||
|
||
def test_encode_uri():
|
||
expected = ('https://ru.wikipedia.org/wiki/%D0%A1%D0%B8%D1%81%D1%82%D0%B5%D0%BC%D0%B0_'
|
||
'%D1%83%D0%BF%D1%80%D0%B0%D0%B2%D0%BB%D0%B5%D0%BD%D0%B8%D1%8F_'
|
||
'%D0%B1%D0%B0%D0%B7%D0%B0%D0%BC%D0%B8_%D0%B4%D0%B0%D0%BD%D0%BD%D1%8B%D1%85')
|
||
uri = ('https://ru.wikipedia.org/wiki'
|
||
'/Система_управления_базами_данных')
|
||
assert expected == encode_uri(uri)
|
||
|
||
expected = ('https://github.com/search?utf8=%E2%9C%93&q=is%3Aissue+is%3Aopen+is%3A'
|
||
'sprint-friendly+user%3Ajupyter&type=Issues&ref=searchresults')
|
||
uri = ('https://github.com/search?utf8=✓&q=is%3Aissue+is%3Aopen+is%3A'
|
||
'sprint-friendly+user%3Ajupyter&type=Issues&ref=searchresults')
|
||
assert expected == encode_uri(uri)
|
||
|
||
|
||
def test_ensuredir():
|
||
with tempfile.TemporaryDirectory() as tmp_path:
|
||
# Does not raise an exception for an existing directory.
|
||
ensuredir(tmp_path)
|
||
|
||
path = os.path.join(tmp_path, 'a', 'b', 'c')
|
||
ensuredir(path)
|
||
assert os.path.isdir(path)
|
||
|
||
with tempfile.NamedTemporaryFile() as tmp:
|
||
with pytest.raises(OSError):
|
||
ensuredir(tmp.name)
|
||
|
||
|
||
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'
|
||
|
||
|
||
def test_get_module_source():
|
||
assert get_module_source('sphinx') == ('file', sphinx.__file__)
|
||
|
||
# failed to obtain source information from builtin modules
|
||
with pytest.raises(PycodeError):
|
||
get_module_source('builtins')
|
||
with pytest.raises(PycodeError):
|
||
get_module_source('itertools')
|
||
|
||
|
||
@pytest.mark.sphinx('dummy')
|
||
@patch('sphinx.util.console._tw', 40) # terminal width = 40
|
||
def test_status_iterator(app, status, warning):
|
||
logging.setup(app, status, warning)
|
||
|
||
# test for old_status_iterator
|
||
status.truncate(0)
|
||
yields = list(status_iterator(['hello', 'sphinx', 'world'], 'testing ... '))
|
||
output = strip_escseq(status.getvalue())
|
||
assert 'testing ... hello sphinx world \n' in output
|
||
assert yields == ['hello', 'sphinx', 'world']
|
||
|
||
# test for status_iterator (verbosity=0)
|
||
status.truncate(0)
|
||
yields = list(status_iterator(['hello', 'sphinx', 'world'], 'testing ... ',
|
||
length=3, verbosity=0))
|
||
output = strip_escseq(status.getvalue())
|
||
assert 'testing ... [ 33%] hello \r' in output
|
||
assert 'testing ... [ 66%] sphinx \r' in output
|
||
assert 'testing ... [100%] world \r\n' in output
|
||
assert yields == ['hello', 'sphinx', 'world']
|
||
|
||
# test for status_iterator (verbosity=1)
|
||
status.truncate(0)
|
||
yields = list(status_iterator(['hello', 'sphinx', 'world'], 'testing ... ',
|
||
length=3, verbosity=1))
|
||
output = strip_escseq(status.getvalue())
|
||
assert 'testing ... [ 33%] hello\n' in output
|
||
assert 'testing ... [ 66%] sphinx\n' in output
|
||
assert 'testing ... [100%] world\n\n' in output
|
||
assert yields == ['hello', 'sphinx', 'world']
|
||
|
||
|
||
def test_parselinenos():
|
||
assert parselinenos('1,2,3', 10) == [0, 1, 2]
|
||
assert parselinenos('4, 5, 6', 10) == [3, 4, 5]
|
||
assert parselinenos('-4', 10) == [0, 1, 2, 3]
|
||
assert parselinenos('7-9', 10) == [6, 7, 8]
|
||
assert parselinenos('7-', 10) == [6, 7, 8, 9]
|
||
assert parselinenos('1,7-', 10) == [0, 6, 7, 8, 9]
|
||
assert parselinenos('7-7', 10) == [6]
|
||
assert parselinenos('11-', 10) == [10]
|
||
with pytest.raises(ValueError):
|
||
parselinenos('1-2-3', 10)
|
||
with pytest.raises(ValueError):
|
||
parselinenos('abc-def', 10)
|
||
with pytest.raises(ValueError):
|
||
parselinenos('-', 10)
|
||
with pytest.raises(ValueError):
|
||
parselinenos('3-1', 10)
|
||
|
||
|
||
def test_xmlname_check():
|
||
checker = xmlname_checker()
|
||
assert checker.match('id-pub')
|
||
assert checker.match('webpage')
|
||
assert not checker.match('1bfda21')
|