abydos.phonetic._phonetic.Phonetic._delete_consecutive_repeats() - Code Metrics - Inspection of "0.3.6" - chrislit/abydos - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#135)

by Chris

created 2018-11-04 07:51 UTC

Phonetic._delete_consecutive_repeats() A

↳ Parent: abydos.phonetic._phonetic

Complexity

Conditions

Size

Total Lines	17
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	1

Importance

Changes

Metric	Value
eloc	2
dl	0
loc	17
ccs	2
cts	2
cp	1
rs	10
c	0
b	0
f	0
cc	1
nop	2
crap	1

# -*- coding: utf-8 -*-

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

The phonetic._phonetic module implements abstract class Phonetic.
"""

from __future__ import unicode_literals

from itertools import groupby


class Phonetic(object):

    """Abstract Phonetic class."""

    _uc_set = set('ABCDEFGHIJKLMNOPQRSTUVWXYZ')
    _lc_set = set('abcdefghijklmnopqrstuvwxyz')
    _uc_v_set = set('AEIOU')
    _lc_v_set = set('aeiou')
    _uc_vy_set = set('AEIOUY')
    _lc_vy_set = set('aeiouy')

    def _delete_consecutive_repeats(self, word):
class Foo:
    def some_method(self, x, y):
        return x + y;
        """Delete consecutive repeated characters in a word.

        :param str word: the word to transform
        :returns: word with consecutive repeating characters collapsed to
            a single instance
        :rtype: str

        >>> pe = Phonetic()
        >>> pe._delete_consecutive_repeats('REDDEE')
        'REDE'
        >>> pe._delete_consecutive_repeats('AEIOU')
        'AEIOU'
        >>> pe._delete_consecutive_repeats('AAACCCTTTGGG')
        'ACTG'
        """
        return ''.join(char for char, _ in groupby(word))

    def encode(self, word):
        """Encode phonetically.

        :param word: word to encode
        :return:
        """
        pass

    def encode_alpha(self, word):
        """Encode phonetically using alphabetic characters.

        :param word: word to encode
        :return:
        """
        return self.encode(word)


if __name__ == '__main__':
    import doctest

    doctest.testmod()


1		# -- coding: utf-8 --
2
3		# Copyright 2018 by Christopher C. Little.
4		# This file is part of Abydos.
5		#
6		# Abydos is free software: you can redistribute it and/or modify
7		# it under the terms of the GNU General Public License as published by
8		# the Free Software Foundation, either version 3 of the License, or
9		# (at your option) any later version.
10		#
11		# Abydos is distributed in the hope that it will be useful,
12		# but WITHOUT ANY WARRANTY; without even the implied warranty of
13		# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14		# GNU General Public License for more details.
15		#
16		# You should have received a copy of the GNU General Public License
17		# along with Abydos. If not, see <http://www.gnu.org/licenses/>.
18
19	1	"""abydos.phonetic._phonetic.
20
21		The phonetic._phonetic module implements abstract class Phonetic.
22		"""
23
24	1	from __future__ import unicode_literals
25
26	1	from itertools import groupby
27
28
29	1	class Phonetic(object):
		0 ignored issues – show Unused Code introduced 2018-11-04 08:02 UTC by Report Bug Copy Issue Report The variable `__class__` seems to be unused. Loading history...
30		"""Abstract Phonetic class."""
31
32	1	_uc_set = set('ABCDEFGHIJKLMNOPQRSTUVWXYZ')
33	1	_lc_set = set('abcdefghijklmnopqrstuvwxyz')
34	1	_uc_v_set = set('AEIOU')
35	1	_lc_v_set = set('aeiou')
36	1	_uc_vy_set = set('AEIOUY')
37	1	_lc_vy_set = set('aeiouy')
38
39	1	def _delete_consecutive_repeats(self, word):
		0 ignored issues – show Coding Style introduced 2018-11-04 08:02 UTC by Report Bug Copy Issue Report This method could be written as a function/class method. If a method does not access any attributes of the class, it could also be implemented as a function or static method. This can help improve readability. For example class Foo: def some_method(self, x, y): return x + y; could be written as class Foo: @classmethod def some_method(cls, x, y): return x + y; Loading history...
40		"""Delete consecutive repeated characters in a word.
41
42		:param str word: the word to transform
43		:returns: word with consecutive repeating characters collapsed to
44		a single instance
45		:rtype: str
46
47		>>> pe = Phonetic()
48		>>> pe._delete_consecutive_repeats('REDDEE')
49		'REDE'
50		>>> pe._delete_consecutive_repeats('AEIOU')
51		'AEIOU'
52		>>> pe._delete_consecutive_repeats('AAACCCTTTGGG')
53		'ACTG'
54		"""
55	1	return ''.join(char for char, _ in groupby(word))
56
57	1	def encode(self, word):
58		"""Encode phonetically.
59
60		:param word: word to encode
61		:return:
62		"""
63		pass
64
65	1	def encode_alpha(self, word):
66		"""Encode phonetically using alphabetic characters.
67
68		:param word: word to encode
69		:return:
70		"""
71		return self.encode(word)
72
73
74		if __name__ == '__main__':
75		import doctest
76
77		doctest.testmod()
78

chrislit / abydos

Pull Request — master (#135)

Phonetic._delete_consecutive_repeats() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like