feat(analyzer): add Taiwan-specific recognizers for national id and phone by matheme-justyn · Pull Request #2073 · data-privacy-stack/presidio

matheme-justyn · 2026-06-18T06:02:42Z

Change Description

This PR adds Taiwan-specific predefined recognizers in presidio-analyzer:

TW_NATIONAL_ID
TW_PHONE_NUMBER

This iteration intentionally does not include Taiwan Unified Business Number.

Issue reference

Fixes #2065

Public references

Taiwan National ID

Taiwan Ministry of the Interior, Department of Household Registration:
- National ID related official pages
- https://www.ris.gov.tw/app/portal/3014
- https://www.ris.gov.tw/app/portal/188

Taiwan phone numbers

ITU-T Recommendation E.164 (international numbering plan):
- https://www.itu.int/rec/T-REC-E.164/en
Taiwan NCC / telecommunications numbering references:
- https://law.moda.gov.tw/Download.ashx?FileID=176&id=55&type=HLAW
- https://ncclaw.ncc.gov.tw/Eng/FLAWDAT01.aspx?id=FL103297

What is included

tests for TW_NATIONAL_ID
TW_NATIONAL_ID recognizer with checksum validation
docs for TW_NATIONAL_ID
tests for TW_PHONE_NUMBER
TW_PHONE_NUMBER recognizer using Taiwan (TW) regional phone validation
docs for TW_PHONE_NUMBER
default recognizer config entries for both Taiwan recognizers
registry-level test coverage for default config visibility and loader resolution

Implementation notes

TW_NATIONAL_ID first matches one leading letter followed by 9 digits, restricts the second digit to 1 or 2, and then validates the candidate with the Taiwan ID checksum calculation implemented locally in Presidio.
TW_PHONE_NUMBER follows the upstream Taiwan phone-validation flow: the input is normalized, +886 or region TW is used to determine the country code, the national trunk prefix 0 is stripped, and the resulting national number is checked against Taiwan metadata by length and full ^(?:pattern)$ regular-expression match across the supported number types (for example mobile, fixed line, toll-free, and others).
In this PR, Presidio does not reimplement a separate Taiwan numbering table; it wraps that existing Taiwan-region matching/parsing behavior and adds Taiwan-specific tests and documentation around it.

Notes

TW_PHONE_NUMBER is intentionally implemented as a thin Taiwan-specific wrapper around the existing generic PhoneRecognizer, restricting validation to the TW region instead of duplicating parsing logic.
Both Taiwan recognizers are added to default_recognizers.yaml with enabled: false, matching the existing convention for many country-specific recognizers.
Taiwan Unified Business Number is intentionally left out of this PR.

Tests

Executed locally:

../.venv/bin/python -m pytest tests/test_tw_national_id_recognizer.py tests/test_tw_phone_number_recognizer.py
../.venv/bin/python -m pytest tests/test_tw_national_id_recognizer.py tests/test_tw_phone_number_recognizer.py tests/test_recognizer_registry.py -k 'tw or country or default_yaml'
../.venv/bin/python -m ruff check tests/test_tw_national_id_recognizer.py tests/test_tw_phone_number_recognizer.py presidio_analyzer/predefined_recognizers/country_specific/taiwan/tw_national_id_recognizer.py presidio_analyzer/predefined_recognizers/country_specific/taiwan/tw_phone_number_recognizer.py presidio_analyzer/predefined_recognizers/__init__.py

Result:

63 passed, 19 deselected
ruff check passed for the touched Python files

Checklist

I have reviewed the contribution guidelines
I have signed the CLA (if required)
My code includes unit tests
Relevant local tests pass
My PR contains documentation updates / additions if required

Copilot

Pull request overview

Adds Taiwan (TW) country-specific predefined recognizers to presidio-analyzer for detecting Taiwan National ID numbers and Taiwan phone numbers, including default-registry configuration, unit tests, and public documentation updates.

Changes:

Introduce TwNationalIdRecognizer (checksum-validated) and TwPhoneNumberRecognizer (TW-region wrapper over generic PhoneRecognizer).
Register both recognizers in default_recognizers.yaml (disabled by default) and expose them via presidio_analyzer.predefined_recognizers.
Add unit tests and update supported-entities docs and changelog entries.

Reviewed changes

Copilot reviewed 9 out of 9 changed files in this pull request and generated 3 comments.

Show a summary per file

File	Description
presidio-analyzer/presidio_analyzer/predefined_recognizers/country_specific/taiwan/tw_national_id_recognizer.py	New TW national ID recognizer with checksum validation.
presidio-analyzer/presidio_analyzer/predefined_recognizers/country_specific/taiwan/tw_phone_number_recognizer.py	New TW phone recognizer wrapper restricting validation to region `TW`.
presidio-analyzer/presidio_analyzer/predefined_recognizers/init.py	Exposes Taiwan recognizers from the predefined recognizers package.
presidio-analyzer/presidio_analyzer/conf/default_recognizers.yaml	Adds disabled-by-default YAML entries for the two TW recognizers with `country_code: tw`.
presidio-analyzer/tests/test_tw_national_id_recognizer.py	Adds unit coverage for TW national ID detection and checksum validation.
presidio-analyzer/tests/test_tw_phone_number_recognizer.py	Adds unit coverage for TW phone number detection and metadata defaults.
presidio-analyzer/tests/test_recognizer_registry.py	Adds registry-level test ensuring YAML entries exist and classes resolve via loader.
docs/supported_entities.md	Documents the new TW entity types (needs section placement/content correction per review).
CHANGELOG.md	Notes the addition of the two Taiwan recognizers under Unreleased.

matheme-justyn · 2026-06-18T07:04:17Z

@microsoft-github-policy-service agree

Copilot

Pull request overview

Copilot reviewed 10 out of 10 changed files in this pull request and generated 2 comments.

omri374 · 2026-07-12T12:56:53Z

+    PATTERNS = [
+        Pattern(
+            "TW_NATIONAL_ID",
+            r"\b[A-Z][12]\d{8}\b",


@matheme-justyn consider using a different boundary.

+        ),
+        (
+            "National ID A100000001 belongs to the applicant.",
+            1,


omri374

Thanks! left a couple of minor comments.

omri374 · 2026-07-12T12:56:53Z

+    PATTERNS = [
+        Pattern(
+            "TW_NATIONAL_ID",
+            r"\b[A-Z][12]\d{8}\b",


@matheme-justyn consider using a different boundary.

omri374 · 2026-07-12T12:57:25Z

+)
+
+
+class TwPhoneNumberRecognizer(PhoneRecognizer):


Why not define a region in the existing phone number recognizer? any gaps that made it not work for you?

Copilot

Pull request overview

Copilot reviewed 10 out of 10 changed files in this pull request and generated 2 comments.

+        Pattern(
+            "TW_NATIONAL_ID",
+            r"\b[A-Z][12]\d{8}\b",
+            0.3,
+        ),


+            ((6, 16),),
+            ((0.5, 1.0),),
+        ),
+        (


matheme-justyn added 12 commits June 18, 2026 12:10

test(analyzer): add TW national id recognizer tests

8852e85

feat(analyzer): add TW national id recognizer

c61c005

docs: document TW national id recognizer

4c1db61

test(analyzer): add TW phone recognizer tests

c65d5b5

feat(analyzer): add TW phone recognizer

dac8df7

docs: document TW phone recognizer

1dff54d

refactor(analyzer): tighten TW recognizer docs and tests

2aefeec

fix(analyzer): export TW recognizers

87ec90c

test(analyzer): align TW expectations with matcher behavior

fb97168

feat(analyzer): load TW recognizers by default config

e78d940

test(analyzer): verify TW default recognizer config

06230b8

fix(test): import recognizer list loader

6333603

Copilot AI review requested due to automatic review settings June 18, 2026 06:02

Copilot started reviewing on behalf of matheme-justyn June 18, 2026 06:03 View session

github-actions Bot added the external label Jun 18, 2026

matheme-justyn marked this pull request as draft June 18, 2026 06:03

Copilot AI reviewed Jun 18, 2026

View reviewed changes

Comment thread docs/supported_entities.md Outdated

Comment thread presidio-analyzer/presidio_analyzer/predefined_recognizers/__init__.py

Comment thread ...residio_analyzer/predefined_recognizers/country_specific/taiwan/tw_national_id_recognizer.py Outdated

matheme-justyn added 4 commits June 30, 2026 10:16

style(analyzer): format TW recognizer changes

3289310

Merge upstream/main into codex/issue-2065

a86ce6f

fix(analyzer): address Taiwan recognizer review comments

f636dfd

style(analyzer): wrap Taiwan recognizer docstring

788f4dc

matheme-justyn marked this pull request as ready for review July 12, 2026 07:31

Copilot AI review requested due to automatic review settings July 12, 2026 07:31

Copilot started reviewing on behalf of matheme-justyn July 12, 2026 07:31 View session

Copilot AI reviewed Jul 12, 2026

View reviewed changes

Merge branch 'main' into codex/issue-2065

109e17a

Copilot AI review requested due to automatic review settings July 12, 2026 12:57

Copilot started reviewing on behalf of omri374 July 12, 2026 12:58 View session

omri374 reviewed Jul 12, 2026

View reviewed changes

Copilot AI reviewed Jul 12, 2026

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

feat(analyzer): add Taiwan-specific recognizers for national id and phone#2073

feat(analyzer): add Taiwan-specific recognizers for national id and phone#2073
matheme-justyn wants to merge 17 commits into
data-privacy-stack:mainfrom
matheme-justyn:codex/issue-2065

matheme-justyn commented Jun 18, 2026 •

edited

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

matheme-justyn commented Jun 18, 2026

Uh oh!

Copilot AI left a comment

Uh oh!

omri374 Jul 12, 2026

Uh oh!

omri374 left a comment

Uh oh!

omri374 Jul 12, 2026

Uh oh!

omri374 Jul 12, 2026

Uh oh!

Copilot AI left a comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

		)


		class TwPhoneNumberRecognizer(PhoneRecognizer):

Uh oh!

Conversation

matheme-justyn commented Jun 18, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Change Description

Issue reference

Public references

Taiwan National ID

Taiwan phone numbers

What is included

Implementation notes

Notes

Tests

Checklist

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

matheme-justyn commented Jun 18, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

omri374 Jul 12, 2026

Choose a reason for hiding this comment

Uh oh!

omri374 left a comment

Choose a reason for hiding this comment

Uh oh!

omri374 Jul 12, 2026

Choose a reason for hiding this comment

Uh oh!

omri374 Jul 12, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

matheme-justyn commented Jun 18, 2026 •

edited

Loading