test_active_cells.py

import pytest
from jupytext.compare import compare
import jupytext
from .utils import skip_if_dict_is_not_ordered

HEADER = {'.py': '''# ---
# jupyter:
#   jupytext:
#     main_language: python
# ---

''',
          '.R': '''# ---
# jupyter:
#   jupytext:
#     main_language: python
# ---

''',

          '.Rmd': '''---
jupyter:
  jupytext:
    main_language: python
---

'''}

ACTIVE_ALL = {'.py': """# + {"active": "ipynb,py,R,Rmd"}
# This cell is active in all extensions
""",
              '.Rmd': """```{python active="ipynb,py,R,Rmd"}
# This cell is active in all extensions
```
""",
              '.R': """# + {"active": "ipynb,py,R,Rmd"}
# This cell is active in all extensions
""",
              '.ipynb': {'cell_type': 'code',
                         'source': '# This cell is active in all extensions',
                         'metadata': {'active': 'ipynb,py,R,Rmd'},
                         'execution_count': None,
                         'outputs': []}}


@pytest.mark.parametrize('ext', ['.Rmd', '.py', '.R'])
def test_active_all(ext, no_jupytext_version_number):
    nb = jupytext.reads(HEADER[ext] + ACTIVE_ALL[ext], ext)
    assert len(nb.cells) == 1
    compare(ACTIVE_ALL[ext], jupytext.writes(nb, ext))
    compare(nb.cells[0], ACTIVE_ALL['.ipynb'])


ACTIVE_IPYNB = {'.py': """# + {"active": "ipynb"}
# # This cell is active only in ipynb
# %matplotlib inline
""",
                '.Rmd': """```{python active="ipynb", eval=FALSE}
# This cell is active only in ipynb
%matplotlib inline
```
""",
                '.R': """# + {"active": "ipynb"}
# # This cell is active only in ipynb
# %matplotlib inline
""",
                '.ipynb': {'cell_type': 'code',
                           'source': '# This cell is active only in ipynb\n'
                                     '%matplotlib inline',
                           'metadata': {'active': 'ipynb'},
                           'execution_count': None,
                           'outputs': []}}


@skip_if_dict_is_not_ordered
@pytest.mark.parametrize('ext', ['.Rmd', '.py', '.R'])
def test_active_ipynb(ext, no_jupytext_version_number):
    nb = jupytext.reads(HEADER[ext] + ACTIVE_IPYNB[ext], ext)
    assert len(nb.cells) == 1
    compare(ACTIVE_IPYNB[ext], jupytext.writes(nb, ext))
    compare(nb.cells[0], ACTIVE_IPYNB['.ipynb'])


ACTIVE_IPYNB_RMD_USING_TAG = {'.py': """# + {"tags": ["active-ipynb-Rmd"]}
# # This cell is active only in ipynb and Rmd
# %matplotlib inline
""",
                              '.Rmd': """```{python tags=c("active-ipynb-Rmd")}
# This cell is active only in ipynb and Rmd
# %matplotlib inline
```
""",
                              '.R': """# + {"tags": ["active-ipynb-Rmd"]}
# # This cell is active only in ipynb and Rmd
# %matplotlib inline
""",
                              '.ipynb': {'cell_type': 'code',
                                         'source': '# This cell is active only in ipynb and Rmd\n'
                                                   '%matplotlib inline',
                                         'metadata': {'tags': ['active-ipynb-Rmd']},
                                         'execution_count': None,
                                         'outputs': []}}


@skip_if_dict_is_not_ordered
@pytest.mark.parametrize('ext', ['.Rmd', '.py', '.R'])
def test_active_ipynb_rmd_using_tags(ext, no_jupytext_version_number):
    nb = jupytext.reads(HEADER[ext] + ACTIVE_IPYNB_RMD_USING_TAG[ext], ext)
    assert len(nb.cells) == 1
    compare(ACTIVE_IPYNB_RMD_USING_TAG[ext], jupytext.writes(nb, ext))
    compare(nb.cells[0], ACTIVE_IPYNB_RMD_USING_TAG['.ipynb'])


ACTIVE_IPYNB_RSPIN = {'.R': """#+ active="ipynb", eval=FALSE
# # This cell is active only in ipynb
# 1 + 1
""",
                      '.ipynb': {'cell_type': 'code',
                                 'source': '# This cell is active only in ipynb\n'
                                           '1 + 1',
                                 'metadata': {'active': 'ipynb'},
                                 'execution_count': None,
                                 'outputs': []}}


@skip_if_dict_is_not_ordered
def test_active_ipynb_rspin(no_jupytext_version_number):
    nb = jupytext.reads(ACTIVE_IPYNB_RSPIN['.R'], 'R:spin')
    assert len(nb.cells) == 1
    compare(ACTIVE_IPYNB_RSPIN['.R'], jupytext.writes(nb, 'R:spin'))
    compare(nb.cells[0], ACTIVE_IPYNB_RSPIN['.ipynb'])


ACTIVE_PY_IPYNB = {'.py': """# + {"active": "ipynb,py"}
# This cell is active in py and ipynb extensions
""",
                   '.Rmd': """```{python active="ipynb,py", eval=FALSE}
# This cell is active in py and ipynb extensions
```
""",
                   '.R': """# + {"active": "ipynb,py"}
# # This cell is active in py and ipynb extensions
""",
                   '.ipynb': {'cell_type': 'code',
                              'source': '# This cell is active in py and '
                                        'ipynb extensions',
                              'metadata': {'active': 'ipynb,py'},
                              'execution_count': None,
                              'outputs': []}}


@skip_if_dict_is_not_ordered
@pytest.mark.parametrize('ext', ['.Rmd', '.py', '.R'])
def test_active_py_ipynb(ext, no_jupytext_version_number):
    nb = jupytext.reads(HEADER[ext] + ACTIVE_PY_IPYNB[ext], ext)
    assert len(nb.cells) == 1
    compare(ACTIVE_PY_IPYNB[ext], jupytext.writes(nb, ext))
    compare(nb.cells[0], ACTIVE_PY_IPYNB['.ipynb'])


ACTIVE_PY_R_IPYNB = {'.py': """# + {"active": "ipynb,py,R"}
# This cell is active in py, R and ipynb extensions
""",
                     '.Rmd': """```{python active="ipynb,py,R", eval=FALSE}
# This cell is active in py, R and ipynb extensions
```
""",
                     '.R': """# + {"active": "ipynb,py,R"}
# This cell is active in py, R and ipynb extensions
""",
                     '.ipynb': {'cell_type': 'code',
                                'source': '# This cell is active in py, R and '
                                          'ipynb extensions',
                                'metadata': {'active': 'ipynb,py,R'},
                                'execution_count': None,
                                'outputs': []}}


@skip_if_dict_is_not_ordered
@pytest.mark.parametrize('ext', ['.Rmd', '.py', '.R'])
def test_active_py_r_ipynb(ext, no_jupytext_version_number):
    nb = jupytext.reads(HEADER[ext] + ACTIVE_PY_R_IPYNB[ext], ext)
    assert len(nb.cells) == 1
    compare(ACTIVE_PY_R_IPYNB[ext], jupytext.writes(nb, ext))
    compare(nb.cells[0], ACTIVE_PY_R_IPYNB['.ipynb'])


ACTIVE_RMD = {'.py': """# + {"active": "Rmd"}
# # This cell is active in Rmd only
""",
              '.Rmd': """```{python active="Rmd"}
# This cell is active in Rmd only
```
""",
              '.R': """# + {"active": "Rmd"}
# # This cell is active in Rmd only
""",
              '.ipynb': {'cell_type': 'raw',
                         'source': '# This cell is active in Rmd only',
                         'metadata': {'active': 'Rmd'}}}


@skip_if_dict_is_not_ordered
@pytest.mark.parametrize('ext', ['.Rmd', '.py', '.R'])
def test_active_rmd(ext, no_jupytext_version_number):
    nb = jupytext.reads(HEADER[ext] + ACTIVE_RMD[ext], ext)
    assert len(nb.cells) == 1
    compare(ACTIVE_RMD[ext], jupytext.writes(nb, ext))
    compare(nb.cells[0], ACTIVE_RMD['.ipynb'])


ACTIVE_NOT_INCLUDE_RMD = {'.py': """# + {"hide_output": true, "active": "Rmd"}
# # This cell is active in Rmd only
""",
                          '.Rmd': """```{python include=FALSE, active="Rmd"}
# This cell is active in Rmd only
```
""",
                          '.R': """# + {"hide_output": true, "active": "Rmd"}
# # This cell is active in Rmd only
""",
                          '.ipynb':
                              {'cell_type': 'raw',
                               'source': '# This cell is active in Rmd only',
                               'metadata': {'active': 'Rmd',
                                            'hide_output': True}}}


@skip_if_dict_is_not_ordered
@pytest.mark.parametrize('ext', ['.Rmd', '.py', '.R'])
def test_active_not_include_rmd(ext, no_jupytext_version_number):
    nb = jupytext.reads(ACTIVE_NOT_INCLUDE_RMD[ext], ext)
    assert len(nb.cells) == 1
    compare(ACTIVE_NOT_INCLUDE_RMD[ext], jupytext.writes(nb, ext))
    compare(nb.cells[0], ACTIVE_NOT_INCLUDE_RMD['.ipynb'])