-

cool-RR · cool-RR · commit 43524fb3e51e · 2015-12-13T23:13:38.000+02:00
diff --git a/source_py3/python_toolbox/number_encoding.py b/source_py3/python_toolbox/number_encoding.py
@@ -5,14 +5,34 @@
 
 
 class NumberEncoder:
+    '''
+    A very simple encoders between lines and strings.
+    
+    Example:
+    
+        >>> my_encoder = number_encoding.NumberEncoder('isogram')
+        >>> my_encoder.encode(10000)
+        'rssir'
+        >>> my_encoder.encode(10000000)
+        'saimmmgrg'
+        >>> my_encoder.decode('saimmmgrg')
+        10000000
+
+    '''
     def __init__(self, characters):
         self.characters = \
                sequence_tools.ensure_iterable_is_immutable_sequence(characters)
         recurrences = sequence_tools.get_recurrences(self.characters)
         if recurrences:
             raise Exception('`characters` must not have recurring characters.')
         
-    def encode(number, minimum_length=1):
+    def encode(self, number, minimum_length=1):
+        '''
+        Encode the number into a string.
+        
+        If `minimum_length > 1`, the string will be padded (with the "zero"
+        character) if the number isn't big enough.
+        '''
         current_number = number
         result = ''
         while current_number:
@@ -24,6 +44,12 @@ def encode(number, minimum_length=1):
         return result
 
     def decode(self, string):
+        '''Decode `string` into a number'''
+        
         assert isinstance(string, (str, bytes))
         return sum((len(self.characters)**i) * self.characters.index(x)
                                          for (i, x) in enumerate(string[::-1]))
+
+    def __repr__(self):
+        return '<%s: %s>' % (type(self).__name__, repr(self.characters))
+        
diff --git a/source_py3/test_python_toolbox/test_number_encoding/__init__.py b/source_py3/test_python_toolbox/test_number_encoding/__init__.py
diff --git a/source_py3/test_python_toolbox/test_number_encoding/test_number_encoding.py b/source_py3/test_python_toolbox/test_number_encoding/test_number_encoding.py
@@ -0,0 +1,19 @@
+# Copyright 2009-2015 Ram Rachum.
+# This program is distributed under the MIT license.
+
+from python_toolbox import cute_testing
+from python_toolbox import number_encoding
+
+numbers = (234123, 63435, 2222, 643534, 34, 233)
+
+def test_number_encoding():
+    my_encoder = number_encoding.NumberEncoder('isogram')
+    
+    for number in numbers:
+        string = my_encoder.encode(number)
+        assert my_encoder.decode(string) == number
+        assert set(string) <= set(my_encoder.characters)
+    
+        padded_string = my_encoder.encode(number, 100)
+        assert len(padded_string) >= 100
+        assert padded_string.endswith(string)
