rename words_to_int to hashables_to_int

CHANGELOG.md

@@ -2,5 +2,5 @@
 
 * `memoize` will release the per-function lock while calling target function
 * added `cache_memoize`
-* added `words_to_int`
+* added `hashables_to_int`
 * added covariance to hashable for `satella.coding.typing.K`

docs/coding/transforms.rst

 Rudimentary data transforms and algorithms
 ==========================================
 
-.. autofunction:: satella.coding.transforms.words_to_int
+.. autofunction:: satella.coding.transforms.hashables_to_int
 
 .. autofunction:: satella.coding.transforms.linear_interpolate
 

satella/__init__.py

-__version__ = '2.14.19_a4'
+__version__ = '2.14.19_a5'

satella/coding/transforms/__init__.py

@@ -9,7 +9,7 @@ from .merger import merge_series
 from .percentile import percentile
 from .base64 import b64encode
 from .interpol import linear_interpolate
-from .words import words_to_int
+from .words import hashables_to_int
 
 __all__ = ['stringify', 'split_shuffle_and_join', 'one_tuple',
            'merge_series', 'pad_to_multiple_of_length', 'clip',

satella/coding/transforms/words.py

 import typing as tp
 
+from satella.coding.typing import K
 
-def words_to_int(words: tp.List[str]) -> tp.Dict[str, int]:
+
+def hashables_to_int(words: tp.List[K]) -> tp.Dict[K, int]:
     """
-    Assign each word an integer, starting from 0, and return the resulting mapping
+    Assign each hashable an integer, starting from 0, and return the resulting mapping
 
-    :param words: a list of words
-    :return: a dictionary keyed by words and values are the assigned integers
+    :param words: a list of hashables
+    :return: a dictionary keyed by hashable and values are the assigned integers
     """
     dictionary = {}
     i = 0

tests/test_coding/test_transforms.py

@@ -4,14 +4,14 @@ import base64
 
 from satella.coding.transforms import stringify, split_shuffle_and_join, one_tuple, \
     merge_series, pad_to_multiple_of_length, clip, b64encode, linear_interpolate, \
-    words_to_int
+    hashables_to_int
 
 
 class TestTransforms(unittest.TestCase):
 
     def test_words_to_int(self):
         words = ['a', 'word', 'a']
-        dct = words_to_int(words)
+        dct = hashables_to_int(words)
         self.assertEqual(len(dct), 2)
         self.assertEqual(len(list(dct.values())), 2)