Merge pull request #7920 from tk0miya/napoleon_namedtuple

napoleon: Adjust test expectation for namedtuple in py37+
This commit is contained in:
Takeshi KOMIYA 2020-07-06 02:06:21 +09:00 committed by GitHub
commit 27ac10de04
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -9,6 +9,7 @@
:license: BSD, see LICENSE for details.
"""
import sys
from collections import namedtuple
from unittest import TestCase, mock
@ -136,9 +137,18 @@ class SkipMemberTest(TestCase):
mock.Mock()))
def test_namedtuple(self):
if sys.version_info < (3, 7):
self.assertSkip('class', '_asdict',
SampleNamedTuple._asdict, False,
'napoleon_include_private_with_doc')
else:
# Since python 3.7, namedtuple._asdict() has not been documented
# because there is no way to check the method is a member of the
# namedtuple class. This testcase confirms only it does not
# raise an error on building document (refs: #1455)
self.assertSkip('class', '_asdict',
SampleNamedTuple._asdict, True,
'napoleon_include_private_with_doc')
def test_class_private_doc(self):
self.assertSkip('class', '_private_doc',