# -*- coding: utf-8 -*-
# Copyright 2014-2018 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
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# 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 <http://www.gnu.org/licenses/>.
"""abydos.phonetic._phonem.
Phonem
"""
from __future__ import (
absolute_import,
division,
print_function,
unicode_literals,
)
from unicodedata import normalize as unicode_normalize
from deprecation import deprecated
from six import text_type
from ._phonetic import _Phonetic
from .. import __version__
__all__ = ['Phonem', 'phonem']
[docs]class Phonem(_Phonetic):
"""Phonem.
Phonem is defined in :cite:`Wilde:1988`.
This version is based on the Perl implementation documented at
:cite:`Wilz:2005`.
It includes some enhancements presented in the Java port at
:cite:`dcm4che:2011`.
Phonem is intended chiefly for German names/words.
.. versionadded:: 0.3.6
"""
_substitutions = (
('SC', 'C'),
('SZ', 'C'),
('CZ', 'C'),
('TZ', 'C'),
('TS', 'C'),
('KS', 'X'),
('PF', 'V'),
('QU', 'KW'),
('PH', 'V'),
('UE', 'Y'),
('AE', 'E'),
('OE', 'Ö'),
('EI', 'AY'),
('EY', 'AY'),
('EU', 'OY'),
('AU', 'A§'),
('OU', '§'),
)
_trans = dict(
zip(
(ord(_) for _ in 'ZKGQÇÑßFWPTÁÀÂÃÅÄÆÉÈÊËIJÌÍÎÏÜݧÚÙÛÔÒÓÕØ'),
'CCCCCNSVVBDAAAAAEEEEEEYYYYYYYYUUUUOOOOÖ',
)
)
_uc_set = set('ABCDLMNORSUVWXYÖ')
[docs] def encode(self, word):
"""Return the Phonem code for a word.
Parameters
----------
word : str
The word to transform
Returns
-------
str
The Phonem value
Examples
--------
>>> pe = Phonem()
>>> pe.encode('Christopher')
'CRYSDOVR'
>>> pe.encode('Niall')
'NYAL'
>>> pe.encode('Smith')
'SMYD'
>>> pe.encode('Schmidt')
'CMYD'
.. versionadded:: 0.1.0
.. versionchanged:: 0.3.6
Encapsulated in class
"""
word = unicode_normalize('NFC', text_type(word.upper()))
for i, j in self._substitutions:
word = word.replace(i, j)
word = word.translate(self._trans)
return ''.join(
c
for c in self._delete_consecutive_repeats(word)
if c in self._uc_set
)
[docs]@deprecated(
deprecated_in='0.4.0',
removed_in='0.6.0',
current_version=__version__,
details='Use the Phonem.encode method instead.',
)
def phonem(word):
"""Return the Phonem code for a word.
This is a wrapper for :py:meth:`Phonem.encode`.
Parameters
----------
word : str
The word to transform
Returns
-------
str
The Phonem value
Examples
--------
>>> phonem('Christopher')
'CRYSDOVR'
>>> phonem('Niall')
'NYAL'
>>> phonem('Smith')
'SMYD'
>>> phonem('Schmidt')
'CMYD'
.. versionadded:: 0.1.0
"""
return Phonem().encode(word)
if __name__ == '__main__':
import doctest
doctest.testmod()