Add allow_key decorator to accept object

fuzzywuzzy/utils.py

@@ -99,6 +99,18 @@ def full_process(s, force_ascii=False):
     string_out = StringProcessor.strip(string_out)
     return string_out
 
+def allow_key(func):
+    """Allow key function that extracts the text from passed object to be used.
+    similar to python's max, min functions
+    """
+    @functools.wraps(func)
+    def decorated(*args,
+                  key = lambda s: s, #type: Callable[[Any], str]
+                  **kwargs):
+        kwargs.update(zip(func.__code__.co_varnames, args))
+        return func(**{k:key(v) for k,v in kwargs.items()})
+    return decorated
+
 
 def intr(n):
     '''Returns a correctly rounded integer'''

test_fuzzywuzzy.py

@@ -4,6 +4,7 @@
 import re
 import sys
 import pycodestyle
+from collections import namedtuple
 
 from fuzzywuzzy import fuzz
 from fuzzywuzzy import process
@@ -50,6 +51,9 @@ def setUp(self):
             "a\xac\u1234\u20ac\U00008000",
             "\u00C1"
         ]
+        self.Dummy = namedtuple("DummyObject",["content"])
+        self.dummy_key_simple = lambda obj:obj.content
+        self.dummy_key_typed = lambda obj:obj.content if isinstance(obj,self.Dummy) else obj
 
     def tearDown(self):
         pass
@@ -72,6 +76,19 @@ def test_fullProcessForceAscii(self):
         for s in self.mixed_strings:
             utils.full_process(s, force_ascii=True)
 
+    def testAllowKey(self):
+        s1_obj = self.Dummy(self.s1)
+        @utils.allow_key
+        def upper(s): return s.upper()
+        self.assertEqual(self.s1.upper(), upper(s1_obj, key=self.dummy_key_simple))
+        @utils.allow_key
+        def upper_if_length_n(s, length):
+            if len(s) == length: return s.upper()
+            else: return s
+        processed = upper_if_length_n(s1_obj, length=len(self.s1),
+                                      key=self.dummy_key_typed)
+        self.assertEqual(self.s1.upper(), processed)
+
 
 class RatioTest(unittest.TestCase):