Files
instructor/tests/openai/docs/test_docs.py
T
Jason Liu dcb84b1301 Test all of our documentation. (#404)
Co-authored-by: grit-app[bot] <grit-app[bot]@users.noreply.github.com>
2024-02-05 16:42:57 -05:00

55 lines
1.9 KiB
Python

import pytest
from pytest_examples import find_examples, CodeExample, EvalExample
@pytest.mark.parametrize("example", find_examples("README.md"), ids=str)
def test_readme(example: CodeExample, eval_example: EvalExample):
if eval_example.update_examples:
eval_example.format(example)
eval_example.run_print_update(example)
else:
eval_example.lint(example)
eval_example.run(example)
@pytest.mark.parametrize("example", find_examples("docs/index.md"), ids=str)
def test_index(example: CodeExample, eval_example: EvalExample):
if eval_example.update_examples:
eval_example.format(example)
eval_example.run_print_update(example)
else:
eval_example.lint(example)
eval_example.run(example)
@pytest.mark.skip("Blogs have too many small examples")
@pytest.mark.parametrize("example", find_examples("docs/blog"), ids=str)
def test_format_blog(example: CodeExample, eval_example: EvalExample):
if eval_example.update_examples:
eval_example.format(example)
eval_example.run_print_update(example)
else:
eval_example.lint(example)
eval_example.run(example)
@pytest.mark.parametrize("example", find_examples("docs/concepts"), ids=str)
def test_format_concepts(example: CodeExample, eval_example: EvalExample):
if eval_example.update_examples:
eval_example.format(example)
eval_example.run_print_update(example)
else:
eval_example.lint(example)
eval_example.run(example)
@pytest.mark.skip("Examples are too long")
@pytest.mark.parametrize("example", find_examples("docs/examples"), ids=str)
def test_format_examples(example: CodeExample, eval_example: EvalExample):
if eval_example.update_examples:
eval_example.format(example)
eval_example.run_print_update(example)
else:
eval_example.lint(example)
eval_example.run(example)