sima/lib/simastr.py

   1 # -*- coding: utf-8 -*-
   2
   3 #
   4 # Copyright (c) 2009, 2010, 2013 Jack Kaliko <kaliko@azylum.org>
   5 #
   6 #  This program is free software; you can redistribute it and/or modify
   7 #  it under the terms of the GNU General Public License as
   8 #  published by the Free Software Foundation; either version 3 of the
   9 #  License, or (at your option) any later version.
  10 #
  11 #  This program is distributed in the hope that it will be useful, but
  12 #  WITHOUT ANY WARRANTY; without even the implied warranty of
  13 #  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14 #  General Public License for more details.
  15 #
  16 #  You should have received a copy of the GNU General Public
  17 #  License along with this program.
  18 #  If not, see <http://www.gnu.org/licenses/>.
  19 #
  20
  21 """
  22 SimaStr
  23
  24 Special unicode() subclass to perform fuzzy match on specific strings with
  25 known noise.
  26
  27  * SimaStr() object removes specific patterns from the string
  28  * Diacritic are removed
  29  * Equality test is done on lower-cased string
  30  * Equality test is not an exact comparison, the levenshtein edition distance
  31    between stripped and filtered strings is used
  32
  33 >>> from simastr import SimaStr
  34 >>> art0 = SimaStr('The Desert Sessions & PJ Harvey')
  35 >>> art1 = SimaStr('Desert Sessions And PJ Harvey')
  36 >>> art0 == art1
  37 >>> True
  38 >>> art0 == 'Desert Sessions And PJ Harvey'
  39 >>> True
  40 >>> # diacritic filter + levenshtein  example
  41 >>> art0 = sima.lib.simastr.SimaStr('Hubert Félix Thiéphaine')
  42 >>> art1 = sima.lib.simastr.SimaStr('Hubert-Felix Thiephaine')
  43 >>> art0 == art1
  44 >>> True
  45 >>>
  46
  47 Current stripped word patterns (usually English followed by French and
  48 Spanish alternatives)
  49     leading (case-insensitive):
  50             "the","le","la","les","el","los"
  51     middle:
  52             "[Aa]nd","&","[Nn]'?","[Ee]t"
  53     trailing:
  54             combination of "[- !?\.]+" "\(? ?[Ll]ive ?\)?"
  55
  56
  57 Possibility to access to stripped string:
  58
  59 >>> art0 = SimaStr('The Desert Sessions & PJ Harvey')
  60 >>> print (art0, art0.stripped)
  61 >>> ('The Desert Sessions & PJ Harvey', 'Desert Sessions PJ Harvey')
  62
  63 TODO:
  64     * Have a look to difflib.SequenceMatcher to find possible improvements
  65     * Find a way to allow users patterns.
  66 """
  67
  68 __author__ = 'Jack Kaliko'
  69 __version__ = '0.4'
  70
  71 # IMPORTS
  72 import unicodedata
  73 from re import (compile, U, I)
  74
  75 from ..utils.leven import levenshtein_ratio
  76
  77
  78 class SimaStr(str):
  79     """
  80     Specific string object for artist names and song titles.
  81     Here follows some class variables for regex to run on strings.
  82     """
  83     diafilter = True
  84     leven_ratio = 0.82
  85     regexp_dict = dict()
  86
  87     # Leading patterns: The Le Les
  88     # case-insensitive matching for this RE
  89     regexp_dict.update({'lead': '(the|l[ae][s]?|los|el)'})
  90
  91     # Middle patterns: And & Et N
  92     regexp_dict.update({'mid': '(And|&|and|[Nn]\'?|et)'})
  93
  94     # Trailing patterns: ! ? live
  95     # TODO: add "concert" key word
  96     #       add "Live at <somewhere>"
  97     regexp_dict.update({'trail': '([- !?\.]|\(? ?[Ll]ive ?\)?)'})
  98
  99     reg_lead = compile('^(?P<lead>%(lead)s )(?P<root0>.*)$' % regexp_dict, I | U)
 100     reg_midl = compile('^(?P<root0>.*)(?P<mid> %(mid)s )(?P<root1>.*)' % regexp_dict, U)
 101     reg_trail = compile('^(?P<root0>.*?)(?P<trail>%(trail)s+$)' % regexp_dict, U)
 102
 103     def __init__(self, fuzzstr):
 104         """
 105         """
 106         self.orig = str(fuzzstr)
 107         self.stripped = str(fuzzstr.strip())
 108         # fuzzy computation
 109         self._get_root()
 110         if self.__class__.diafilter:
 111            self.remove_diacritics()
 112
 113     def __new__(cls, fuzzstr):
 114         return super(SimaStr, cls).__new__(cls, fuzzstr)
 115
 116     def _get_root(self):
 117         """
 118         Remove all patterns in string.
 119         """
 120         sea = SimaStr.reg_lead.search(self.stripped)
 121         if sea:
 122             #print sea.groupdict()
 123             self.stripped = sea.group('root0')
 124
 125         sea = SimaStr.reg_midl.search(self.stripped)
 126         if sea:
 127             #print sea.groupdict()
 128             self.stripped = str().join([sea.group('root0'), ' ',
 129                                         sea.group('root1')])
 130
 131         sea = SimaStr.reg_trail.search(self.stripped)
 132         if sea:
 133             #print sea.groupdict()
 134             self.stripped = sea.group('root0')
 135
 136     def remove_diacritics(self):
 137         self.stripped = ''.join(x for x in
 138                                 unicodedata.normalize('NFKD', self.stripped)
 139                                 if unicodedata.category(x) != 'Mn')
 140
 141     def __hash__(self):
 142         return hash(self.stripped)
 143
 144     def __eq__(self, other):
 145         if not isinstance(other, SimaStr):
 146             other = SimaStr(other)
 147         levenr = levenshtein_ratio(self.stripped.lower(),
 148                                    other.stripped.lower())
 149         if hash(self) == hash(other):
 150             return True
 151         return levenr >= self.__class__.leven_ratio
 152
 153     def __ne__(self, other):
 154         if not isinstance(other, SimaStr):
 155             return hash(self) != hash(SimaStr(other))
 156         return hash(self) != hash(other)
 157
 158
 159 # Script starts here
 160 if __name__ == "__main__":
 161     import time
 162     print(SimaStr('Kétanoue'))
 163     #from leven import levenshtein_ratio
 164     CASES_LIST = list([
 165         dict({
 166                     'got': 'Guns N\' Roses (live)!! !',
 167                 'look for': 'Guns And Roses'}),
 168         dict({
 169                      'got': 'Jesus & Mary Chains',
 170                 'look for': 'The Jesus and Mary Chains - live'}),
 171         dict({
 172                          'got': 'Desert sessions',
 173                     'look for': 'The Desert Sessions'}),
 174         dict({
 175                          'got': 'Têtes Raides',
 176                     'look for': 'Les Têtes Raides'}),
 177         dict({
 178                          'got': 'Noir Désir',
 179                     'look for': 'Noir Désir'}),
 180         dict({
 181                          'got': 'No Future',
 182                     'look for': 'Future'})])
 183
 184     for case in CASES_LIST[:]:
 185         str0 = case.get('got')
 186         str1 = case.get('look for')
 187         fz_str0 = SimaStr(str0)
 188         fz_str1 = SimaStr(str1)
 189         print(fz_str0, '\n', fz_str1)
 190         print(fz_str0.stripped == fz_str1.stripped)
 191         #print levenshtein_ratio(fz_str0.lower(), fz_str1.lower())
 192         time.sleep(1)
 193
 194 # VIM MODLINE
 195 # vim: ai ts=4 sw=4 sts=4 expandtab