def test_func_returns_int(self) -> None:
parser = SphinxParser()
doc = pydoc.getdoc(tests.test_parsers.sphinx_class.CorrectTestClass.func_returns_int)
arguments = parser.get_parameters(doc, tests.test_parsers.sphinx_class)
assert len(arguments) == 0, f"SphinxParser failed assertion"
return_type = parser.get_return_type(doc, tests.test_parsers.sphinx_class)
assert return_type == int, f"SphinxParser failed assertion"
def test_func_with_multiline_summary(self) -> None:
parser = SphinxParser()
doc = pydoc.getdoc(tests.test_parsers.sphinx_class.CorrectTestClass.func_with_multiline_summary)
arguments = parser.get_parameters(doc, tests.test_parsers.sphinx_class)
assert len(arguments) == 1, f"SphinxParser failed assertion"
assert arguments[0].type == int, f"SphinxParser failed assertion"
return_type = parser.get_return_type(doc, tests.test_parsers.sphinx_class)
assert return_type == int, f"SphinxParser failed assertion"
def test_func_with_generics(self) -> None:
parser = SphinxParser()
doc = pydoc.getdoc(tests.test_parsers.sphinx_class.CorrectTestClass.func_with_generics)
parameters = parser.get_parameters(doc, tests.test_parsers.sphinx_class)
assert len(parameters) == 1
assert parameters[0].type == Dict[str, Any]
assert parameters[0].name == 'a_a'
return_type = parser.get_return_type(doc, tests.test_parsers.sphinx_class)
assert return_type == Dict[str, Any]
def test_get_summary_empty_summary(self) -> None:
parser = SphinxParser()
doc = pydoc.getdoc(tests.test_parsers.sphinx_class.CorrectTestClass.func_no_summary)
arguments = parser.get_parameters(doc, tests.test_parsers.sphinx_class)
assert len(arguments) == 0, f"SphinxParser failed assertion"
return_type = parser.get_return_type(doc, tests.test_parsers.sphinx_class)
assert return_type == type(None), f"SphinxParser failed assertion"
summary = parser.get_summary(doc, tests.test_parsers.sphinx_class)
assert summary is None, f"SphinxParser failed assertion"