motest 0.1.1

Small cli that allows for more elborate testing inside Marimo

motest

Small cli that allows for more elaborate testing inside Marimo

This project was made so I might more easily write elaborate tests in side of Marimo notebooks. It is barely worth the effort because you can also just add the commands together in a Makefile, but it was a fun exercise that led me to learn how pytest can be called directly from Python.

Installation

uv pip install motest

Usage

Suppose that you have a notebook some_notebook.py that you want to test. Maybe with the following content:

import marimo as mo
import pytest

def add(a, b):
    return a + b

@pytest.mark.parametrize("a,b,c", [(1, 1, 2), (1, 2, 3)])
def test_add(a, b, c):
    assert add(a, b) == c

You can test this notebook by running the following command:

python -m motest some_notebook.py

This is what the output will look like:

============================= test session starts ==============================
platform darwin -- Python 3.10.14, pytest-8.3.4, pluggy-1.5.0
rootdir: /Users/vincent/Development/motest
configfile: pyproject.toml
plugins: anyio-4.7.0
collected 2 items                                                              

test_some_notebook.py ..                                                   [100%]

============================== 2 passed in 0.11s ===============================

How it works

The setup is really minimal. We call the marimo export script command and write the Python code to a temporary file. We then point pytest to this file and do a cleanup after the tests are done. The status code is returned to the caller and you are also able to pass any pytest arguments to the command as well.

You could accomplish the same thing by adding this to a Makefile:

test:
    marimo export script -o test_some_notebook.py some_notebook.py
    python -m pytest test_some_notebook.py

But it kind of felt nicer to have a dedicated command for this.