def test_add_line(self):
from traits.util.trait_documenter import TraitDocumenter
src = textwrap.dedent(
"""\
class Fake(HasTraits):
#: Test attribute
test = Property(Bool, label=u"ミスあり")
"""
)
mocked_directive = mock.MagicMock()
documenter = TraitDocumenter(mocked_directive, "test", " ")
documenter.object_name = "Property"
with mock.patch(
"traits.util.trait_documenter.inspect.getsource", return_value=src
):
with mock.patch(
(
"traits.util.trait_documenter.ClassLevelDocumenter"
".add_directive_header"
)
):
documenter.add_directive_header("")
self.assertEqual(
len(documenter.directive.result.append.mock_calls), 1)
def test_can_document_member(self):
# Regression test for enthought/traits#1238
with self.create_directive() as directive:
class_documenter = ClassDocumenter(
directive, __name__ + ".FindTheTraits"
)
class_documenter.parse_name()
class_documenter.import_object()
self.assertTrue(
TraitDocumenter.can_document_member(
INSTANCEATTR, "an_int", True, class_documenter,
)
)
self.assertTrue(
TraitDocumenter.can_document_member(
INSTANCEATTR, "another_int", True, class_documenter,
)
)
self.assertFalse(
TraitDocumenter.can_document_member(
INSTANCEATTR, "magic_number", True, class_documenter,
)
)
self.assertFalse(
TraitDocumenter.can_document_member(
INSTANCEATTR, "not_a_trait", True, class_documenter,
)
)
def test_add_line(self):
src = textwrap.dedent(
"""\
class Fake(HasTraits):
#: Test attribute
test = Property(Bool, label="ミスあり")
"""
)
mocked_directive = mock.MagicMock()
documenter = TraitDocumenter(mocked_directive, "test", " ")
documenter.object_name = "Property"
with mock.patch(
"traits.util.trait_documenter.inspect.getsource", return_value=src
):
with mock.patch(
(
"traits.util.trait_documenter.ClassLevelDocumenter"
".add_directive_header"
)
):
documenter.add_directive_header("")
self.assertEqual(
len(documenter.directive.result.append.mock_calls), 1)
def test_add_line(self):
from traits.util.trait_documenter import TraitDocumenter
src = textwrap.dedent("""\
class Fake(HasTraits):
#: Test attribute
test = Property(Bool, label=u"ミスあり")
""")
mocked_directive = mock.MagicMock()
documenter = TraitDocumenter(mocked_directive, 'test', ' ')
documenter.object_name = 'Property'
with mock.patch(
'traits.util.trait_documenter.inspect.getsource',
return_value=src):
with mock.patch(
('traits.util.trait_documenter.ClassLevelDocumenter'
'.add_directive_header')
):
documenter.add_directive_header('')
documenter.directive.result.append.assert_called_once()
def test_abbreviated_annotations(self):
# Regression test for enthought/traits#493.
with self.create_directive() as directive:
documenter = TraitDocumenter(directive,
__name__ + ".MyTestClass.bar")
documenter.generate(all_members=True)
result = directive.result
# Find annotations line.
for item in result:
if item.lstrip().startswith(":annotation:"):
break
else:
self.fail("Didn't find the expected trait :annotation:")
# Annotation should be a single line.
self.assertIn("First line", item)
self.assertNotIn("\n", item)
def test_add_line(self):
mocked_directive = mock.MagicMock()
documenter = TraitDocumenter(mocked_directive, "test", " ")
documenter.object_name = "test_attribute"
documenter.parent = Fake
with mock.patch(("traits.util.trait_documenter.ClassLevelDocumenter"
".add_directive_header")):
documenter.add_directive_header("")
self.assertEqual(len(documenter.directive.result.append.mock_calls), 1)