Skip to content

Commit 71cee05

Browse files
committed
Document lockfile id vs signature in custom node guide
1 parent b877aec commit 71cee05

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

docs/source/how_to_guides/writing_custom_nodes.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -89,6 +89,13 @@ Here are some explanations.
8989
signature is a hash and a unique identifier for the node. For most nodes it will be a
9090
hash of the path or the name.
9191

92+
- `signature` and lockfile `id` are different concepts.
93+
94+
- `signature` is the runtime identity in pytask's in-memory DAG.
95+
- lockfile `id` is the portable key stored in `pytask.lock`.
96+
97+
For custom nodes, make sure the lockfile id stays stable and unique within a task.
98+
9299
- The classmethod {meth}`~pytask.PickleNode.from_path` is a convenient method to
93100
instantiate the class.
94101

0 commit comments

Comments
 (0)