def test_rendinging_with_extra_alias_custom_alias(): extra_aliases = { "tests.dummy_package.dummy_module.ImageDataGenerator": "some.new.Thing" } generated = autogen.DocumentationGenerator( extra_aliases=extra_aliases)._render(doing_things) assert "- __an_argument__ `some.new.Thing`: Some" in generated
def test_aliases_in_hints(): pages = { 'dod.md': [ 'tests.dummy_package.DataGenerator', 'tests.dummy_package.dummy_module2.dodo' ] } doc_generator = autogen.DocumentationGenerator(pages=pages) result = doc_generator._render('tests.dummy_package.dummy_module2.dodo') assert result == expected_dodo
def check_against_expected(elements): doc_generator = autogen.DocumentationGenerator( project_url='www.dummy.com/my_project') markdown_text = '' for element in elements: markdown_text += doc_generator._render(element) current_file_path = pathlib.Path(__file__).resolve() expected_file = current_file_path.parent / 'dummy_package' / 'expected.md' expected_text = expected_file.read_text() # we check that the generated html is the same # to ignore blank lines or other differences not relevant. assert markdown(markdown_text) == markdown(expected_text)
def test_rendinging_with_extra_alias(): extra_aliases = ["tests.dummy_package.DataGenerator"] generated = autogen.DocumentationGenerator( extra_aliases=extra_aliases)._render(doing_things) assert "- __an_argument__ `tests.dummy_package.DataGenerator`: Some" in generated
def test_get_docstring_of_super_class(): computed = autogen.DocumentationGenerator()._render(B.dodo) assert 'Some docstring' in computed
def test_aliases_methods(element, expected): doc_generator = autogen.DocumentationGenerator() computed = doc_generator._render(element) assert expected in computed
def test_aliases_class_function(element): doc_generator = autogen.DocumentationGenerator() computed = doc_generator._render(element) expected = element + '(' assert expected in computed
def test_hard_method(): generated = autogen.DocumentationGenerator()._render(hard_method) assert "- __arg__ `Union[int, Tuple[int, int]]`: One or" in generated assert "- __arg2__ `int`: One integer." in generated
def test_types_in_docstring(): result = autogen.DocumentationGenerator()._render(water_plant) assert "water_plant(self, amount, fertilizer_type=None)" in result assert "- __amount__ `Union[int, float]`: How much" in result assert "- __fertilizer_type__ `Optional[str]`: What" in result