Source code for abydos.fingerprint._phonetic

# Copyright 2014-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
# 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.fingerprint._phonetic.

phonetic fingerprint
"""

from typing import Callable, Optional, Union

from ._string import String
from ..phonetic import DoubleMetaphone
from ..phonetic._phonetic import _Phonetic


__all__ = ['Phonetic']


[docs]class Phonetic(String): """Phonetic Fingerprint. A phonetic fingerprint is identical to a standard string fingerprint, as implemented in :py:class:`.String`, but performs the fingerprinting function after converting the string to its phonetic form, as determined by some phonetic algorithm. This fingerprint is described at :cite:`OpenRefine:2012`. .. versionadded:: 0.3.6 """ def __init__( self, phonetic_algorithm: Optional[ Union[Callable[[str], str], _Phonetic] ] = None, joiner: str = ' ', ) -> None: """Initialize Phonetic instance. phonetic_algorithm : function A phonetic algorithm that takes a string and returns a string (presumably a phonetic representation of the original string). By default, this function uses :py:func:`.double_metaphone`. joiner : str The string that will be placed between each word .. versionadded:: 0.4.0 """ super(Phonetic, self).__init__() if isinstance(phonetic_algorithm, _Phonetic): phonetic_algorithm = phonetic_algorithm.encode self._phonetic_algorithm = ( phonetic_algorithm if phonetic_algorithm is not None else DoubleMetaphone().encode ) self._joiner = joiner
[docs] def fingerprint(self, phrase: str) -> str: """Return the phonetic fingerprint of a phrase. Parameters ---------- phrase : str The string from which to calculate the phonetic fingerprint Returns ------- str The phonetic fingerprint of the phrase Examples -------- >>> pf = Phonetic() >>> pf.fingerprint('The quick brown fox jumped over the lazy dog.') '0 afr fks jmpt kk ls prn tk' >>> from abydos.phonetic import Soundex >>> pf = Phonetic(Soundex()) >>> pf.fingerprint('The quick brown fox jumped over the lazy dog.') 'b650 d200 f200 j513 l200 o160 q200 t000' .. versionadded:: 0.1.0 .. versionchanged:: 0.3.6 Encapsulated in class """ phonetic = self._joiner.join( self._phonetic_algorithm(word).split(',')[0] for word in phrase.split() ) return super(Phonetic, self).fingerprint(phonetic)
if __name__ == '__main__': import doctest doctest.testmod()