fix pytest-dev#571: deprecate pytest_collect_directory as its missali…

…gned since 2010
RonnyPfannschmidt · Mar 1, 2020 · 933f302 · 933f302
1 parent 5fc80d8
commit 933f302
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 1 deletion.
diff --git a/changelog/571.deprecation.rst b/changelog/571.deprecation.rst
@@ -0,0 +1 @@
+Deprecate he unused/broken `pytest_collect_directory` hook.
diff --git a/src/_pytest/deprecated.py b/src/_pytest/deprecated.py
@@ -49,3 +49,8 @@
     "--no-print-logs is deprecated and scheduled for removal in pytest 6.0.\n"
     "Please use --show-capture instead."
 )
+
+COLLECT_DIRECTORY_HOOK = PytestDeprecationWarning(
+    "the pytest_collect_directory was intended to be deprecated since 2014\n"
+    "as it's missaligned since the removal of Directory as collector in 2010"
+)
diff --git a/src/_pytest/hookspec.py b/src/_pytest/hookspec.py
@@ -4,6 +4,7 @@
 
 from pluggy import HookspecMarker
 
+from .deprecated import COLLECT_DIRECTORY_HOOK
 from _pytest.compat import TYPE_CHECKING
 
 if TYPE_CHECKING:
@@ -205,7 +206,7 @@ def pytest_ignore_collect(path, config):
     """
 
 
-@hookspec(firstresult=True)
+@hookspec(firstresult=True, warn_on_impl=COLLECT_DIRECTORY_HOOK)
 def pytest_collect_directory(path, parent):
     """ called before traversing a directory for collection files.