Extend code coverage across sphinx-runpython utilities by Copilot · Pull Request #60 · sdpython/sphinx-runpython

Copilot · 2026-05-04T09:21:44Z

Code coverage was insufficient across several core modules. This PR adds tests to significantly improve coverage, with several modules reaching 100%.

Coverage improvements

Module	Before	After
`_cmd_helper.py`	62%	100%
`language.py`	20%	100%
`conf_helper.py`	77%	100%
`tools/latex_functions.py`	96%	100%
`process_rst.py`	77%	98%
`tools/img_export.py`	74%	97%
`ext_test_case.py`	64%	85%
`import_object_helper.py`	44%	89%
`github_link.py`	0%	79%
`runpython/run_cmd.py`	59%	65%

Total passing tests: 89 → 229

New test files

test_github_link.py — _linkcode_resolve, make_linkcode_resolve, import errors
test_language.py — TITLES, sphinx_lang with fake env objects
test_ext_helper.py — TinyNode, NodeEnter/Leave, traverse, WrappedNode
test_ext_io_helper.py — _get_file_url, exception classes, get_url_content_timeout
test_import_object_helper.py — import_object for all kinds (function/class/method/property/staticmethod), import_path, error paths
test_process_rst.py — docutils (use_sphinx=False) mode, invalid writer kwarg
test_readme_helpers.py — VirtualEnvError, build_venv_cmd, is_virtual_environment
test_ext_test_case.py — all ExtTestCase assertion helpers, hide_stdout, sys_path_append, platform guards

Extended existing tests

test_cmd.py — in-place latex processing, process_args for all commands (nb2py, api, latex, img2pdf, readme), main() entry point
test_helpers.py — mocked _check_cmd to cover both return paths without requiring dvipng/dvisvgm installed
test_run_cmd.py — get_interpreter_path, split_cmp_command, decode_outerr (including Unicode fallback and error paths), run_cmd with logf, change_path, catch_exit, prefix_log, wait=False
test_imgexport.py — single-file string input, glob string input, stream output, rotate+zoom with verbose, invalid inputs
test_latex_functions.py — callable pattern, invalid regex pattern, unknown value type

Warning

Firewall rules blocked me from connecting to one or more addresses (expand for details)

I tried to connect to the following addresses, but was blocked by firewall rules:

cdnjs.cloudflare.com
- Triggering command: /usr/bin/python /usr/bin/python -m sphinx -b rst /tmp/tmp45hzxrzf /tmp/tmp45hzxrzf/output /usr/local/bin/uname (dns block)
- Triggering command: /usr/bin/python /usr/bin/python -m sphinx -b rst /tmp/tmp7etbiibi /tmp/tmp7etbiibi/output /usr/sbin/uname (dns block)
- Triggering command: /usr/bin/python /usr/bin/python -m sphinx -b rst /tmp/tmphb4bjza6 /tmp/tmphb4bjza6/output /usr/bin/uname (dns block)
requirejs.org
- Triggering command: /usr/bin/python /usr/bin/python -m sphinx -b rst /tmp/tmp45hzxrzf /tmp/tmp45hzxrzf/output /usr/local/bin/uname (dns block)
- Triggering command: /usr/bin/python /usr/bin/python -m sphinx -b rst /tmp/tmp7etbiibi /tmp/tmp7etbiibi/output /usr/sbin/uname (dns block)
- Triggering command: /usr/bin/python /usr/bin/python -m sphinx -b rst /tmp/tmphb4bjza6 /tmp/tmphb4bjza6/output /usr/bin/uname (dns block)

If you need me to access, download, or install something from one of these locations, you can either:

Configure Actions setup steps to set up my environment, which run before the firewall is enabled
Add the appropriate URLs or hosts to the custom allowlist in this repository's Copilot coding agent settings (admins only)

Agent-Logs-Url: https://github.com/sdpython/sphinx-runpython/sessions/5f7ddf50-ca98-4180-bfc7-e949b3b79b24 Co-authored-by: xadupre <22452781+xadupre@users.noreply.github.com>

…_helper, process_rst, readme Agent-Logs-Url: https://github.com/sdpython/sphinx-runpython/sessions/5f7ddf50-ca98-4180-bfc7-e949b3b79b24 Co-authored-by: xadupre <22452781+xadupre@users.noreply.github.com>

…ther Agent-Logs-Url: https://github.com/sdpython/sphinx-runpython/sessions/5f7ddf50-ca98-4180-bfc7-e949b3b79b24 Co-authored-by: xadupre <22452781+xadupre@users.noreply.github.com>

xadupre · 2026-05-04T10:15:35Z

@copilot merge with main branch

…overage Co-authored-by: xadupre <22452781+xadupre@users.noreply.github.com>

Copilot · 2026-05-04T10:17:51Z

@copilot merge with main branch

Done — merged origin/main into this branch in commit 809c065. The merge brought in the GitHub Actions CI switch and ext_test_case.py docstring updates. All tests continue to pass.

sdpython · 2026-05-04T11:17:50Z

@copilot bypss _unittests/ut__main/test_cmd.py::TestCmd::test_process_args_readme on windows

xadupre · 2026-05-04T11:26:06Z

@copilot ignore _unittests/ut__main/test_cmd.py::TestCmd::test_process_args_readme on windows

Agent-Logs-Url: https://github.com/sdpython/sphinx-runpython/sessions/6bff9a98-f076-48c0-b958-a41e73f5b704 Co-authored-by: xadupre <22452781+xadupre@users.noreply.github.com>

Copilot · 2026-05-04T11:27:36Z

@copilot bypss _unittests/ut__main/test_cmd.py::TestCmd::test_process_args_readme on windows

Done — added @skipif_ci_windows("readme processing does not work on Windows") to test_process_args_readme in commit fb82f76.

@copilot ignore _unittests/ut__main/test_cmd.py::TestCmd::test_process_args_readme on windows

Done — test_process_args_readme is now skipped on Windows via @skipif_ci_windows in commit fb82f76.

xadupre · 2026-05-04T12:03:43Z

@copilot FAILED _unittests/ut__main/test_github_link.py::TestGithubLink::test_linkcode_resolve_function - ValueError: path is on mount 'D:', start on mount 'C:'
FAILED _unittests/ut__main/test_github_link.py::TestGithubLink::test_make_linkcode_resolve_call - ValueError: path is on mount 'D:', start on mount 'C:'
FAILED _unittests/ut__main/test_import_object_helper.py::TestImportObjectHelper::test_import_path_function - AssertionError: 'os' not found in 'ntpath'
FAILED _unittests/ut_runpython/test_run_cmd.py::TestRunCmd::test_run_cmd_with_change_path - AssertionError: 'C:\Users\runneradmin\AppData\Local\Temp\tmpgzi_gpay' not found in 'D:\tmp\tmpgzi_gpay'

Agent-Logs-Url: https://github.com/sdpython/sphinx-runpython/sessions/673d9b92-6119-4171-8dc5-2c28bc233e20 Co-authored-by: xadupre <22452781+xadupre@users.noreply.github.com>

Copilot · 2026-05-04T12:06:19Z

@copilot FAILED _unittests/ut__main/test_github_link.py::TestGithubLink::test_linkcode_resolve_function - ValueError: path is on mount 'D:', start on mount 'C:'
FAILED _unittests/ut__main/test_github...

Fixed in commit 4f3d669:

test_linkcode_resolve_function and test_make_linkcode_resolve_call — skipped on Windows via @skipif_ci_windows (cross-drive os.path.relpath raises ValueError when the repo and Python stdlib are on different drives).
test_import_path_function — assertion updated to accept ntpath (Windows) in addition to os/posixpath.
test_run_cmd_with_change_path — skipped on Windows via @skipif_ci_windows (pwd is Unix-only and temp dirs may be on a different drive than the working directory).

Agent-Logs-Url: https://github.com/sdpython/sphinx-runpython/sessions/15edfe84-fbd3-4ec9-a96d-dd20182e8f72 Co-authored-by: xadupre <22452781+xadupre@users.noreply.github.com>

Initial plan

0fbb3f2

Copilot AI assigned Copilot and xadupre May 4, 2026

Copilot started work on behalf of xadupre May 4, 2026 09:21 View session

Copilot AI linked an issue May 4, 2026 that may be closed by this pull request

extend code coverage #59

Closed

Copilot AI and others added 4 commits May 4, 2026 09:31

initial plan for code coverage extension

fec36a9

Agent-Logs-Url: https://github.com/sdpython/sphinx-runpython/sessions/5f7ddf50-ca98-4180-bfc7-e949b3b79b24 Co-authored-by: xadupre <22452781+xadupre@users.noreply.github.com>

Add tests to improve code coverage for multiple modules

cfd2e8f

Agent-Logs-Url: https://github.com/sdpython/sphinx-runpython/sessions/5f7ddf50-ca98-4180-bfc7-e949b3b79b24 Co-authored-by: xadupre <22452781+xadupre@users.noreply.github.com>

Add more tests for higher coverage: latex_functions, img_export, conf…

08b7d7e

…_helper, process_rst, readme Agent-Logs-Url: https://github.com/sdpython/sphinx-runpython/sessions/5f7ddf50-ca98-4180-bfc7-e949b3b79b24 Co-authored-by: xadupre <22452781+xadupre@users.noreply.github.com>

Add tests for run_cmd, ext_test_case utilities improving coverage fur…

fa9c4ee

…ther Agent-Logs-Url: https://github.com/sdpython/sphinx-runpython/sessions/5f7ddf50-ca98-4180-bfc7-e949b3b79b24 Co-authored-by: xadupre <22452781+xadupre@users.noreply.github.com>

Copilot AI changed the title ~~[WIP] Add tests to extend code coverage~~ Extend code coverage across sphinx-runpython utilities May 4, 2026

Copilot finished work on behalf of xadupre May 4, 2026 10:06

Copilot AI requested a review from xadupre May 4, 2026 10:06

Copilot started work on behalf of xadupre May 4, 2026 10:15 View session

Merge remote-tracking branch 'origin/main' into copilot/extend-code-c…

809c065

…overage Co-authored-by: xadupre <22452781+xadupre@users.noreply.github.com>

Copilot finished work on behalf of xadupre May 4, 2026 10:18

black

07b880c

Copilot started work on behalf of xadupre May 4, 2026 11:26 View session

Skip test_process_args_readme on Windows

fb82f76

Agent-Logs-Url: https://github.com/sdpython/sphinx-runpython/sessions/6bff9a98-f076-48c0-b958-a41e73f5b704 Co-authored-by: xadupre <22452781+xadupre@users.noreply.github.com>

Copilot finished work on behalf of xadupre May 4, 2026 11:28

Copilot started work on behalf of xadupre May 4, 2026 12:03 View session

Fix Windows CI failures in github_link, import_path, and run_cmd tests

4f3d669

Agent-Logs-Url: https://github.com/sdpython/sphinx-runpython/sessions/673d9b92-6119-4171-8dc5-2c28bc233e20 Co-authored-by: xadupre <22452781+xadupre@users.noreply.github.com>

Copilot finished work on behalf of xadupre May 4, 2026 12:07

sdpython marked this pull request as ready for review May 4, 2026 12:40

sdpython merged commit e805bf1 into main May 4, 2026
16 of 17 checks passed

Copilot AI mentioned this pull request May 4, 2026

Bump version to 0.4.4 and update changelog #64

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Extend code coverage across sphinx-runpython utilities#60

Extend code coverage across sphinx-runpython utilities#60
sdpython merged 9 commits into
mainfrom
copilot/extend-code-coverage

Copilot AI commented May 4, 2026 •

edited

Loading

Uh oh!

xadupre commented May 4, 2026

Uh oh!

Copilot AI commented May 4, 2026

Uh oh!

sdpython commented May 4, 2026

Uh oh!

xadupre commented May 4, 2026

Uh oh!

Copilot AI commented May 4, 2026 •

edited

Loading

Uh oh!

xadupre commented May 4, 2026

Uh oh!

Copilot AI commented May 4, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Conversation

Copilot AI commented May 4, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Coverage improvements

New test files

Extended existing tests

I tried to connect to the following addresses, but was blocked by firewall rules:

Uh oh!

xadupre commented May 4, 2026

Uh oh!

Copilot AI commented May 4, 2026

Uh oh!

sdpython commented May 4, 2026

Uh oh!

xadupre commented May 4, 2026

Uh oh!

Copilot AI commented May 4, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

xadupre commented May 4, 2026

Uh oh!

Copilot AI commented May 4, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Copilot AI commented May 4, 2026 •

edited

Loading

Copilot AI commented May 4, 2026 •

edited

Loading