faker_file.providers package¶
Subpackages¶
- faker_file.providers.augment_file_from_dir package
- faker_file.providers.helpers package
- Submodules
- faker_file.providers.helpers.inner module
create_inner_bin_file()
create_inner_csv_file()
create_inner_docx_file()
create_inner_eml_file()
create_inner_epub_file()
create_inner_ico_file()
create_inner_jpeg_file()
create_inner_mp3_file()
create_inner_odp_file()
create_inner_ods_file()
create_inner_odt_file()
create_inner_pdf_file()
create_inner_png_file()
create_inner_pptx_file()
create_inner_rtf_file()
create_inner_svg_file()
create_inner_tar_file()
create_inner_txt_file()
create_inner_webp_file()
create_inner_xlsx_file()
create_inner_zip_file()
fuzzy_choice_create_inner_file()
- Module contents
- faker_file.providers.mixins package
- faker_file.providers.mp3_file 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 import Faker from faker_file.providers.bin_file import BinFileProvider
file = BinFileProvider(Faker()).bin_file()
Usage example with options:
- file = BinFileProvider(Faker()).bin_file(
prefix=”zzz”, length=1024**2,
)
Usage example with FileSystemStorage storage (for Django):
from django.conf import settings from faker_file.storages.filesystem import FileSystemStorage
- file = BinFileProvider(Faker()).bin_file(
- storage=FileSystemStorage(
root_path=settings.MEDIA_ROOT, rel_path=”tmp”,
), prefix=”zzz”, length=1024**2,
)
Usage example with AWS S3 storage:
from faker_file.storages.aws_s3 import AWSS3Storage
- file = BinFileProvider(Faker()).bin_file(
storage=AWSS3Storage(bucket_name=”My-test-bucket”), prefix=”zzz”, length=1024**2,
)
- bin_file(storage: Optional[BaseStorage] = None, prefix: Optional[str] = None, length: int = 1048576, content: Optional[bytes] = None, **kwargs) StringValue [source]¶
Generate a CSV file with random text.
- Parameters:
storage – Storage class. Defaults to FileSystemStorage.
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 import Faker from faker_file.providers.csv_file import CsvFileProvider
file = CsvFileProvider(Faker()).csv_file()
Usage example with options:
from faker_file.providers.csv_file import CsvFileProvider
- file = CsvFileProvider(Faker()).csv_file(
prefix=”zzz”, num_rows=100, data_columns=(‘{{name}}’, ‘{{sentence}}’, ‘{{address}}’), include_row_ids=True,
)
Usage example with FileSystemStorage storage (for Django):
from django.conf import settings from faker_file.storages.filesystem import FileSystemStorage
- file = CsvFileProvider(Faker()).csv_file(
- storage=FileSystemStorage(
root_path=settings.MEDIA_ROOT, rel_path=”tmp”,
), prefix=”zzz”, num_rows=100,
)
- csv_file(storage: Optional[BaseStorage] = None, 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, encoding: Optional[str] = None, **kwargs) StringValue [source]¶
Generate a CSV file with random text.
- Parameters:
storage – Storage. Defaults to FileSystemStorage.
prefix – File name prefix.
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 topystr_format()
for data generation. Argument Groups are used to pass arguments to the provider methods. Bothheader
anddata_columns
must be of the same length.num_rows – The
num_rows
argument controls how many rows of data to generate, and theinclude_row_ids
argument may be set toTrue
to include a sequential row ID column.include_row_ids –
content – File content. If given, used as is.
encoding – Encoding.
- 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 import Faker from faker_file.providers.docx_file import DocxFileProvider
file = DocxFileProvider(Faker()).docx_file()
Usage example with options:
- file = DocxFileProvider(Faker()).docx_file(
prefix=”zzz”, max_nb_chars=100_000, wrap_chars_after=80,
)
Usage example with FileSystemStorage storage (for Django):
from django.conf import settings from faker_file.storages.filesystem import FileSystemStorage
- file = DocxFileProvider(Faker()).docx_file(
- storage=FileSystemStorage(
root_path=settings.MEDIA_ROOT, rel_path=”tmp”,
), prefix=”zzz”, max_nb_chars=100_000, wrap_chars_after=80,
)
- docx_file(storage: Optional[BaseStorage] = None, 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:
storage – Storage. Defaults to FileSystemStorage.
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.eml_file module¶
- class faker_file.providers.eml_file.EmlFileProvider(generator: Any)[source]¶
Bases:
BaseProvider
,FileMixin
EML file provider.
Usage example:
from faker import Faker from faker_file.providers.eml_file import EmlFileProvider
FAKER = Faker()
file = EmlFileProvider(FAKER).eml_file()
Usage example with attachments:
from faker_file.providers.helpers.inner import create_inner_docx_file from faker_file.providers.eml_file import EmlFileProvider
- file = EmlFileProvider(FAKER).eml_file(
prefix=”zzz_email_”, options={
“count”: 5, “create_inner_file_func”: create_inner_docx_file, “create_inner_file_args”: {
“prefix”: “zzz_docx_file_”, “max_nb_chars”: 1_024,
},
}
)
Usage example of nested EMLs attachments:
from faker_file.providers.helpers.inner import create_inner_eml_file
- file = EmlFileProvider(FAKER).eml_file(
- options={
“create_inner_file_func”: create_inner_eml_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 EML, check the
file.data["files"]
.- eml_file(storage: Optional[BaseStorage] = None, prefix: Optional[str] = None, options: Optional[Dict[str, Any]] = None, max_nb_chars: int = 10000, wrap_chars_after: Optional[int] = None, content: Optional[str] = None, **kwargs) StringValue [source]¶
Generate an EML file with random text.
- Parameters:
storage – Storage. Defaults to FileSystemStorage.
prefix – File name prefix.
options – Options (non-structured) for complex types, such as ZIP.
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 = 'eml'¶
faker_file.providers.epub_file module¶
- class faker_file.providers.epub_file.EpubFileProvider(generator: Any)[source]¶
Bases:
BaseProvider
,FileMixin
EPUB file provider.
Usage example:
from faker import Faker from faker_file.providers.epub_file import EpubFileProvider
file = EpubFileProvider(Faker()).epub_file()
Usage example with options:
- file = EpubFileProvider(Faker()).epub_file(
prefix=”zzz”, max_nb_chars=100_000, wrap_chars_after=80,
)
Usage example with FileSystemStorage storage (for Django):
from django.conf import settings from faker_file.storages.filesystem import FileSystemStorage
- file = EpubFileProvider(Faker()).epub_file(
- storage=FileSystemStorage(
root_path=settings.MEDIA_ROOT, rel_path=”tmp”,
), prefix=”zzz”, max_nb_chars=100_000, wrap_chars_after=80,
)
- epub_file(storage: Optional[BaseStorage] = None, prefix: Optional[str] = None, max_nb_chars: int = 10000, wrap_chars_after: Optional[int] = None, content: Optional[str] = None, title: Optional[str] = None, chapter_title: Optional[str] = None, **kwargs) StringValue [source]¶
Generate a EPUB file with random text.
- Parameters:
storage – Storage. Defaults to FileSystemStorage.
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.
title – E-book title. Might contain dynamic elements, which are then replaced by correspondent fixtures.
chapter_title – Chapter title. Might contain dynamic elements, which are then replaced by correspondent fixtures.
- Returns:
Relative path (from root directory) of the generated file.
- extension: str = 'epub'¶
faker_file.providers.ico_file module¶
- class faker_file.providers.ico_file.IcoFileProvider(generator: Any)[source]¶
Bases:
BaseProvider
,ImageMixin
ICO file provider.
Usage example:
from faker import Faker from faker_file.providers.png_file import IcoFileProvider
file = IcoFileProvider(Faker()).ico_file()
Usage example with options:
- file = IcoFileProvider(Faker()).ico_file(
prefix=”zzz”, max_nb_chars=100_000, wrap_chars_after=80,
)
Usage example with FileSystemStorage storage (for Django):
from django.conf import settings from faker_file.storages.filesystem import FileSystemStorage
- file = IcoFileProvider(Faker()).ico_file(
- storage=FileSystemStorage(
root_path=settings.MEDIA_ROOT, rel_path=”tmp”,
), prefix=”zzz”, max_nb_chars=100_000, wrap_chars_after=80,
)
- extension: str = 'ico'¶
- ico_file(storage: Optional[BaseStorage] = None, 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:
storage – Storage. Defaults to FileSystemStorage.
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
,ImageMixin
JPEG file provider.
Usage example:
from faker import Faker from faker_file.providers.jpeg_file import JpegFileProvider
file = JpegFileProvider(None).jpeg_file()
Usage example with options:
- file = JpegFileProvider(None).jpeg_file(
prefix=”zzz”, max_nb_chars=100_000, wrap_chars_after=80,
)
Usage example with FileSystemStorage storage (for Django):
from django.conf import settings from faker_file.storages.filesystem import FileSystemStorage
- file = JpegFileProvider(Faker()).jpeg_file(
- storage=FileSystemStorage(
root_path=settings.MEDIA_ROOT, rel_path=”tmp”,
), prefix=”zzz”, max_nb_chars=100_000, wrap_chars_after=80,
)
- extension: str = 'jpg'¶
- jpeg_file(storage: Optional[BaseStorage] = None, 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:
storage – Storage. Defaults to FileSystemStorage.
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.ods_file module¶
- class faker_file.providers.ods_file.OdsFileProvider(generator: Any)[source]¶
Bases:
BaseProvider
,TabularDataMixin
ODS file provider.
Usage example:
from faker import Faker from faker_file.providers.ods_file import OdsFileProvider
file = OdsFileProvider(Faker()).ods_file()
Usage example with options:
from faker import Faker from faker_file.providers.ods_file import OdsFileProvider
- file = OdsFileProvider(Faker()).ods_file(
prefix=”zzz”, num_rows=100, data_columns={
“name”: “{{name}}”, “residency”: “{{address}}”,
}, include_row_ids=True,
)
Usage example with FileSystemStorage storage (for Django):
from django.conf import settings from faker_file.storages.filesystem import FileSystemStorage
- file = OdsFileProvider(Faker()).ods_file(
- storage=FileSystemStorage(
root_path=settings.MEDIA_ROOT, rel_path=”tmp”,
), prefix=”zzz”, num_rows=100, data_columns={
“name”: “{{name}}”, “residency”: “{{address}}”,
}, include_row_ids=True,
)
- extension: str = 'ods'¶
- ods_file(storage: Optional[BaseStorage] = None, prefix: Optional[str] = None, data_columns: Optional[Dict[str, str]] = None, num_rows: int = 10, content: Optional[str] = None, **kwargs) StringValue [source]¶
Generate an ODS file with random text.
- Parameters:
storage – Storage. Defaults to FileSystemStorage.
data_columns – The
data_columns
argument expects a list or a tuple of string tokens, and these string tokens will be passed topystr_format()
for data generation. Argument Groups are used to pass arguments to the provider methods. Bothheader
anddata_columns
must be of the same length.num_rows – The
num_rows
argument controls how many rows of data to generate, and theinclude_row_ids
argument may be set toTrue
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.odt_file module¶
- class faker_file.providers.odt_file.OdtFileProvider(generator: Any)[source]¶
Bases:
BaseProvider
,FileMixin
ODT file provider.
Usage example:
from faker import Faker from faker_file.providers.odt_file import OdtFileProvider
FAKER = Faker()
file = OdtFileProvider(FAKER).odt_file()
Usage example with options:
- file = OdtFileProvider(FAKER).odt_file(
prefix=”zzz”, max_nb_chars=100_000, wrap_chars_after=80,
)
Usage example with FileSystemStorage storage (for Django):
from django.conf import settings from faker_file.storages.filesystem import FileSystemStorage
- file = OdtFileProvider(FAKER).odt_file(
- storage=FileSystemStorage(
root_path=settings.MEDIA_ROOT, rel_path=”tmp”,
), prefix=”zzz”, max_nb_chars=100_000, wrap_chars_after=80,
)
- extension: str = 'odt'¶
- odt_file(storage: Optional[BaseStorage] = None, prefix: Optional[str] = None, max_nb_chars: int = 10000, wrap_chars_after: Optional[int] = None, content: Optional[str] = None, **kwargs) StringValue [source]¶
Generate an ODT file with random text.
- Parameters:
storage – Storage. Defaults to FileSystemStorage.
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,
)
Usage example with FileSystemStorage storage (for Django):
from django.conf import settings from faker_file.storages.filesystem import FileSystemStorage
- file = PdfFileProvider(Faker()).pdf_file(
- storage=FileSystemStorage(
root_path=settings.MEDIA_ROOT, rel_path=”tmp”,
), prefix=”zzz”, max_nb_chars=100_000, wrap_chars_after=80,
)
- extension: str = 'pdf'¶
- pdf_file(storage: Optional[BaseStorage] = None, prefix: Optional[str] = None, max_nb_chars: int = 10000, wrap_chars_after: Optional[int] = None, content: Optional[str] = None, encoding: Optional[str] = 'utf-8', **kwargs) StringValue [source]¶
Generate a PDF file with random text.
- Parameters:
storage – Storage. Defaults to FileSystemStorage.
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.
encoding – Encoding of the file.
- 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
,ImageMixin
PNG file provider.
Usage example:
from faker import Faker from faker_file.providers.png_file import PngFileProvider
file = PngFileProvider(Faker()).png_file()
Usage example with options:
- file = PngFileProvider(Faker()).png_file(
prefix=”zzz”, max_nb_chars=100_000, wrap_chars_after=80,
)
Usage example with FileSystemStorage storage (for Django):
from django.conf import settings from faker_file.storages.filesystem import FileSystemStorage
- file = PngFileProvider(Faker()).png_file(
- storage=FileSystemStorage(
root_path=settings.MEDIA_ROOT, rel_path=”tmp”,
), prefix=”zzz”, max_nb_chars=100_000, wrap_chars_after=80,
)
- extension: str = 'png'¶
- png_file(storage: Optional[BaseStorage] = None, 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:
storage – Storage. Defaults to FileSystemStorage.
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,
)
Usage example with FileSystemStorage storage (for Django):
from django.conf import settings from faker_file.storages.filesystem import FileSystemStorage
- file = PptxFileProvider(Faker()).pptx_file(
- storage=FileSystemStorage(
root_path=settings.MEDIA_ROOT, rel_path=”tmp”,
), prefix=”zzz”, max_nb_chars=100_000, wrap_chars_after=80,
)
- extension: str = 'pptx'¶
- pptx_file(storage: Optional[BaseStorage] = None, 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:
storage – Storage. Defaults to FileSystemStorage.
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.random_file_from_dir module¶
- class faker_file.providers.random_file_from_dir.RandomFileFromDirProvider(generator: Any)[source]¶
Bases:
BaseProvider
,FileMixin
Random file from given directory provider.
Usage example:
- from faker_file.providers.random_file_from_dir import (
RandomFileFromDirProvider,
)
- file = RandomFileFromDirProvider(None).random_file_from_dir(
source_dir_path=”/tmp/tmp/”,
)
Usage example with options:
- from faker_file.providers.random_file_from_dir import (
RandomFileFromDirProvider,
)
- file = RandomFileFromDirProvider(None).random_file_from_dir(
source_dir_path=”/tmp/tmp/”, prefix=”zzz”,
)
- extension: str = ''¶
- random_file_from_dir(source_dir_path: str, storage: Optional[BaseStorage] = None, prefix: Optional[str] = None, **kwargs) StringValue [source]¶
Pick a random file from given directory.
- Parameters:
source_dir_path – Source files directory.
storage – Storage. Defaults to FileSystemStorage.
prefix – File name prefix.
- Returns:
Relative path (from root directory) of the generated file.
faker_file.providers.rtf_file module¶
- class faker_file.providers.rtf_file.RtfFileProvider(generator: Any)[source]¶
Bases:
BaseProvider
,FileMixin
RTF file provider.
Usage example:
from faker_file.providers.rtf_file import RtfFileProvider
file = RtfFileProvider(None).rtf_file()
Usage example with options:
from faker_file.providers.rtf_file import RtfFileProvider
- file = RtfFileProvider(None).rtf_file(
prefix=”zzz”, max_nb_chars=100_000, wrap_chars_after=80,
)
Usage example with FileSystemStorage storage (for Django):
from django.conf import settings from faker_file.storages.filesystem import FileSystemStorage
- file = RtfFileProvider(Faker()).rtf_file(
- storage=FileSystemStorage(
root_path=settings.MEDIA_ROOT, rel_path=”tmp”,
), prefix=”zzz”, max_nb_chars=100_000, wrap_chars_after=80,
)
- extension: str = 'rtf'¶
- rtf_file(storage: Optional[BaseStorage] = None, prefix: Optional[str] = None, max_nb_chars: int = 10000, wrap_chars_after: Optional[int] = None, content: Optional[str] = None, **kwargs) StringValue [source]¶
Generate a RTF file with random text.
- Parameters:
storage – Storage. Defaults to FileSystemStorage.
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
,ImageMixin
SVG file provider.
Usage example:
from faker import Faker from faker_file.providers.svg_file import SvgFileProvider
file = SvgFileProvider(Faker()).svg_file()
Usage example with options:
- file = SvgFileProvider(Faker()).svg_file(
prefix=”zzz”, max_nb_chars=100_000, wrap_chars_after=80,
)
Usage example with FileSystemStorage storage (for Django):
from django.conf import settings from faker_file.storages.filesystem import FileSystemStorage
- file = SvgFileProvider(Faker()).svg_file(
- storage=FileSystemStorage(
root_path=settings.MEDIA_ROOT, rel_path=”tmp”,
), prefix=”zzz”, max_nb_chars=100_000, wrap_chars_after=80,
)
- extension: str = 'svg'¶
- svg_file(storage: Optional[BaseStorage] = None, 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:
storage – Storage. Defaults to FileSystemStorage.
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 import Faker from faker_file.providers.txt_file import TxtFileProvider
file = TxtFileProvider(Faker()).txt_file()
Usage example with options:
- file = TxtFileProvider(Faker()).txt_file(
prefix=”zzz”, max_nb_chars=100_000, wrap_chars_after=80,
)
Usage example with FileSystemStorage storage (for Django):
from django.conf import settings from faker_file.storages.filesystem import FileSystemStorage
- file = TxtFileProvider(Faker()).txt_file(
- storage=FileSystemStorage(
root_path=settings.MEDIA_ROOT, rel_path=”tmp”,
), prefix=”zzz”, max_nb_chars=100_000, wrap_chars_after=80,
)
- extension: str = 'txt'¶
- txt_file(storage: Optional[BaseStorage] = None, 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:
storage – Storage. Defaults to FileSystemStorage.
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
,ImageMixin
WEBP file provider.
Usage example:
from faker import Faker from faker_file.providers.webp_file import WebpFileProvider
file = WebpFileProvider(Faker()).webp_file()
Usage example with options:
- file = WebpFileProvider(Faker()).webp_file(
prefix=”zzz”, max_nb_chars=100_000, wrap_chars_after=80,
)
Usage example with FileSystemStorage storage (for Django):
from django.conf import settings from faker_file.storages.filesystem import FileSystemStorage
- file = WebpFileProvider(Faker()).webp_file(
- storage=FileSystemStorage(
root_path=settings.MEDIA_ROOT, rel_path=”tmp”,
), prefix=”zzz”, max_nb_chars=100_000, wrap_chars_after=80,
)
- extension: str = 'webp'¶
- webp_file(storage: Optional[BaseStorage] = None, 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:
storage – Storage. Defaults to FileSystemStorage.
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
,TabularDataMixin
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,
)
Usage example with FileSystemStorage storage (for Django):
from django.conf import settings from faker_file.storages.filesystem import FileSystemStorage
- file = XlsxFileProvider(Faker()).xlsx_file(
- storage=FileSystemStorage(
root_path=settings.MEDIA_ROOT, rel_path=”tmp”,
), prefix=”zzz”, num_rows=100, data_columns={
“name”: “{{name}}”, “residency”: “{{address}}”,
}, include_row_ids=True,
)
- extension: str = 'xlsx'¶
- xlsx_file(storage: Optional[BaseStorage] = None, 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:
storage – Storage. Defaults to FileSystemStorage.
data_columns – The
data_columns
argument expects a list or a tuple of string tokens, and these string tokens will be passed topystr_format()
for data generation. Argument Groups are used to pass arguments to the provider methods. Bothheader
anddata_columns
must be of the same length.num_rows – The
num_rows
argument controls how many rows of data to generate, and theinclude_row_ids
argument may be set toTrue
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.helpers.inner import create_inner_docx_file from faker_file.providers.zip_file import ZipFileProvider
- 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:
from faker_file.providers.helpers.inner import create_inner_zip_file
- 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(storage: Optional[BaseStorage] = None, prefix: Optional[str] = None, options: Optional[Dict[str, Any]] = None, **kwargs) StringValue [source]¶
Generate a ZIP file with random text.
- Parameters:
storage – Storage. Defaults to FileSystemStorage.
prefix – File name prefix.
options – Options (non-structured) for complex types, such as ZIP.
- Returns:
Relative path (from root directory) of the generated file.