File: test_codecell_file.py

package info (click to toggle)
myst-nb 1.3.0-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 2,452 kB
  • sloc: python: 6,066; xml: 1,434; makefile: 33
file content (88 lines) | stat: -rw-r--r-- 2,941 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
"""Test notebooks containing code cells with the `load` option."""

import pytest
from sphinx.util.fileutil import copy_asset_file


@pytest.mark.sphinx_params(
    "mystnb_codecell_file.md",
    conf={"nb_execution_mode": "cache", "source_suffix": {".md": "myst-nb"}},
)
def test_codecell_file(sphinx_run, file_regression, check_nbs, get_test_path):
    asset_path = get_test_path("mystnb_codecell_file.py")
    copy_asset_file(str(asset_path), str(sphinx_run.app.srcdir))
    sphinx_run.build()
    assert sphinx_run.warnings() == ""
    assert set(sphinx_run.env.metadata["mystnb_codecell_file"].keys()) == {
        "jupytext",
        "author",
        "source_map",
        "wordcount",
        "kernelspec",
        "language_info",
    }
    assert set(sphinx_run.env.nb_metadata["mystnb_codecell_file"].keys()) == {
        "exec_data",
    }
    assert sphinx_run.env.metadata["mystnb_codecell_file"]["author"] == "Matt"
    assert sphinx_run.env.metadata["mystnb_codecell_file"]["kernelspec"] == {
        "display_name": "Python 3",
        "language": "python",
        "name": "python3",
    }
    try:
        file_regression.check(
            sphinx_run.get_nb(),
            check_fn=check_nbs,
            extension=".ipynb",
            encoding="utf-8",
        )
    finally:
        file_regression.check(
            sphinx_run.get_doctree().pformat(), extension=".xml", encoding="utf-8"
        )


@pytest.mark.sphinx_params(
    "mystnb_codecell_file_warnings.md",
    conf={"nb_execution_mode": "force", "source_suffix": {".md": "myst-nb"}},
)
def test_codecell_file_warnings(sphinx_run, file_regression, check_nbs, get_test_path):
    asset_path = get_test_path("mystnb_codecell_file.py")
    copy_asset_file(str(asset_path), str(sphinx_run.app.srcdir))
    sphinx_run.build()
    # assert (
    #     "mystnb_codecell_file_warnings.md:14 content of code-cell "
    #     "is being overwritten by :load: mystnb_codecell_file.py"
    #     in sphinx_run.warnings()
    # )
    assert set(sphinx_run.env.metadata["mystnb_codecell_file_warnings"].keys()) == {
        "jupytext",
        "author",
        "source_map",
        "wordcount",
        "kernelspec",
        "language_info",
    }
    assert set(sphinx_run.env.nb_metadata["mystnb_codecell_file_warnings"].keys()) == {
        "exec_data",
    }
    assert (
        sphinx_run.env.metadata["mystnb_codecell_file_warnings"]["author"] == "Aakash"
    )
    assert sphinx_run.env.metadata["mystnb_codecell_file_warnings"]["kernelspec"] == {
        "display_name": "Python 3",
        "language": "python",
        "name": "python3",
    }
    try:
        file_regression.check(
            sphinx_run.get_nb(),
            check_fn=check_nbs,
            extension=".ipynb",
            encoding="utf-8",
        )
    finally:
        file_regression.check(
            sphinx_run.get_doctree().pformat(), extension=".xml", encoding="utf-8"
        )