py-pytest-html: Add version 3.2.0

[Jordan474]

Add py-pytest-html 3.2.0.

Add conflict with py-pytest@7.2:, due to conflicting py python modules (see PR comments). A reliable fix should come with py-pytest-html 4 (not released yet).

For the record, here is the errors you'd get with a conflicting py python module:

$ python3 -m pytest --version
[...]
  File "/.../spack/linux-ubuntu22.04-skylake/gcc-11.3.0/py-pytest-html-3.1.1-hhlwraizrwicneboermmg6ft7p37544k/lib/python3.10/site-packages/pytest_html/plugin.py", line 22, in <module>
    from py.xml import html
ModuleNotFoundError: No module named 'py.xml'; 'py' is not a package

Or

$ python3 -m pytest --version
[...]
  File "/.../spack/linux-ubuntu22.04-skylake/gcc-12.1.0/py-pytest-html-3.2.0-gujzhqzf4cjuahf4chqz5dtitohihzn2/lib/python3.10/site-packages/pytest_html/html_report.py", line 11, in <module>
    from py.xml import html
ModuleNotFoundError: No module named 'py.xml'; 'py' is not a package

[Jordan474]

EDIT: The conflicts directive did not fix all version combinations, the addition of the py-py dependency seems to work better.

[tldahlgren]

Confirmed the version sha256.

[Jordan474]

I think there is something shady going on with dependency ordering.

First, there is a python module name collision between import py as py.py in py-pytest and, import py.xml as py/{xml.py,__init__.py} in py-py. Not great, but if py-py is in PYTHONPATH before pytest, this seems ok.

But then, I don't understand Spack's dependency ordering:

• sometimes depending on if you add or remove the when in depends_on("py-py@1.8.2:", when="^py-pytest@7.2.0:", type=("build", "run")), you get different PYTHONPATH order, consistently
• sometimes the order changes between spack install --fresh py-pytest-html and spack install --fresh py-pytest-html ^py-pytest@7.3.2 maybe inconsistently

So I still get the ModuleNotFoundError: No module named 'py.xml'; 'py' is not a package error from time to time, but I cannot find what causes the bad order, or how to control it.

ADDENDUM: I confirm sometimes the install-time test would pass, but then spack load py-pytest-html; pytest -VV would fail again due to py-pytest being load before py-py.

[Jordan474]

I didn't expect this fix to go down a rabbit hole...

If there is no way to control PYTHONPATH order, I'm beginning to think it is safer to constrain to pytest@:7.1 pending pytest-html@4.0.0.

Maybe add 4.0.0rc4 as non-preferred ? (4.0.0rc4 not released on pypi yet)

EDIT: 4.0.0rc4 is not released on pypi.

[adamjstewart]

Oh, that's fun. I think the reason that no one else has complained is that the py.py file that comes with pytest 7.2+ will normally get overridden by the py/__init__.py file that comes with py, assuming that they're installed in the same directory. Since Spack installs them to different directories, we're completely dependent on the order of PYTHONPATH to control which gets used.

I don't think there's going to be a reliable way to control the order of this, especially if you have a root package that depends on all 3 of these packages. So I agree with the decision to pin to pytest 7.1 and older until the pytest-html 4.0 release.

[Jordan474]

I added the conflict. I wasn't sure about it until I found the install-test would pass but then spack load would set the faulty PYTHONPATH order:

$ spack install --fresh --test root py-pytest-html ^py-pytest@7.3.2
[... install ok ... test ok ...]

$ ( spack load py-pytest-html/...; pytest -VV )
[...]
ModuleNotFoundError: No module named 'py.xml'; 'py' is not a package

I'll edit the PR description.