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
52a099b7ec
sphinx/tests/test_ext_napoleon_iterators.py

359 lines
11 KiB
Python
Raw Normal View History

Fix whitespace
2022-03-07 09:17:45 -06:00
"""Tests for :mod:`sphinx.ext.napoleon.iterators` module."""
Merges napoleon extension into mainline sphinx
2014-01-18 12:56:23 -06:00
Replace `napoleon.iterators` by simpler stack implementation (#9856)
2022-06-26 06:40:42 -05:00
import sys
Merges napoleon extension into mainline sphinx
2014-01-18 12:56:23 -06:00
Treat Python warnings as errors during testing
2023-02-01 05:15:05 -06:00
import pytest
Replace `napoleon.iterators` by simpler stack implementation (#9856)
2022-06-26 06:40:42 -05:00
from sphinx.deprecation import RemovedInSphinx70Warning
Treat Python warnings as errors during testing
2023-02-01 05:15:05 -06:00
with pytest.warns(DeprecationWarning,
match="sphinx.ext.napoleon.iterators is deprecated."):
from sphinx.ext.napoleon.iterators import modify_iter, peek_iter
Fix flake8 violations
2018-02-19 07:39:14 -06:00
Merges napoleon extension into mainline sphinx
2014-01-18 12:56:23 -06:00
Avoid ``unittest.TestCase`` methods
2023-02-17 17:05:57 -06:00
class TestModuleIsDeprecated:
Replace `napoleon.iterators` by simpler stack implementation (#9856)
2022-06-26 06:40:42 -05:00
def test_module_is_deprecated(self):
sys.modules.pop("sphinx.ext.napoleon.iterators")
Avoid ``unittest.TestCase`` methods
2023-02-17 17:05:57 -06:00
with pytest.warns(RemovedInSphinx70Warning,
match="sphinx.ext.napoleon.iterators is deprecated."):
remove blanket 'noqas'
2022-12-15 11:22:07 -06:00
import sphinx.ext.napoleon.iterators # noqa: F401
Replace `napoleon.iterators` by simpler stack implementation (#9856)
2022-06-26 06:40:42 -05:00
Avoid ``unittest.TestCase`` methods
2023-02-17 17:05:57 -06:00
def _assert_equal_twice(expected, func, *args):
assert expected == func(*args)
assert expected == func(*args)
Merges napoleon extension into mainline sphinx
2014-01-18 12:56:23 -06:00
Avoid ``unittest.TestCase`` methods
2023-02-17 17:05:57 -06:00
def _assert_false_twice(func, *args):
assert not func(*args)
assert not func(*args)
Merges napoleon extension into mainline sphinx
2014-01-18 12:56:23 -06:00
Avoid ``unittest.TestCase`` methods
2023-02-17 17:05:57 -06:00
def _assert_next(it, expected, is_last):
_assert_true_twice(it.has_next)
_assert_equal_twice(expected, it.peek)
_assert_true_twice(it.has_next)
_assert_equal_twice(expected, it.peek)
_assert_true_twice(it.has_next)
assert expected == next(it)
if is_last:
_assert_false_twice(it.has_next)
_assert_raises_twice(StopIteration, it.next)
else:
_assert_true_twice(it.has_next)
Merges napoleon extension into mainline sphinx
2014-01-18 12:56:23 -06:00
Avoid ``unittest.TestCase`` methods
2023-02-17 17:05:57 -06:00
def _assert_raises_twice(exc, func, *args):
with pytest.raises(exc):
func(*args)
with pytest.raises(exc):
func(*args)
def _assert_true_twice(func, *args):
assert func(*args)
assert func(*args)
class TestPeekIter:
Merges napoleon extension into mainline sphinx
2014-01-18 12:56:23 -06:00
def test_init_with_sentinel(self):
a = iter(['1', '2', 'DONE'])
sentinel = 'DONE'
Avoid ``unittest.TestCase`` methods
2023-02-17 17:05:57 -06:00
with pytest.raises(TypeError):
peek_iter(a, sentinel)
Merges napoleon extension into mainline sphinx
2014-01-18 12:56:23 -06:00
def get_next():
return next(a)
it = peek_iter(get_next, sentinel)
Avoid ``unittest.TestCase`` methods
2023-02-17 17:05:57 -06:00
assert it.sentinel == sentinel
_assert_next(it, '1', is_last=False)
_assert_next(it, '2', is_last=True)
Merges napoleon extension into mainline sphinx
2014-01-18 12:56:23 -06:00
def test_iter(self):
a = ['1', '2', '3']
it = peek_iter(a)
Avoid ``unittest.TestCase`` methods
2023-02-17 17:05:57 -06:00
assert it is it.__iter__()
Merges napoleon extension into mainline sphinx
2014-01-18 12:56:23 -06:00
a = []
remove unnecessary list comprehension (C416)
2022-01-09 10:55:12 -06:00
b = list(peek_iter(a))
Avoid ``unittest.TestCase`` methods
2023-02-17 17:05:57 -06:00
assert [] == b
Merges napoleon extension into mainline sphinx
2014-01-18 12:56:23 -06:00
a = ['1']
remove unnecessary list comprehension (C416)
2022-01-09 10:55:12 -06:00
b = list(peek_iter(a))
Avoid ``unittest.TestCase`` methods
2023-02-17 17:05:57 -06:00
assert ["1"] == b
Merges napoleon extension into mainline sphinx
2014-01-18 12:56:23 -06:00
a = ['1', '2']
remove unnecessary list comprehension (C416)
2022-01-09 10:55:12 -06:00
b = list(peek_iter(a))
Avoid ``unittest.TestCase`` methods
2023-02-17 17:05:57 -06:00
assert ["1", "2"] == b
Merges napoleon extension into mainline sphinx
2014-01-18 12:56:23 -06:00
a = ['1', '2', '3']
remove unnecessary list comprehension (C416)
2022-01-09 10:55:12 -06:00
b = list(peek_iter(a))
Avoid ``unittest.TestCase`` methods
2023-02-17 17:05:57 -06:00
assert ["1", "2", "3"] == b
Merges napoleon extension into mainline sphinx
2014-01-18 12:56:23 -06:00
def test_next_with_multi(self):
a = []
it = peek_iter(a)
Avoid ``unittest.TestCase`` methods
2023-02-17 17:05:57 -06:00
_assert_false_twice(it.has_next)
_assert_raises_twice(StopIteration, it.next, 2)
Merges napoleon extension into mainline sphinx
2014-01-18 12:56:23 -06:00
a = ['1']
it = peek_iter(a)
Avoid ``unittest.TestCase`` methods
2023-02-17 17:05:57 -06:00
_assert_true_twice(it.has_next)
_assert_raises_twice(StopIteration, it.next, 2)
_assert_true_twice(it.has_next)
Merges napoleon extension into mainline sphinx
2014-01-18 12:56:23 -06:00
a = ['1', '2']
it = peek_iter(a)
Avoid ``unittest.TestCase`` methods
2023-02-17 17:05:57 -06:00
_assert_true_twice(it.has_next)
assert ["1", "2"] == it.next(2)
_assert_false_twice(it.has_next)
Merges napoleon extension into mainline sphinx
2014-01-18 12:56:23 -06:00
a = ['1', '2', '3']
it = peek_iter(a)
Avoid ``unittest.TestCase`` methods
2023-02-17 17:05:57 -06:00
_assert_true_twice(it.has_next)
assert ["1", "2"] == it.next(2)
_assert_true_twice(it.has_next)
_assert_raises_twice(StopIteration, it.next, 2)
_assert_true_twice(it.has_next)
Merges napoleon extension into mainline sphinx
2014-01-18 12:56:23 -06:00
a = ['1', '2', '3', '4']
it = peek_iter(a)
Avoid ``unittest.TestCase`` methods
2023-02-17 17:05:57 -06:00
_assert_true_twice(it.has_next)
assert ["1", "2"] == it.next(2)
_assert_true_twice(it.has_next)
assert ["3", "4"] == it.next(2)
_assert_false_twice(it.has_next)
_assert_raises_twice(StopIteration, it.next, 2)
_assert_false_twice(it.has_next)
Merges napoleon extension into mainline sphinx
2014-01-18 12:56:23 -06:00
def test_next_with_none(self):
a = []
it = peek_iter(a)
Avoid ``unittest.TestCase`` methods
2023-02-17 17:05:57 -06:00
_assert_false_twice(it.has_next)
_assert_raises_twice(StopIteration, it.next)
_assert_false_twice(it.has_next)
Merges napoleon extension into mainline sphinx
2014-01-18 12:56:23 -06:00
a = ['1']
it = peek_iter(a)
Avoid ``unittest.TestCase`` methods
2023-02-17 17:05:57 -06:00
assert it.__next__() == "1"
Merges napoleon extension into mainline sphinx
2014-01-18 12:56:23 -06:00
a = ['1']
it = peek_iter(a)
Avoid ``unittest.TestCase`` methods
2023-02-17 17:05:57 -06:00
_assert_next(it, '1', is_last=True)
Merges napoleon extension into mainline sphinx
2014-01-18 12:56:23 -06:00
a = ['1', '2']
it = peek_iter(a)
Avoid ``unittest.TestCase`` methods
2023-02-17 17:05:57 -06:00
_assert_next(it, '1', is_last=False)
_assert_next(it, '2', is_last=True)
Merges napoleon extension into mainline sphinx
2014-01-18 12:56:23 -06:00
a = ['1', '2', '3']
it = peek_iter(a)
Avoid ``unittest.TestCase`` methods
2023-02-17 17:05:57 -06:00
_assert_next(it, '1', is_last=False)
_assert_next(it, '2', is_last=False)
_assert_next(it, '3', is_last=True)
Merges napoleon extension into mainline sphinx
2014-01-18 12:56:23 -06:00
def test_next_with_one(self):
a = []
it = peek_iter(a)
Avoid ``unittest.TestCase`` methods
2023-02-17 17:05:57 -06:00
_assert_false_twice(it.has_next)
_assert_raises_twice(StopIteration, it.next, 1)
Merges napoleon extension into mainline sphinx
2014-01-18 12:56:23 -06:00
a = ['1']
it = peek_iter(a)
Avoid ``unittest.TestCase`` methods
2023-02-17 17:05:57 -06:00
_assert_true_twice(it.has_next)
assert ["1"] == it.next(1)
_assert_false_twice(it.has_next)
_assert_raises_twice(StopIteration, it.next, 1)
Merges napoleon extension into mainline sphinx
2014-01-18 12:56:23 -06:00
a = ['1', '2']
it = peek_iter(a)
Avoid ``unittest.TestCase`` methods
2023-02-17 17:05:57 -06:00
_assert_true_twice(it.has_next)
assert ["1"] == it.next(1)
_assert_true_twice(it.has_next)
assert ["2"] == it.next(1)
_assert_false_twice(it.has_next)
_assert_raises_twice(StopIteration, it.next, 1)
Merges napoleon extension into mainline sphinx
2014-01-18 12:56:23 -06:00
def test_next_with_zero(self):
a = []
it = peek_iter(a)
Avoid ``unittest.TestCase`` methods
2023-02-17 17:05:57 -06:00
_assert_false_twice(it.has_next)
_assert_raises_twice(StopIteration, it.next, 0)
Merges napoleon extension into mainline sphinx
2014-01-18 12:56:23 -06:00
a = ['1']
it = peek_iter(a)
Avoid ``unittest.TestCase`` methods
2023-02-17 17:05:57 -06:00
_assert_true_twice(it.has_next)
_assert_equal_twice([], it.next, 0)
_assert_true_twice(it.has_next)
_assert_equal_twice([], it.next, 0)
Merges napoleon extension into mainline sphinx
2014-01-18 12:56:23 -06:00
a = ['1', '2']
it = peek_iter(a)
Avoid ``unittest.TestCase`` methods
2023-02-17 17:05:57 -06:00
_assert_true_twice(it.has_next)
_assert_equal_twice([], it.next, 0)
_assert_true_twice(it.has_next)
_assert_equal_twice([], it.next, 0)
Merges napoleon extension into mainline sphinx
2014-01-18 12:56:23 -06:00
def test_peek_with_multi(self):
a = []
it = peek_iter(a)
Avoid ``unittest.TestCase`` methods
2023-02-17 17:05:57 -06:00
_assert_false_twice(it.has_next)
_assert_equal_twice([it.sentinel, it.sentinel], it.peek, 2)
_assert_false_twice(it.has_next)
Merges napoleon extension into mainline sphinx
2014-01-18 12:56:23 -06:00
a = ['1']
it = peek_iter(a)
Avoid ``unittest.TestCase`` methods
2023-02-17 17:05:57 -06:00
_assert_true_twice(it.has_next)
_assert_equal_twice(['1', it.sentinel], it.peek, 2)
_assert_true_twice(it.has_next)
_assert_equal_twice(['1', it.sentinel, it.sentinel], it.peek, 3)
_assert_true_twice(it.has_next)
Merges napoleon extension into mainline sphinx
2014-01-18 12:56:23 -06:00
a = ['1', '2']
it = peek_iter(a)
Avoid ``unittest.TestCase`` methods
2023-02-17 17:05:57 -06:00
_assert_true_twice(it.has_next)
_assert_equal_twice(['1', '2'], it.peek, 2)
_assert_true_twice(it.has_next)
_assert_equal_twice(['1', '2', it.sentinel], it.peek, 3)
_assert_true_twice(it.has_next)
_assert_equal_twice(['1', '2', it.sentinel, it.sentinel], it.peek, 4)
_assert_true_twice(it.has_next)
Merges napoleon extension into mainline sphinx
2014-01-18 12:56:23 -06:00
a = ['1', '2', '3']
it = peek_iter(a)
Avoid ``unittest.TestCase`` methods
2023-02-17 17:05:57 -06:00
_assert_true_twice(it.has_next)
_assert_equal_twice(['1', '2'], it.peek, 2)
_assert_true_twice(it.has_next)
_assert_equal_twice(['1', '2', '3'], it.peek, 3)
_assert_true_twice(it.has_next)
_assert_equal_twice(['1', '2', '3', it.sentinel], it.peek, 4)
_assert_true_twice(it.has_next)
assert next(it) == "1"
_assert_true_twice(it.has_next)
_assert_equal_twice(['2', '3'], it.peek, 2)
_assert_true_twice(it.has_next)
_assert_equal_twice(['2', '3', it.sentinel], it.peek, 3)
_assert_true_twice(it.has_next)
_assert_equal_twice(['2', '3', it.sentinel, it.sentinel], it.peek, 4)
_assert_true_twice(it.has_next)
Merges napoleon extension into mainline sphinx
2014-01-18 12:56:23 -06:00
def test_peek_with_none(self):
a = []
it = peek_iter(a)
Avoid ``unittest.TestCase`` methods
2023-02-17 17:05:57 -06:00
_assert_false_twice(it.has_next)
_assert_equal_twice(it.sentinel, it.peek)
_assert_false_twice(it.has_next)
Merges napoleon extension into mainline sphinx
2014-01-18 12:56:23 -06:00
a = ['1']
it = peek_iter(a)
Avoid ``unittest.TestCase`` methods
2023-02-17 17:05:57 -06:00
_assert_true_twice(it.has_next)
_assert_equal_twice('1', it.peek)
assert next(it) == "1"
_assert_false_twice(it.has_next)
_assert_equal_twice(it.sentinel, it.peek)
_assert_false_twice(it.has_next)
Merges napoleon extension into mainline sphinx
2014-01-18 12:56:23 -06:00
a = ['1', '2']
it = peek_iter(a)
Avoid ``unittest.TestCase`` methods
2023-02-17 17:05:57 -06:00
_assert_true_twice(it.has_next)
_assert_equal_twice('1', it.peek)
assert next(it) == "1"
_assert_true_twice(it.has_next)
_assert_equal_twice('2', it.peek)
assert next(it) == "2"
_assert_false_twice(it.has_next)
_assert_equal_twice(it.sentinel, it.peek)
_assert_false_twice(it.has_next)
Merges napoleon extension into mainline sphinx
2014-01-18 12:56:23 -06:00
def test_peek_with_one(self):
a = []
it = peek_iter(a)
Avoid ``unittest.TestCase`` methods
2023-02-17 17:05:57 -06:00
_assert_false_twice(it.has_next)
_assert_equal_twice([it.sentinel], it.peek, 1)
_assert_false_twice(it.has_next)
Merges napoleon extension into mainline sphinx
2014-01-18 12:56:23 -06:00
a = ['1']
it = peek_iter(a)
Avoid ``unittest.TestCase`` methods
2023-02-17 17:05:57 -06:00
_assert_true_twice(it.has_next)
_assert_equal_twice(['1'], it.peek, 1)
assert next(it) == "1"
_assert_false_twice(it.has_next)
_assert_equal_twice([it.sentinel], it.peek, 1)
_assert_false_twice(it.has_next)
Merges napoleon extension into mainline sphinx
2014-01-18 12:56:23 -06:00
a = ['1', '2']
it = peek_iter(a)
Avoid ``unittest.TestCase`` methods
2023-02-17 17:05:57 -06:00
_assert_true_twice(it.has_next)
_assert_equal_twice(['1'], it.peek, 1)
assert next(it) == "1"
_assert_true_twice(it.has_next)
_assert_equal_twice(['2'], it.peek, 1)
assert next(it) == "2"
_assert_false_twice(it.has_next)
_assert_equal_twice([it.sentinel], it.peek, 1)
_assert_false_twice(it.has_next)
Merges napoleon extension into mainline sphinx
2014-01-18 12:56:23 -06:00
def test_peek_with_zero(self):
a = []
it = peek_iter(a)
Avoid ``unittest.TestCase`` methods
2023-02-17 17:05:57 -06:00
_assert_false_twice(it.has_next)
_assert_equal_twice([], it.peek, 0)
Merges napoleon extension into mainline sphinx
2014-01-18 12:56:23 -06:00
a = ['1']
it = peek_iter(a)
Avoid ``unittest.TestCase`` methods
2023-02-17 17:05:57 -06:00
_assert_true_twice(it.has_next)
_assert_equal_twice([], it.peek, 0)
_assert_true_twice(it.has_next)
_assert_equal_twice([], it.peek, 0)
Merges napoleon extension into mainline sphinx
2014-01-18 12:56:23 -06:00
a = ['1', '2']
it = peek_iter(a)
Avoid ``unittest.TestCase`` methods
2023-02-17 17:05:57 -06:00
_assert_true_twice(it.has_next)
_assert_equal_twice([], it.peek, 0)
_assert_true_twice(it.has_next)
_assert_equal_twice([], it.peek, 0)
Merges napoleon extension into mainline sphinx
2014-01-18 12:56:23 -06:00
Avoid ``unittest.TestCase`` methods
2023-02-17 17:05:57 -06:00
class TestModifyIter:
Merges napoleon extension into mainline sphinx
2014-01-18 12:56:23 -06:00
def test_init_with_sentinel_args(self):
a = iter(['1', '2', '3', 'DONE'])
sentinel = 'DONE'
def get_next():
return next(a)
it = modify_iter(get_next, sentinel, int)
expected = [1, 2, 3]
Avoid ``unittest.TestCase`` methods
2023-02-17 17:05:57 -06:00
assert expected == list(it)
Merges napoleon extension into mainline sphinx
2014-01-18 12:56:23 -06:00
def test_init_with_sentinel_kwargs(self):
a = iter([1, 2, 3, 4])
sentinel = 4
def get_next():
return next(a)
it = modify_iter(get_next, sentinel, modifier=str)
expected = ['1', '2', '3']
Avoid ``unittest.TestCase`` methods
2023-02-17 17:05:57 -06:00
assert expected == list(it)
Merges napoleon extension into mainline sphinx
2014-01-18 12:56:23 -06:00
def test_modifier_default(self):
a = ['', ' ', ' a ', 'b ', ' c', ' ', '']
it = modify_iter(a)
expected = ['', ' ', ' a ', 'b ', ' c', ' ', '']
Avoid ``unittest.TestCase`` methods
2023-02-17 17:05:57 -06:00
assert expected == list(it)
Merges napoleon extension into mainline sphinx
2014-01-18 12:56:23 -06:00
def test_modifier_not_callable(self):
Avoid ``unittest.TestCase`` methods
2023-02-17 17:05:57 -06:00
with pytest.raises(TypeError):
modify_iter([1], modifier='not_callable')
Merges napoleon extension into mainline sphinx
2014-01-18 12:56:23 -06:00
def test_modifier_rstrip(self):
a = ['', ' ', ' a ', 'b ', ' c', ' ', '']
it = modify_iter(a, modifier=lambda s: s.rstrip())
expected = ['', '', ' a', 'b', ' c', '', '']
Avoid ``unittest.TestCase`` methods
2023-02-17 17:05:57 -06:00
assert expected == list(it)
Merges napoleon extension into mainline sphinx
2014-01-18 12:56:23 -06:00
def test_modifier_rstrip_unicode(self):
refactor: Remove u-prefix from strings
2018-12-15 08:02:28 -06:00
a = ['', ' ', ' a ', 'b ', ' c', ' ', '']
Merges napoleon extension into mainline sphinx
2014-01-18 12:56:23 -06:00
it = modify_iter(a, modifier=lambda s: s.rstrip())
refactor: Remove u-prefix from strings
2018-12-15 08:02:28 -06:00
expected = ['', '', ' a', 'b', ' c', '', '']
Avoid ``unittest.TestCase`` methods
2023-02-17 17:05:57 -06:00
assert expected == list(it)
Reference in New Issue Copy Permalink