Merge pull request #773 from dimitri-yatsenko/master

fix #771 - rename `hash.key_hash` into `hash.hash_key_values`.

Author: eywalker

datajoint/hash.py

@@ -4,12 +4,14 @@
 from pathlib import Path
 
 
-def key_hash(key):
+def hash_key_values(mapping):
     """
-    32-byte hash used for lookup of primary keys of jobs
+    32-byte hash of the mapping's key values sorted by the key name.
+    This is often used to convert a long primary key value into a shorter hash.
+    For example, the JobTable in datajoint.jobs uses this function to hash the primary key of autopopulated tables.
     """
     hashed = hashlib.md5()
-    for k, v in sorted(key.items()):
+    for k, v in sorted(mapping.items()):
         hashed.update(str(v).encode())
     return hashed.hexdigest()
 

datajoint/jobs.py

@@ -1,5 +1,5 @@
-from .hash import key_hash
 import os
+from .hash import hash_key_values
 import platform
 from .table import Table
 from .settings import config
@@ -69,7 +69,7 @@ def reserve(self, table_name, key):
         """
         job = dict(
             table_name=table_name,
-            key_hash=key_hash(key),
+            key_hash=hash_key_values(key),
             status='reserved',
             host=platform.node(),
             pid=os.getpid(),
@@ -89,7 +89,7 @@ def complete(self, table_name, key):
         :param table_name: `database`.`table_name`
         :param key: the dict of the job's primary key
         """
-        job_key = dict(table_name=table_name, key_hash=key_hash(key))
+        job_key = dict(table_name=table_name, key_hash=hash_key_values(key))
         (self & job_key).delete_quick()
 
     def error(self, table_name, key, error_message, error_stack=None):
@@ -107,7 +107,7 @@ def error(self, table_name, key, error_message, error_stack=None):
             self.insert1(
                 dict(
                     table_name=table_name,
-                    key_hash=key_hash(key),
+                    key_hash=hash_key_values(key),
                     status="error",
                     host=platform.node(),
                     pid=os.getpid(),