Refactor: Simplify interfaces, expose more functions (#33)

Author: hmgaudecker

CHANGES.md

@@ -6,6 +6,7 @@ releases are available on [conda-forge](https://anaconda.org/conda-forge/dags).
 
 ## 0.3.0
 
+- :gh:`33` Simplify interfaces, expose more functions (:ghuser:`hmgaudecker`)
 - :gh:`29` Improve namespace handling, allow for relative paths (:ghuser:`hmgaudecker`)
 - :gh:`31` Refactor `dag_tree` (:ghuser:`hmgaudecker`)
 - :gh:`28` Expose relevant functions for working with function trees (:ghuser:`hmgaudecker`)

pixi.lock

@@ -5,7 +5,6 @@ requires-python = ">=3.10"
 dynamic = ["version"]
 dependencies = [
     "networkx",
-    "types-networkx",
     "flatten-dict",
 ]
 classifiers = [
@@ -89,10 +88,11 @@ pre-commit = "*"
 pytest = "*"
 pytest-cov = "*"
 pytest-xdist = "*"
-mypy = "==1.15.0"
+mypy = "~=1.15"
 
 [tool.pixi.pypi-dependencies]
 dags = {path = ".", editable = true}
+types-networkx = "*"
 pdbp = "*"
 
 # Features and Tasks
@@ -106,16 +106,16 @@ tests-with-cov = "pytest tests --cov-report=xml --cov=./"
 # --------------------------------------------------------------------------------------
 
 [tool.pixi.feature.py310.dependencies]
-python = "~=3.10.0"
+python = "~=3.10"
 
 [tool.pixi.feature.py311.dependencies]
-python = "~=3.11.0"
+python = "~=3.11"
 
 [tool.pixi.feature.py312.dependencies]
-python = "~=3.12.0"
+python = "~=3.12"
 
 [tool.pixi.feature.py313.dependencies]
-python = "~=3.13.0"
+python = "~=3.13"
 
 # Environments
 # --------------------------------------------------------------------------------------

pyproject.toml

@@ -169,7 +169,7 @@ def _create_combined_function_from_dag(
         targets,
     )
 
-    _arglist = _create_arguments_of_concatenated_function(_functions, dag)
+    _arglist = create_arguments_of_concatenated_function(_functions, dag)
     _exec_info = _create_execution_info(_functions, dag)
     _concatenated = _create_concatenated_function(
         _exec_info,
@@ -333,12 +333,12 @@ def _create_complete_dag(
 
     """
     functions_arguments_dict = {
-        name: _get_free_arguments(function) for name, function in functions.items()
+        name: get_free_arguments(function) for name, function in functions.items()
     }
     return nx.DiGraph(functions_arguments_dict).reverse()  # type: ignore[arg-type]
 
 
-def _get_free_arguments(
+def get_free_arguments(
     func: GenericCallable,
 ) -> list[str]:
     arguments = list(inspect.signature(func).parameters)
@@ -379,7 +379,7 @@ def _limit_dag_to_targets_and_their_ancestors(
     return dag
 
 
-def _create_arguments_of_concatenated_function(
+def create_arguments_of_concatenated_function(
     functions: dict[str, GenericCallable],
     dag: nx.DiGraph[str],
 ) -> list[str]:
@@ -418,7 +418,7 @@ def _create_execution_info(
     out = {}
     for node in nx.topological_sort(dag):
         if node in functions:
-            arguments = _get_free_arguments(functions[node])
+            arguments = get_free_arguments(functions[node])
             out[node] = FunctionExecutionInfo(func=functions[node], arguments=arguments)
     return out
 

src/dags/dag.py

@@ -4,6 +4,8 @@
     concatenate_functions_tree,
     create_dag_tree,
     create_input_structure_tree,
+    functions_without_tree_logic,
+    one_function_without_tree_logic,
 )
 from dags.tree.tree_utils import (
     QUAL_NAME_DELIMITER,
@@ -18,6 +20,7 @@
 )
 from dags.tree.validation import (
     fail_if_path_elements_have_trailing_undersores,
+    fail_if_paths_are_invalid,
     fail_if_top_level_elements_repeated_in_paths,
     fail_if_top_level_elements_repeated_in_single_path,
 )
@@ -27,7 +30,10 @@
     "create_input_structure_tree",
     "create_dag_tree",
     "concatenate_functions_tree",
+    "functions_without_tree_logic",
+    "one_function_without_tree_logic",
     # Validation functions
+    "fail_if_paths_are_invalid",
     "fail_if_path_elements_have_trailing_undersores",
     "fail_if_top_level_elements_repeated_in_paths",
     "fail_if_top_level_elements_repeated_in_single_path",