sphinx-examples-as-code 0.8.0__tar.gz → 0.8.1__tar.gz

{sphinx_examples_as_code-0.8.0 → sphinx_examples_as_code-0.8.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: sphinx-examples-as-code
-Version: 0.8.0
+Version: 0.8.1
 Summary: Sphinx extension for converting docstring examples into downloadable code.
 Author-email: The PyVista Developers <info@pyvista.org>
 License-Expression: MIT
@@ -96,7 +96,7 @@ sphinx_examples_as_code_conf = {
   (default) or `'bottom'`.
 - `formats`: which downloads to generate. A list containing any of `'python'` (a plain
   Python script, `<name>.py`), `'jupyter'` (a Jupyter notebook, `<name>.ipynb`) and
-  `'marimo'` (a marimo notebook, `<name>.marimo.py`); defaults to all three. Always
+  `'marimo'` (a marimo notebook, `<name>_marimo.py`); defaults to all three. Always
   offered in that order regardless of how the list is written. Without marimo 0.14 or
   newer installed, the default skips the marimo download, and a `formats` that names
   `'marimo'` (in `conf.py` or through `-D`) stops the build with a configuration error. An unknown format raises a configuration error too;
@@ -150,7 +150,7 @@ imports, plus any `dependencies` set for its format, and says how to run it:
   `"`, `$`, a backtick, `\`, `%` or a `!` not followed by `=` is single-quoted instead,
   which cmd does not understand.
 - marimo notebooks start with the same `# /// script` block, which also lists `marimo`,
-  followed by `# Open this notebook with: uvx marimo edit --sandbox <name>.marimo.py`.
+  followed by `# Open this notebook with: uvx marimo edit --sandbox <name>_marimo.py`.
 - Each run command is followed by a line linking to
   [uv's installation guide](https://docs.astral.sh/uv/getting-started/installation/).
 
@@ -221,7 +221,7 @@ cells instead.
 
 Generated marimo notebooks are that same Jupyter notebook converted by marimo's own
 converter, the one behind `marimo convert`. `from __future__` imports are dropped first,
-so the notebook also runs as a plain script (`python <name>.marimo.py`).
+so the notebook also runs as a plain script (`python <name>_marimo.py`).
 
 A download link is only added if the resulting code contains at least one real
 executable statement.

{sphinx_examples_as_code-0.8.0 → sphinx_examples_as_code-0.8.1}/README.md

@@ -64,7 +64,7 @@ sphinx_examples_as_code_conf = {
   (default) or `'bottom'`.
 - `formats`: which downloads to generate. A list containing any of `'python'` (a plain
   Python script, `<name>.py`), `'jupyter'` (a Jupyter notebook, `<name>.ipynb`) and
-  `'marimo'` (a marimo notebook, `<name>.marimo.py`); defaults to all three. Always
+  `'marimo'` (a marimo notebook, `<name>_marimo.py`); defaults to all three. Always
   offered in that order regardless of how the list is written. Without marimo 0.14 or
   newer installed, the default skips the marimo download, and a `formats` that names
   `'marimo'` (in `conf.py` or through `-D`) stops the build with a configuration error. An unknown format raises a configuration error too;
@@ -118,7 +118,7 @@ imports, plus any `dependencies` set for its format, and says how to run it:
   `"`, `$`, a backtick, `\`, `%` or a `!` not followed by `=` is single-quoted instead,
   which cmd does not understand.
 - marimo notebooks start with the same `# /// script` block, which also lists `marimo`,
-  followed by `# Open this notebook with: uvx marimo edit --sandbox <name>.marimo.py`.
+  followed by `# Open this notebook with: uvx marimo edit --sandbox <name>_marimo.py`.
 - Each run command is followed by a line linking to
   [uv's installation guide](https://docs.astral.sh/uv/getting-started/installation/).
 
@@ -189,7 +189,7 @@ cells instead.
 
 Generated marimo notebooks are that same Jupyter notebook converted by marimo's own
 converter, the one behind `marimo convert`. `from __future__` imports are dropped first,
-so the notebook also runs as a plain script (`python <name>.marimo.py`).
+so the notebook also runs as a plain script (`python <name>_marimo.py`).
 
 A download link is only added if the resulting code contains at least one real
 executable statement.

{sphinx_examples_as_code-0.8.0 → sphinx_examples_as_code-0.8.1}/sphinx_examples_as_code/__init__.py

@@ -181,6 +181,9 @@ _FMT_PYTHON = 'python'
 _FMT_JUPYTER = 'jupyter'
 _FMT_MARIMO = 'marimo'
 
+#: File name suffix of each download format, e.g. ``pyvista_read_marimo.py``.
+_SUFFIXES = {_FMT_PYTHON: '.py', _FMT_JUPYTER: '.ipynb', _FMT_MARIMO: '_marimo.py'}
+
 
 @dataclass(frozen=True)
 class _RenderContext:
@@ -931,13 +934,13 @@ def _build_notebook(cells: list[tuple[str, list[str]]]) -> dict:
     }
 
 
-def _download_filename(name: str, extension: str) -> str:
+def _download_filename(name: str, fmt: str) -> str:
     """Return the file name a download is written under, e.g. ``pyvista_read.py``."""
     safe_name = name.replace('.', '_') if name else 'example'
-    return f'{safe_name}.{extension}'
+    return f'{safe_name}{_SUFFIXES[fmt]}'
 
 
-def _write_download_file(app: Sphinx, name: str, extension: str, content: str) -> str:
+def _write_download_file(app: Sphinx, name: str, fmt: str, content: str) -> str:
     """Write generated content directly into the builder's downloads dir.
 
     Returns the written file's path relative to the downloads directory --
@@ -948,7 +951,7 @@ def _write_download_file(app: Sphinx, name: str, extension: str, content: str) -
     """
     # 32 hex chars, matching Sphinx's own native _downloads/<digest>/... layout.
     digest = hashlib.sha256(content.encode()).hexdigest()[:32]
-    filename = _download_filename(name, extension)
+    filename = _download_filename(name, fmt)
     rel_path = f'{digest}/{filename}'
 
     out_path = Path(app.outdir) / '_downloads' / digest / filename
@@ -959,12 +962,12 @@ def _write_download_file(app: Sphinx, name: str, extension: str, content: str) -
 
 def _write_python_script(app: Sphinx, name: str, source: str) -> str:
     """Write a generated Python script; see ``_write_download_file``."""
-    return _write_download_file(app, name, 'py', source)
+    return _write_download_file(app, name, _FMT_PYTHON, source)
 
 
 def _write_jupyter_notebook(app: Sphinx, name: str, notebook: dict) -> str:
     """Write a generated Jupyter notebook; see ``_write_download_file``."""
-    return _write_download_file(app, name, 'ipynb', json.dumps(notebook, indent=1))
+    return _write_download_file(app, name, _FMT_JUPYTER, json.dumps(notebook, indent=1))
 
 
 def _drop_future_imports(source: list[str]) -> list[str]:
@@ -995,7 +998,7 @@ def _write_marimo_notebook(app: Sphinx, name: str, notebook: dict, header: str =
         for cell in notebook['cells']
     ]
     source = MarimoConvert.from_ipynb(json.dumps({**notebook, 'cells': cells})).to_py()
-    return _write_download_file(app, name, 'marimo.py', header + source)
+    return _write_download_file(app, name, _FMT_MARIMO, header + source)
 
 
 @functools.cache
@@ -1304,18 +1307,16 @@ def _build_download_entries(
         if fmt not in formats:
             continue
         label = link_labels[fmt]
+        filename = _download_filename(name, fmt)
         if fmt == _FMT_PYTHON:
-            filename = _download_filename(name, 'py')
             header = header_for(fmt, f'Run this script with: uv run {filename}')
             rel_path = _write_python_script(app, name, header + source)
         elif fmt == _FMT_JUPYTER:
-            filename = _download_filename(name, 'ipynb')
             run_line = (
                 _jupyter_run_line(deps[fmt], requires_python_for(fmt), filename) if deps else None
             )
             rel_path = _write_jupyter_notebook(app, name, notebook_for(run_line))
         else:
-            filename = _download_filename(name, 'marimo.py')
             run_line = f'Open this notebook with: uvx marimo edit --sandbox {filename}'
             rel_path = _write_marimo_notebook(
                 app, name, notebook_for(None), header_for(fmt, run_line)

{sphinx_examples_as_code-0.8.0 → sphinx_examples_as_code-0.8.1}/sphinx_examples_as_code/_version.py

@@ -18,7 +18,7 @@ version_tuple: tuple[int | str, ...]
 commit_id: str | None
 __commit_id__: str | None
 
-__version__ = version = '0.8.0'
-__version_tuple__ = version_tuple = (0, 8, 0)
+__version__ = version = '0.8.1'
+__version_tuple__ = version_tuple = (0, 8, 1)
 
-__commit_id__ = commit_id = 'g35e7c7f07'
+__commit_id__ = commit_id = 'g6e63b87fa'

{sphinx_examples_as_code-0.8.0 → sphinx_examples_as_code-0.8.1}/sphinx_examples_as_code.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: sphinx-examples-as-code
-Version: 0.8.0
+Version: 0.8.1
 Summary: Sphinx extension for converting docstring examples into downloadable code.
 Author-email: The PyVista Developers <info@pyvista.org>
 License-Expression: MIT
@@ -96,7 +96,7 @@ sphinx_examples_as_code_conf = {
   (default) or `'bottom'`.
 - `formats`: which downloads to generate. A list containing any of `'python'` (a plain
   Python script, `<name>.py`), `'jupyter'` (a Jupyter notebook, `<name>.ipynb`) and
-  `'marimo'` (a marimo notebook, `<name>.marimo.py`); defaults to all three. Always
+  `'marimo'` (a marimo notebook, `<name>_marimo.py`); defaults to all three. Always
   offered in that order regardless of how the list is written. Without marimo 0.14 or
   newer installed, the default skips the marimo download, and a `formats` that names
   `'marimo'` (in `conf.py` or through `-D`) stops the build with a configuration error. An unknown format raises a configuration error too;
@@ -150,7 +150,7 @@ imports, plus any `dependencies` set for its format, and says how to run it:
   `"`, `$`, a backtick, `\`, `%` or a `!` not followed by `=` is single-quoted instead,
   which cmd does not understand.
 - marimo notebooks start with the same `# /// script` block, which also lists `marimo`,
-  followed by `# Open this notebook with: uvx marimo edit --sandbox <name>.marimo.py`.
+  followed by `# Open this notebook with: uvx marimo edit --sandbox <name>_marimo.py`.
 - Each run command is followed by a line linking to
   [uv's installation guide](https://docs.astral.sh/uv/getting-started/installation/).
 
@@ -221,7 +221,7 @@ cells instead.
 
 Generated marimo notebooks are that same Jupyter notebook converted by marimo's own
 converter, the one behind `marimo convert`. `from __future__` imports are dropped first,
-so the notebook also runs as a plain script (`python <name>.marimo.py`).
+so the notebook also runs as a plain script (`python <name>_marimo.py`).
 
 A download link is only added if the resulting code contains at least one real
 executable statement.

{sphinx_examples_as_code-0.8.0 → sphinx_examples_as_code-0.8.1}/sphinx_examples_as_code.egg-info/scm_version.json

@@ -1,7 +1,7 @@
 {
-  "tag": "0.8.0",
+  "tag": "0.8.1",
   "distance": 0,
-  "node": "g35e7c7f071baf732904a6fad8b7ea7a63f03d1f2",
+  "node": "g6e63b87faff4aa6f3530f1bbe7a85fad508570f9",
   "dirty": false,
   "branch": "HEAD",
   "node_date": "2026-11-01"

{sphinx_examples_as_code-0.8.0 → sphinx_examples_as_code-0.8.1}/tests/test_gallery_downloads.py

@@ -275,7 +275,7 @@ def test_gallery_downloads_generated_python_executes(gallery_build: tuple[Path,
 def test_gallery_downloads_marimo_notebook_executes(gallery_build: tuple[Path, str]):
     """The marimo notebook holds the page's code and runs as a plain script."""
     html_dir, _html = gallery_build
-    (marimo_path,) = (html_dir / '_downloads').rglob('*.marimo.py')
+    (marimo_path,) = (html_dir / '_downloads').rglob('*_marimo.py')
     src = marimo_path.read_text(encoding='utf-8')
     assert 'app = marimo.App(' in src
     assert 'A minimal gallery example' in src

{sphinx_examples_as_code-0.8.0 → sphinx_examples_as_code-0.8.1}/tests/test_single_function_page.py

@@ -29,7 +29,7 @@ def test_download_named_after_the_function_not_the_docname(tmp_path: Path):
     assert returncode == 0, f'sphinx build failed with stdout:\n{out}\nstderr:\n{err}\n'
 
     downloads_dir = html_dir / '_downloads'
-    python_files = [p for p in downloads_dir.rglob('*.py') if not p.name.endswith('.marimo.py')]
+    python_files = [p for p in downloads_dir.rglob('*.py') if not p.name.endswith('_marimo.py')]
     assert len(python_files) == 1, f'expected exactly one generated .py, got {python_files}'
     python_path = python_files[0]
 

{sphinx_examples_as_code-0.8.0 → sphinx_examples_as_code-0.8.1}/tests/test_sphinx_examples_as_code.py

@@ -1856,8 +1856,8 @@ def test_process_span_footer_in_notebook_is_linkified(tmp_path: Path):
         (['jupyter'], ['.ipynb']),
         (['python', 'jupyter'], ['.py', '.ipynb']),
         (['jupyter', 'python'], ['.py', '.ipynb']),  # canonical order regardless of config order
-        (['marimo'], ['.marimo.py']),
-        (['marimo', 'python', 'jupyter'], ['.py', '.ipynb', '.marimo.py']),
+        (['marimo'], ['_marimo.py']),
+        (['marimo', 'python', 'jupyter'], ['.py', '.ipynb', '_marimo.py']),
         ([], []),
     ],
 )

{sphinx_examples_as_code-0.8.0 → sphinx_examples_as_code-0.8.1}/tests/test_tinypages.py

@@ -92,7 +92,7 @@ def built(tmp_path_factory) -> tuple[Path, list[Path]]:
     assert returncode == 0, f'sphinx build failed with stdout:\n{out}\nstderr:\n{err}\n'
 
     downloads_dir = html_dir / '_downloads'
-    examples = sorted(p for p in downloads_dir.rglob('*.py') if not p.name.endswith('.marimo.py'))
+    examples = sorted(p for p in downloads_dir.rglob('*.py') if not p.name.endswith('_marimo.py'))
     return html_dir, examples
 
 
@@ -494,7 +494,7 @@ def test_formats_config_selection(
     assert returncode == 0, f'sphinx build failed with stdout:\n{out}\nstderr:\n{err}\n'
 
     downloads_dir = html_dir / '_downloads'
-    marimo_files = list(downloads_dir.rglob('*.marimo.py'))
+    marimo_files = list(downloads_dir.rglob('*_marimo.py'))
     python_files = [p for p in downloads_dir.rglob('*.py') if p not in marimo_files]
     jupyter_files = list(downloads_dir.rglob('*.ipynb'))
 
@@ -553,7 +553,7 @@ def test_base_url_set_resolves_links(tmp_path: Path):
     assert returncode == 0, f'sphinx build failed with stdout:\n{out}\nstderr:\n{err}\n'
 
     downloads_dir = html_dir / '_downloads'
-    python_files = [p for p in downloads_dir.rglob('*.py') if not p.name.endswith('.marimo.py')]
+    python_files = [p for p in downloads_dir.rglob('*.py') if not p.name.endswith('_marimo.py')]
     jupyter_files = list(downloads_dir.rglob('*.ipynb'))
 
     # a regular reference: link resolved in .ipynb, omitted in .py