added disable_warnings instruction to .coveragerc

[alexpdev]

Every time I run the test suite using tox -e py -- scrapy tests -n auto on WindowsOS I always receive about a dozen repeated CoverageWarnings.

Example:

.pkg: _optional_hooks> python C:\Users\asp\Documents\Code\clones\scrapy\venv\lib\site-packages\pyproject_api\_backend.py True setuptools.build_meta __legacy__
.pkg: get_requires_for_build_sdist> python C:\Users\asp\Documents\Code\clones\scrapy\venv\lib\site-packages\pyproject_api\_backend.py True setuptools.build_meta __legacy__
.pkg: prepare_metadata_for_build_wheel> python C:\Users\asp\Documents\Code\clones\scrapy\venv\lib\site-packages\pyproject_api\_backend.py True setuptools.build_meta __legacy__
.pkg: build_sdist> python C:\Users\asp\Documents\Code\clones\scrapy\venv\lib\site-packages\pyproject_api\_backend.py True setuptools.build_meta __legacy__
py: install_package> python -I -m pip install -ctests/upper-constraints.txt --force-reinstall --no-deps C:\Users\asp\Documents\Code\clones\scrapy\.tox\.tmp\package\97\Scrapy-2.7.1.tar.gz
py: commands[0]> pytest --cov=scrapy --cov-report=xml --cov-report= scrapy tests -n auto
C:\Users\asp\Documents\Code\clones\scrapy\.tox\py\lib\site-packages\coverage\inorout.py:460: CoverageWarning: --include is ignored because --source is set (include-ignored)
  self.warn("--include is ignored because --source is set", slug="include-ignored")
C:\Users\asp\Documents\Code\clones\scrapy\.tox\py\lib\site-packages\coverage\inorout.py:460: CoverageWarning: --include is ignored because --source is set (include-ignored)
  self.warn("--include is ignored because --source is set", slug="include-ignored")
C:\Users\asp\Documents\Code\clones\scrapy\.tox\py\lib\site-packages\coverage\inorout.py:460: CoverageWarning: --include is ignored because --source is set (include-ignored)
  self.warn("--include is ignored because --source is set", slug="include-ignored")
C:\Users\asp\Documents\Code\clones\scrapy\.tox\py\lib\site-packages\coverage\inorout.py:460: CoverageWarning: --include is ignored because --source is set (include-ignored)
  self.warn("--include is ignored because --source is set", slug="include-ignored")
C:\Users\asp\Documents\Code\clones\scrapy\.tox\py\lib\site-packages\coverage\inorout.py:460: CoverageWarning: --include is ignored because --source is set (include-ignored)
  self.warn("--include is ignored because --source is set", slug="include-ignored")
C:\Users\asp\Documents\Code\clones\scrapy\.tox\py\lib\site-packages\coverage\inorout.py:460: CoverageWarning: --include is ignored because --source is set (include-ignored)
  self.warn("--include is ignored because --source is set", slug="include-ignored")
C:\Users\asp\Documents\Code\clones\scrapy\.tox\py\lib\site-packages\coverage\inorout.py:460: CoverageWarning: --include is ignored because --source is set (include-ignored)
  self.warn("--include is ignored because --source is set", slug="include-ignored")
C:\Users\asp\Documents\Code\clones\scrapy\.tox\py\lib\site-packages\coverage\inorout.py:460: CoverageWarning: --include is ignored because --source is set (include-ignored)
  self.warn("--include is ignored because --source is set", slug="include-ignored")
C:\Users\asp\Documents\Code\clones\scrapy\.tox\py\lib\site-packages\coverage\inorout.py:460: CoverageWarning: --include is ignored because --source is set (include-ignored)
  self.warn("--include is ignored because --source is set", slug="include-ignored")
C:\Users\asp\Documents\Code\clones\scrapy\.tox\py\lib\site-packages\coverage\inorout.py:460: CoverageWarning: --include is ignored because --source is set (include-ignored)
  self.warn("--include is ignored because --source is set", slug="include-ignored")
C:\Users\asp\Documents\Code\clones\scrapy\.tox\py\lib\site-packages\coverage\inorout.py:460: CoverageWarning: --include is ignored because --source is set (include-ignored)
  self.warn("--include is ignored because --source is set", slug="include-ignored")
C:\Users\asp\Documents\Code\clones\scrapy\.tox\py\lib\site-packages\coverage\inorout.py:460: CoverageWarning: --include is ignored because --source is set (include-ignored)
  self.warn("--include is ignored because --source is set", slug="include-ignored")
C:\Users\asp\Documents\Code\clones\scrapy\.tox\py\lib\site-packages\coverage\inorout.py:460: CoverageWarning: --include is ignored because --source is set (include-ignored)
  self.warn("--include is ignored because --source is set", slug="include-ignored")
C:\Users\asp\Documents\Code\clones\scrapy\.tox\py\lib\site-packages\coverage\inorout.py:460: CoverageWarning: --include is ignored because --source is set (include-ignored)
  self.warn("--include is ignored because --source is set", slug="include-ignored")
C:\Users\asp\Documents\Code\clones\scrapy\.tox\py\lib\site-packages\coverage\inorout.py:460: CoverageWarning: --include is ignored because --source is set (include-ignored)
  self.warn("--include is ignored because --source is set", slug="include-ignored")
C:\Users\asp\Documents\Code\clones\scrapy\.tox\py\lib\site-packages\coverage\inorout.py:460: CoverageWarning: --include is ignored because --source is set (include-ignored)
  self.warn("--include is ignored because --source is set", slug="include-ignored")
==================================================================================== test session starts =====================================================================================
platform win32 -- Python 3.10.9, pytest-7.2.1, pluggy-1.0.0
...
...

This happens on linux as well but it doesn't seem to repeat so many times. This doesn't seem to have any effect on the results of the tests, so it really isn't an issue, however I did a quick google search on the warning and found this fix.

So I added the line disable_warnings = include-ignored to the scrapy coverage.rc file and it successfully removed all of the warnings. So with all that in mind I decided to submit this PR suggesting adding the line to coverage.rc

[codecov]

Codecov Report

Merging #5820 (69d6894) into master (874a879) will not change coverage.
The diff coverage is n/a.

❗ Current head 69d6894 differs from pull request most recent head d366782. Consider uploading reports for the commit d366782 to get more accurate results

@@           Coverage Diff           @@
##           master    #5820   +/-   ##
=======================================
  Coverage   88.94%   88.94%           
=======================================
  Files         162      162           
  Lines       11002    11002           
  Branches     1798     1798           
=======================================
  Hits         9786     9786           
  Misses        937      937           
  Partials      279      279           

[alexpdev]

I didn't realize disabling a warning would have such detrimental impacts to the coverage results.

Is that accurate?

[Gallaecio]

Is that accurate?

I don’t believe so 😞