Skip to content

faker

faker

Faker-backed structured PII replacement generator adapter.

Classes:

Name Description
FakerReplacementGenerator

Generate structured replacements using Faker.

FakerReplacementGenerator(*, sampler, locale)

Generate structured replacements using Faker.

Parameters:

Name Type Description Default
sampler PiiSamplerConfig

Sampler configuration; its backend must be Faker.

required
locale str

Faker locale for generated values.

required

Methods:

Name Description
generate

Generate a Faker-backed replacement for request.

Source code in src/nemo_safe_synthesizer/pii_replacer/replacement/generators/faker.py
def __init__(self, *, sampler: PiiSamplerConfig, locale: str) -> None:
    backend = sampler.backend
    if backend is not self.backend:
        raise InternalError(
            f"{type(self).__name__} requires the {self.backend.value} sampler backend, got {backend.value}"
        )
    self._locale = locale
    self._phone_region = phone_region(locale)
    self._warned_generation_fallbacks: set[str] = set()
    # Building a Faker takes most of a value's generation time, so one instance is reseeded per value.
    self._fake: Faker | None = None

generate(request)

Generate a Faker-backed replacement for request.

Source code in src/nemo_safe_synthesizer/pii_replacer/replacement/generators/faker.py
def generate(self, request: ReplacementGenerationRequest) -> str:
    """Generate a Faker-backed replacement for ``request``."""
    rng = Random(request.seed)
    entity_type = request.entity_type
    if entity_type is EntityType.PHONE_NUMBER:
        return _phone_number(request.original_value, request.pattern, rng, self._phone_region)
    if entity_type is EntityType.DATE_OF_BIRTH:
        return self._birth_date(request, rng)
    if entity_type is EntityType.CREDIT_DEBIT_CARD and request.pattern is not None:
        return render_luhn_pattern(request.pattern, rng)
    if entity_type in {EntityType.API_KEY, EntityType.UNIQUE_IDENTIFIER} and (
        shaped := _shaped_identifier(request, rng)
    ):
        return shaped

    fake = self._faker(request.seed)
    dependencies = dependency_values(request.effective_dependency_tuple)
    if entity_type in NAME_ENTITY_TYPES:
        gender_value = dependencies.get(EntityType.GENDER)
        gender_values = (
            resolve_dependency_values(request, EntityType.GENDER, gender_value)
            if gender_value is not None
            else None
        )
        values = name_values(
            dependencies,
            _faker_name_values(fake, _select_dependency_value(gender_values, request.seed)),
            locale=self._locale,
            full_name_pattern=request.full_name_pattern,
        )
        name = render_name(entity_type, request.pattern, rng, values, locale=self._locale)
        if entity_type is EntityType.FULL_NAME:
            return with_name_affixes(request.original_value, name, locale=self._locale, pattern=request.pattern)
        return name
    if entity_type is EntityType.EMAIL:
        return self._generate_email(request, fake, rng, dependencies)
    if entity_type is EntityType.STREET_ADDRESS:
        # Some locales, such as en_GB, put a flat or unit on its own line.
        return fake.street_address().replace("\n", ", ")
    if entity_type is EntityType.NATIONAL_ID:
        return _national_id(request.original_value, self._locale, fake, rng)
    if entity_type is EntityType.CREDIT_DEBIT_CARD:
        return fake.credit_card_number()
    if entity_type in {EntityType.API_KEY, EntityType.UNIQUE_IDENTIFIER}:
        if entity_type is EntityType.UNIQUE_IDENTIFIER and _is_uuid(request.original_value):
            return str(fake.uuid4())
        fallback = str(fake.uuid4()).replace("-", "")
        return fallback if entity_type is EntityType.UNIQUE_IDENTIFIER else f"key-{fallback}"
    if entity_type is EntityType.IPV4:
        return fake.ipv4()
    if entity_type is EntityType.IPV6:
        return fake.ipv6()
    raise GenerationError(f"entity type {entity_type.value!r} is not supported by structured replacement")