Refactor pytask to two packages, pytask and _pytask. (#14)

Author: tobiasraabe

.github/workflows/continuous-integration-workflow.yml

@@ -35,7 +35,7 @@ jobs:
 
       - name: Run unit tests and doctests.
         shell: bash -l {0}
-        run: tox -e pytest -- -m "unit or (not integration and not end_to_end)" --cov=./ --cov-report=xml -n auto
+        run: tox -e pytest -- -m "unit or (not integration and not end_to_end)" --cov=./src --cov-report=xml -n auto
 
       - name: Upload coverage report for unit tests and doctests.
         if: runner.os == 'Linux' && matrix.python-version == '3.8'
@@ -44,7 +44,7 @@ jobs:
 
       - name: Run integration tests.
         shell: bash -l {0}
-        run: tox -e pytest -- -m integration --cov=./ --cov-report=xml -n auto
+        run: tox -e pytest -- -m integration --cov=./src --cov-report=xml -n auto
 
       - name: Upload coverage reports of integration tests.
         if: runner.os == 'Linux' && matrix.python-version == '3.8'
@@ -53,7 +53,7 @@ jobs:
 
       - name: Run end-to-end tests.
         shell: bash -l {0}
-        run: tox -e pytest -- -m end_to_end --cov=./ --cov-report=xml -n auto
+        run: tox -e pytest -- -m end_to_end --cov=./src --cov-report=xml -n auto
 
       - name: Upload coverage reports of end-to-end tests.
         if: runner.os == 'Linux' && matrix.python-version == '3.8'

codecov.yml

@@ -22,3 +22,4 @@ coverage:
 ignore:
   - ".tox/**/*"
   - "setup.py"
+  - "tests/**/*"

setup.cfg

@@ -1,7 +1,7 @@
 [bumpversion]
 current_version = 0.0.4
 parse = (?P<major>\d+)\.(?P<minor>\d+)(\.(?P<patch>\d+))(\-?((dev)?(?P<dev>\d+))?)
-serialize = 
+serialize =
 	{major}.{minor}.{patch}dev{dev}
 	{major}.{minor}.{patch}
 
@@ -10,3 +10,5 @@ serialize =
 [bumpversion:file:docs/conf.py]
 
 [bumpversion:file:src/pytask/__init__.py]
+
+[bumpversion:file:src/_pytask/__init__.py]

setup.py

@@ -36,7 +36,7 @@
         "Programming Language :: Python :: 3.8",
     ],
     platforms="any",
-    entry_points={"console_scripts": ["pytask=pytask.cli:pytask"]},
+    entry_points={"console_scripts": ["pytask=pytask:pytask"]},
     packages=find_packages(where="src"),
     package_dir={"": "src"},
 )

src/_pytask/__init__.py

@@ -0,0 +1 @@
+__version__ = "0.0.4"

src/pytask/cli.py renamed to src/_pytask/cli.py

@@ -2,8 +2,8 @@
 from pathlib import Path
 
 import click
-from pytask.config import hookimpl
-from pytask.pluginmanager import get_plugin_manager
+from _pytask.config import hookimpl
+from _pytask.pluginmanager import get_plugin_manager
 
 
 CONTEXT_SETTINGS = {"help_option_names": ["-h", "--help"]}
@@ -28,17 +28,17 @@ def _prepare_plugin_manager():
 
 @hookimpl
 def pytask_add_hooks(pm):
-    from pytask import collect
-    from pytask import config
-    from pytask import database
-    from pytask import debugging
-    from pytask import execute
-    from pytask import logging
-    from pytask import main
-    from pytask import parametrize
-    from pytask import resolve_dependencies
-    from pytask import skipping
-    from pytask import mark_
+    from _pytask import collect
+    from _pytask import config
+    from _pytask import database
+    from _pytask import debugging
+    from _pytask import execute
+    from _pytask import logging
+    from _pytask import main
+    from _pytask import parametrize
+    from _pytask import resolve_dependencies
+    from _pytask import skipping
+    from _pytask import mark
 
     pm.register(collect)
     pm.register(config)
@@ -50,7 +50,7 @@ def pytask_add_hooks(pm):
     pm.register(parametrize)
     pm.register(resolve_dependencies)
     pm.register(skipping)
-    pm.register(mark_)
+    pm.register(mark)
 
 
 def _to_path(ctx, param, value):  # noqa: U100

src/pytask/collect.py renamed to src/_pytask/collect.py

@@ -8,18 +8,18 @@
 from pathlib import Path
 
 import click
-import pytask
-from pytask.exceptions import CollectionError
-from pytask.exceptions import TaskDuplicatedError
-from pytask.mark_ import has_marker
-from pytask.nodes import FilePathNode
-from pytask.nodes import PythonFunctionTask
-from pytask.report import CollectionReport
-from pytask.report import CollectionReportFile
-from pytask.report import CollectionReportTask
-
-
-@pytask.hookimpl
+from _pytask.config import hookimpl
+from _pytask.exceptions import CollectionError
+from _pytask.exceptions import TaskDuplicatedError
+from _pytask.mark import has_marker
+from _pytask.nodes import FilePathNode
+from _pytask.nodes import PythonFunctionTask
+from _pytask.report import CollectionReport
+from _pytask.report import CollectionReportFile
+from _pytask.report import CollectionReportTask
+
+
+@hookimpl
 def pytask_collect(session):
     reports = _collect_from_paths(session)
     tasks = _extract_tasks_from_reports(reports)
@@ -66,13 +66,13 @@ def _collect_from_paths(session):
     return collected_reports
 
 
-@pytask.hookimpl
+@hookimpl
 def pytask_ignore_collect(path, config):
     ignored = any(fnmatch.fnmatch(path, pattern) for pattern in config["ignore"])
     return ignored
 
 
-@pytask.hookimpl
+@hookimpl
 def pytask_collect_file_protocol(session, path, reports):
     try:
         reports = session.hook.pytask_collect_file(
@@ -85,7 +85,7 @@ def pytask_collect_file_protocol(session, path, reports):
     return reports
 
 
-@pytask.hookimpl
+@hookimpl
 def pytask_collect_file(session, path, reports):
     if path.name.startswith("task_") and path.suffix == ".py":
         spec = importlib.util.spec_from_file_location(path.stem, str(path))
@@ -115,7 +115,7 @@ def pytask_collect_file(session, path, reports):
         return collected_reports
 
 
-@pytask.hookimpl
+@hookimpl
 def pytask_collect_task_protocol(session, reports, path, name, obj):
     try:
         session.hook.pytask_collect_task_setup(
@@ -132,7 +132,7 @@ def pytask_collect_task_protocol(session, reports, path, name, obj):
         return CollectionReportTask.from_exception(path, name, exc_info)
 
 
-@pytask.hookimpl(trylast=True)
+@hookimpl(trylast=True)
 def pytask_collect_task_setup(session, reports, path, name):
     paths_to_tasks_w_ident_name = [
         i.path.as_posix()
@@ -148,7 +148,7 @@ def pytask_collect_task_setup(session, reports, path, name):
         )
 
 
-@pytask.hookimpl(trylast=True)
+@hookimpl(trylast=True)
 def pytask_collect_task(session, path, name, obj):
     """Collect a task which is a function.
 
@@ -163,7 +163,7 @@ def pytask_collect_task(session, path, name, obj):
         )
 
 
-@pytask.hookimpl(trylast=True)
+@hookimpl(trylast=True)
 def pytask_collect_node(path, node):
     """Collect a node of a task as a :class:`pytask.nodes.FilePathNode`.
 
@@ -219,7 +219,7 @@ def _extract_tasks_from_reports(reports):
     return [i.task for i in reports if i.successful]
 
 
-@pytask.hookimpl
+@hookimpl
 def pytask_collect_log(session, reports, tasks):
     tm_width = session.config["terminal_width"]
 

src/pytask/config.py renamed to src/_pytask/config.py

@@ -8,8 +8,8 @@
 
 import click
 import pluggy
-from pytask.shared import get_first_not_none_value
-from pytask.shared import to_list
+from _pytask.shared import get_first_not_none_value
+from _pytask.shared import to_list
 
 
 hookimpl = pluggy.HookimplMarker("pytask")

src/pytask/dag.py renamed to src/_pytask/dag.py

@@ -1,9 +1,9 @@
 from pathlib import Path
 
 import click
-import pytask
+from _pytask.config import hookimpl
+from _pytask.shared import get_first_not_none_value
 from pony import orm
-from pytask.shared import get_first_not_none_value
 
 
 db = orm.Database()
@@ -35,7 +35,7 @@ def create_or_update_state(first_key, second_key, state):
         state_in_db.state = state
 
 
-@pytask.hookimpl
+@hookimpl
 def pytask_add_parameters_to_cli(command):
     additional_parameters = [
         click.Option(
@@ -60,7 +60,7 @@ def pytask_add_parameters_to_cli(command):
     command.params.extend(additional_parameters)
 
 
-@pytask.hookimpl
+@hookimpl
 def pytask_parse_config(config, config_from_cli, config_from_file):
     provider = get_first_not_none_value(
         config_from_cli, config_from_file, key="database_provider", default="sqlite"

src/pytask/database.py renamed to src/_pytask/database.py

@@ -3,12 +3,12 @@
 import traceback
 
 import click
-import pytask
-from pytask.nodes import PythonFunctionTask
-from pytask.shared import get_first_not_none_value
+from _pytask.config import hookimpl
+from _pytask.nodes import PythonFunctionTask
+from _pytask.shared import get_first_not_none_value
 
 
-@pytask.hookimpl
+@hookimpl
 def pytask_add_parameters_to_cli(command):
     additional_parameters = [
         click.Option(
@@ -24,7 +24,7 @@ def pytask_add_parameters_to_cli(command):
     command.params.extend(additional_parameters)
 
 
-@pytask.hookimpl
+@hookimpl
 def pytask_parse_config(config, config_from_cli, config_from_file):
     config["pdb"] = get_first_not_none_value(
         config_from_cli, config_from_file, key="pdb", default=False
@@ -34,7 +34,7 @@ def pytask_parse_config(config, config_from_cli, config_from_file):
     )
 
 
-@pytask.hookimpl
+@hookimpl
 def pytask_post_parse(config):
     if config["pdb"]:
         config["pm"].register(PdbDebugger)
@@ -45,7 +45,7 @@ def pytask_post_parse(config):
 
 class PdbDebugger:
     @staticmethod
-    @pytask.hookimpl(hookwrapper=True)
+    @hookimpl(hookwrapper=True)
     def pytask_execute_task(task):
         if isinstance(task, PythonFunctionTask):
             task.function = wrap_function_for_post_mortem_debugging(task.function)
@@ -67,7 +67,7 @@ def wrapper(*args, **kwargs):
 
 class PdbTrace:
     @staticmethod
-    @pytask.hookimpl(hookwrapper=True)
+    @hookimpl(hookwrapper=True)
     def pytask_execute_task(task):
         if isinstance(task, PythonFunctionTask):
             task.function = wrap_function_for_tracing(task.function)

src/pytask/debugging.py renamed to src/_pytask/debugging.py

@@ -4,18 +4,17 @@
 import traceback
 
 import click
-import pytask
-from pytask import hookimpl
-from pytask.dag import descending_tasks
-from pytask.dag import node_and_neigbors
-from pytask.dag import sort_tasks_topologically
-from pytask.database import create_or_update_state
-from pytask.exceptions import ExecutionError
-from pytask.exceptions import NodeNotFoundError
-from pytask.mark_ import Mark
-from pytask.nodes import FilePathNode
-from pytask.report import ExecutionReport
-from pytask.report import format_execute_footer
+from _pytask.config import hookimpl
+from _pytask.dag import descending_tasks
+from _pytask.dag import node_and_neigbors
+from _pytask.dag import sort_tasks_topologically
+from _pytask.database import create_or_update_state
+from _pytask.exceptions import ExecutionError
+from _pytask.exceptions import NodeNotFoundError
+from _pytask.mark import Mark
+from _pytask.nodes import FilePathNode
+from _pytask.report import ExecutionReport
+from _pytask.report import format_execute_footer
 
 
 @hookimpl
@@ -139,7 +138,7 @@ def pytask_execute_task_log_end(report):
     return True
 
 
-@pytask.hookimpl
+@hookimpl
 def pytask_execute_log_end(session, reports):
     session.execution_end = time.time()
     click.echo("")

src/pytask/enums.py renamed to src/_pytask/enums.py

@@ -1,20 +1,21 @@
 import platform
 import sys
+from typing import List
 
+import _pytask
 import click
 import pluggy
-import pytask
-from _pytest.terminal import _plugin_nameversions
+from _pytask.config import hookimpl
 
 
-@pytask.hookimpl
+@hookimpl
 def pytask_log_session_header(session):
     tm_width = session.config["terminal_width"]
 
     click.echo(f"{{:=^{tm_width}}}".format(" Start pytask session "), nl=True)
     click.echo(
         f"Platform: {sys.platform} -- Python {platform.python_version()}, "
-        f"pytask {pytask.__version__}, pluggy {pluggy.__version__}"
+        f"pytask {_pytask.__version__}, pluggy {pluggy.__version__}"
     )
     click.echo(f"Root: {session.config['root'].as_posix()}")
     if session.config["ini"] is not None:
@@ -24,3 +25,17 @@ def pytask_log_session_header(session):
     if plugin_info:
         formatted_plugins_w_versions = ", ".join(_plugin_nameversions(plugin_info))
         click.echo(f"Plugins: {formatted_plugins_w_versions}")
+
+
+def _plugin_nameversions(plugininfo) -> List[str]:
+    values = []  # type: List[str]
+    for _, dist in plugininfo:
+        # Gets us name and version!
+        name = f"{dist.project_name}-{dist.version}"
+        # Questionable convenience, but it keeps things short.
+        if name.startswith("pytask-"):
+            name = name[7:]
+        # We decided to print python package names they can have more than one plugin.
+        if name not in values:
+            values.append(name)
+    return values