faker-file ¶

Generate fake files

Prerequisites ¶

All of core dependencies of this package are MIT licensed. Most of optional dependencies of this package are MIT licensed, while a few are BSD- or Apache 2 licensed. All licenses are mentioned below between the brackets.

Core package requires Python 3.7, 3.8, 3.9, 3.10 and 3.11.
Django (BSD) integration with factory_boy (MIT) has been tested with Django 2.2, 3.0, 3.1, 3.2, 4.0 and 4.1.
DOCX file support requires python-docx (MIT).
ICO, JPEG, PNG, SVG and WEBP files support requires imgkit (MIT).
PDF file support requires pdfkit (MIT).
PPTX file support requires python-pptx (MIT).
ODS file support requires tablib (MIT) and odfpy (Apache 2).
XLSX file support requires tablib (MIT) and openpyxl (MIT).

Documentation ¶

Documentation is available on Read the Docs.

Installation ¶

Latest stable version on PyPI:

pip install faker-file[all]

Or development version from GitHub:

pip install https://github.com/barseghyanartur/faker-file/archive/main.tar.gz

Supported file types ¶

BIN
CSV
DOCX
ICO
JPEG
ODS
PDF
PNG
PPTX
SVG
TXT
WEBP
XLSX
ZIP

Usage examples ¶

With `Faker`¶

One way ¶

from faker import Faker
from faker_file.providers.txt_file import TxtFileProvider

FAKER = Faker()

file = TxtFileProvider(FAKER).txt_file()

Or another ¶

from faker import Faker
from faker_file.providers.txt_file import TxtFileProvider

FAKER = Faker()
FAKER.add_provider(TxtFileProvider)

file = FAKER.txt_file()

With `factory_boy`¶

upload/models.py ¶

from django.db import models

class Upload(models.Model):

    # ...
    file = models.FileField()

upload/factory.py ¶

Note, that when using faker-file with Django, you need to pass your MEDIA_ROOT setting as root_path value (which is by default set to tempfile.gettempdir()).

import factory
from django.conf import settings
from factory import Faker
from factory.django import DjangoModelFactory
from faker_file.providers.docx_file import DocxFileProvider

from upload.models import Upload

factory.Faker.add_provider(DocxFileProvider)

class UploadFactory(DjangoModelFactory):

    # ...
    file = Faker("docx_file", root_path=settings.MEDIA_ROOT)

    class Meta:
        model = Upload

Testing ¶

Simply type:

pytest -vvv

Or use tox:

tox

Or use tox to check specific env:

tox -e py310-django41

Writing documentation ¶

Keep the following hierarchy.

=====
title
=====

header
======

sub-header
----------

sub-sub-header
~~~~~~~~~~~~~~

sub-sub-sub-header
^^^^^^^^^^^^^^^^^^

sub-sub-sub-sub-header
++++++++++++++++++++++

sub-sub-sub-sub-sub-header
**************************

License ¶

MIT

Support ¶

For any security issues contact me at the e-mail given in the Author section.

For overall issues, go to GitHub.

Author ¶

Artur Barseghyan <artur.barseghyan@gmail.com>

Project documentation ¶

Contents:

Quick start¶

Installation¶

pip install faker-file[all]

Usage¶

With `Faker`¶

from faker import Faker
from faker_file.providers.bin_file import BinFileProvider
from faker_file.providers.csv_file import CsvFileProvider
from faker_file.providers.docx_file import DocxFileProvider
from faker_file.providers.ico_file import IcoFileProvider
from faker_file.providers.jpeg_file import JpegFileProvider
from faker_file.providers.ods_file import OdsFileProvider
from faker_file.providers.pdf_file import PdfFileProvider
from faker_file.providers.png_file import PngFileProvider
from faker_file.providers.pptx_file import PptxFileProvider
from faker_file.providers.svg_file import SvgFileProvider
from faker_file.providers.txt_file import TxtFileProvider
from faker_file.providers.webp_file import WebpFileProvider
from faker_file.providers.xlsx_file import XlsxFileProvider
from faker_file.providers.zip_file import ZipFileProvider

FAKER = Faker()
FAKER.add_provider(BinFileProvider)
FAKER.add_provider(CsvFileProvider)
FAKER.add_provider(DocxFileProvider)
FAKER.add_provider(IcoFileProvider)
FAKER.add_provider(JpegFileProvider)
FAKER.add_provider(OdsFileProvider)
FAKER.add_provider(PdfFileProvider)
FAKER.add_provider(PngFileProvider)
FAKER.add_provider(PptxFileProvider)
FAKER.add_provider(SvgFileProvider)
FAKER.add_provider(TxtFileProvider)
FAKER.add_provider(WebpFileProvider)
FAKER.add_provider(XlsxFileProvider)
FAKER.add_provider(ZipFileProvider)

bin_file = FAKER.bin_file()
csv_file = FAKER.csv_file()
docx_file = FAKER.docx_file()
ico_file = FAKER.ico_file()
jpeg_file = FAKER.jpeg_file()
ods_file = FAKER.ods_file()
pdf_file = FAKER.pdf_file()
png_file = FAKER.png_file()
pptx_file = FAKER.pptx_file()
svg_file = FAKER.svg_file()
txt_file = FAKER.txt_file()
webp_file = FAKER.webp_file()
xlsx_file = FAKER.xlsx_file()
zip_file = FAKER.zip_file()

With `factory_boy`¶

upload/models.py¶

from django.db import models

class Upload(models.Model):
    """Upload model."""

    name = models.CharField(max_length=255, unique=True)
    description = models.TextField(null=True, blank=True)

    # Files
    docx_file = models.FileField(null=True)
    pdf_file = models.FileField(null=True)
    pptx_file = models.FileField(null=True)
    txt_file = models.FileField(null=True)
    zip_file = models.FileField(null=True)

    class Meta:
        verbose_name = "Upload"
        verbose_name_plural = "Upload"

    def __str__(self):
        return self.name

upload/factories.py¶

from django.conf import settings

from factory import Faker
from factory.django import DjangoModelFactory

# Import all providers we want to use
from faker_file.providers.docx_file import DocxFileProvider
from faker_file.providers.pdf_file import PdfFileProvider
from faker_file.providers.pptx_file import PptxFileProvider
from faker_file.providers.txt_file import TxtFileProvider
from faker_file.providers.zip_file import ZipFileProvider

from upload.models import Upload

# Add all providers we want to use
Faker.add_provider(DocxFileProvider)
Faker.add_provider(PdfFileProvider)
Faker.add_provider(PptxFileProvider)
Faker.add_provider(TxtFileProvider)
Faker.add_provider(ZipFileProvider)


class UploadFactory(DjangoModelFactory):
    """Upload factory."""

    name = Faker("text", max_nb_chars=100)
    description = Faker("text", max_nb_chars=1000)

    # Files
    docx_file = Faker("docx_file", root_path=settings.MEDIA_ROOT)
    pdf_file = Faker("pdf_file", root_path=settings.MEDIA_ROOT)
    pptx_file = Faker("pptx_file", root_path=settings.MEDIA_ROOT)
    txt_file = Faker("txt_file", root_path=settings.MEDIA_ROOT)
    zip_file = Faker("zip_file", root_path=settings.MEDIA_ROOT)

    class Meta:
        model = Upload

Recipes¶

When using with `Faker`¶

One way¶

Prerequisites¶

Imports and initializations

import Faker
from faker_file.providers.docx_file import DocxFileProvider
from faker_file.providers.pdf_file import PdfFileProvider
from faker_file.providers.pptx_file import PptxFileProvider
from faker_file.providers.txt_file import TxtFileProvider
from faker_file.providers.zip_file import ZipFileProvider

FAKER = Faker()

Create a TXT file with static content¶

Content of the file is Lorem ipsum.

file = TxtFileProvider(FAKER).txt_file(content="Lorem ipsum")

Create a DOCX file with dynamically generated content¶

Content is generated dynamically.
Content is limited to 1024 chars.
Wrap lines after 80 chars.
Prefix the filename with zzz.

file = DocxFileProvider(FAKER).docx_file(
    prefix="zzz",
    max_nb_chars=1_024,
    wrap_chars_after=80,
)

Create a ZIP file consisting of TXT files with static content¶

5 TXT files in the ZIP archive (default value is 5).
Content of all files is Lorem ipsum.

file = ZipFileProvider(FAKER).zip_file(options={"content": "Lorem ipsum"})

Create a ZIP file consisting of 3 DOCX files with dynamically generated content¶

3 DOCX files in the ZIP archive.
Content is generated dynamically.
Content is limited to 1024 chars.
Prefix the filenames in archive with xxx_.
Prefix the filename of the archive itself with zzz.
Inside the ZIP, put all files in directory yyy.

from faker_file.providers.zip_file import create_inner_docx_file
file = ZipFileProvider(FAKER).zip_file(
    prefix="zzz",
    options={
        "count": 3,
        "create_inner_file_func": create_inner_docx_file,
        "create_inner_file_args": {
            "prefix": "xxx_",
            "max_nb_chars": 1_024,
        }
        "directory": "yyy",
    }
)

Create a ZIP file which contains 5 ZIP files which contain 5 ZIP files which contain 5 DOCX files¶

5 ZIP files in the ZIP archive.
Content is generated dynamically.
Prefix the filenames in archive with nested_level_1_.
Prefix the filename of the archive itself with nested_level_0_.
Each of the ZIP files inside the ZIP file in their turn contains 5 other ZIP files, prefixed with nested_level_2_, which in their turn contain 5 DOCX files.

from faker_file.providers.zip_file import create_inner_docx_file, create_inner_zip_file
file = ZipFileProvider(FAKER).zip_file(
    prefix="nested_level_0_",
    options={
        "create_inner_file_func": create_inner_zip_file,
        "create_inner_file_args": {
            "prefix": "nested_level_1_",
            "options": {
                "create_inner_file_func": create_inner_zip_file,
                "create_inner_file_args": {
                    "prefix": "nested_level_2_",
                    "options": {
                        "create_inner_file_func": create_inner_docx_file,
                    }
                },
            }
        },
    }
)

Or another¶

Imports and initializations

import Faker
from faker_file.providers.docx_file import DocxFileProvider
from faker_file.providers.pdf_file import PdfFileProvider
from faker_file.providers.pptx_file import PptxFileProvider
from faker_file.providers.txt_file import TxtFileProvider
from faker_file.providers.zip_file import ZipFileProvider

FAKER = Faker()
FAKER.add_provider(DocxFileProvider)
FAKER.add_provider(PdfFileProvider)
FAKER.add_provider(PptxFileProvider)
FAKER.add_provider(TxtFileProvider)
FAKER.add_provider(ZipFileProvider)

Create a TXT file with static content¶

file = FAKER("txt_file", content="Lorem ipsum dolor sit amet")

Create a DOCX file with dynamically generated content¶

Content is generated dynamically.
Content is limited to 1024 chars.
Wrap lines after 80 chars.
Prefix the filename with zzz.

file = FAKER(
    "docx_file",
    prefix="zzz",
    max_nb_chars=1_024,
    wrap_chars_after=80,
)

Create a PDF file with predefined template containing dynamic fixtures¶

Content template is predefined and contains dynamic fixtures.
Wrap lines after 80 chars.

template = """
{{date}} {{city}}, {{country}}

Hello {{name}},

{{text}} {{text}} {{text}}

{{text}} {{text}} {{text}}

{{text}} {{text}} {{text}}

Address: {{address}}

Best regards,

{{name}}
{{address}}
{{phone_number}}
"""

file = FAKER("pdf_file", content=template, wrap_chars_after=80)

When using with `Django` (and `factory_boy`)¶

When used with Django (to generate fake data with factory_boy factories), the root_path argument shall be provided. Otherwise (although no errors will be triggered) the generated files will reside outside the MEDIA_ROOT directory (by default in /tmp/tmp/ on Linux) and further operations with those files through Django will cause SuspiciousOperation exception.

Basic example¶

Imaginary `Django` model¶

from django.db import models

class Upload(models.Model):
    """Upload model."""

    name = models.CharField(max_length=255, unique=True)
    description = models.TextField(null=True, blank=True)

    # Files
    docx_file = models.FileField(null=True)
    pdf_file = models.FileField(null=True)
    pptx_file = models.FileField(null=True)
    txt_file = models.FileField(null=True)
    zip_file = models.FileField(null=True)
    file = models.FileField(null=True)

    class Meta:
        verbose_name = "Upload"
        verbose_name_plural = "Upload"

    def __str__(self):
        return self.name

Correspondent `factory_boy` factory¶

from django.conf import settings

from factory import Faker
from factory.django import DjangoModelFactory

# Import all providers we want to use
from faker_file.providers.docx_file import DocxFileProvider
from faker_file.providers.pdf_file import PdfFileProvider
from faker_file.providers.pptx_file import PptxFileProvider
from faker_file.providers.txt_file import TxtFileProvider
from faker_file.providers.zip_file import ZipFileProvider

from upload.models import Upload

# Add all providers we want to use
Faker.add_provider(DocxFileProvider)
Faker.add_provider(PdfFileProvider)
Faker.add_provider(PptxFileProvider)
Faker.add_provider(TxtFileProvider)
Faker.add_provider(ZipFileProvider)

class UploadFactory(DjangoModelFactory):
    """Upload factory."""

    name = Faker("text", max_nb_chars=100)
    description = Faker("text", max_nb_chars=1000)

    # Files
    docx_file = Faker("docx_file", root_path=settings.MEDIA_ROOT)
    pdf_file = Faker("pdf_file", root_path=settings.MEDIA_ROOT)
    pptx_file = Faker("pptx_file", root_path=settings.MEDIA_ROOT)
    txt_file = Faker("txt_file", root_path=settings.MEDIA_ROOT)
    zip_file = Faker("zip_file", root_path=settings.MEDIA_ROOT)
    file = Faker("txt_file", root_path=settings.MEDIA_ROOT)

    class Meta:
        model = Upload

Randomize provider choice¶

from random import choice

from factory import LazyAttribute
from faker import Faker as FakerFaker

FAKER = FakerFaker()

PROVIDER_CHOICES = [
    lambda: DocxFileProvider(FAKER).docx_file(root_path=settings.MEDIA_ROOT),
    lambda: PdfFileProvider(FAKER).pdf_file(root_path=settings.MEDIA_ROOT),
    lambda: PptxFileProvider(FAKER).pptx_file(root_path=settings.MEDIA_ROOT),
    lambda: TxtFileProvider(FAKER).txt_file(root_path=settings.MEDIA_ROOT),
    lambda: ZipFileProvider(FAKER).zip_file(root_path=settings.MEDIA_ROOT),
]

def pick_random_provider(*args, **kwargs):
    return choice(PROVIDER_CHOICES)()

class UploadFactory(DjangoModelFactory):
    """Upload factory that randomly picks a file provider."""

    # ...
    file = LazyAttribute(pick_random_provider)
    # ...

Release history and notes¶

Sequence based identifiers are used for versioning (schema follows below):

major.minor[.revision]

It’s always safe to upgrade within the same minor version (for example, from 0.3 to 0.3.4).
Minor version changes might be backwards incompatible. Read the release notes carefully before upgrading (for example, when upgrading from 0.3.4 to 0.4).
All backwards incompatible changes are mentioned in this document.

0.6¶

2022-12-11

Pass optional generator argument to inner functions of the ZipFileProvider.
Added create_inner_zip_file inner function which allows to create nested ZIPs.
Reached test coverage of 100%.

0.5¶

2022-12-10

Note, that this release introduces breaking changes!

Added ODS file support.
Switched to tablib for easy, non-variant support of various formats (XLSX, ODS).
Silence imgkit logging output.

ZipFileProvider allows to pass arbitrary arguments to inner functions. Put all your inner function arguments into a dictionary and pass it in create_inner_file_args key inside options argument. See the example below.

zip_file = ZipFileProvider(None).file(
    prefix="zzz_archive_",
    options={
        "count": 5,
        "create_inner_file_func": create_inner_docx_file,
        "create_inner_file_args": {
            "prefix": "zzz_file_",
            "max_nb_chars": 1_024,
            "content": "{{date}}\r\n{{text}}\r\n{{name}}",
        },
        "directory": "zzz",
    }
)

0.4¶

2022-12-09

Note, that this release introduces breaking changes!

Remove the concept of content generators (and the correspondent content_generator arguments in implemented providers). Instead, allow usage of dynamic fixtures in the provided content argument.
Remove temporary files when creating ZIP archives.
Various improvements and fixes in docs.

0.3¶

2022-12-08

Add support for BIN, CSV and XLSX files.
Better visual representation of generated images and PDFs.

0.2¶

2022-12-07

Added support for ICO, JPEG, PNG, SVG and WEBP files.
Documentation improvements.

0.1¶

2022-12-06

Initial beta release.

Package ¶

Contents:

faker_file package¶

Subpackages¶

faker_file.providers package¶

Submodules¶

faker_file.providers.bin_file module¶

class faker_file.providers.bin_file.BinFileProvider(generator: Any)[source]¶

Bases: BaseProvider, FileMixin

BIN file provider.

Usage example:

from faker_file.providers.bin_file import BinFileProvider

file = BinFileProvider(None).bin_file()

Usage example with options:

from faker_file.providers.bin_file import BinFileProvider

file = BinFileProvider(None).bin_file(
prefix=”zzz”, length=1024**2,

)

bin_file(root_path: Optional[str] = None, rel_path: str = 'tmp', prefix: Optional[str] = None, length: int = 1048576, content: Optional[bytes] = None, **kwargs) → StringValue[source]¶

Generate a CSV file with random text.

Parameters:

root_path – Path of your files root directory (in case of Django it would be settings.MEDIA_ROOT).
rel_path – Relative path (from root directory).
prefix – File name prefix.
length –
content – File content. If given, used as is.

Returns:

Relative path (from root directory) of the generated file.

extension: str = 'bin'¶

faker_file.providers.csv_file module¶

class faker_file.providers.csv_file.CsvFileProvider(generator: Any)[source]¶

Bases: BaseProvider, FileMixin

CSV file provider.

Usage example:

from faker_file.providers.csv_file import CsvFileProvider

file = CsvFileProvider(None).csv_file()

Usage example with options:

from faker_file.providers.csv_file import CsvFileProvider

file = CsvFileProvider(None).csv_file(
prefix=”zzz”, num_rows=100, data_columns=(‘{{name}}’, ‘{{sentence}}’, ‘{{address}}’), include_row_ids=True,

)

csv_file(root_path: Optional[str] = None, rel_path: str = 'tmp', prefix: Optional[str] = None, header: Optional[Sequence[str]] = None, data_columns: Tuple[str, str] = ('{{name}}', '{{address}}'), num_rows: int = 10, include_row_ids: bool = False, content: Optional[str] = None, **kwargs) → StringValue[source]¶

Generate a CSV file with random text.

Parameters:

root_path – Path of your files root directory (in case of Django it would be settings.MEDIA_ROOT).
rel_path – Relative path (from root directory).
header – The header argument expects a list or a tuple of strings that will serve as the header row if supplied.
data_columns – The data_columns argument expects a list or a tuple of string tokens, and these string tokens will be passed to pystr_format() for data generation. Argument Groups are used to pass arguments to the provider methods. Both header and data_columns must be of the same length.
num_rows – The num_rows argument controls how many rows of data to generate, and the include_row_ids argument may be set to True to include a sequential row ID column.
include_row_ids –
prefix – File name prefix.
content – File content. If given, used as is.

Returns:

Relative path (from root directory) of the generated file.

extension: str = 'csv'¶

faker_file.providers.docx_file module¶

class faker_file.providers.docx_file.DocxFileProvider(generator: Any)[source]¶

Bases: BaseProvider, FileMixin

DOCX file provider.

Usage example:

from faker_file.providers.docx_file import DocxFileProvider

file = DocxFileProvider(None).docx_file()

Usage example with options:

from faker_file.providers.docx_file import DocxFileProvider

file = DocxFileProvider(None).docx_file(
prefix=”zzz”, max_nb_chars=100_000, wrap_chars_after=80,

)

docx_file(root_path: Optional[str] = None, rel_path: str = 'tmp', prefix: Optional[str] = None, max_nb_chars: int = 10000, wrap_chars_after: Optional[int] = None, content: Optional[str] = None, **kwargs) → StringValue[source]¶

Generate a DOCX file with random text.

Parameters:

root_path – Path of your files root directory (in case of Django it would be settings.MEDIA_ROOT).
rel_path – Relative path (from root directory).
prefix – File name prefix.
max_nb_chars – Max number of chars for the content.
wrap_chars_after – If given, the output string would be separated by line breaks after the given position.
content – File content. Might contain dynamic elements, which are then replaced by correspondent fixtures.

Returns:

Relative path (from root directory) of the generated file.

extension: str = 'docx'¶

faker_file.providers.ico_file module¶

class faker_file.providers.ico_file.IcoFileProvider(generator: Any)[source]¶

Bases: BaseProvider, FileMixin

ICO file provider.

Usage example:

from faker_file.providers.png_file import IcoFileProvider

file = IcoFileProvider(None).ico_file()

Usage example with options:

from faker_file.providers.ico_file import IcoFileProvider

file = IcoFileProvider(None).ico_file(
prefix=”zzz”, max_nb_chars=100_000, wrap_chars_after=80,

)

extension: str = 'ico'¶

ico_file(root_path: Optional[str] = None, rel_path: str = 'tmp', prefix: Optional[str] = None, max_nb_chars: int = 5000, wrap_chars_after: Optional[int] = None, content: Optional[str] = None, **kwargs) → StringValue[source]¶

Generate an ICO file with random text.

Parameters:

root_path – Path of your files root directory (in case of Django it would be settings.MEDIA_ROOT).
rel_path – Relative path (from root directory).
prefix – File name prefix.
max_nb_chars – Max number of chars for the content.
wrap_chars_after – If given, the output string would be separated by line breaks after the given position.
content – File content. Might contain dynamic elements, which are then replaced by correspondent fixtures.

Returns:

Relative path (from root directory) of the generated file.

faker_file.providers.jpeg_file module¶

class faker_file.providers.jpeg_file.JpegFileProvider(generator: Any)[source]¶

Bases: BaseProvider, FileMixin

JPEG file provider.

Usage example:

from faker_file.providers.jpeg_file import JpegFileProvider

file = JpegFileProvider(None).jpeg_file()

Usage example with options:

from faker_file.providers.jpeg_file import JpegFileProvider

file = JpegFileProvider(None).jpeg_file(
prefix=”zzz”, max_nb_chars=100_000, wrap_chars_after=80,

)

extension: str = 'jpg'¶

jpeg_file(root_path: Optional[str] = None, rel_path: str = 'tmp', prefix: Optional[str] = None, max_nb_chars: int = 5000, wrap_chars_after: Optional[int] = None, content: Optional[str] = None, **kwargs) → StringValue[source]¶

Generate a JPEG file with random text.

Parameters:

root_path – Path of your files root directory (in case of Django it would be settings.MEDIA_ROOT).
rel_path – Relative path (from root directory).
prefix – File name prefix.
max_nb_chars – Max number of chars for the content.
wrap_chars_after – If given, the output string would be separated by line breaks after the given position.
content – File content. Might contain dynamic elements, which are then replaced by correspondent fixtures.

Returns:

Relative path (from root directory) of the generated file.

faker_file.providers.pdf_file module¶

class faker_file.providers.pdf_file.PdfFileProvider(generator: Any)[source]¶

Bases: BaseProvider, FileMixin

PDF file provider.

Usage example:

from faker_file.providers.pdf_file import PdfFileProvider

file = PdfFileProvider(None).pdf_file()

Usage example with options:

from faker_file.providers.pdf_file import PdfFileProvider

file = PdfFileProvider(None).pdf_file(
prefix=”zzz”, max_nb_chars=100_000, wrap_chars_after=80,

)

extension: str = 'pdf'¶

pdf_file(root_path: Optional[str] = None, rel_path: str = 'tmp', prefix: Optional[str] = None, max_nb_chars: int = 10000, wrap_chars_after: Optional[int] = None, content: Optional[str] = None, **kwargs) → StringValue[source]¶

Generate a PDF file with random text.

Parameters:

root_path – Path of your files root directory (in case of Django it would be settings.MEDIA_ROOT).
rel_path – Relative path (from root directory).
prefix – File name prefix.
max_nb_chars – Max number of chars for the content.
wrap_chars_after – If given, the output string would be separated by line breaks after the given position.
content – File content. Might contain dynamic elements, which are then replaced by correspondent fixtures.

Returns:

Relative path (from root directory) of the generated file.

faker_file.providers.png_file module¶

class faker_file.providers.png_file.PngFileProvider(generator: Any)[source]¶

Bases: BaseProvider, FileMixin

PNG file provider.

Usage example:

from faker_file.providers.png_file import PngFileProvider

file = PngFileProvider(None).png_file()

Usage example with options:

from faker_file.providers.png_file import PngFileProvider

file = PngFileProvider(None).png_file(
prefix=”zzz”, max_nb_chars=100_000, wrap_chars_after=80,

)

extension: str = 'png'¶

png_file(root_path: Optional[str] = None, rel_path: str = 'tmp', prefix: Optional[str] = None, max_nb_chars: int = 5000, wrap_chars_after: Optional[int] = None, content: Optional[str] = None, **kwargs) → StringValue[source]¶

Generate a PNG file with random text.

Parameters:

root_path – Path of your files root directory (in case of Django it would be settings.MEDIA_ROOT).
rel_path – Relative path (from root directory).
prefix – File name prefix.
max_nb_chars – Max number of chars for the content.
wrap_chars_after – If given, the output string would be separated by line breaks after the given position.
content – File content. Might contain dynamic elements, which are then replaced by correspondent fixtures.

Returns:

Relative path (from root directory) of the generated file.

faker_file.providers.pptx_file module¶

class faker_file.providers.pptx_file.PptxFileProvider(generator: Any)[source]¶

Bases: BaseProvider, FileMixin

PPTX file provider.

Usage example:

from faker_file.providers.pptx_file import PptxFileProvider

file = PptxFileProvider(None).pptx_file()

Usage example with options:

from faker_file.providers.pptx_file import PptxFileProvider

file = PptxFileProvider(None).pptx_file(
prefix=”zzz”, max_nb_chars=100_000, wrap_chars_after=80,

)

extension: str = 'pptx'¶

pptx_file(root_path: Optional[str] = None, rel_path: str = 'tmp', prefix: Optional[str] = None, max_nb_chars: int = 10000, wrap_chars_after: Optional[int] = None, content: Optional[str] = None, **kwargs) → StringValue[source]¶

Generate a file with random text.

Parameters:

root_path – Path of your files root directory (in case of Django it would be settings.MEDIA_ROOT).
rel_path – Relative path (from root directory).
prefix – File name prefix.
max_nb_chars – Max number of chars for the content.
wrap_chars_after – If given, the output string would be separated by line breaks after the given position.
content – File content. Might contain dynamic elements, which are then replaced by correspondent fixtures.

Returns:

Relative path (from root directory) of the generated file.

faker_file.providers.svg_file module¶

class faker_file.providers.svg_file.SvgFileProvider(generator: Any)[source]¶

Bases: BaseProvider, FileMixin

SVG file provider.

Usage example:

from faker_file.providers.svg_file import SvgFileProvider

file = SvgFileProvider(None).svg_file()

Usage example with options:

from faker_file.providers.svg_file import SvgFileProvider

file = SvgFileProvider(None).svg_file(
prefix=”zzz”, max_nb_chars=100_000, wrap_chars_after=80,

)

extension: str = 'svg'¶

svg_file(root_path: Optional[str] = None, rel_path: str = 'tmp', prefix: Optional[str] = None, max_nb_chars: int = 5000, wrap_chars_after: Optional[int] = None, content: Optional[str] = None, **kwargs) → StringValue[source]¶

Generate an SVG file with random text.

Parameters:

root_path – Path of your files root directory (in case of Django it would be settings.MEDIA_ROOT).
rel_path – Relative path (from root directory).
prefix – File name prefix.
max_nb_chars – Max number of chars for the content.
wrap_chars_after – If given, the output string would be separated by line breaks after the given position.
content – File content. Might contain dynamic elements, which are then replaced by correspondent fixtures.

Returns:

Relative path (from root directory) of the generated file.

faker_file.providers.txt_file module¶

class faker_file.providers.txt_file.TxtFileProvider(generator: Any)[source]¶

Bases: BaseProvider, FileMixin

TXT file provider.

Usage example:

from faker_file.providers.txt_file import TxtFileProvider

file = TxtFileProvider(None).txt_file()

Usage example with options:

from faker_file.providers.txt_file import TxtFileProvider

file = TxtFileProvider(None).txt_file(
prefix=”zzz”, max_nb_chars=100_000, wrap_chars_after=80,

)

extension: str = 'txt'¶

txt_file(root_path: Optional[str] = None, rel_path: str = 'tmp', prefix: Optional[str] = None, max_nb_chars: int = 10000, wrap_chars_after: Optional[int] = None, content: Optional[str] = None, **kwargs) → StringValue[source]¶

Generate a TXT file with random text.

Parameters:

root_path – Path of your files root directory (in case of Django it would be settings.MEDIA_ROOT).
rel_path – Relative path (from root directory).
prefix – File name prefix.
max_nb_chars – Max number of chars for the content.
wrap_chars_after – If given, the output string would be separated by line breaks after the given position.
content – File content. Might contain dynamic elements, which are then replaced by correspondent fixtures.

Returns:

Relative path (from root directory) of the generated file.

faker_file.providers.webp_file module¶

class faker_file.providers.webp_file.WebpFileProvider(generator: Any)[source]¶

Bases: BaseProvider, FileMixin

WEBP file provider.

Usage example:

from faker_file.providers.webp_file import WebpFileProvider

file = WebpFileProvider(None).webp_file()

Usage example with options:

from faker_file.providers.webp_file import WebpFileProvider

file = WebpFileProvider(None).webp_file(
prefix=”zzz”, max_nb_chars=100_000, wrap_chars_after=80,

)

extension: str = 'webp'¶

webp_file(root_path: Optional[str] = None, rel_path: str = 'tmp', prefix: Optional[str] = None, max_nb_chars: int = 5000, wrap_chars_after: Optional[int] = None, content: Optional[str] = None, **kwargs) → StringValue[source]¶

Generate a WEBP file with random text.

Parameters:

root_path – Path of your files root directory (in case of Django it would be settings.MEDIA_ROOT).
rel_path – Relative path (from root directory).
prefix – File name prefix.
max_nb_chars – Max number of chars for the content.
wrap_chars_after – If given, the output string would be separated by line breaks after the given position.
content – File content. Might contain dynamic elements, which are then replaced by correspondent fixtures.

Returns:

Relative path (from root directory) of the generated file.

faker_file.providers.xlsx_file module¶

class faker_file.providers.xlsx_file.XlsxFileProvider(generator: Any)[source]¶

Bases: BaseProvider, FileMixin

XLSX file provider.

Usage example:

from faker import Faker from faker_file.providers.xlsx_file import XlsxFileProvider

file = XlsxFileProvider(Faker()).xlsx_file()

Usage example with options:

from faker import Faker from faker_file.providers.xlsx_file import XlsxFileProvider

file = XlsxFileProvider(Faker()).xlsx_file(
prefix=”zzz”, num_rows=100, data_columns={

“name”: “{{name}}”, “residency”: “{{address}}”,

}, include_row_ids=True,

)

extension: str = 'xlsx'¶

xlsx_file(root_path: Optional[str] = None, rel_path: str = 'tmp', prefix: Optional[str] = None, data_columns: Optional[Dict[str, str]] = None, num_rows: int = 10, content: Optional[str] = None, **kwargs) → StringValue[source]¶

Generate a XLSX file with random text.

Parameters:

root_path – Path of your files root directory (in case of Django it would be settings.MEDIA_ROOT).
rel_path – Relative path (from root directory).
data_columns – The data_columns argument expects a list or a tuple of string tokens, and these string tokens will be passed to pystr_format() for data generation. Argument Groups are used to pass arguments to the provider methods. Both header and data_columns must be of the same length.
num_rows – The num_rows argument controls how many rows of data to generate, and the include_row_ids argument may be set to True to include a sequential row ID column.
prefix – File name prefix.
content – List of dicts with content (JSON-like format). If given, used as is.

Returns:

Relative path (from root directory) of the generated file.

faker_file.providers.zip_file module¶

class faker_file.providers.zip_file.ZipFileProvider(generator: Any)[source]¶

Bases: BaseProvider, FileMixin

ZIP file provider.

Usage example:

from faker import Faker from faker_file.providers.zip_file import ZipFileProvider

FAKER = Faker()

file = ZipFileProvider(FAKER).zip_file()

Usage example with options:

from faker_file.providers.zip_file import (
ZipFileProvider, create_inner_docx_file

)

file = ZipFileProvider(FAKER).zip_file(
prefix=”zzz_archive_”, options={

“count”: 5, “create_inner_file_func”: create_inner_docx_file, “create_inner_file_args”: {

“prefix”: “zzz_docx_file_”, “max_nb_chars”: 1_024,

}, “directory”: “zzz”,

}

)

Usage example of nested ZIPs:

file = ZipFileProvider(FAKER).zip_file(

options={
“create_inner_file_func”: create_inner_zip_file, “create_inner_file_args”: {

“options”: {
“create_inner_file_func”: create_inner_docx_file,

}

}

}

)

If you want to see, which files were included inside the zip, check the file.data["files"].

extension: str = 'zip'¶

zip_file(root_path: Optional[str] = None, rel_path: str = 'tmp', prefix: Optional[str] = None, options: Optional[Dict[str, Any]] = None, **kwargs) → StringValue[source]¶

Generate a ZIP file with random text.

Parameters:

root_path – Path of your files root directory (in case of Django it would be settings.MEDIA_ROOT).
rel_path – Relative path (from root directory).
prefix – File name prefix.
options – Options (non-structured) for complex types, such as zip.

Returns:

Relative path (from root directory) of the generated file.

faker_file.providers.zip_file.create_inner_bin_file(root_path: Optional[str] = None, rel_path: str = 'tmp', prefix: Optional[str] = None, generator: Optional[Union[Provider, Faker]] = None, length: int = 1048576, content: Optional[str] = None, **kwargs) → StringValue[source]¶: Create inner BIN file.

faker_file.providers.zip_file.create_inner_csv_file(root_path: Optional[str] = None, rel_path: str = 'tmp', prefix: Optional[str] = None, generator: Optional[Union[Provider, Faker]] = None, header: Optional[Sequence[str]] = None, data_columns: Tuple[str, str] = ('{{name}}', '{{address}}'), num_rows: int = 10, include_row_ids: bool = False, content: Optional[str] = None, **kwargs) → StringValue[source]¶: Create inner CSV file.

faker_file.providers.zip_file.create_inner_docx_file(root_path: Optional[str] = None, rel_path: str = 'tmp', prefix: Optional[str] = None, generator: Optional[Union[Provider, Faker]] = None, max_nb_chars: int = 10000, wrap_chars_after: Optional[int] = None, content: Optional[str] = None, **kwargs) → StringValue[source]¶: Create inner DOCX file.

faker_file.providers.zip_file.create_inner_ico_file(root_path: Optional[str] = None, rel_path: str = 'tmp', prefix: Optional[str] = None, generator: Optional[Union[Provider, Faker]] = None, max_nb_chars: int = 5000, wrap_chars_after: Optional[int] = None, content: Optional[str] = None, **kwargs) → StringValue[source]¶: Create inner ICO file.

faker_file.providers.zip_file.create_inner_jpeg_file(root_path: Optional[str] = None, rel_path: str = 'tmp', prefix: Optional[str] = None, generator: Optional[Union[Provider, Faker]] = None, max_nb_chars: int = 5000, wrap_chars_after: Optional[int] = None, content: Optional[str] = None, **kwargs) → StringValue[source]¶: Create inner JPEG file.

faker_file.providers.zip_file.create_inner_ods_file(root_path: Optional[str] = None, rel_path: str = 'tmp', prefix: Optional[str] = None, generator: Optional[Union[Provider, Faker]] = None, data_columns: Optional[Dict[str, str]] = None, num_rows: int = 10, content: Optional[str] = None, **kwargs) → StringValue[source]¶: Create inner ODS file.

faker_file.providers.zip_file.create_inner_pdf_file(root_path: Optional[str] = None, rel_path: str = 'tmp', prefix: Optional[str] = None, generator: Optional[Union[Provider, Faker]] = None, max_nb_chars: int = 10000, wrap_chars_after: Optional[int] = None, content: Optional[str] = None, **kwargs) → StringValue[source]¶: Create inner PDF file.

faker_file.providers.zip_file.create_inner_png_file(root_path: Optional[str] = None, rel_path: str = 'tmp', prefix: Optional[str] = None, generator: Optional[Union[Provider, Faker]] = None, max_nb_chars: int = 5000, wrap_chars_after: Optional[int] = None, content: Optional[str] = None, **kwargs) → StringValue[source]¶: Create inner PNG file.

faker_file.providers.zip_file.create_inner_pptx_file(root_path: Optional[str] = None, rel_path: str = 'tmp', prefix: Optional[str] = None, generator: Optional[Union[Provider, Faker]] = None, max_nb_chars: int = 10000, wrap_chars_after: Optional[int] = None, content: Optional[str] = None, **kwargs) → StringValue[source]¶: Create inner PPTX file.

faker_file.providers.zip_file.create_inner_svg_file(root_path: Optional[str] = None, rel_path: str = 'tmp', prefix: Optional[str] = None, generator: Optional[Union[Provider, Faker]] = None, max_nb_chars: int = 5000, wrap_chars_after: Optional[int] = None, content: Optional[str] = None, **kwargs) → StringValue[source]¶: Create inner SVG file.

faker_file.providers.zip_file.create_inner_txt_file(root_path: Optional[str] = None, rel_path: str = 'tmp', prefix: Optional[str] = None, generator: Optional[Union[Provider, Faker]] = None, max_nb_chars: int = 10000, wrap_chars_after: Optional[int] = None, content: Optional[str] = None, **kwargs) → StringValue[source]¶

faker_file.providers.zip_file.create_inner_webp_file(root_path: Optional[str] = None, rel_path: str = 'tmp', prefix: Optional[str] = None, generator: Optional[Union[Provider, Faker]] = None, max_nb_chars: int = 5000, wrap_chars_after: Optional[int] = None, content: Optional[str] = None, **kwargs) → StringValue[source]¶: Create inner WEBP file.

faker_file.providers.zip_file.create_inner_xlsx_file(root_path: Optional[str] = None, rel_path: str = 'tmp', prefix: Optional[str] = None, generator: Optional[Union[Provider, Faker]] = None, data_columns: Optional[Dict[str, str]] = None, num_rows: int = 10, content: Optional[str] = None, **kwargs) → StringValue[source]¶: Create inner XLSX file.

faker_file.providers.zip_file.create_inner_zip_file(root_path: Optional[str] = None, rel_path: str = 'tmp', prefix: Optional[str] = None, generator: Optional[Union[Provider, Faker]] = None, options: Optional[Dict[str, Any]] = None, **kwargs) → StringValue[source]¶: Create inner ZIP file.

Module contents¶

faker_file.tests package¶

Submodules¶

faker_file.tests.test_django_integration module¶

class faker_file.tests.test_django_integration.DjangoIntegrationTestCase(methodName='runTest')[source]¶

Bases: TestCase

Django integration test case.

FAKER: Faker¶

test_file¶

faker_file.tests.test_providers module¶

class faker_file.tests.test_providers.ProvidersTestCase(methodName='runTest')[source]¶

Bases: TestCase

Providers test case.

FAKER: Faker¶

test_broken_imports¶

test_faker¶

test_standalone_providers¶

test_standalone_providers_allow_failures¶

test_standalone_zip_file¶

test_standalone_zip_file_allow_failures¶

Module contents¶

Submodules¶

faker_file.base module¶

class faker_file.base.FileMixin[source]¶

Bases: object

File mixin.

extension: str¶

formats: List[str]¶

generator: Union[Provider, Faker]¶

numerify: Callable¶

random_element: Callable¶

class faker_file.base.StringValue[source]¶

Bases: str

data: Dict[str, Any] = {}¶

faker_file.constants module¶

faker_file.helpers module¶

faker_file.helpers.wrap_text(text: str, wrap_chars_after: int) → str[source]¶

Quick start¶

Installation¶

Usage¶

With Faker¶

With factory_boy¶

upload/models.py¶

upload/factories.py¶

Recipes¶

When using with Faker¶

One way¶

Prerequisites¶

Create a TXT file with static content¶

Create a DOCX file with dynamically generated content¶

Create a ZIP file consisting of TXT files with static content¶

Create a ZIP file consisting of 3 DOCX files with dynamically generated content¶

Create a ZIP file which contains 5 ZIP files which contain 5 ZIP files which contain 5 DOCX files¶

Or another¶

Create a TXT file with static content¶

Create a DOCX file with dynamically generated content¶

Create a PDF file with predefined template containing dynamic fixtures¶

When using with Django (and factory_boy)¶

Basic example¶

Imaginary Django model¶

Correspondent factory_boy factory¶

Randomize provider choice¶

Release history and notes¶

0.6¶

0.5¶

0.4¶

0.3¶

0.2¶

0.1¶

faker_file package¶

Subpackages¶

faker_file.providers package¶

Submodules¶

faker_file.providers.bin_file module¶

faker_file.providers.csv_file module¶

faker_file.providers.docx_file module¶

faker_file.providers.ico_file module¶

faker_file.providers.jpeg_file module¶

faker_file.providers.pdf_file module¶

faker_file.providers.png_file module¶

faker_file.providers.pptx_file module¶

faker_file.providers.svg_file module¶

faker_file.providers.txt_file module¶

faker_file.providers.webp_file module¶

faker_file.providers.xlsx_file module¶

faker_file.providers.zip_file module¶

Module contents¶

faker_file.tests package¶

Submodules¶

faker_file.tests.test_django_integration module¶

faker_file.tests.test_providers module¶

Module contents¶

Submodules¶

faker_file.base module¶

faker_file.constants module¶

faker_file.helpers module¶

Module contents¶

With `Faker`¶

With `factory_boy`¶

When using with `Faker`¶

When using with `Django` (and `factory_boy`)¶

Imaginary `Django` model¶

Correspondent `factory_boy` factory¶