New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Better guidance in --result-log deprecation warning #2739

Closed
thebjorn opened this Issue Aug 31, 2017 · 1 comment

Comments

Projects
None yet
2 participants
@thebjorn

thebjorn commented Aug 31, 2017

The current warnings summary when using --result-log looks like this:

============================== warnings summary ===============================
None
  --result-log is deprecated and scheduled for removal in pytest 4.0
 
-- Docs: http://doc.pytest.org/en/latest/warnings.html
 
==================== 17 passed, 1 warnings in 3.76 seconds ====================

which doesn't give any information on what to use instead, possible work-arounds, links to more information, etc.

The link to warnings.html looks promising but is a red-herring. Perhaps a more distinctive way of indicating that it isn't related to the --result-log warning can be found?

I wasn't actually using the output of --result-log for anything so the easiest solution was just to remove the usage of the switch (but I didn't think to look at the contents until after I'd found #1812 and #830..)

@nicoddemus

This comment has been minimized.

Member

nicoddemus commented Aug 31, 2017

@thebjorn you are absolutely right, we should include a link in the warnings message to the Creating resultlog format files section in the docs, and update that section with guidance for users on how to deal with the deprecation.

I think one of the suggestions was to use pytest-tap or create a new external plugin which would generate a stream of JSON objects.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment