Make functions in clean.py private. (#22)

Author: tobiasraabe

docs/changes.rst

@@ -12,8 +12,8 @@ all releases are available on `Anaconda.org <https://anaconda.org/pytask/pytask>
 - :gh:`16` reduces the traceback generated from tasks, failure section in report, fix
   error passing a file path to pytask, add demo to README.
 - :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.
+  path to a configuration file and adds ``pytask clean`` (:gh:`22` as well), 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.

src/_pytask/clean.py

@@ -16,7 +16,7 @@
 from _pytask.shared import to_path
 
 
-HELP_TEXT_MODE = (
+_HELP_TEXT_MODE = (
     "Choose 'dry-run' to print the paths of files/directories which would be removed, "
     "'interactive' for a confirmation prompt for every path, and 'force' to remove all "
     "unknown paths at once.  [default: dry-run]"
@@ -49,7 +49,7 @@ def pytask_parse_config(config, config_from_cli):
     "-m",
     "--mode",
     type=click.Choice(["dry-run", "interactive", "force"]),
-    help=HELP_TEXT_MODE,
+    help=_HELP_TEXT_MODE,
 )
 @click.option("-d", "--directories", is_flag=True, help="Remove whole directories.")
 @click.option(
@@ -83,9 +83,9 @@ def clean(**config_from_cli):
             session.hook.pytask_log_session_header(session=session)
             session.hook.pytask_collect(session=session)
 
-            known_paths = collect_all_paths_known_to_pytask(session)
+            known_paths = _collect_all_paths_known_to_pytask(session)
             include_directories = session.config["directories"]
-            unknown_paths = find_all_unknown_paths(
+            unknown_paths = _find_all_unknown_paths(
                 session, known_paths, include_directories
             )
 
@@ -120,15 +120,15 @@ def clean(**config_from_cli):
     return session
 
 
-def collect_all_paths_known_to_pytask(session):
+def _collect_all_paths_known_to_pytask(session):
     """Collect all paths from the session which are known to pytask.
 
     Paths belong to tasks and nodes and configuration values.
 
     """
     known_files = set()
     for task in session.tasks:
-        for path in yield_paths_from_task(task):
+        for path in _yield_paths_from_task(task):
             known_files.add(path)
 
     known_directories = set()
@@ -145,7 +145,7 @@ def collect_all_paths_known_to_pytask(session):
     return known_paths
 
 
-def yield_paths_from_task(task):
+def _yield_paths_from_task(task):
     """Yield all paths attached to a task."""
     yield task.path
     for attribute in ["depends_on", "produces"]:
@@ -154,44 +154,44 @@ def yield_paths_from_task(task):
                 yield node.value
 
 
-def find_all_unknown_paths(session, known_paths, include_directories):
+def _find_all_unknown_paths(session, known_paths, include_directories):
     """Find all unknown paths.
 
-    First, create a tree of :class:`RecursivePathNode`. Then, create a list of unknown
+    First, create a tree of :class:`_RecursivePathNode`. Then, create a list of unknown
     paths and potentially take short-cuts if complete directories can be deleted.
 
     """
     recursive_nodes = [
-        RecursivePathNode.from_path(path, known_paths)
+        _RecursivePathNode.from_path(path, known_paths)
         for path in session.config["paths"]
     ]
     unknown_paths = list(
         itertools.chain.from_iterable(
             [
-                find_all_unkown_paths_per_recursive_node(node, include_directories)
+                _find_all_unkown_paths_per_recursive_node(node, include_directories)
                 for node in recursive_nodes
             ]
         )
     )
     return unknown_paths
 
 
-def find_all_unkown_paths_per_recursive_node(node, include_directories):
+def _find_all_unkown_paths_per_recursive_node(node, include_directories):
     """Return unknown paths per recursive file node.
 
-    If ``"--directories"`` is given, take a short-cut and return only the path of the
+    If ``--directories`` is given, take a short-cut and return only the path of the
     directory and not the path of every single file in it.
 
     """
     if node.is_unknown and (node.is_file or (node.is_dir and include_directories)):
         yield node.path
     else:
         for n in node.sub_nodes:
-            yield from find_all_unkown_paths_per_recursive_node(n, include_directories)
+            yield from _find_all_unkown_paths_per_recursive_node(n, include_directories)
 
 
 @attr.s(repr=False)
-class RecursivePathNode:
+class _RecursivePathNode:
     """A class for a path to a file or directory which recursively instantiates itself.
 
     The problem is that we want to take a short-cut for unknown directories with only
@@ -219,7 +219,7 @@ def from_path(cls, path: Path, known_paths: list):
 
         """
         sub_nodes = (
-            [RecursivePathNode.from_path(p, known_paths) for p in path.glob("*")]
+            [_RecursivePathNode.from_path(p, known_paths) for p in path.iterdir()]
             if path.is_dir()
             else []
         )