Improve ignore patterns and add test. (#19)

Author: tobiasraabe

docs/changes.rst

@@ -14,6 +14,8 @@ all releases are available on `Anaconda.org <https://anaconda.org/pytask/pytask>
 - :gh:`17` changes the interface to subcommands, adds ``"-c/--config"`` option to pass a
   path to a configuration file and adds ``pytask clean``, a command to clean your
   project.
+- :gh:`18` changes the documentation theme to alabaster.
+- :gh:`19` adds some changes related to ignored folders.
 - :gh:`20` fixes copying code examples in the documentation.
 
 

docs/tutorials/how_to_configure_pytask.rst

@@ -25,8 +25,6 @@ stable root and will store the information about tasks, dependencies, and produc
 the same directory as the configuration file.
 
 
-.. _tutorial_configure_markers:
-
 markers
 -------
 
@@ -67,9 +65,9 @@ Or, use the configuration file:
 .. code-block:: ini
 
     # For single entries only.
-    ignore = */some_file.py
+    ignore = some_file.py
 
     # Or single and multiple entries.
     ignore =
-        */some_directory/*
-        */some_file.py
+        some_directory/*
+        some_file.py

src/_pytask/config.py

@@ -16,20 +16,20 @@
 hookimpl = pluggy.HookimplMarker("pytask")
 
 
-IGNORED_FILES_AND_FOLDERS = [
-    "*/.git/*",
-    "*/.hg/*",
-    "*/.svn/*",
-    "*/.venv/*",
-    "*/*.egg-info/*",
-    "*/.ipynb_checkpoints/*",
-    "*/.mypy_cache/*",
-    "*/.nox/*",
-    "*/.tox/*",
-    "*/_build/*",
-    "*/__pycache__/*",
-    "*/build/*",
-    "*/dist/*",
+IGNORED_FOLDERS = [
+    ".git/*",
+    ".hg/*",
+    ".svn/*",
+    ".venv/*",
+    "*.egg-info/*",
+    ".ipynb_checkpoints/*",
+    ".mypy_cache/*",
+    ".nox/*",
+    ".tox/*",
+    "_build/*",
+    "__pycache__/*",
+    "build/*",
+    "dist/*",
 ]
 
 
@@ -80,7 +80,7 @@ def pytask_parse_config(config, config_from_cli, config_from_file):
             default=[],
             callback=to_list,
         )
-        + IGNORED_FILES_AND_FOLDERS
+        + IGNORED_FOLDERS
     )
 
     config["debug_pytask"] = get_first_not_none_value(

tests/test_config.py

@@ -4,9 +4,14 @@
 import pytest
 from _pytask.config import _find_project_root_and_ini
 from _pytask.config import _get_terminal_width
+from _pytask.config import IGNORED_FOLDERS
 from pytask import main
 
 
+_IGNORED_FOLDERS = [i.split("/")[0] for i in IGNORED_FOLDERS]
+_IGNORED_FOLDERS.remove("*.egg-info")
+
+
 @pytest.mark.unit
 @pytest.mark.parametrize(
     "in_ini, paths, expected_root, expected_ini",
@@ -79,6 +84,23 @@ def test_debug_pytask(capsys, tmp_path):
     assert "finish pytask_execute --> None [hook]" in captured.out
 
 
+@pytest.mark.end_to_end
+@pytest.mark.parametrize("ignored_folder", _IGNORED_FOLDERS + ["pytask.egg-info"])
+def test_ignore_default_paths(tmp_path, ignored_folder):
+    source = """
+    def task_dummy():
+        pass
+    """
+    tmp_path.joinpath(ignored_folder).mkdir()
+    tmp_path.joinpath(ignored_folder, "task_dummy.py").write_text(
+        textwrap.dedent(source)
+    )
+
+    session = main({"paths": tmp_path})
+    assert session.exit_code == 0
+    assert len(session.tasks) == 0
+
+
 @pytest.mark.end_to_end
 @pytest.mark.parametrize("config_path", ["pytask.ini", "tox.ini", "setup.cfg"])
 @pytest.mark.parametrize("ignore", ["", "*task_dummy.py"])