tmux-python/libtmux

unknown pytest option --doctest-docutils-modules

dvzrv opened this issue · 7 comments

dvzrv commented

Hi! I'm currently updating to 0.23.0post0 on Arch Linux and ran into the issue, that the setup.cfg declares an option to pytest that is not understood.

This is probably due to some pytest plugin or similar not being around or some version mismatch on your target test infrastructure.

ERROR: usage: pytest [options] [file_or_dir] [file_or_dir] [...]
pytest: error: unrecognized arguments: --doctest-docutils-modules
  inifile: /build/python-libtmux/src/libtmux-0.23.0post0/setup.cfg
  rootdir: /build/python-libtmux/src/libtmux-0.23.0post0

This is (roughly) how the package is being built: https://gitlab.archlinux.org/archlinux/packaging/packages/python-libtmux/-/blob/main/PKGBUILD
Here are the full build/test logs:
python-libtmux-0.23.0post0-1-x86_64-check.log
python-libtmux-0.23.0post0-1-x86_64-build.log

After using sed to replace --doctest-docutils-modules with --doctest-modules the tests work.

tony commented

@dvzrv Does 0.23.0 (without the post0) give this issue, too?

Are you able to tell if gp-libs is installed along py.test?

gp-libs (homepage, github) is a test dependency and where the --doctest-docutils-modules comes from

dvzrv commented

@dvzrv Does 0.23.0 (without the post0) give this issue, too?

I haven't checked.

Are you able to tell if gp-libs is installed along py.test?

No I'm not installing/packaging that. It is not in the test environment.

gp-libs (homepage, github) is a test dependency and where the --doctest-docutils-modules comes from

I have been orienting according to this block to figure out what are the relevant test requirements for me.

Hm, guess I need to package yet another package 🥲

tony commented

Hm, guess I need to package yet another package 🥲

Yes I think so - as a test dependency. gp-libs is also used by tmuxp, vcspull, and python-libvcs.

gp-libs' --doctest-docutils-modules lets tests be ran on markdown code, so, assume these lines on README.md, code examples like that get ran on py.test.

Shouldn't this be in the test dependencies section in the pyproject.toml? And not (only) in the docs section?

tony commented
tony commented

@johanneskastl @dvzrv If you try v0.24.1 (PyPI, github release, changelog), is anything different?

@johanneskastl @dvzrv If you try v0.24.1 (PyPI, github release, changelog), is anything different?

See #508 for my findings. The unknown pytest option error was worked around by adding it to the dependencies in the openSUSE packaging already, so it's up to @dvzrv to test and report back :-)