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

CSV file provider.

Usage example:

from faker_file.providers.xlsx_file import XlsxFileProvider

file = XlsxFileProvider(None).xlsx_file()

Usage example with options:

from faker_file.providers.xlsx_file import XlsxFileProvider

file = XlsxFileProvider(None).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_file.providers.zip_file import ZipFileProvider

file = ZipFileProvider(None).zip_file()

Usage example with options:

from faker_file.providers.zip_file import (

ZipFileProvider, create_inner_docx_file

)

file = ZipFileProvider(None).zip_file(

prefix=”zzz_archive_”, options={

“count”: 5, “create_inner_file_func”: create_inner_docx_file, “max_nb_chars”: 1_024, “prefix”: “zzz_docx_file_”, “directory”: “zzz”,

}

)

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, 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, 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, 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, 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, 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_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]

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, 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, 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, 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, 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, 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, data_columns: Optional[Dict[str, str]] = None, num_rows: int = 10, content: Optional[str] = None, **kwargs) → StringValue[source]

Create inner XLSX file.

Module contents