chrislit /
abydos
| Conditions | 56 |
| Total Lines | 185 |
| Code Lines | 111 |
| Lines | 0 |
| Ratio | 0 % |
| Tests | 91 |
| CRAP Score | 56 |
| Changes | 0 | ||
Small methods make your code easier to understand, in particular if combined with a good name. Besides, if your method is small, finding a good name is usually much easier.
For example, if you find yourself adding comments to a method's body, this is usually a good sign to extract the commented part to a new method, and use the comment as a starting point when coming up with a good name for this new method.
Commonly applied refactorings include:
If many parameters/temporary variables are present:
Complex classes like abydos.phonetic._henry_early.HenryEarly.encode() often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes.
Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.
| 1 | # Copyright 2018-2020 by Christopher C. Little. |
||
| 64 | 1 | def encode(self, word: str) -> str: |
|
| 65 | """Calculate the early version of the Henry code for a word. |
||
| 66 | |||
| 67 | Parameters |
||
| 68 | ---------- |
||
| 69 | word : str |
||
| 70 | The word to transform |
||
| 71 | |||
| 72 | Returns |
||
| 73 | ------- |
||
| 74 | str |
||
| 75 | The early Henry code |
||
| 76 | 1 | ||
| 77 | Examples |
||
| 78 | 1 | -------- |
|
| 79 | >>> pe = HenryEarly() |
||
| 80 | >>> pe.encode('Marchand') |
||
| 81 | 'MRC' |
||
| 82 | >>> pe.encode('Beaulieu') |
||
| 83 | 'BL' |
||
| 84 | >>> pe.encode('Beaumont') |
||
| 85 | 'BM' |
||
| 86 | >>> pe.encode('Legrand') |
||
| 87 | 'LGR' |
||
| 88 | >>> pe.encode('Pelletier') |
||
| 89 | 'PLT' |
||
| 90 | |||
| 91 | |||
| 92 | .. versionadded:: 0.3.0 |
||
| 93 | .. versionchanged:: 0.3.6 |
||
| 94 | Encapsulated in class |
||
| 95 | |||
| 96 | """ |
||
| 97 | word = unicode_normalize('NFKD', word.upper()) |
||
| 98 | word = ''.join(c for c in word if c in self._uc_set) |
||
| 99 | |||
| 100 | if not word: |
||
| 101 | return '' |
||
| 102 | |||
| 103 | # Rule Ia seems to be covered entirely in II |
||
| 104 | |||
| 105 | # Rule Ib |
||
| 106 | if word[0] in self._uc_vy_set: |
||
| 107 | # Ib1 |
||
| 108 | if ( |
||
| 109 | word[1:2] in self._uc_c_set - {'M', 'N'} |
||
| 110 | and word[2:3] in self._uc_c_set |
||
| 111 | 1 | ) or ( |
|
| 112 | 1 | word[1:2] in self._uc_c_set and word[2:3] not in self._uc_c_set |
|
| 113 | ): |
||
| 114 | 1 | if word[0] == 'Y': |
|
| 115 | 1 | word = 'I' + word[1:] |
|
| 116 | # Ib2 |
||
| 117 | elif word[1:2] in {'M', 'N'} and word[2:3] in self._uc_c_set: |
||
| 118 | if word[0] == 'E': |
||
| 119 | word = 'A' + word[1:] |
||
| 120 | 1 | elif word[0] in {'I', 'U', 'Y'}: |
|
| 121 | word = 'E' + word[1:] |
||
| 122 | 1 | # Ib3 |
|
| 123 | elif word[:2] in self._diph: |
||
| 124 | word = self._diph[word[:2]] + word[2:] |
||
| 125 | # Ib4 |
||
| 126 | elif word[1:2] in self._uc_vy_set and word[0] == 'Y': |
||
| 127 | word = 'I' + word[1:] |
||
| 128 | 1 | ||
| 129 | 1 | code = '' |
|
| 130 | skip = 0 |
||
| 131 | 1 | ||
| 132 | 1 | # Rule II |
|
| 133 | 1 | for pos, char in enumerate(word): |
|
| 134 | 1 | nxch = word[pos + 1 : pos + 2] |
|
| 135 | 1 | prev = word[pos - 1 : pos] |
|
| 136 | |||
| 137 | 1 | if skip: |
|
| 138 | 1 | skip -= 1 |
|
| 139 | elif char in self._uc_vy_set: |
||
| 140 | 1 | code += char |
|
| 141 | 1 | # IIc |
|
| 142 | elif char == nxch: |
||
| 143 | 1 | skip = 1 |
|
| 144 | 1 | code += char |
|
| 145 | elif word[pos : pos + 2] in {'CQ', 'DT', 'SC'}: |
||
| 146 | continue |
||
| 147 | 1 | # IIb |
|
| 148 | 1 | elif char in self._simple: |
|
| 149 | 1 | code += self._simple[char] |
|
| 150 | elif char in {'C', 'G', 'P', 'Q', 'S'}: |
||
| 151 | 1 | if char == 'C': |
|
| 152 | 1 | if nxch in {'A', 'O', 'U', 'L', 'R'}: |
|
| 153 | 1 | code += 'K' |
|
| 154 | 1 | elif nxch in {'E', 'I', 'Y'}: |
|
| 155 | code += 'S' |
||
| 156 | 1 | elif nxch == 'H': |
|
| 157 | 1 | if word[pos + 2 : pos + 3] in self._uc_vy_set: |
|
| 158 | 1 | code += 'C' |
|
| 159 | 1 | else: # CHR, CHL, etc. |
|
| 160 | 1 | code += 'K' |
|
| 161 | else: |
||
| 162 | 1 | code += 'C' |
|
| 163 | 1 | elif char == 'G': |
|
| 164 | 1 | if nxch in {'A', 'O', 'U', 'L', 'R'}: |
|
| 165 | 1 | code += 'G' |
|
| 166 | 1 | elif nxch in {'E', 'I', 'Y'}: |
|
| 167 | 1 | code += 'J' |
|
| 168 | 1 | elif nxch == 'N': |
|
| 169 | 1 | code += 'N' |
|
| 170 | 1 | elif char == 'P': |
|
| 171 | 1 | if nxch != 'H': |
|
| 172 | 1 | code += 'P' |
|
| 173 | else: |
||
| 174 | 1 | code += 'F' |
|
| 175 | elif char == 'Q': |
||
| 176 | 1 | if word[pos + 1 : pos + 3] in {'UE', 'UI', 'UY'}: |
|
| 177 | 1 | code += 'G' |
|
| 178 | 1 | else: # QUA, QUO, etc. |
|
| 179 | 1 | code += 'K' |
|
| 180 | 1 | else: # S... |
|
| 181 | 1 | if word[pos : pos + 6] == 'SAINTE': |
|
| 182 | 1 | code += 'X' |
|
| 183 | 1 | skip = 5 |
|
| 184 | 1 | elif word[pos : pos + 5] == 'SAINT': |
|
| 185 | 1 | code += 'X' |
|
| 186 | 1 | skip = 4 |
|
| 187 | elif word[pos : pos + 3] == 'STE': |
||
| 188 | 1 | code += 'X' |
|
| 189 | 1 | skip = 2 |
|
| 190 | 1 | elif word[pos : pos + 2] == 'ST': |
|
| 191 | 1 | code += 'X' |
|
| 192 | skip = 1 |
||
| 193 | 1 | elif nxch in self._uc_c_set: |
|
| 194 | continue |
||
| 195 | 1 | else: |
|
| 196 | 1 | code += 'S' |
|
| 197 | 1 | # IId |
|
| 198 | 1 | elif char == 'H' and prev in self._uc_c_set: |
|
| 199 | 1 | continue |
|
| 200 | 1 | elif char in self._uc_c_set - { |
|
| 201 | 1 | 'L', |
|
| 202 | 1 | 'R', |
|
| 203 | 1 | } and nxch in self._uc_c_set - {'L', 'R'}: |
|
| 204 | 1 | continue |
|
| 205 | 1 | elif char == 'L' and nxch in {'M', 'N'}: |
|
| 206 | 1 | continue |
|
| 207 | 1 | elif ( |
|
| 208 | 1 | char in {'M', 'N'} |
|
| 209 | and prev in self._uc_vy_set |
||
| 210 | 1 | and nxch in self._uc_c_set |
|
| 211 | ): |
||
| 212 | 1 | continue |
|
| 213 | 1 | # IIa |
|
| 214 | 1 | else: |
|
| 215 | code += char |
||
| 216 | |||
| 217 | # IIe1 |
||
| 218 | 1 | if code[-4:] in {'AULT', 'EULT', 'OULT'}: |
|
| 219 | 1 | code = code[:-2] |
|
| 220 | 1 | # The following are blocked by rules above |
|
| 221 | 1 | # elif code[-4:-3] in _vows and code[-3:] == 'MPS': |
|
| 222 | # code = code[:-3] |
||
| 223 | # elif code[-3:-2] in _vows and code[-2:] in {'MB', 'MP', 'ND', |
||
| 224 | # 'NS', 'NT'}: |
||
| 225 | # code = code[:-2] |
||
| 226 | 1 | elif code[-2:-1] == 'R' and code[-1:] in self._uc_c_set: |
|
| 227 | code = code[:-1] |
||
| 228 | # IIe2 |
||
| 229 | 1 | elif code[-2:-1] in self._uc_vy_set and code[-1:] in { |
|
| 230 | 'D', |
||
| 231 | 'M', |
||
| 232 | 1 | 'N', |
|
| 233 | 1 | 'S', |
|
| 234 | 'T', |
||
| 235 | }: |
||
| 236 | code = code[:-1] |
||
| 237 | elif code[-2:] == 'ER': |
||
| 238 | code = code[:-1] |
||
| 239 | |||
| 240 | 1 | # Drop non-initial vowels |
|
| 241 | 1 | code = code[:1] + code[1:].translate( |
|
| 242 | {65: '', 69: '', 73: '', 79: '', 85: '', 89: ''} |
||
| 243 | 1 | ) |
|
| 244 | |||
| 245 | if self._max_length != -1: |
||
| 246 | code = code[: self._max_length] |
||
| 247 | |||
| 248 | return code |
||
| 249 | |||
| 255 |
