def test_type_annotations():
class Foo(RefinableObject):
a: int = Refinable()
b: Dict = Refinable()
c: Fragment = Refinable()
(actual_filename,
actual_doc), (_, _) = list(_generate_rst_docs(classes=[Foo, Fragment]))
assert actual_filename == '/Foo.rst'
expected_doc = """
Foo
===
Base class: `RefinableObject`
Refinable members
-----------------
* `a`
Type: `int`
* `b`
Type: `Dict`
* `c`
Type: :doc:`Fragment`
"""
print(actual_doc)
assert actual_doc.strip() == expected_doc.strip()
def test_generate_docs_kill_obscure_mutant():
class Foo(RefinableObject):
name = Refinable()
@dispatch(
# this is to handle that mutmut mutates strip(',') to strip('XX,XX')
name=lambda X: X, )
def __init__(self, **kwargs):
super(Foo, self).__init__(**kwargs) # pragma: no cover
(actual_filename, actual_doc), = list(_generate_rst_docs(classes=[Foo]))
assert actual_filename == '/Foo.rst'
expected_doc = """
Foo
===
Base class: `RefinableObject`
Refinable members
-----------------
* `name`
Defaults
^^^^^^^^
* `name`
* `lambda X: X`
"""
print(actual_doc)
assert actual_doc.strip() == expected_doc.strip()
def test_generate_docs_empty_docstring():
class Foo(RefinableObject):
name = Refinable()
(actual_filename, actual_doc), = list(_generate_rst_docs(classes=[Foo]))
assert actual_filename == '/Foo.rst'
expected_doc = """
Foo
===
Base class: `RefinableObject`
Refinable members
-----------------
* `name`
"""
assert actual_doc.strip() == expected_doc.strip()
def test_generate_docs_description_and_params_in_constructor():
class Foo(RefinableObject):
"""
First description
"""
name = Refinable()
@dispatch
def __init__(self, **kwargs):
"""
__init__ description
:param foo: foo description
"""
super(Foo, self).__init__(**kwargs) # pragma: no cover
(actual_filename, actual_doc), (_, _) = list(
_generate_rst_docs(classes=[Foo, RefinableObject]))
assert actual_filename == '/Foo.rst'
expected_doc = """
Foo
===
Base class: :doc:`RefinableObject`
First description
__init__ description
Refinable members
-----------------
* `name`
"""
assert actual_doc.strip() == expected_doc.strip()
def test_generate_docs():
def some_callable():
pass # pragma: no cover
class Foo(RefinableObject):
"""
docstring for Foo
"""
name = Refinable()
description = Refinable()
some_other_thing = Refinable()
empty_string_default = Refinable()
@dispatch(
name='foo-name',
description=lambda foo, bar: 'qwe',
some_other_thing=some_callable,
empty_string_default='',
)
def __init__(self):
"""
:param name: description of the name field
"""
super(Foo, self).__init__() # pragma: no cover
@staticmethod
@refinable
def refinable_func(field, instance, value):
pass # pragma: no cover
@classmethod
@class_shortcut
def shortcut1(cls):
return cls() # pragma: no cover
@classmethod
@class_shortcut(description='fish')
def shortcut2(cls, call_target):
"""shortcut2 docstring"""
return call_target() # pragma: no cover
@classmethod
@class_shortcut(description=lambda foo: 'qwe')
def shortcut3(cls, call_target):
"""
shortcut3 docstring
:param call_target: something something call_target
"""
return call_target() # pragma: no cover
Foo.shortcut4 = Shortcut(
call_target=Foo,
name='baz',
description='qwe',
)
(actual_filename, actual_doc), = list(_generate_rst_docs(classes=[Foo]))
assert actual_filename == '/Foo.rst'
expected_doc = """
Foo
===
Base class: `RefinableObject`
docstring for Foo
Refinable members
-----------------
* `description`
* `empty_string_default`
* `name`
description of the name field
* `refinable_func`
* `some_other_thing`
Defaults
^^^^^^^^
* `description`
* `lambda foo, bar: 'qwe'`
* `empty_string_default`
* `""`
* `name`
* `foo-name`
* `some_other_thing`
* `iommi.docs__tests.some_callable`
Shortcuts
---------
`shortcut1`
^^^^^^^^^^^
`shortcut2`
^^^^^^^^^^^
shortcut2 docstring
Defaults
++++++++
* `description`
* `fish`
`shortcut3`
^^^^^^^^^^^
shortcut3 docstring
:param call_target: something something call_target
Defaults
++++++++
* `description`
* `lambda foo: 'qwe'`
`shortcut4`
^^^^^^^^^^^
Defaults
++++++++
* `call_target`
* `iommi.docs__tests.Foo`
* `name`
* `baz`
* `description`
* `qwe`
"""
assert actual_doc.strip() == expected_doc.strip()
