-

cool-RR · cool-RR · commit dc1dba68dc8f · 2014-10-04T22:20:33.000+03:00
diff --git a/source_py3/python_toolbox/collection_tools.py b/source_py3/python_toolbox/collection_tools.py
@@ -34,8 +34,7 @@ def _get_all_contained_counters(counter, use_lazy_tuple=True):
         counter,
         (
             collections.Counter,
-            nifty_collections.frozen_tally_and_frozen_ordered_tally.
-                                                              _FrozenTallyMixin
+            nifty_collections.tallying._TallyMixin
         )
     )
     counter_type = type(counter)
diff --git a/source_py3/python_toolbox/nifty_collections/__init__.py b/source_py3/python_toolbox/nifty_collections/__init__.py
@@ -9,8 +9,7 @@
 from .weak_key_identity_dict import WeakKeyIdentityDict
 from .lazy_tuple import LazyTuple
 from .frozen_dict_and_frozen_ordered_dict import FrozenDict, FrozenOrderedDict
-from .frozen_tally_and_frozen_ordered_tally import (FrozenTally,
-                                                    FrozenOrderedTally)
+from .tallying import Tally, OrderedTally, FrozenTally, FrozenOrderedTally
 from .frozen_tally_tally import FrozenTallyTally
 from .default_sorted_dict import DefaultSortedDict
 from .cute_enum import CuteEnum
diff --git a/source_py3/python_toolbox/nifty_collections/frozen_tally_tally.py b/source_py3/python_toolbox/nifty_collections/frozen_tally_tally.py
@@ -5,7 +5,7 @@
 
 from python_toolbox import math_tools
 
-from .frozen_tally_and_frozen_ordered_tally import FrozenTally
+from .tallying import FrozenTally
 
 
 class FrozenTallyTally(FrozenTally):
diff --git a/source_py3/python_toolbox/nifty_collections/tallying.py b/source_py3/python_toolbox/nifty_collections/tallying.py
@@ -21,7 +21,7 @@ def _count_elements(mapping, iterable):
         for element in iterable:
             mapping[element] = mapping_get(element, 0) + 1
 
-class _FrozenTallyMixin:
+class _BaseTallyMixin:
     '''Mixin for `FrozenTally` and `FrozenOrderedTally`.'''
     
     def __init__(self, iterable={}):
@@ -40,7 +40,7 @@ def __init__(self, iterable={}):
                 if value < 0:
                     raise TypeError(
                         "You passed %s as the count of %s, while "
-                        "a `Tally` doesn't support negative amounts." %
+                        "`Tally` doesn't support negative amounts." %
                                                                    (value, key)
                     )
                     
@@ -107,7 +107,7 @@ def __add__(self, other):
             FrozenTally({'b': 4, 'c': 2, 'a': 1})
             
         '''
-        if not isinstance(other, _FrozenTallyMixin):
+        if not isinstance(other, _BaseTallyMixin):
             return NotImplemented
         
         # Using `OrderedDict` to store interim results because
@@ -133,7 +133,7 @@ def __sub__(self, other):
             FrozenTally({'b': 2, 'a': 1})
             
         '''
-        if not isinstance(other, _FrozenTallyMixin):
+        if not isinstance(other, _BaseTallyMixin):
             return NotImplemented
         
         # Using `OrderedDict` to store interim results because
@@ -154,7 +154,7 @@ def __or__(self, other):
             FrozenTally({'b': 3, 'c': 2, 'a': 1})
             
         '''
-        if not isinstance(other, _FrozenTallyMixin):
+        if not isinstance(other, _BaseTallyMixin):
             return NotImplemented
 
         # Using `OrderedDict` to store interim results because
@@ -181,7 +181,7 @@ def __and__(self, other):
             FrozenTally({'b': 1})
             
         '''
-        if not isinstance(other, _FrozenTallyMixin):
+        if not isinstance(other, _BaseTallyMixin):
             return NotImplemented
 
         # Using `OrderedDict` to store interim results because
@@ -227,7 +227,7 @@ def frozen_tally_tally(self):
     # takes the items' order into account.
     
     def __lt__(self, other):
-        if not isinstance(other, _FrozenTallyMixin):
+        if not isinstance(other, _BaseTallyMixin):
             return NotImplemented
         found_strict_difference = False # Until challenged.
         for element, count in self.items():
@@ -242,7 +242,7 @@ def __lt__(self, other):
         return found_strict_difference
     
     def __le__(self, other):
-        if not isinstance(other, _FrozenTallyMixin):
+        if not isinstance(other, _BaseTallyMixin):
             return NotImplemented
         for element, count in self.items():
             try:
@@ -254,7 +254,7 @@ def __le__(self, other):
         return True
     
     def __gt__(self, other):
-        if not isinstance(other, _FrozenTallyMixin):
+        if not isinstance(other, _BaseTallyMixin):
             return NotImplemented
         found_strict_difference = False # Until challenged.
         for element, count in self.items():
@@ -269,7 +269,7 @@ def __gt__(self, other):
         return found_strict_difference
     
     def __ge__(self, other):
-        if not isinstance(other, _FrozenTallyMixin):
+        if not isinstance(other, _BaseTallyMixin):
             return NotImplemented
         for element, count in self.items():
             try:
@@ -280,8 +280,65 @@ def __ge__(self, other):
                 return False
         return True
             
+
+class _TallyMixin(_BaseTallyMixin):
+    # blocktodo: add all mutable methods, like __iadd__ and everything
+    pass
+        
+        
+class _OrderedTallyMixin:
+    def __repr__(self):
+        if not self:
+            return '%s()' % type(self).__name__
+        return '%s(%s)' % (
+            type(self).__name__,
+            '[%s]' % ', '.join('%s' % (item,) for item in self.items())
+        )
+    
+                
+class Tally(_TallyMixin, FrozenDict):
+    '''
+    blocktododoc
+    An immutable tally.
+    
+    A tally that (a) can't be changed and (b) has only positive integer values.
+    This is like `collections.Counter`, except:
+    
+     - Because it's immutable, it's also hashable, and thus it can be used as a
+       key in dicts and sets.
+     
+     - Unlike `collections.Counter`, we don't think of it as a "dict who
+       happens to count objects" but as an object that is absolutely intended
+       for counting objects. This means we do not allow arbitrary values for 
+       counts like `collections.Counter` and we don't have to deal with a 
+       class that has an identity crisis and doesn't know whether it's a
+       counter or a dict.
+     
+    '''                
+                
+class OrderedTally(_TallyMixin, FrozenDict):
+    '''
+    blocktododoc
+    An immutable, ordered tally.
+    
+    A tally that (a) can't be changed and (b) has only positive integer values.
+    This is like `collections.Counter`, except:
+    
+     - Because it's immutable, it's also hashable, and thus it can be used as a
+       key in dicts and sets.
+     
+     - Unlike `collections.Counter`, we don't think of it as a "dict who
+       happens to count objects" but as an object that is absolutely intended
+       for counting objects. This means we do not allow arbitrary values for 
+       counts like `collections.Counter` and we don't have to deal with a 
+       class that has an identity crisis and doesn't know whether it's a
+       counter or a dict.
+       
+     - It has an order to its elements, like `collections.OrderedDict`.
+     
+    '''                
                 
-class FrozenTally(_FrozenTallyMixin, FrozenDict):
+class FrozenTally(_BaseTallyMixin, FrozenDict):
     '''
     An immutable tally.
     
@@ -300,7 +357,8 @@ class that has an identity crisis and doesn't know whether it's a
      
     '''                
                 
-class FrozenOrderedTally(_FrozenTallyMixin, FrozenOrderedDict):
+class FrozenOrderedTally(_OrderedTallyMixin, _BaseTallyMixin,
+                         FrozenOrderedDict):
     '''
     An immutable, ordered tally.
     

Original file line number	Diff line number	Diff line change
`@@ -34,8 +34,7 @@ def _get_all_contained_counters(counter, use_lazy_tuple=True):`
`34`	`34`	`counter,`
`35`	`35`	`(`
`36`	`36`	`collections.Counter,`
`37`		`- nifty_collections.frozen_tally_and_frozen_ordered_tally.`
`38`		`- _FrozenTallyMixin`
	`37`	`+ nifty_collections.tallying._TallyMixin`
`39`	`38`	`)`
`40`	`39`	`)`
`41`	`40`	`counter_type = type(counter)`