Source code for abydos.phonetic._fonem

# Copyright 2018-2020 by Christopher C. Little.
# This file is part of Abydos.
# Abydos is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
# Abydos is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# GNU General Public License for more details.
# You should have received a copy of the GNU General Public License
# along with Abydos. If not, see <>.



from re import compile as re_compile
from unicodedata import normalize as unicode_normalize

from deprecation import deprecated

from ._phonetic import _Phonetic
from .. import __version__

__all__ = ['FONEM', 'fonem']

def _get_parts(m):
    return ( or '') + ( or '')

[docs]class FONEM(_Phonetic): """FONEM. FONEM is a phonetic algorithm designed for French (particularly surnames in Saguenay, Canada), defined in :cite:`Bouchard:1981`. Guillaume Plique's Javascript implementation :cite:`Plique:2018` at was also consulted for this implementation. .. versionadded:: 0.3.6 """ # I don't see a sane way of doing this without regexps :( _rule_table = { # Vowels & groups of vowels 'V-1': (re_compile('E?AU'), 'O'), 'V-2,5': (re_compile('(E?AU|O)L[TX]$'), 'O'), 'V-3,4': (re_compile('E?AU[TX]$'), 'O'), 'V-6': (re_compile('E?AUL?D$'), 'O'), 'V-7': (re_compile(r'(?<!G)AY$'), 'E'), 'V-8': (re_compile('EUX$'), 'EU'), 'V-9': (re_compile('EY(?=$|[BCDFGHJKLMNPQRSTVWXZ])'), 'E'), 'V-10': ('Y', 'I'), 'V-11': (re_compile('(?<=[AEIOUY])I(?=[AEIOUY])'), 'Y'), 'V-12': (re_compile('(?<=[AEIOUY])ILL'), 'Y'), 'V-13': (re_compile('OU(?=[AEOU]|I(?!LL))'), 'W'), 'V-14': (re_compile(r'([AEIOUY])(?=\1)'), ''), # Nasal vowels 'V-15': (re_compile('[AE]M(?=[BCDFGHJKLMPQRSTVWXZ])(?!$)'), 'EN'), 'V-16': (re_compile('OM(?=[BCDFGHJKLMPQRSTVWXZ])'), 'ON'), 'V-17': (re_compile('AN(?=[BCDFGHJKLMNPQRSTVWXZ])'), 'EN'), 'V-18': (re_compile('(AI[MN]|EIN)(?=[BCDFGHJKLMNPQRSTVWXZ]|$)'), 'IN'), 'V-19': (re_compile('B(O|U|OU)RNE?$'), 'BURN'), 'V-20': ( re_compile( '(^IM|(?<=[BCDFGHJKLMNPQRSTVWXZ])' + 'IM(?=[BCDFGHJKLMPQRSTVWXZ]))' ), 'IN', ), # Consonants and groups of consonants 'C-1': ('BV', 'V'), 'C-2': (re_compile('(?<=[AEIOUY])C(?=[EIY])'), 'SS'), 'C-3': (re_compile('(?<=[BDFGHJKLMNPQRSTVWZ])C(?=[EIY])'), 'S'), 'C-4': (re_compile('^C(?=[EIY])'), 'S'), 'C-5': (re_compile('^C(?=[OUA])'), 'K'), 'C-6': (re_compile('(?<=[AEIOUY])C$'), 'K'), 'C-7': (re_compile('C(?=[BDFGJKLMNPQRSTVWXZ])'), 'K'), 'C-8': (re_compile('CC(?=[AOU])'), 'K'), 'C-9': (re_compile('CC(?=[EIY])'), 'X'), 'C-10': (re_compile('G(?=[EIY])'), 'J'), 'C-11': (re_compile('GA(?=I?[MN])'), 'G#'), 'C-12': (re_compile('GE(O|AU)'), 'JO'), 'C-13': (re_compile('GNI(?=[AEIOUY])'), 'GN'), 'C-14': (re_compile('(?<![PCS])H'), ''), 'C-15': ('JEA', 'JA'), 'C-16': (re_compile('^MAC(?=[BCDFGHJKLMNPQRSTVWXZ])'), 'MA#'), 'C-17': (re_compile('^MC'), 'MA#'), 'C-18': ('PH', 'F'), 'C-19': ('QU', 'K'), 'C-20': (re_compile('^SC(?=[EIY])'), 'S'), 'C-21': (re_compile('(?<=.)SC(?=[EIY])'), 'SS'), 'C-22': (re_compile('(?<=.)SC(?=[AOU])'), 'SK'), 'C-23': ('SH', 'CH'), 'C-24': (re_compile('TIA$'), 'SSIA'), 'C-25': (re_compile('(?<=[AIOUY])W'), ''), 'C-26': (re_compile('X[CSZ]'), 'X'), 'C-27': ( re_compile( '(?<=[AEIOUY])Z|(?<=[BCDFGHJKLMNPQRSTVWXZ])' + 'Z(?=[BCDFGHJKLMNPQRSTVWXZ])' ), 'S', ), 'C-28': (re_compile(r'([BDFGHJKMNPQRTVWXZ])\1'), r'\1'), 'C-28a': (re_compile('CC(?=[BCDFGHJKLMNPQRSTVWXZ]|$)'), 'C'), 'C-28b': (re_compile('((?<=[BCDFGHJKLMNPQRSTVWXZ])|^)SS'), 'S'), 'C-28bb': (re_compile('SS(?=[BCDFGHJKLMNPQRSTVWXZ]|$)'), 'S'), 'C-28c': (re_compile('((?<=[^I])|^)LL'), 'L'), 'C-28d': (re_compile('ILE$'), 'ILLE'), 'C-29': ( re_compile( '(ILS|[CS]H|[MN]P|R[CFKLNSX])$|([BCDFGHJKL' + 'MNPQRSTVWXZ])[BCDFGHJKLMNPQRSTVWXZ]$' ), _get_parts, ), 'C-30,32': (re_compile('^(SA?INT?|SEI[NM]|CINQ?|ST)(?!E)-?'), 'ST-'), 'C-31,33': (re_compile('^(SAINTE|STE)-?'), 'STE-'), # Rules to undo rule bleeding prevention in C-11, C-16, C-17 'C-34': ('G#', 'GA'), 'C-35': ('MA#', 'MAC'), } _rule_order = ( 'V-14', 'C-28', 'C-28a', 'C-28b', 'C-28bb', 'C-28c', 'C-28d', 'C-12', 'C-8', 'C-9', 'C-10', 'C-16', 'C-17', 'C-2', 'C-3', 'C-7', 'V-2,5', 'V-3,4', 'V-6', 'V-1', 'C-14', 'C-31,33', 'C-30,32', 'C-11', 'V-15', 'V-17', 'V-18', 'V-7', 'V-8', 'V-9', 'V-10', 'V-11', 'V-12', 'V-13', 'V-16', 'V-19', 'V-20', 'C-1', 'C-4', 'C-5', 'C-6', 'C-13', 'C-15', 'C-18', 'C-19', 'C-20', 'C-21', 'C-22', 'C-23', 'C-24', 'C-25', 'C-26', 'C-27', 'C-29', 'V-14', 'C-28', 'C-28a', 'C-28b', 'C-28bb', 'C-28c', 'C-28d', 'C-34', 'C-35', ) _uc_set = set('ABCDEFGHIJKLMNOPQRSTUVWXYZ-')
[docs] def encode(self, word): """Return the FONEM code of a word. Parameters ---------- word : str The word to transform Returns ------- str The FONEM code Examples -------- >>> pe = FONEM() >>> pe.encode('Marchand') 'MARCHEN' >>> pe.encode('Beaulieu') 'BOLIEU' >>> pe.encode('Beaumont') 'BOMON' >>> pe.encode('Legrand') 'LEGREN' >>> pe.encode('Pelletier') 'PELETIER' .. versionadded:: 0.3.0 .. versionchanged:: 0.3.6 Encapsulated in class """ # normalize, upper-case, and filter non-French letters word = unicode_normalize('NFKD', word.upper()) word = word.translate({198: 'AE', 338: 'OE'}) word = ''.join(c for c in word if c in self._uc_set) for rule in self._rule_order: regex, repl = self._rule_table[rule] if isinstance(regex, str): word = word.replace(regex, repl) else: word = regex.sub(repl, word) return word
[docs]@deprecated( deprecated_in='0.4.0', removed_in='0.6.0', current_version=__version__, details='Use the FONEM.encode method instead.', ) def fonem(word): """Return the FONEM code of a word. This is a wrapper for :py:meth:`FONEM.encode`. Parameters ---------- word : str The word to transform Returns ------- str The FONEM code Examples -------- >>> fonem('Marchand') 'MARCHEN' >>> fonem('Beaulieu') 'BOLIEU' >>> fonem('Beaumont') 'BOMON' >>> fonem('Legrand') 'LEGREN' >>> fonem('Pelletier') 'PELETIER' .. versionadded:: 0.3.0 """ return FONEM().encode(word)
if __name__ == '__main__': import doctest doctest.testmod()