faker_file.providers.augment_file_from_dir.augmenters package

Submodules

faker_file.providers.augment_file_from_dir.augmenters.faker_augmenter module

class faker_file.providers.augment_file_from_dir.augmenters.faker_augmenter.FakerWordAugmenter(**kwargs)[source]

Bases: BaseTextAugmenter

Text augmenter that randomly replaces words with Faker-generated words.

Usage example:

from faker import Faker
from faker_file.providers.augment_file_from_dir import (
    AugmentFileFromDirProvider,
)
from faker_file.providers.augment_file_from_dir.augmenters import (
    faker_augmenter,
)

FAKER = Faker()
FAKER.add_provider(AugmentFileFromDirProvider)

file = FAKER.augment_file_from_dir(
    source_dir_path="/tmp/tmp/",
    text_augmenter_cls=faker_augmenter.FakerWordAugmenter,
    text_augmenter_kwargs={
        "augmentation_probability": 0.3,
        "pool_size": 500,
        "locale": "en_US",
    }
)

You may also pass an existing Faker instance via generator, which is useful when you want the augmenter to share the same Faker instance as the rest of your application:

from faker import Faker
from faker_file.providers.augment_file_from_dir import (
    AugmentFileFromDirProvider,
)
from faker_file.providers.augment_file_from_dir.augmenters import (
    faker_augmenter,
)

MY_FAKER = Faker("de_DE")

FAKER = Faker()
FAKER.add_provider(AugmentFileFromDirProvider)

file = FAKER.augment_file_from_dir(
    source_dir_path="/tmp/tmp/",
    text_augmenter_cls=faker_augmenter.FakerWordAugmenter,
    text_augmenter_kwargs={
        "generator": MY_FAKER,
        "augmentation_probability": 0.3,
        "pool_size": 500,
    }
)

Options:

  • augmentation_probability (float, default 0.2): probability that any given word will be replaced with a randomly chosen Faker word.

  • pool_size (int, default 1000): number of words pre-generated from Faker to draw replacements from. A larger pool increases variety; a smaller pool improves startup time.

  • locale (str, default None): Faker locale used when building the word pool (e.g. "en_US", "de_DE"). When None, the default Faker locale is used. Ignored when generator is given.

  • generator (Faker, default None): an existing Faker instance to use for building the word pool. When provided, a new Faker instance is not created and locale is ignored.

augment(text: str) → str[source]

Augment text by randomly replacing words with Faker-generated ones.

Parameters:

text – Text to augment.

Returns:

Augmented text.

augmentation_probability: float = 0.2
generator: Faker = None
handle_kwargs(**kwargs) → None[source]

Handle kwargs.

locale: str = None
pool_size: int = 1000

Module contents