Write table report progress messages to stderr

[priscilla-b]

Towards #1175

[Vincent-Maladiere]

Hello @priscilla-b, thank you for this PR, LGTM :)

Woops, actually, need to look at what is failing in the CI

[priscilla-b]

Woops, actually, need to look at what is failing in the CI

Yeahh trying to figure that out @Vincent-Maladiere
Will add to the changelog, but can't figure out why the others are failing.

[Vincent-Maladiere]

So the issue comes from doctest, which checks that examples in the docstring match their expected value.

We configured pytest to run doctest at the beginning of the test suite:

skrub/pyproject.toml

Lines 276 to 277 in 4cdd5d9

	addopts = "--doctest-modules"
	doctest_optionflags = "NORMALIZE_WHITESPACE ELLIPSIS"

You can reproduce this error with:

from skrub import TableReport
import doctest

doctest.run_docstring_examples(
    TableReport,
    globals(),
    optionflags=doctest.NORMALIZE_WHITESPACE + doctest.ELLIPSIS
)

And to fix it, you have to replace Processing ... with <BLANKLINE> in the docstring of skrub/_reporting/_table_report.py L86

Let me know if this works for you :)

[priscilla-b]

So the issue comes from doctest, which checks that examples in the docstring match their expected value.

Yes, I was able to reproduce it !
And the fix works, thank you :)

[Vincent-Maladiere]

Great! This time, LGTM

[jeromedockes]

Thanks a lot @priscilla-b ! super useful 🚀 . a couple of small adjustments and we can merge it!

[jeromedockes]

I think the second print to add a newline on line 103 should also go to stderr

[priscilla-b]

Got it, will work on that

[jeromedockes]

once all progress output goes to stderr I think you will need to change the test_verbosity_parameter above to replace out with err

[priscilla-b]

Alright, that makes sense

[jeromedockes]

LGTM 🎉 thanks a lot @priscilla-b 👍