API
Anonymizer
Text anonymization module
Anonymizer
Anonymization class based on strategies formating
Source code in incognito_anonymizer/anonymizer.py
22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 | |
add_analyzer(name)
Add analyser
:param name: analyzer used for anonymisation
Source code in incognito_anonymizer/anonymizer.py
117 118 119 120 121 122 123 124 125 126 127 128 129 | |
annotate(text)
Global function to annotate a text base on the choosen strategies
:param text: text to annotate :returns: annonated text
Source code in incognito_anonymizer/anonymizer.py
195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 | |
anonymize(text, infos=None)
Global function to anonymise a text base on the choosen strategies
:param text: text to anonymize :returns: anonimized text
Source code in incognito_anonymizer/anonymizer.py
154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 | |
get_entities()
Function to get matched entites in anonymisation.
:returns: DetectedEntity class list
Source code in incognito_anonymizer/anonymizer.py
186 187 188 189 190 191 192 | |
open_json_file(path)
Open input json file for personal infos
:param path: path of the json file :returns: file content :raises FileExistsError: if given file not found
Source code in incognito_anonymizer/anonymizer.py
71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 | |
open_text_file(path)
Open input txt file
:param path: path of the input txt file :returns: file content :raises FileExistsError: if given file not found
Source code in incognito_anonymizer/anonymizer.py
55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 | |
set_annotator(name)
Set annotator
:param name: wanted annotator
Source code in incognito_anonymizer/anonymizer.py
143 144 145 146 147 148 149 150 151 152 | |
set_info(infos)
Set personal info
:param infos: PersonalInfo
Source code in incognito_anonymizer/anonymizer.py
87 88 89 90 91 92 93 94 | |
set_info_from_dict(**kwargs)
Set dict to PersonalInfo Class
:param infos: dict with all the Personal info values
Source code in incognito_anonymizer/anonymizer.py
96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 | |
set_mask(name)
Set masks
:param name: wanted mask
Source code in incognito_anonymizer/anonymizer.py
131 132 133 134 135 136 137 138 139 140 141 | |
Analyzer
AnalyzerStrategy
Constructeur de la Class Strategy
Source code in incognito_anonymizer/analyzer.py
23 24 25 26 27 | |
LossyStrategy
Bases: RegexStrategy
Find word position based on regex
:param text: text to anonymise :returns: List of tuples where each tuple contains: - A tuple with the start and end positions of the word. - The replacement string. .. warning:: This strategy is intentionally lossy: it trades recall precision for maximum anonymization coverage. Information loss is expected and assumed.
Source code in incognito_anonymizer/analyzer.py
336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 | |
analyze(text, info=None)
Hide text using regular expression :param text: text to anonymize
Source code in incognito_anonymizer/analyzer.py
429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 | |
multi_subs_by_regex(text)
Analyze text using an aggressive uppercase-based matching strategy.
:param text: Text to anonymize. :returns: Dictionary mapping span tuples to replacement strings.
.. warning:: This strategy can suppress legitimate content. Any token matching the uppercase pattern will be replaced, regardless of whether it is actually a personal identifier.
Source code in incognito_anonymizer/analyzer.py
381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 | |
PiiStrategy
Bases: AnalyzerStrategy
Detect personal infos
Source code in incognito_anonymizer/analyzer.py
30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 | |
analyze(text, info=None)
Hide specific words based on keywords
:param text: text to anonymize
Source code in incognito_anonymizer/analyzer.py
81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 | |
hide_by_keywords(text, keywords)
Hide text using keywords and return positions with replacements.
:param text: text to anonymize :param keywords: Iterable of tuples (word, replacement).
:returns: List of tuples where each tuple contains: - A tuple with the start and end positions of the word. - The replacement string.
Source code in incognito_anonymizer/analyzer.py
36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 | |
RegexStrategy
Bases: AnalyzerStrategy
Detect word based on regex
Source code in incognito_anonymizer/analyzer.py
110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 | |
analyze(text, info=None)
Hide text using regular expression :param text: text to anonymize
Source code in incognito_anonymizer/analyzer.py
262 263 264 265 266 267 | |
multi_subs_by_regex(text)
Find word position based on regex
:param text: text to anonymise :returns: List of tuples where each tuple contains: - A tuple with the start and end positions of the word. - The replacement string.
Source code in incognito_anonymizer/analyzer.py
189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 | |
Mask
FakeStrategy
Bases: Strategy
Replace word by natural placeholder
Source code in incognito_anonymizer/mask.py
12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 | |
mask(text, coordinate)
Replace in text, words at the given coordinates by a natural palceholder.
:param test: text to anonymize :param coordinate: position and placehoder of the word to replace :returns: anonymzed text
Example :
anonymizer = FakeStrategy() text = "Bob" coordinate = {((0,3),): '
',} anonymizer.mask(text, coordinate) 'Margaret Hamilton'
Source code in incognito_anonymizer/mask.py
29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 | |
HashStrategy
Bases: Strategy
Replace les mots par leur hash
Source code in incognito_anonymizer/mask.py
119 120 121 122 123 | |
HideStrategy
Bases: Strategy
Replace by *
Source code in incognito_anonymizer/mask.py
87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 | |
mask(text, coordinate)
Replace in text, words at the given coordinates by *. :param test: text to anonymize :param coordinate: position and placehoder of the word to replace :returns: anonymzed text
Example :
anonymizer = HideStrategy() text = "Bob" coordinate = {((0,3),): '
',} anonymizer.mask(text, coordinate) '**'
Source code in incognito_anonymizer/mask.py
90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 | |
PlaceholderStrategy
Bases: Strategy
Replace by placeholders
Source code in incognito_anonymizer/mask.py
56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 | |
mask(text, coordinate)
Replace in text, words at the given coordinates by a placeholder. :param test: text to anonymize :param coordinate: position and placehoder of the word to replace :returns: anonymzed text
Example :
anonymizer = PlaceholderStrategy() text = "Bob" coordinate = {((0,3),): '
',} anonymizer.mask(text, coordinate) ' '
Source code in incognito_anonymizer/mask.py
59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 | |