Add hook to sort __all__. (#459)

Author: tobiasraabe

.pre-commit-config.yaml

@@ -39,6 +39,10 @@ repos:
 #     rev: 1.2.0
 #     hooks:
 #     -   id: pyproject-fmt
+-   repo: https://github.com/aio-libs/sort-all
+    rev: v1.2.0
+    hooks:
+    -   id: sort-all
 -   repo: https://github.com/psf/black
     rev: 23.9.1
     hooks:

docs/source/changes.md

@@ -14,6 +14,7 @@ releases are available on [PyPI](https://pypi.org/project/pytask) and
   execution.
 - {pull}`456` refers to the source code on Github when clicking on a source link.
 - {pull}`457` refactors everything around formatting node names.
+- {pull}`459` adds a pre-commit hook to sort `__all__`.
 
 ## 0.4.1 - 2023-10-11
 

src/_pytask/collect_utils.py

@@ -40,8 +40,8 @@
 __all__ = [
     "depends_on",
     "parse_dependencies_from_task_function",
-    "parse_products_from_task_function",
     "parse_nodes",
+    "parse_products_from_task_function",
     "produces",
 ]
 

src/_pytask/console.py

@@ -39,12 +39,12 @@
 
 
 __all__ = [
+    "console",
     "create_summary_panel",
-    "create_url_style_for_task",
     "create_url_style_for_path",
-    "console",
-    "format_task_name",
+    "create_url_style_for_task",
     "format_strings_as_flat_tree",
+    "format_task_name",
     "get_file",
     "is_jupyter",
     "render_to_string",

src/_pytask/database_utils.py

@@ -18,10 +18,10 @@
 
 
 __all__ = [
-    "create_database",
-    "update_states_in_database",
     "BaseTable",
     "DatabaseSession",
+    "create_database",
+    "update_states_in_database",
 ]
 
 

src/_pytask/traceback.py

@@ -20,8 +20,8 @@
 
 __all__ = [
     "format_exception_without_traceback",
-    "remove_internal_traceback_frames_from_exception",
     "remove_internal_traceback_frames_from_exc_info",
+    "remove_internal_traceback_frames_from_exception",
     "remove_traceback_from_exc_info",
     "render_exc_info",
 ]

src/_pytask/tree_util.py

@@ -14,13 +14,13 @@
 
 
 __all__ = [
+    "PyTree",
+    "TREE_UTIL_LIB_DIRECTORY",
     "tree_flatten_with_path",
     "tree_leaves",
     "tree_map",
     "tree_map_with_path",
     "tree_structure",
-    "PyTree",
-    "TREE_UTIL_LIB_DIRECTORY",
 ]
 
 TREE_UTIL_LIB_DIRECTORY = Path(optree.__file__).parent

src/pytask/__init__.py

@@ -92,21 +92,21 @@
     "ExecutionReport",
     "Exit",
     "ExitCode",
-    "PathNode",
     "Mark",
     "MarkDecorator",
     "MarkGenerator",
     "MetaNode",
     "NodeInfo",
     "NodeNotCollectedError",
     "NodeNotFoundError",
-    "PathNode",
-    "Persisted",
     "PNode",
     "PPathNode",
-    "Product",
     "PTask",
     "PTaskWithPath",
+    "PathNode",
+    "PathNode",
+    "Persisted",
+    "Product",
     "PytaskError",
     "PythonNode",
     "ResolvingDependenciesError",

src/pytask/tree_util.py

@@ -10,10 +10,10 @@
 
 
 __all__ = [
+    "PyTree",
     "tree_flatten_with_path",
     "tree_leaves",
     "tree_map",
     "tree_map_with_path",
     "tree_structure",
-    "PyTree",
 ]