Merges napoleon extension into mainline sphinx

4 files changed, 797 insertions, 1 deletions

diff --git a/tests/root/conf.py b/tests/root/conf.py
index 8025ba33..9b881760 100644
--- a/tests/root/conf.py
+++ b/tests/root/conf.py
@@ -8,7 +8,8 @@ sys.path.append(os.path.abspath('..'))
 extensions = ['sphinx.ext.autodoc', 'sphinx.ext.jsmath', 'sphinx.ext.todo',
               'sphinx.ext.coverage', 'sphinx.ext.autosummary',
               'sphinx.ext.doctest', 'sphinx.ext.extlinks',
-              'sphinx.ext.viewcode', 'sphinx.ext.oldcmarkup', 'ext']
+              'sphinx.ext.viewcode', 'sphinx.ext.oldcmarkup',
+              'sphinx.ext.napoleon', 'ext']
 
 jsmath_path = 'dummy.js'
 
diff --git a/tests/test_napoleon.py b/tests/test_napoleon.py
new file mode 100644
index 00000000..d8c71960
--- /dev/null
+++ b/tests/test_napoleon.py
@@ -0,0 +1,190 @@
+# -*- coding: utf-8 -*-
+"""
+    test_napoleon
+    ~~~~~~~~~~~~~
+
+    Tests for :mod:`sphinx.ext.napoleon.__init__` module.
+
+
+    :copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS.
+    :license: BSD, see LICENSE for details.
+"""
+
+from mock import Mock
+from sphinx.application import Sphinx
+from sphinx.ext.napoleon import (_process_docstring, _skip_member, Config,
+                                 setup)
+from unittest import TestCase
+
+
+def _private_doc():
+    """module._private_doc.DOCSTRING"""
+    pass
+
+
+def _private_undoc():
+    pass
+
+
+def __special_doc__():
+    """module.__special_doc__.DOCSTRING"""
+    pass
+
+
+def __special_undoc__():
+    pass
+
+
+class SampleClass(object):
+    def _private_doc(self):
+        """SampleClass._private_doc.DOCSTRING"""
+        pass
+
+    def _private_undoc(self):
+        pass
+
+    def __special_doc__(self):
+        """SampleClass.__special_doc__.DOCSTRING"""
+        pass
+
+    def __special_undoc__(self):
+        pass
+
+
+class SampleError(Exception):
+    def _private_doc(self):
+        """SampleError._private_doc.DOCSTRING"""
+        pass
+
+    def _private_undoc(self):
+        pass
+
+    def __special_doc__(self):
+        """SampleError.__special_doc__.DOCSTRING"""
+        pass
+
+    def __special_undoc__(self):
+        pass
+
+
+class ProcessDocstringTest(TestCase):
+    def test_modify_in_place(self):
+        lines = ['Summary line.',
+                 '',
+                 'Args:',
+                 '   arg1: arg1 description']
+        app = Mock()
+        app.config = Config()
+        _process_docstring(app, 'class', 'SampleClass', SampleClass, Mock(),
+                           lines)
+
+        expected = ['Summary line.',
+                    '',
+                    ':Parameters: **arg1** --',
+                    '             arg1 description']
+        self.assertEqual(expected, lines)
+
+
+class SetupTest(TestCase):
+    def test_unknown_app_type(self):
+        setup(object())
+
+    def test_add_config_values(self):
+        app = Mock(Sphinx)
+        setup(app)
+        for name, (default, rebuild) in Config._config_values.items():
+            has_config = False
+            for method_name, args, kwargs in app.method_calls:
+                if(method_name == 'add_config_value' and
+                   args[0] == name):
+                    has_config = True
+            if not has_config:
+                self.fail('Config value was not added to app %s' % name)
+
+        has_process_docstring = False
+        has_skip_member = False
+        for method_name, args, kwargs in app.method_calls:
+            if method_name == 'connect':
+                if(args[0] == 'autodoc-process-docstring' and
+                   args[1] == _process_docstring):
+                    has_process_docstring = True
+                elif(args[0] == 'autodoc-skip-member' and
+                     args[1] == _skip_member):
+                    has_skip_member = True
+        if not has_process_docstring:
+            self.fail('autodoc-process-docstring never connected')
+        if not has_skip_member:
+            self.fail('autodoc-skip-member never connected')
+
+
+class SkipMemberTest(TestCase):
+    def assertSkip(self, what, member, obj, expect_skip, config_name):
+        skip = 'default skip'
+        app = Mock()
+        app.config = Config()
+        setattr(app.config, config_name, True)
+        if expect_skip:
+            self.assertEqual(skip, _skip_member(app, what, member, obj, skip,
+                                                Mock()))
+        else:
+            self.assertFalse(_skip_member(app, what, member, obj, skip,
+                                          Mock()))
+        setattr(app.config, config_name, False)
+        self.assertEqual(skip, _skip_member(app, what, member, obj, skip,
+                                            Mock()))
+
+    def test_class_private_doc(self):
+        self.assertSkip('class', '_private_doc',
+                        SampleClass._private_doc, False,
+                        'napoleon_include_private_with_doc')
+
+    def test_class_private_undoc(self):
+        self.assertSkip('class', '_private_undoc',
+                        SampleClass._private_undoc, True,
+                        'napoleon_include_private_with_doc')
+
+    def test_class_special_doc(self):
+        self.assertSkip('class', '__special_doc__',
+                        SampleClass.__special_doc__, False,
+                        'napoleon_include_special_with_doc')
+
+    def test_class_special_undoc(self):
+        self.assertSkip('class', '__special_undoc__',
+                        SampleClass.__special_undoc__, True,
+                        'napoleon_include_special_with_doc')
+
+    def test_exception_private_doc(self):
+        self.assertSkip('exception', '_private_doc',
+                        SampleError._private_doc, False,
+                        'napoleon_include_private_with_doc')
+
+    def test_exception_private_undoc(self):
+        self.assertSkip('exception', '_private_undoc',
+                        SampleError._private_undoc, True,
+                        'napoleon_include_private_with_doc')
+
+    def test_exception_special_doc(self):
+        self.assertSkip('exception', '__special_doc__',
+                        SampleError.__special_doc__, False,
+                        'napoleon_include_special_with_doc')
+
+    def test_exception_special_undoc(self):
+        self.assertSkip('exception', '__special_undoc__',
+                        SampleError.__special_undoc__, True,
+                        'napoleon_include_special_with_doc')
+
+    def test_module_private_doc(self):
+        self.assertSkip('module', '_private_doc', _private_doc, False,
+                        'napoleon_include_private_with_doc')
+
+    def test_module_private_undoc(self):
+        self.assertSkip('module', '_private_undoc', _private_undoc, True,
+                        'napoleon_include_private_with_doc')
+
+    def test_module_special_doc(self):
+        self.assertSkip('module', '__special_doc__', __special_doc__, False,
+                        'napoleon_include_special_with_doc')
+
+    def test_module_special_undoc(self):
+        self.assertSkip('module', '__special_undoc__', __special_undoc__, True,
+                        'napoleon_include_special_with_doc')
diff --git a/tests/test_napoleon_docstring.py b/tests/test_napoleon_docstring.py
new file mode 100644
index 00000000..aa52aebe
--- /dev/null
+++ b/tests/test_napoleon_docstring.py
@@ -0,0 +1,259 @@
+# -*- coding: utf-8 -*-
+"""
+    test_napoleon_docstring
+    ~~~~~~~~~~~~~~~~~~~~~~~
+
+    Tests for :mod:`sphinx.ext.napoleon.docstring` module.
+
+
+    :copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS.
+    :license: BSD, see LICENSE for details.
+"""
+
+import textwrap
+from sphinx.ext.napoleon.docstring import GoogleDocstring, NumpyDocstring
+from unittest import TestCase
+
+
+class BaseDocstringTest(TestCase):
+    pass
+
+
+class GoogleDocstringTest(BaseDocstringTest):
+    docstrings = [(
+        """Single line summary""",
+        """Single line summary"""
+    ), (
+        """
+        Single line summary
+
+        Extended description
+
+        """,
+        """
+        Single line summary
+
+        Extended description
+        """
+    ), (
+        """
+        Single line summary
+
+        Args:
+          arg1(str):Extended
+            description of arg1
+        """,
+        """
+        Single line summary
+
+        :Parameters: **arg1** (*str*) --
+                     Extended
+                     description of arg1"""
+    ), (
+        """
+        Single line summary
+
+        Args:
+          arg1(str):Extended
+            description of arg1
+          arg2 ( int ) : Extended
+            description of arg2
+
+        Keyword Args:
+          kwarg1(str):Extended
+            description of kwarg1
+          kwarg2 ( int ) : Extended
+            description of kwarg2""",
+        """
+        Single line summary
+
+        :Parameters: * **arg1** (*str*) --
+                       Extended
+                       description of arg1
+                     * **arg2** (*int*) --
+                       Extended
+                       description of arg2
+
+        :Keyword Arguments: * **kwarg1** (*str*) --
+                              Extended
+                              description of kwarg1
+                            * **kwarg2** (*int*) --
+                              Extended
+                              description of kwarg2"""
+    ), (
+        """
+        Single line summary
+
+        Arguments:
+          arg1(str):Extended
+            description of arg1
+          arg2 ( int ) : Extended
+            description of arg2
+
+        Keyword Arguments:
+          kwarg1(str):Extended
+            description of kwarg1
+          kwarg2 ( int ) : Extended
+            description of kwarg2""",
+        """
+        Single line summary
+
+        :Parameters: * **arg1** (*str*) --
+                       Extended
+                       description of arg1
+                     * **arg2** (*int*) --
+                       Extended
+                       description of arg2
+
+        :Keyword Arguments: * **kwarg1** (*str*) --
+                              Extended
+                              description of kwarg1
+                            * **kwarg2** (*int*) --
+                              Extended
+                              description of kwarg2"""
+    ), (
+        """
+        Single line summary
+
+        Return:
+          str:Extended
+          description of return value
+        """,
+        """
+        Single line summary
+
+        :returns: *str* --
+                  Extended
+                  description of return value"""
+    ), (
+        """
+        Single line summary
+
+        Returns:
+          str:Extended
+          description of return value
+        """,
+        """
+        Single line summary
+
+        :returns: *str* --
+                  Extended
+                  description of return value"""
+    )]
+
+    def test_docstrings(self):
+        for docstring, expected in self.docstrings:
+            actual = str(GoogleDocstring(textwrap.dedent(docstring)))
+            expected = textwrap.dedent(expected)
+            self.assertEqual(expected, actual)
+
+
+class NumpyDocstringTest(BaseDocstringTest):
+    docstrings = [(
+        """Single line summary""",
+        """Single line summary"""
+    ), (
+        """
+        Single line summary
+
+        Extended description
+
+        """,
+        """
+        Single line summary
+
+        Extended description
+        """
+    ), (
+        """
+        Single line summary
+
+        Parameters
+        ----------
+        arg1:str
+            Extended
+            description of arg1
+        """,
+        """
+        Single line summary
+
+        :Parameters: **arg1** (*str*) --
+                     Extended
+                     description of arg1"""
+    ), (
+        """
+        Single line summary
+
+        Parameters
+        ----------
+        arg1:str
+            Extended
+            description of arg1
+        arg2 : int
+            Extended
+            description of arg2
+
+        Keyword Arguments
+        -----------------
+          kwarg1:str
+              Extended
+              description of kwarg1
+          kwarg2 : int
+              Extended
+              description of kwarg2
+        """,
+        """
+        Single line summary
+
+        :Parameters: * **arg1** (*str*) --
+                       Extended
+                       description of arg1
+                     * **arg2** (*int*) --
+                       Extended
+                       description of arg2
+
+        :Keyword Arguments: * **kwarg1** (*str*) --
+                              Extended
+                              description of kwarg1
+                            * **kwarg2** (*int*) --
+                              Extended
+                              description of kwarg2"""
+    ), (
+        """
+        Single line summary
+
+        Return
+        ------
+        str
+            Extended
+            description of return value
+        """,
+        """
+        Single line summary
+
+        :returns: *str* --
+                  Extended
+                  description of return value"""
+    ), (
+        """
+        Single line summary
+
+        Returns
+        -------
+        str
+            Extended
+            description of return value
+        """,
+        """
+        Single line summary
+
+        :returns: *str* --
+                  Extended
+                  description of return value"""
+    )]
+
+    def test_docstrings(self):
+        for docstring, expected in self.docstrings:
+            actual = str(NumpyDocstring(textwrap.dedent(docstring)))
+            expected = textwrap.dedent(expected)
+            self.assertEqual(expected, actual)
diff --git a/tests/test_napoleon_iterators.py b/tests/test_napoleon_iterators.py
new file mode 100644
index 00000000..db0be32c
--- /dev/null
+++ b/tests/test_napoleon_iterators.py
@@ -0,0 +1,346 @@
+# -*- coding: utf-8 -*-
+"""
+    test_napoleon_iterators
+    ~~~~~~~~~~~~~~~~~~~~~~~
+
+    Tests for :mod:`sphinx.ext.napoleon.iterators` module.
+
+
+    :copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS.
+    :license: BSD, see LICENSE for details.
+"""
+
+from sphinx.ext.napoleon.iterators import peek_iter, modify_iter
+from unittest import TestCase
+
+
+class BaseIteratorsTest(TestCase):
+    def assertEqualTwice(self, expected, func, *args):
+        self.assertEqual(expected, func(*args))
+        self.assertEqual(expected, func(*args))
+
+    def assertFalseTwice(self, func, *args):
+        self.assertFalse(func(*args))
+        self.assertFalse(func(*args))
+
+    def assertNext(self, it, expected, is_last):
+        self.assertTrueTwice(it.has_next)
+        self.assertEqualTwice(expected, it.peek)
+        self.assertTrueTwice(it.has_next)
+        self.assertEqualTwice(expected, it.peek)
+        self.assertTrueTwice(it.has_next)
+        self.assertEqual(expected, it.next())
+        if is_last:
+            self.assertFalseTwice(it.has_next)
+            self.assertRaisesTwice(StopIteration, it.next)
+        else:
+            self.assertTrueTwice(it.has_next)
+
+    def assertRaisesTwice(self, exc, func, *args):
+        self.assertRaises(exc, func, *args)
+        self.assertRaises(exc, func, *args)
+
+    def assertTrueTwice(self, func, *args):
+        self.assertTrue(func(*args))
+        self.assertTrue(func(*args))
+
+
+class PeekIterTest(BaseIteratorsTest):
+    def test_init_with_sentinel(self):
+        a = iter(['1', '2', 'DONE'])
+        sentinel = 'DONE'
+        self.assertRaises(TypeError, peek_iter, a, sentinel)
+
+        def get_next():
+            return next(a)
+        it = peek_iter(get_next, sentinel)
+        self.assertEqual(it.sentinel, sentinel)
+        self.assertNext(it, '1', is_last=False)
+        self.assertNext(it, '2', is_last=True)
+
+    def test_iter(self):
+        a = ['1', '2', '3']
+        it = peek_iter(a)
+        self.assertTrue(it is it.__iter__())
+
+        a = []
+        b = [i for i in peek_iter(a)]
+        self.assertEqual([], b)
+
+        a = ['1']
+        b = [i for i in peek_iter(a)]
+        self.assertEqual(['1'], b)
+
+        a = ['1', '2']
+        b = [i for i in peek_iter(a)]
+        self.assertEqual(['1', '2'], b)
+
+        a = ['1', '2', '3']
+        b = [i for i in peek_iter(a)]
+        self.assertEqual(['1', '2', '3'], b)
+
+    def test_next_with_multi(self):
+        a = []
+        it = peek_iter(a)
+        self.assertFalseTwice(it.has_next)
+        self.assertRaisesTwice(StopIteration, it.next, 2)
+
+        a = ['1']
+        it = peek_iter(a)
+        self.assertTrueTwice(it.has_next)
+        self.assertRaisesTwice(StopIteration, it.next, 2)
+        self.assertTrueTwice(it.has_next)
+
+        a = ['1', '2']
+        it = peek_iter(a)
+        self.assertTrueTwice(it.has_next)
+        self.assertEqual(['1', '2'], it.next(2))
+        self.assertFalseTwice(it.has_next)
+
+        a = ['1', '2', '3']
+        it = peek_iter(a)
+        self.assertTrueTwice(it.has_next)
+        self.assertEqual(['1', '2'], it.next(2))
+        self.assertTrueTwice(it.has_next)
+        self.assertRaisesTwice(StopIteration, it.next, 2)
+        self.assertTrueTwice(it.has_next)
+
+        a = ['1', '2', '3', '4']
+        it = peek_iter(a)
+        self.assertTrueTwice(it.has_next)
+        self.assertEqual(['1', '2'], it.next(2))
+        self.assertTrueTwice(it.has_next)
+        self.assertEqual(['3', '4'], it.next(2))
+        self.assertFalseTwice(it.has_next)
+        self.assertRaisesTwice(StopIteration, it.next, 2)
+        self.assertFalseTwice(it.has_next)
+
+    def test_next_with_none(self):
+        a = []
+        it = peek_iter(a)
+        self.assertFalseTwice(it.has_next)
+        self.assertRaisesTwice(StopIteration, it.next)
+        self.assertFalseTwice(it.has_next)
+
+        a = ['1']
+        it = peek_iter(a)
+        self.assertEqual('1', it.__next__())
+
+        a = ['1']
+        it = peek_iter(a)
+        self.assertNext(it, '1', is_last=True)
+
+        a = ['1', '2']
+        it = peek_iter(a)
+        self.assertNext(it, '1', is_last=False)
+        self.assertNext(it, '2', is_last=True)
+
+        a = ['1', '2', '3']
+        it = peek_iter(a)
+        self.assertNext(it, '1', is_last=False)
+        self.assertNext(it, '2', is_last=False)
+        self.assertNext(it, '3', is_last=True)
+
+    def test_next_with_one(self):
+        a = []
+        it = peek_iter(a)
+        self.assertFalseTwice(it.has_next)
+        self.assertRaisesTwice(StopIteration, it.next, 1)
+
+        a = ['1']
+        it = peek_iter(a)
+        self.assertTrueTwice(it.has_next)
+        self.assertEqual(['1'], it.next(1))
+        self.assertFalseTwice(it.has_next)
+        self.assertRaisesTwice(StopIteration, it.next, 1)
+
+        a = ['1', '2']
+        it = peek_iter(a)
+        self.assertTrueTwice(it.has_next)
+        self.assertEqual(['1'], it.next(1))
+        self.assertTrueTwice(it.has_next)
+        self.assertEqual(['2'], it.next(1))
+        self.assertFalseTwice(it.has_next)
+        self.assertRaisesTwice(StopIteration, it.next, 1)
+
+    def test_next_with_zero(self):
+        a = []
+        it = peek_iter(a)
+        self.assertFalseTwice(it.has_next)
+        self.assertRaisesTwice(StopIteration, it.next, 0)
+
+        a = ['1']
+        it = peek_iter(a)
+        self.assertTrueTwice(it.has_next)
+        self.assertEqualTwice([], it.next, 0)
+        self.assertTrueTwice(it.has_next)
+        self.assertEqualTwice([], it.next, 0)
+
+        a = ['1', '2']
+        it = peek_iter(a)
+        self.assertTrueTwice(it.has_next)
+        self.assertEqualTwice([], it.next, 0)
+        self.assertTrueTwice(it.has_next)
+        self.assertEqualTwice([], it.next, 0)
+
+    def test_peek_with_multi(self):
+        a = []
+        it = peek_iter(a)
+        self.assertFalseTwice(it.has_next)
+        self.assertEqualTwice([it.sentinel, it.sentinel], it.peek, 2)
+        self.assertFalseTwice(it.has_next)
+
+        a = ['1']
+        it = peek_iter(a)
+        self.assertTrueTwice(it.has_next)
+        self.assertEqualTwice(['1', it.sentinel], it.peek, 2)
+        self.assertTrueTwice(it.has_next)
+        self.assertEqualTwice(['1', it.sentinel, it.sentinel], it.peek, 3)
+        self.assertTrueTwice(it.has_next)
+
+        a = ['1', '2']
+        it = peek_iter(a)
+        self.assertTrueTwice(it.has_next)
+        self.assertEqualTwice(['1', '2'], it.peek, 2)
+        self.assertTrueTwice(it.has_next)
+        self.assertEqualTwice(['1', '2', it.sentinel], it.peek, 3)
+        self.assertTrueTwice(it.has_next)
+        self.assertEqualTwice(['1', '2', it.sentinel, it.sentinel], it.peek, 4)
+        self.assertTrueTwice(it.has_next)
+
+        a = ['1', '2', '3']
+        it = peek_iter(a)
+        self.assertTrueTwice(it.has_next)
+        self.assertEqualTwice(['1', '2'], it.peek, 2)
+        self.assertTrueTwice(it.has_next)
+        self.assertEqualTwice(['1', '2', '3'], it.peek, 3)
+        self.assertTrueTwice(it.has_next)
+        self.assertEqualTwice(['1', '2', '3', it.sentinel], it.peek, 4)
+        self.assertTrueTwice(it.has_next)
+        self.assertEqual('1', it.next())
+        self.assertTrueTwice(it.has_next)
+        self.assertEqualTwice(['2', '3'], it.peek, 2)
+        self.assertTrueTwice(it.has_next)
+        self.assertEqualTwice(['2', '3', it.sentinel], it.peek, 3)
+        self.assertTrueTwice(it.has_next)
+        self.assertEqualTwice(['2', '3', it.sentinel, it.sentinel], it.peek, 4)
+        self.assertTrueTwice(it.has_next)
+
+    def test_peek_with_none(self):
+        a = []
+        it = peek_iter(a)
+        self.assertFalseTwice(it.has_next)
+        self.assertEqualTwice(it.sentinel, it.peek)
+        self.assertFalseTwice(it.has_next)
+
+        a = ['1']
+        it = peek_iter(a)
+        self.assertTrueTwice(it.has_next)
+        self.assertEqualTwice('1', it.peek)
+        self.assertEqual('1', it.next())
+        self.assertFalseTwice(it.has_next)
+        self.assertEqualTwice(it.sentinel, it.peek)
+        self.assertFalseTwice(it.has_next)
+
+        a = ['1', '2']
+        it = peek_iter(a)
+        self.assertTrueTwice(it.has_next)
+        self.assertEqualTwice('1', it.peek)
+        self.assertEqual('1', it.next())
+        self.assertTrueTwice(it.has_next)
+        self.assertEqualTwice('2', it.peek)
+        self.assertEqual('2', it.next())
+        self.assertFalseTwice(it.has_next)
+        self.assertEqualTwice(it.sentinel, it.peek)
+        self.assertFalseTwice(it.has_next)
+
+    def test_peek_with_one(self):
+        a = []
+        it = peek_iter(a)
+        self.assertFalseTwice(it.has_next)
+        self.assertEqualTwice([it.sentinel], it.peek, 1)
+        self.assertFalseTwice(it.has_next)
+
+        a = ['1']
+        it = peek_iter(a)
+        self.assertTrueTwice(it.has_next)
+        self.assertEqualTwice(['1'], it.peek, 1)
+        self.assertEqual('1', it.next())
+        self.assertFalseTwice(it.has_next)
+        self.assertEqualTwice([it.sentinel], it.peek, 1)
+        self.assertFalseTwice(it.has_next)
+
+        a = ['1', '2']
+        it = peek_iter(a)
+        self.assertTrueTwice(it.has_next)
+        self.assertEqualTwice(['1'], it.peek, 1)
+        self.assertEqual('1', it.next())
+        self.assertTrueTwice(it.has_next)
+        self.assertEqualTwice(['2'], it.peek, 1)
+        self.assertEqual('2', it.next())
+        self.assertFalseTwice(it.has_next)
+        self.assertEqualTwice([it.sentinel], it.peek, 1)
+        self.assertFalseTwice(it.has_next)
+
+    def test_peek_with_zero(self):
+        a = []
+        it = peek_iter(a)
+        self.assertFalseTwice(it.has_next)
+        self.assertEqualTwice([], it.peek, 0)
+
+        a = ['1']
+        it = peek_iter(a)
+        self.assertTrueTwice(it.has_next)
+        self.assertEqualTwice([], it.peek, 0)
+        self.assertTrueTwice(it.has_next)
+        self.assertEqualTwice([], it.peek, 0)
+
+        a = ['1', '2']
+        it = peek_iter(a)
+        self.assertTrueTwice(it.has_next)
+        self.assertEqualTwice([], it.peek, 0)
+        self.assertTrueTwice(it.has_next)
+        self.assertEqualTwice([], it.peek, 0)
+
+
+class ModifyIterTest(BaseIteratorsTest):
+    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]
+        self.assertEqual(expected, [i for i in it])
+
+    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']
+        self.assertEqual(expected, [i for i in it])
+
+    def test_modifier_default(self):
+        a = ['', '  ', '  a  ', 'b  ', '  c', '  ', '']
+        it = modify_iter(a)
+        expected = ['', '  ', '  a  ', 'b  ', '  c', '  ', '']
+        self.assertEqual(expected, [i for i in it])
+
+    def test_modifier_not_callable(self):
+        self.assertRaises(TypeError, modify_iter, [1], modifier='not_callable')
+
+    def test_modifier_rstrip(self):
+        a = ['', '  ', '  a  ', 'b  ', '  c', '  ', '']
+        it = modify_iter(a, modifier=lambda s: s.rstrip())
+        expected = ['', '', '  a', 'b', '  c', '', '']
+        self.assertEqual(expected, [i for i in it])
+
+    def test_modifier_rstrip_unicode(self):
+        a = [u'', u'  ', u'  a  ', u'b  ', u'  c', u'  ', u'']
+        it = modify_iter(a, modifier=lambda s: s.rstrip())
+        expected = [u'', u'', u'  a', u'b', u'  c', u'', u'']
+        self.assertEqual(expected, [i for i in it])