Fixed interaction between discovery and htmlcov (#3836)

changelog.d/3836.misc.rst

@@ -0,0 +1,9 @@
+Fixed interaction between ``setuptools``' package auto-discovery and
+auto-generated ``htmlcov`` files.
+
+Previously, the ``htmlcov`` name was ignored when searching for single-file
+modules, however the correct behaviour is to ignore it when searching for
+packages (since it is supposed to be a directory, see `coverage config`_)
+-- by :user:`yukihiko-shinoda`.
+
+.. _coverage config: https://coverage.readthedocs.io/en/stable/config.html#html-directory

setuptools/discovery.py

@@ -234,6 +234,7 @@ class FlatLayoutPackageFinder(PEP420PackageFinder):
         "benchmarks",
         "exercise",
         "exercises",
+        "htmlcov",  # Coverage.py
         # ---- Hidden directories/Private packages ----
         "[._]*",
     )
@@ -273,7 +274,6 @@ class FlatLayoutModuleFinder(ModuleFinder):
         "benchmarks",
         "exercise",
         "exercises",
-        "htmlcov",
         # ---- Hidden files/Private modules ----
         "[._]*",
     )

setuptools/tests/test_find_packages.py

@@ -217,6 +217,7 @@ class TestFlatLayoutPackageFinder:
         ),
         "tool-specific": (
             [
+                "htmlcov/index.html",
                 "pkg/__init__.py",
                 "tasks/__init__.py",
                 "tasks/subpackage/__init__.py",