Release 0.0.5 and better tasks ids and selection of tasks. (#15)

Author: tobiasraabe

.conda/meta.yaml

@@ -13,7 +13,7 @@ build:
   noarch: python
   number: 0
   entry_points:
-    - pytask = pytask.cli:pytask
+    - pytask = _pytask.cli:pytask
 
 requirements:
   host:

docs/api.rst

@@ -0,0 +1,12 @@
+API Reference
+=============
+
+This page contains auto-generated API reference documentation [#f1]_.
+
+.. toctree::
+   :titlesonly:
+
+   /autoapi/pytask/index
+   /autoapi/_pytask/index
+
+.. [#f1] Created with `sphinx-autoapi <https://github.com/readthedocs/sphinx-autoapi>`_

docs/changes.rst

@@ -6,13 +6,15 @@ chronological order. Releases follow `semantic versioning <https://semver.org/>`
 all releases are available on `Anaconda.org <https://anaconda.org/pytask/pytask>`_.
 
 
-0.0.5 - 2020-xx-xx
+0.0.5 - 2020-08-12
 ------------------
 
 - :gh:`10` turns parametrization into a plugin.
 - :gh:`11` extends the documentation.
 - :gh:`12` replaces ``pytest.mark`` with ``pytask.mark``.
 - :gh:`13` implements selecting tasks via expressions or marker expressions.
+- :gh:`14` separates the namespace of pytask to ``pytask`` and ``_pytask``.
+- :gh:`15` implements better tasks ids which allow and releases 0.0.5.
 
 
 0.0.4 - 2020-07-22

docs/conf.py

@@ -19,7 +19,7 @@
 author = "Tobias Raabe"
 
 # The full version, including alpha/beta/rc tags
-release = "0.0.4"
+release = "0.0.5"
 
 
 # -- General configuration -------------------------------------------------------------
@@ -51,6 +51,8 @@
 # html_extra_path.
 exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
 
+suppress_warnings = ["ref.python"]
+
 # -- Extensions configuration ----------------------------------------------------------
 
 # Configuration for autodoc
@@ -74,8 +76,9 @@
 
 # Configuration for autoapi
 autoapi_type = "python"
-autoapi_dirs = ["../src/pytask"]
+autoapi_dirs = ["../src"]
 autoapi_keep_files = False
+autoapi_add_toctree_entry = False
 
 
 # -- Options for HTML output -----------------------------------------------------------

docs/index.rst

@@ -119,3 +119,4 @@ The documentation has currently one of four planned parts.
 
    glossary
    changes
+   api

docs/reference_guides/hookspecs.rst

@@ -1,7 +1,7 @@
 Hook Specifications
 ===================
 
-.. currentmodule:: pytask.hookspecs
+.. currentmodule:: _pytask.hookspecs
 
 Hook specifications are the :term:`entry-points <entry-point>` provided by pytask to
 change the behavior of the program.

docs/reference_guides/marks.rst

@@ -8,19 +8,19 @@ in the host or in plugins. The following marks are available by default.
 pytask.mark.depends_on
 ----------------------
 
-.. autofunction:: pytask.nodes.depends_on
+.. autofunction:: _pytask.nodes.depends_on
    :noindex:
 
 
 pytask.mark.produces
 --------------------
 
-.. autofunction:: pytask.nodes.produces
+.. autofunction:: _pytask.nodes.produces
    :noindex:
 
 
 pytask.mark.parametrize
 -----------------------
 
-.. autofunction:: pytask.parametrize.parametrize
+.. autofunction:: _pytask.parametrize.parametrize
    :noindex:

docs/tutorials/how_to_configure_pytask.rst

@@ -47,3 +47,29 @@ configuration file.
 
     markers =
         wip: Work-in-progress. These are tasks which I am currently working on.
+
+
+ignore
+------
+
+pytask can ignore files and directories and exclude some tasks or reduce the duration of
+the collection.
+
+To ignore some file/folder via the command line, use the ``--ignore`` flag multiple
+times.
+
+.. code-block:: bash
+
+    $ pytask --ignore */some_file.py --ignore */some_directory/*
+
+Or, use the configuration file:
+
+.. code-block:: ini
+
+    # For single entries only.
+    ignore = */some_file.py
+
+    # Or single and multiple entries.
+    ignore =
+        */some_directory/*
+        */some_file.py

docs/tutorials/how_to_select_tasks.rst

@@ -79,3 +79,9 @@ will execute the first and third task and
     $ pytask -k "1 and not 2"
 
 executes only the first task.
+
+To execute a single task, say ``task_run_this_one``, in ``task_example.py``, use
+
+.. code-block:: bash
+
+    $ pytask -k task_example.py::task_run_this_one

setup.cfg

@@ -1,7 +1,7 @@
 [bumpversion]
-current_version = 0.0.4
+current_version = 0.0.5
 parse = (?P<major>\d+)\.(?P<minor>\d+)(\.(?P<patch>\d+))(\-?((dev)?(?P<dev>\d+))?)
-serialize =
+serialize = 
 	{major}.{minor}.{patch}dev{dev}
 	{major}.{minor}.{patch}
 

setup.py

@@ -15,17 +15,17 @@
 
 setup(
     name="pytask",
-    version="0.0.4",
+    version="0.0.5",
     description=DESCRIPTION,
     long_description=DESCRIPTION + "\n\n" + README,
     long_description_content_type="text/x-rst",
     author="Tobias Raabe",
     author_email="[email protected]",
-    python_requires=">=3.6.0",
+    python_requires=">=3.6",
     url=PROJECT_URLS["Documentation"],
     project_urls=PROJECT_URLS,
     license="None",
-    keywords=["Economics", " Discrete Choice Dynamic Programming Model"],
+    keywords=["Build System"],
     classifiers=[
         "Development Status :: 2 - Pre-Alpha",
         "Framework :: pytask",
@@ -36,7 +36,7 @@
         "Programming Language :: Python :: 3.8",
     ],
     platforms="any",
-    entry_points={"console_scripts": ["pytask=pytask:pytask"]},
+    entry_points={"console_scripts": ["pytask=_pytask.cli:pytask"]},
     packages=find_packages(where="src"),
     package_dir={"": "src"},
 )

src/_pytask/__init__.py

@@ -1 +1 @@
-__version__ = "0.0.4"
+__version__ = "0.0.5"

src/_pytask/cli.py

@@ -9,14 +9,14 @@
 CONTEXT_SETTINGS = {"help_option_names": ["-h", "--help"]}
 
 
-def add_parameters(func):
+def add_parameters(command):
     """Add parameters from plugins to the commandline interface."""
     pm = _prepare_plugin_manager()
-    pm.hook.pytask_add_parameters_to_cli(command=func)
+    pm.hook.pytask_add_parameters_to_cli(command=command)
     # Hack to pass the plugin manager via a hidden option to the ``config_from_cli``.
-    func.params.append(click.Option(["--pm"], default=pm, hidden=True))
+    command.params.append(click.Option(["--pm"], default=pm, hidden=True))
 
-    return func
+    return command
 
 
 def _prepare_plugin_manager():

src/_pytask/collect.py

@@ -2,15 +2,13 @@
 import glob
 import importlib
 import inspect
-import pprint
 import sys
 import traceback
 from pathlib import Path
 
 import click
 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
@@ -132,22 +130,6 @@ def pytask_collect_task_protocol(session, reports, path, name, obj):
         return CollectionReportTask.from_exception(path, name, exc_info)
 
 
-@hookimpl(trylast=True)
-def pytask_collect_task_setup(session, reports, path, name):
-    paths_to_tasks_w_ident_name = [
-        i.path.as_posix()
-        for i in reports
-        if not isinstance(i, CollectionReportFile) and i.name == name
-    ]
-    if paths_to_tasks_w_ident_name:
-        formatted = pprint.pformat(
-            paths_to_tasks_w_ident_name, width=session.config["terminal_width"]
-        )
-        raise TaskDuplicatedError(
-            f"Task '{name}' in '{path}' has the same name as task(s):\n   {formatted}"
-        )
-
-
 @hookimpl(trylast=True)
 def pytask_collect_task(session, path, name, obj):
     """Collect a task which is a function.
@@ -187,7 +169,7 @@ def pytask_collect_node(path, node):
         node = Path(node)
     if isinstance(node, Path):
         if not node.is_absolute():
-            node = path.parent.joinpath(node).resolve()
+            node = path.parent.joinpath(node)
         return FilePathNode.from_path(node)
 
 
@@ -202,7 +184,7 @@ def valid_paths(paths, session):
     ----------
     paths : List[pathlib.Path]
         List of paths from which tasks are collected.
-    session : pytask.main.Session
+    session : _pytask.session.Session
         The session.
 
     """

src/_pytask/config.py

@@ -9,6 +9,7 @@
 import click
 import pluggy
 from _pytask.shared import get_first_not_none_value
+from _pytask.shared import parse_value_or_multiline_option
 from _pytask.shared import to_list
 
 
@@ -54,6 +55,9 @@ def pytask_configure(pm, config_from_cli):
 
 @hookimpl
 def pytask_parse_config(config, config_from_cli, config_from_file):
+    config_from_file["ignore"] = parse_value_or_multiline_option(
+        config_from_file.get("ignore")
+    )
     config["ignore"] = (
         get_first_not_none_value(
             config_from_cli,

src/_pytask/enums.py

@@ -4,14 +4,24 @@
 class ExitCode(enum.IntEnum):
     """Exit codes for pytask."""
 
-    # Tasks were executed successfully.
     OK = 0
+    """Tasks were executed successfully."""
 
-    # Failed while executing tasks.
     FAILED = 1
+    """Failed while executing tasks."""
 
-    # Failed while collecting tasks.
     COLLECTION_FAILED = 2
+    """Failed while collecting tasks."""
 
-    # Failed while resolving dependencies.
     RESOLVING_DEPENDENCIES_FAILED = 3
+    """Failed while resolving dependencies."""
+
+
+class ColorCode(enum.Enum):
+    """Color codes for pytask."""
+
+    SUCCESS = "green"
+
+    FAILED = "red"
+
+    SKIPPED = "yellow"

src/_pytask/exceptions.py

@@ -20,7 +20,3 @@ class ResolvingDependenciesError(PytaskError):
 
 class ExecutionError(PytaskError):
     """Exception during execution."""
-
-
-class TaskDuplicatedError(PytaskError):
-    """Exception for duplicated task during collection."""

src/_pytask/execute.py

@@ -9,6 +9,7 @@
 from _pytask.dag import node_and_neigbors
 from _pytask.dag import sort_tasks_topologically
 from _pytask.database import create_or_update_state
+from _pytask.enums import ColorCode
 from _pytask.exceptions import ExecutionError
 from _pytask.exceptions import NodeNotFoundError
 from _pytask.mark import Mark
@@ -131,9 +132,9 @@ def pytask_execute_task_process_report(session, report):
 @hookimpl(trylast=True)
 def pytask_execute_task_log_end(report):
     if report.success:
-        click.secho(".", fg="green", nl=False)
+        click.secho(".", fg=ColorCode.SUCCESS.value, nl=False)
     else:
-        click.secho("F", fg="red", nl=False)
+        click.secho("F", fg=ColorCode.FAILED.value, nl=False)
 
     return True
 

src/_pytask/mark/__init__.py

@@ -141,7 +141,7 @@ def from_task(cls, task) -> "KeywordMatcher":
         mapped_names = {task.name}
 
         # Add the names attached to the current function through direct assignment.
-        function_obj = getattr(task, "function", None)
+        function_obj = task.function
         if function_obj:
             mapped_names.update(function_obj.__dict__)