# 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
# 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.tokenizer._sonoripy.
SonoriPy class
"""
from ._tokenizer import _Tokenizer
try:
from syllabipy.sonoripy import SonoriPy
except ImportError: # pragma: no cover
# If the system lacks the SyllabiPy library, that's fine, but SyllabiPy
# tokenization won't be supported.
SonoriPy = None
[docs]class SonoriPyTokenizer(_Tokenizer):
"""SonoriPy tokenizer.
.. versionadded:: 0.4.0
"""
def __init__(self, scaler=None):
"""Initialize Tokenizer.
Parameters
----------
scaler : None, str, or function
A scaling function for the Counter:
- None : no scaling
- 'set' : All non-zero values are set to 1.
- 'length' : Each token has weight equal to its length.
- 'length-log' : Each token has weight equal to the log of its
length + 1.
- 'length-exp' : Each token has weight equal to e raised to its
length.
- a callable function : The function is applied to each value
in the Counter. Some useful functions include math.exp,
math.log1p, math.sqrt, and indexes into interesting integer
sequences such as the Fibonacci sequence.
.. versionadded:: 0.4.0
"""
if SonoriPy is None:
raise TypeError( # pragma: no cover
'SonoriPy tokenizer requires installation of SyllabiPy'
+ ' package.'
)
super(SonoriPyTokenizer, self).__init__(scaler)
[docs] def tokenize(self, string):
"""Tokenize the term and store it.
The tokenized term is stored as an ordered list and as a Counter
object.
Parameters
----------
string : str
The string to tokenize
Examples
--------
>>> SonoriPyTokenizer().tokenize('seven-twelfths')
SonoriPyTokenizer({'se': 1, 'ven-': 1, 'twelfths': 1})
>>> SonoriPyTokenizer().tokenize('character')
SonoriPyTokenizer({'cha': 1, 'rac': 1, 'ter': 1})
.. versionadded:: 0.4.0
"""
self._string = string
self._ordered_tokens = []
for word in string.split():
self._ordered_tokens += SonoriPy(word)
if not self._ordered_tokens:
self._ordered_tokens = [self._string]
super(SonoriPyTokenizer, self).tokenize()
return self
if __name__ == '__main__':
import doctest
doctest.testmod()