Resolving Issue #10825

[ardavan34]

Hello,

This PR resolves #10825 issue. It is related to the new versions of PyTest and not reproducible on the main branch.

Description

If the user adds doctest to a test file, if there is a function in the code setup() or teardown() that is not used for test, they would be automatically called. This would basically cause a very long error message which is not even related to the actual test:

Solution

To avoid this long error message, I have added code for this edge case to basically ignore the error caused by it. A warning message is also added to inform the user about using a function name (setup or teardown) that might cause problem. Here is the new outcome for the same test:

This would make the API report only the actual test which is the other function, have a much cleaner output and inform the user about possible bugs that having a function in the specific name might have.

I hope it would come in handy.

Thanks,
Ardavan

[bluetech]

Thanks @ardavan34. Please see the comment I've just left on the issue #10825 (comment); unfortunately we can't accept a patch like you propose for backward compatibility reasons (also, the problem is that setup is executed at all, not just/if it raises an error). So we'll have to wait until the deprecation expires for the issue to be resolved.