Docstring at top of file effects test coverage

[mjbvz]

Testing #22827

For a file:

"""
A module for incrementing and decrementing numbers.
"""

def increment(x):
    """Increment x by 1, but not above 10."""
    return x + 1

The presence of the docstring at the top of the file changes coverage numbers

[eleanorjboyd]

What version of python are you using?

[mjbvz]

3.12.2 with Coverage 7.6.1

[eleanorjboyd]

same as another issue filed by Ben, I don't control this aspect so I think I am going to just close as out of scope

copied from #24171 (comment): huh even with the right python version I am not seeing the comments impact code coverage. Did you have any pytest arguments during this run? I think I can just close this since the decision on the code coverage percentage / numbers are dictated by coverage.py and communicated the extension so in the end we don't have control over the numbers as long as they are getting there correctly. You could always try running it in the terminal python -m pytest --cov=. to see if you get a similar result because our goal is to always mirror the tool behavior.

[mjbvz]

Should we move this upstream to pytest?

[eleanorjboyd]

yes I can look into doing so for coverage. Can you confirm python -m pytest --cov=. in the terminal produces the same change and also get the versions of pytest-cov and coverage.py in your workspace? Thanks