from random import choice
from typing import (
Any,
Callable,
Dict,
Iterable,
List,
Optional,
Sequence,
Tuple,
Type,
Union,
overload,
)
from faker import Faker
from faker.generator import Generator
from faker.providers.python import Provider
from ...base import DEFAULT_FORMAT_FUNC, BytesValue, StringValue
from ...constants import (
DEFAULT_AUDIO_MAX_NB_CHARS,
DEFAULT_IMAGE_MAX_NB_CHARS,
DEFAULT_TEXT_MAX_NB_CHARS,
)
from ...helpers import random_pop
from ...storages.base import BaseStorage
from ..base.mp3_generator import BaseMp3Generator
from ..base.pdf_generator import BasePdfGenerator
__author__ = "Artur Barseghyan <artur.barseghyan@gmail.com>"
__copyright__ = "2022-2023 Artur Barseghyan"
__license__ = "MIT"
__all__ = (
"create_inner_augment_image_from_path",
"create_inner_augment_random_image_from_dir",
"create_inner_bin_file",
"create_inner_csv_file",
"create_inner_docx_file",
"create_inner_eml_file",
"create_inner_epub_file",
"create_inner_file_from_path",
"create_inner_generic_file",
"create_inner_graphic_ico_file",
"create_inner_graphic_jpeg_file",
"create_inner_graphic_pdf_file",
"create_inner_graphic_png_file",
"create_inner_graphic_webp_file",
"create_inner_ico_file",
"create_inner_jpeg_file",
"create_inner_json_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_random_file_from_dir",
"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_xml_file",
"create_inner_zip_file",
"fuzzy_choice_create_inner_file",
"list_create_inner_file",
)
# ************************************************
# ************ augment_image_from_path ***********
# ************************************************
@overload
def create_inner_augment_image_from_path(
path: str,
storage: Optional[BaseStorage] = None,
basename: Optional[str] = None,
prefix: Optional[str] = None,
generator: Optional[Union[Faker, Generator, Provider]] = None,
augmentations: Optional[List[Tuple[Callable, Dict[str, Any]]]] = None,
num_steps: Optional[int] = None,
pop_func: Callable = random_pop,
raw: bool = True,
**kwargs,
) -> BytesValue:
...
@overload
def create_inner_augment_image_from_path(
path: str,
storage: Optional[BaseStorage] = None,
basename: Optional[str] = None,
prefix: Optional[str] = None,
generator: Optional[Union[Faker, Generator, Provider]] = None,
augmentations: Optional[List[Tuple[Callable, Dict[str, Any]]]] = None,
num_steps: Optional[int] = None,
pop_func: Callable = random_pop,
**kwargs,
) -> StringValue:
...
[docs]def create_inner_augment_image_from_path(
path: str,
storage: Optional[BaseStorage] = None,
basename: Optional[str] = None,
prefix: Optional[str] = None,
generator: Optional[Union[Faker, Generator, Provider]] = None,
augmentations: Optional[List[Tuple[Callable, Dict[str, Any]]]] = None,
num_steps: Optional[int] = None,
pop_func: Callable = random_pop,
raw: bool = False,
**kwargs,
) -> Union[BytesValue, StringValue]:
"""Create inner augment_image_from_path file."""
try:
from ..augment_image_from_path import AugmentImageFromPathProvider
except ImportError as err:
raise err
return AugmentImageFromPathProvider(generator).augment_image_from_path(
path=path,
storage=storage,
basename=basename,
prefix=prefix,
augmentations=augmentations,
num_steps=num_steps,
pop_func=pop_func,
raw=raw,
**kwargs,
)
# ************************************************
# ******** augment_random_image_from_dir *********
# ************************************************
@overload
def create_inner_augment_random_image_from_dir(
source_dir_path: str,
extensions: Optional[Iterable[str]] = None,
storage: Optional[BaseStorage] = None,
basename: Optional[str] = None,
prefix: Optional[str] = None,
generator: Optional[Union[Faker, Generator, Provider]] = None,
augmentations: Optional[List[Tuple[Callable, Dict[str, Any]]]] = None,
num_steps: Optional[int] = None,
pop_func: Callable = random_pop,
raw: bool = True,
**kwargs,
) -> BytesValue:
...
@overload
def create_inner_augment_random_image_from_dir(
source_dir_path: str,
extensions: Optional[Iterable[str]] = None,
storage: Optional[BaseStorage] = None,
basename: Optional[str] = None,
prefix: Optional[str] = None,
generator: Optional[Union[Faker, Generator, Provider]] = None,
augmentations: Optional[List[Tuple[Callable, Dict[str, Any]]]] = None,
num_steps: Optional[int] = None,
pop_func: Callable = random_pop,
**kwargs,
) -> StringValue:
...
[docs]def create_inner_augment_random_image_from_dir(
source_dir_path: str,
extensions: Optional[Iterable[str]] = None,
storage: Optional[BaseStorage] = None,
basename: Optional[str] = None,
prefix: Optional[str] = None,
generator: Optional[Union[Faker, Generator, Provider]] = None,
augmentations: Optional[List[Tuple[Callable, Dict[str, Any]]]] = None,
num_steps: Optional[int] = None,
pop_func: Callable = random_pop,
raw: bool = False,
**kwargs,
) -> Union[BytesValue, StringValue]:
"""Create inner augment_random_image_from_dir file."""
try:
from ..augment_random_image_from_dir import (
AugmentRandomImageFromDirProvider,
)
except ImportError as err:
raise err
return AugmentRandomImageFromDirProvider(
generator
).augment_random_image_from_dir(
source_dir_path=source_dir_path,
extensions=extensions,
storage=storage,
basename=basename,
prefix=prefix,
augmentations=augmentations,
num_steps=num_steps,
pop_func=pop_func,
raw=raw,
**kwargs,
)
# ************************************************
# ********************* BIN **********************
# ************************************************
@overload
def create_inner_bin_file(
storage: Optional[BaseStorage] = None,
basename: Optional[str] = None,
prefix: Optional[str] = None,
generator: Optional[Union[Faker, Generator, Provider]] = None,
length: int = (1 * 1024 * 1024),
content: Optional[bytes] = None,
raw: bool = True,
**kwargs,
) -> BytesValue:
...
@overload
def create_inner_bin_file(
storage: Optional[BaseStorage] = None,
basename: Optional[str] = None,
prefix: Optional[str] = None,
generator: Optional[Union[Faker, Generator, Provider]] = None,
length: int = (1 * 1024 * 1024),
content: Optional[bytes] = None,
**kwargs,
) -> StringValue:
...
[docs]def create_inner_bin_file(
storage: Optional[BaseStorage] = None,
basename: Optional[str] = None,
prefix: Optional[str] = None,
generator: Optional[Union[Faker, Generator, Provider]] = None,
length: int = (1 * 1024 * 1024),
content: Optional[bytes] = None,
raw: bool = False,
**kwargs,
) -> Union[BytesValue, StringValue]:
"""Create inner BIN file."""
try:
from ..bin_file import BinFileProvider
except ImportError as err:
raise err
return BinFileProvider(generator).bin_file(
storage=storage,
basename=basename,
prefix=prefix,
length=length,
content=content,
raw=raw,
**kwargs,
)
# ************************************************
# ********************* CSV **********************
# ************************************************
@overload
def create_inner_csv_file(
storage: Optional[BaseStorage] = None,
basename: Optional[str] = None,
prefix: Optional[str] = None,
generator: Optional[Union[Faker, Generator, Provider]] = 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,
format_func: Callable[
[Union[Faker, Generator, Provider], str], str
] = DEFAULT_FORMAT_FUNC,
raw: bool = True,
**kwargs,
) -> BytesValue:
...
@overload
def create_inner_csv_file(
storage: Optional[BaseStorage] = None,
basename: Optional[str] = None,
prefix: Optional[str] = None,
generator: Optional[Union[Faker, Generator, Provider]] = 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,
format_func: Callable[
[Union[Faker, Generator, Provider], str], str
] = DEFAULT_FORMAT_FUNC,
**kwargs,
) -> StringValue:
...
[docs]def create_inner_csv_file(
storage: Optional[BaseStorage] = None,
basename: Optional[str] = None,
prefix: Optional[str] = None,
generator: Optional[Union[Faker, Generator, Provider]] = 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,
format_func: Callable[
[Union[Faker, Generator, Provider], str], str
] = DEFAULT_FORMAT_FUNC,
raw: bool = False,
**kwargs,
) -> Union[BytesValue, StringValue]:
"""Create inner CSV file."""
try:
from ..csv_file import CsvFileProvider
except ImportError as err:
raise err
return CsvFileProvider(generator).csv_file(
storage=storage,
basename=basename,
prefix=prefix,
header=header,
data_columns=data_columns,
num_rows=num_rows,
include_row_ids=include_row_ids,
content=content,
format_func=format_func,
raw=raw,
**kwargs,
)
# ************************************************
# ******************** DOCX **********************
# ************************************************
@overload
def create_inner_docx_file(
storage: Optional[BaseStorage] = None,
basename: Optional[str] = None,
prefix: Optional[str] = None,
generator: Optional[Union[Faker, Generator, Provider]] = None,
max_nb_chars: int = DEFAULT_TEXT_MAX_NB_CHARS,
wrap_chars_after: Optional[int] = None,
content: Optional[str] = None,
format_func: Callable[
[Union[Faker, Generator, Provider], str], str
] = DEFAULT_FORMAT_FUNC,
raw: bool = True,
**kwargs,
) -> BytesValue:
...
@overload
def create_inner_docx_file(
storage: Optional[BaseStorage] = None,
basename: Optional[str] = None,
prefix: Optional[str] = None,
generator: Optional[Union[Faker, Generator, Provider]] = None,
max_nb_chars: int = DEFAULT_TEXT_MAX_NB_CHARS,
wrap_chars_after: Optional[int] = None,
content: Optional[str] = None,
format_func: Callable[
[Union[Faker, Generator, Provider], str], str
] = DEFAULT_FORMAT_FUNC,
**kwargs,
) -> StringValue:
...
[docs]def create_inner_docx_file(
storage: Optional[BaseStorage] = None,
basename: Optional[str] = None,
prefix: Optional[str] = None,
generator: Optional[Union[Faker, Generator, Provider]] = None,
max_nb_chars: int = DEFAULT_TEXT_MAX_NB_CHARS,
wrap_chars_after: Optional[int] = None,
content: Optional[str] = None,
format_func: Callable[
[Union[Faker, Generator, Provider], str], str
] = DEFAULT_FORMAT_FUNC,
raw: bool = False,
**kwargs,
) -> Union[BytesValue, StringValue]:
"""Create inner DOCX file."""
try:
from ..docx_file import DocxFileProvider
except ImportError as err:
raise err
return DocxFileProvider(generator).docx_file(
storage=storage,
basename=basename,
prefix=prefix,
max_nb_chars=max_nb_chars,
wrap_chars_after=wrap_chars_after,
content=content,
raw=raw,
format_func=format_func,
**kwargs,
)
# ************************************************
# ********************* EML **********************
# ************************************************
@overload
def create_inner_eml_file(
storage: Optional[BaseStorage] = None,
basename: Optional[str] = None,
prefix: Optional[str] = None,
generator: Optional[Union[Faker, Generator, Provider]] = None,
options: Optional[Dict[str, Any]] = None,
max_nb_chars: int = DEFAULT_TEXT_MAX_NB_CHARS,
wrap_chars_after: Optional[int] = None,
content: Optional[str] = None,
format_func: Callable[
[Union[Faker, Generator, Provider], str], str
] = DEFAULT_FORMAT_FUNC,
raw: bool = True,
**kwargs,
) -> BytesValue:
...
@overload
def create_inner_eml_file(
storage: Optional[BaseStorage] = None,
basename: Optional[str] = None,
prefix: Optional[str] = None,
generator: Optional[Union[Faker, Generator, Provider]] = None,
options: Optional[Dict[str, Any]] = None,
max_nb_chars: int = DEFAULT_TEXT_MAX_NB_CHARS,
wrap_chars_after: Optional[int] = None,
content: Optional[str] = None,
format_func: Callable[
[Union[Faker, Generator, Provider], str], str
] = DEFAULT_FORMAT_FUNC,
**kwargs,
) -> StringValue:
...
[docs]def create_inner_eml_file(
storage: Optional[BaseStorage] = None,
basename: Optional[str] = None,
prefix: Optional[str] = None,
generator: Optional[Union[Faker, Generator, Provider]] = None,
options: Optional[Dict[str, Any]] = None,
max_nb_chars: int = DEFAULT_TEXT_MAX_NB_CHARS,
wrap_chars_after: Optional[int] = None,
content: Optional[str] = None,
format_func: Callable[
[Union[Faker, Generator, Provider], str], str
] = DEFAULT_FORMAT_FUNC,
raw: bool = False,
**kwargs,
) -> Union[BytesValue, StringValue]:
"""Create inner EML file."""
try:
from ..eml_file import EmlFileProvider
except ImportError as err:
raise err
return EmlFileProvider(generator).eml_file(
storage=storage,
basename=basename,
prefix=prefix,
options=options,
max_nb_chars=max_nb_chars,
wrap_chars_after=wrap_chars_after,
content=content,
format_func=format_func,
raw=raw,
**kwargs,
)
# ************************************************
# ******************** EPUB **********************
# ************************************************
@overload
def create_inner_epub_file(
storage: Optional[BaseStorage] = None,
basename: Optional[str] = None,
prefix: Optional[str] = None,
generator: Optional[Union[Faker, Generator, Provider]] = None,
max_nb_chars: int = DEFAULT_TEXT_MAX_NB_CHARS,
wrap_chars_after: Optional[int] = None,
content: Optional[str] = None,
title: Optional[str] = None,
chapter_title: Optional[str] = None,
format_func: Callable[
[Union[Faker, Generator, Provider], str], str
] = DEFAULT_FORMAT_FUNC,
raw: bool = True,
**kwargs,
) -> BytesValue:
...
@overload
def create_inner_epub_file(
storage: Optional[BaseStorage] = None,
basename: Optional[str] = None,
prefix: Optional[str] = None,
generator: Optional[Union[Faker, Generator, Provider]] = None,
max_nb_chars: int = DEFAULT_TEXT_MAX_NB_CHARS,
wrap_chars_after: Optional[int] = None,
content: Optional[str] = None,
title: Optional[str] = None,
chapter_title: Optional[str] = None,
format_func: Callable[
[Union[Faker, Generator, Provider], str], str
] = DEFAULT_FORMAT_FUNC,
**kwargs,
) -> StringValue:
...
[docs]def create_inner_epub_file(
storage: Optional[BaseStorage] = None,
basename: Optional[str] = None,
prefix: Optional[str] = None,
generator: Optional[Union[Faker, Generator, Provider]] = None,
max_nb_chars: int = DEFAULT_TEXT_MAX_NB_CHARS,
wrap_chars_after: Optional[int] = None,
content: Optional[str] = None,
title: Optional[str] = None,
chapter_title: Optional[str] = None,
format_func: Callable[
[Union[Faker, Generator, Provider], str], str
] = DEFAULT_FORMAT_FUNC,
raw: bool = False,
**kwargs,
) -> Union[BytesValue, StringValue]:
"""Create inner EPUB file."""
try:
from ..epub_file import EpubFileProvider
except ImportError as err:
raise err
return EpubFileProvider(generator).epub_file(
storage=storage,
basename=basename,
prefix=prefix,
max_nb_chars=max_nb_chars,
wrap_chars_after=wrap_chars_after,
content=content,
title=title,
chapter_title=chapter_title,
format_func=format_func,
raw=raw,
**kwargs,
)
# ************************************************
# ***************** FileFromPath *****************
# ************************************************
@overload
def create_inner_file_from_path(
path: str,
storage: Optional[BaseStorage] = None,
basename: Optional[str] = None,
prefix: Optional[str] = None,
generator: Optional[Union[Faker, Generator, Provider]] = None,
raw: bool = True,
**kwargs,
) -> BytesValue:
...
@overload
def create_inner_file_from_path(
path: str,
storage: Optional[BaseStorage] = None,
basename: Optional[str] = None,
prefix: Optional[str] = None,
generator: Optional[Union[Faker, Generator, Provider]] = None,
**kwargs,
) -> StringValue:
...
[docs]def create_inner_file_from_path(
path: str,
storage: Optional[BaseStorage] = None,
basename: Optional[str] = None,
prefix: Optional[str] = None,
generator: Optional[Union[Faker, Generator, Provider]] = None,
raw: bool = False,
**kwargs,
) -> Union[BytesValue, StringValue]:
"""Create inner file from path."""
try:
from ..file_from_path import FileFromPathProvider
except ImportError as err:
raise err
return FileFromPathProvider(generator).file_from_path(
path,
storage=storage,
basename=basename,
prefix=prefix,
raw=raw,
**kwargs,
)
# ************************************************
# ******************** Generic *******************
# ************************************************
@overload
def create_inner_generic_file(
content: Union[bytes, str],
extension: str,
storage: Optional[BaseStorage] = None,
basename: Optional[str] = None,
prefix: Optional[str] = None,
generator: Optional[Union[Faker, Generator, Provider]] = None,
format_func: Callable[
[Union[Faker, Generator, Provider], str], str
] = DEFAULT_FORMAT_FUNC,
raw: bool = True,
**kwargs,
) -> BytesValue:
...
@overload
def create_inner_generic_file(
content: Union[bytes, str],
extension: str,
storage: Optional[BaseStorage] = None,
basename: Optional[str] = None,
prefix: Optional[str] = None,
generator: Optional[Union[Faker, Generator, Provider]] = None,
format_func: Callable[
[Union[Faker, Generator, Provider], str], str
] = DEFAULT_FORMAT_FUNC,
**kwargs,
) -> StringValue:
...
[docs]def create_inner_generic_file(
content: Union[bytes, str],
extension: str,
storage: Optional[BaseStorage] = None,
basename: Optional[str] = None,
prefix: Optional[str] = None,
generator: Optional[Union[Faker, Generator, Provider]] = None,
format_func: Callable[
[Union[Faker, Generator, Provider], str], str
] = DEFAULT_FORMAT_FUNC,
raw: bool = False,
**kwargs,
) -> Union[BytesValue, StringValue]:
"""Create inner generic file."""
try:
from ..generic_file import GenericFileProvider
except ImportError as err:
raise err
return GenericFileProvider(generator).generic_file(
content=content,
extension=extension,
storage=storage,
basename=basename,
prefix=prefix,
format_func=format_func,
raw=raw,
**kwargs,
)
# ************************************************
# ********************* ICO **********************
# ************************************************
# Text-to-image ICO file
@overload
def create_inner_ico_file(
storage: Optional[BaseStorage] = None,
basename: Optional[str] = None,
prefix: Optional[str] = None,
generator: Optional[Union[Faker, Generator, Provider]] = None,
max_nb_chars: int = DEFAULT_IMAGE_MAX_NB_CHARS,
wrap_chars_after: Optional[int] = None,
content: Optional[str] = None,
format_func: Callable[
[Union[Faker, Generator, Provider], str], str
] = DEFAULT_FORMAT_FUNC,
raw: bool = True,
**kwargs,
) -> BytesValue:
...
@overload
def create_inner_ico_file(
storage: Optional[BaseStorage] = None,
basename: Optional[str] = None,
prefix: Optional[str] = None,
generator: Optional[Union[Faker, Generator, Provider]] = None,
max_nb_chars: int = DEFAULT_IMAGE_MAX_NB_CHARS,
wrap_chars_after: Optional[int] = None,
content: Optional[str] = None,
format_func: Callable[
[Union[Faker, Generator, Provider], str], str
] = DEFAULT_FORMAT_FUNC,
**kwargs,
) -> StringValue:
...
[docs]def create_inner_ico_file(
storage: Optional[BaseStorage] = None,
basename: Optional[str] = None,
prefix: Optional[str] = None,
generator: Optional[Union[Faker, Generator, Provider]] = None,
max_nb_chars: int = DEFAULT_IMAGE_MAX_NB_CHARS,
wrap_chars_after: Optional[int] = None,
content: Optional[str] = None,
format_func: Callable[
[Union[Faker, Generator, Provider], str], str
] = DEFAULT_FORMAT_FUNC,
raw: bool = False,
**kwargs,
) -> Union[BytesValue, StringValue]:
"""Create inner ICO file."""
try:
from ..ico_file import IcoFileProvider
except ImportError as err:
raise err
return IcoFileProvider(generator).ico_file(
storage=storage,
basename=basename,
prefix=prefix,
max_nb_chars=max_nb_chars,
wrap_chars_after=wrap_chars_after,
content=content,
format_func=format_func,
raw=raw,
**kwargs,
)
# Graphic ICO file
@overload
def create_inner_graphic_ico_file(
storage: Optional[BaseStorage] = None,
basename: Optional[str] = None,
prefix: Optional[str] = None,
generator: Optional[Union[Faker, Generator, Provider]] = None,
size: Tuple[int, int] = (256, 256),
hue: Union[int, Sequence[int], str, None] = None,
luminosity: Optional[str] = None,
raw: bool = True,
**kwargs,
) -> BytesValue:
...
@overload
def create_inner_graphic_ico_file(
storage: Optional[BaseStorage] = None,
basename: Optional[str] = None,
prefix: Optional[str] = None,
generator: Optional[Union[Faker, Generator, Provider]] = None,
size: Tuple[int, int] = (256, 256),
hue: Union[int, Sequence[int], str, None] = None,
luminosity: Optional[str] = None,
**kwargs,
) -> StringValue:
...
[docs]def create_inner_graphic_ico_file(
storage: Optional[BaseStorage] = None,
basename: Optional[str] = None,
prefix: Optional[str] = None,
generator: Optional[Union[Faker, Generator, Provider]] = None,
size: Tuple[int, int] = (256, 256),
hue: Union[int, Sequence[int], str, None] = None,
luminosity: Optional[str] = None,
raw: bool = False,
**kwargs,
) -> Union[BytesValue, StringValue]:
"""Create inner graphic ICO file."""
try:
from ..ico_file import GraphicIcoFileProvider
except ImportError as err:
raise err
return GraphicIcoFileProvider(generator).graphic_ico_file(
storage=storage,
basename=basename,
prefix=prefix,
size=size,
hue=hue,
luminosity=luminosity,
raw=raw,
**kwargs,
)
# ************************************************
# ******************** JPEG **********************
# ************************************************
@overload
def create_inner_jpeg_file(
storage: Optional[BaseStorage] = None,
basename: Optional[str] = None,
prefix: Optional[str] = None,
generator: Optional[Union[Faker, Generator, Provider]] = None,
max_nb_chars: int = DEFAULT_IMAGE_MAX_NB_CHARS,
wrap_chars_after: Optional[int] = None,
content: Optional[str] = None,
format_func: Callable[
[Union[Faker, Generator, Provider], str], str
] = DEFAULT_FORMAT_FUNC,
raw: bool = True,
**kwargs,
) -> BytesValue:
...
@overload
def create_inner_jpeg_file(
storage: Optional[BaseStorage] = None,
basename: Optional[str] = None,
prefix: Optional[str] = None,
generator: Optional[Union[Faker, Generator, Provider]] = None,
max_nb_chars: int = DEFAULT_IMAGE_MAX_NB_CHARS,
wrap_chars_after: Optional[int] = None,
content: Optional[str] = None,
format_func: Callable[
[Union[Faker, Generator, Provider], str], str
] = DEFAULT_FORMAT_FUNC,
**kwargs,
) -> StringValue:
...
[docs]def create_inner_jpeg_file(
storage: Optional[BaseStorage] = None,
basename: Optional[str] = None,
prefix: Optional[str] = None,
generator: Optional[Union[Faker, Generator, Provider]] = None,
max_nb_chars: int = DEFAULT_IMAGE_MAX_NB_CHARS,
wrap_chars_after: Optional[int] = None,
content: Optional[str] = None,
format_func: Callable[
[Union[Faker, Generator, Provider], str], str
] = DEFAULT_FORMAT_FUNC,
raw: bool = False,
**kwargs,
) -> Union[BytesValue, StringValue]:
"""Create inner JPEG file."""
try:
from ..jpeg_file import JpegFileProvider
except ImportError as err:
raise err
return JpegFileProvider(generator).jpeg_file(
storage=storage,
basename=basename,
prefix=prefix,
max_nb_chars=max_nb_chars,
wrap_chars_after=wrap_chars_after,
content=content,
format_func=format_func,
raw=raw,
**kwargs,
)
# Graphic JPEG file
@overload
def create_inner_graphic_jpeg_file(
storage: Optional[BaseStorage] = None,
basename: Optional[str] = None,
prefix: Optional[str] = None,
generator: Optional[Union[Faker, Generator, Provider]] = None,
size: Tuple[int, int] = (256, 256),
hue: Union[int, Sequence[int], str, None] = None,
luminosity: Optional[str] = None,
raw: bool = True,
**kwargs,
) -> BytesValue:
...
@overload
def create_inner_graphic_jpeg_file(
storage: Optional[BaseStorage] = None,
basename: Optional[str] = None,
prefix: Optional[str] = None,
generator: Optional[Union[Faker, Generator, Provider]] = None,
size: Tuple[int, int] = (256, 256),
hue: Union[int, Sequence[int], str, None] = None,
luminosity: Optional[str] = None,
**kwargs,
) -> StringValue:
...
[docs]def create_inner_graphic_jpeg_file(
storage: Optional[BaseStorage] = None,
basename: Optional[str] = None,
prefix: Optional[str] = None,
generator: Optional[Union[Faker, Generator, Provider]] = None,
size: Tuple[int, int] = (256, 256),
hue: Union[int, Sequence[int], str, None] = None,
luminosity: Optional[str] = None,
raw: bool = False,
**kwargs,
) -> Union[BytesValue, StringValue]:
"""Create inner graphic JPEG file."""
try:
from ..jpeg_file import GraphicJpegFileProvider
except ImportError as err:
raise err
return GraphicJpegFileProvider(generator).graphic_jpeg_file(
storage=storage,
basename=basename,
prefix=prefix,
size=size,
hue=hue,
luminosity=luminosity,
raw=raw,
**kwargs,
)
# ************************************************
# ******************** JSON **********************
# ************************************************
@overload
def create_inner_json_file(
storage: Optional[BaseStorage] = None,
basename: Optional[str] = None,
prefix: Optional[str] = None,
generator: Optional[Union[Faker, Generator, Provider]] = None,
data_columns: Optional[List] = None,
num_rows: int = 10,
indent: Optional[int] = None,
content: Optional[str] = None,
format_func: Callable[
[Union[Faker, Generator, Provider], str], str
] = DEFAULT_FORMAT_FUNC,
raw: bool = True,
**kwargs,
) -> BytesValue:
...
@overload
def create_inner_json_file(
storage: Optional[BaseStorage] = None,
basename: Optional[str] = None,
prefix: Optional[str] = None,
generator: Optional[Union[Faker, Generator, Provider]] = None,
data_columns: Optional[List] = None,
num_rows: int = 10,
indent: Optional[int] = None,
content: Optional[str] = None,
format_func: Callable[
[Union[Faker, Generator, Provider], str], str
] = DEFAULT_FORMAT_FUNC,
**kwargs,
) -> StringValue:
...
[docs]def create_inner_json_file(
storage: Optional[BaseStorage] = None,
basename: Optional[str] = None,
prefix: Optional[str] = None,
generator: Optional[Union[Faker, Generator, Provider]] = None,
data_columns: Optional[List] = None,
num_rows: int = 10,
indent: Optional[int] = None,
content: Optional[str] = None,
format_func: Callable[
[Union[Faker, Generator, Provider], str], str
] = DEFAULT_FORMAT_FUNC,
raw: bool = False,
**kwargs,
) -> Union[BytesValue, StringValue]:
"""Create inner JSON file."""
try:
from ..json_file import JsonFileProvider
except ImportError as err:
raise err
return JsonFileProvider(generator).json_file(
storage=storage,
basename=basename,
prefix=prefix,
data_columns=data_columns,
num_rows=num_rows,
indent=indent,
content=content,
format_func=format_func,
raw=raw,
**kwargs,
)
# ************************************************
# ********************* MP3 **********************
# ************************************************
@overload
def create_inner_mp3_file(
storage: Optional[BaseStorage] = None,
basename: Optional[str] = None,
prefix: Optional[str] = None,
generator: Optional[Union[Faker, Generator, Provider]] = None,
max_nb_chars: int = DEFAULT_AUDIO_MAX_NB_CHARS,
content: Optional[str] = None,
mp3_generator_cls: Optional[Union[str, Type[BaseMp3Generator]]] = None,
mp3_generator_kwargs: Optional[Dict[str, Any]] = None,
format_func: Callable[
[Union[Faker, Generator, Provider], str], str
] = DEFAULT_FORMAT_FUNC,
raw: bool = True,
**kwargs,
) -> BytesValue:
...
@overload
def create_inner_mp3_file(
storage: Optional[BaseStorage] = None,
basename: Optional[str] = None,
prefix: Optional[str] = None,
generator: Optional[Union[Faker, Generator, Provider]] = None,
max_nb_chars: int = DEFAULT_AUDIO_MAX_NB_CHARS,
content: Optional[str] = None,
mp3_generator_cls: Optional[Union[str, Type[BaseMp3Generator]]] = None,
mp3_generator_kwargs: Optional[Dict[str, Any]] = None,
format_func: Callable[
[Union[Faker, Generator, Provider], str], str
] = DEFAULT_FORMAT_FUNC,
**kwargs,
) -> StringValue:
...
[docs]def create_inner_mp3_file(
storage: Optional[BaseStorage] = None,
basename: Optional[str] = None,
prefix: Optional[str] = None,
generator: Optional[Union[Faker, Generator, Provider]] = None,
max_nb_chars: int = DEFAULT_AUDIO_MAX_NB_CHARS,
content: Optional[str] = None,
mp3_generator_cls: Optional[Union[str, Type[BaseMp3Generator]]] = None,
mp3_generator_kwargs: Optional[Dict[str, Any]] = None,
format_func: Callable[
[Union[Faker, Generator, Provider], str], str
] = DEFAULT_FORMAT_FUNC,
raw: bool = False,
**kwargs,
) -> Union[BytesValue, StringValue]:
"""Create inner ODS file."""
try:
from ..mp3_file import Mp3FileProvider
except ImportError as err:
raise err
return Mp3FileProvider(generator).mp3_file(
storage=storage,
basename=basename,
prefix=prefix,
max_nb_chars=max_nb_chars,
content=content,
mp3_generator_cls=mp3_generator_cls,
mp3_generator_kwargs=mp3_generator_kwargs,
format_func=format_func,
raw=raw,
**kwargs,
)
# ************************************************
# ********************* ODP **********************
# ************************************************
@overload
def create_inner_odp_file(
storage: Optional[BaseStorage] = None,
basename: Optional[str] = None,
prefix: Optional[str] = None,
generator: Optional[Union[Faker, Generator, Provider]] = None,
max_nb_chars: int = DEFAULT_TEXT_MAX_NB_CHARS,
wrap_chars_after: Optional[int] = None,
content: Optional[str] = None,
format_func: Callable[
[Union[Faker, Generator, Provider], str], str
] = DEFAULT_FORMAT_FUNC,
raw: bool = True,
**kwargs,
) -> BytesValue:
...
@overload
def create_inner_odp_file(
storage: Optional[BaseStorage] = None,
basename: Optional[str] = None,
prefix: Optional[str] = None,
generator: Optional[Union[Faker, Generator, Provider]] = None,
max_nb_chars: int = DEFAULT_TEXT_MAX_NB_CHARS,
wrap_chars_after: Optional[int] = None,
content: Optional[str] = None,
format_func: Callable[
[Union[Faker, Generator, Provider], str], str
] = DEFAULT_FORMAT_FUNC,
**kwargs,
) -> Union[BytesValue, StringValue]:
...
[docs]def create_inner_odp_file(
storage: Optional[BaseStorage] = None,
basename: Optional[str] = None,
prefix: Optional[str] = None,
generator: Optional[Union[Faker, Generator, Provider]] = None,
max_nb_chars: int = DEFAULT_TEXT_MAX_NB_CHARS,
wrap_chars_after: Optional[int] = None,
content: Optional[str] = None,
format_func: Callable[
[Union[Faker, Generator, Provider], str], str
] = DEFAULT_FORMAT_FUNC,
raw: bool = False,
**kwargs,
) -> Union[BytesValue, StringValue]:
"""Create inner ODP file."""
try:
from ..odp_file import OdpFileProvider
except ImportError as err:
raise err
return OdpFileProvider(generator).odp_file(
storage=storage,
basename=basename,
prefix=prefix,
max_nb_chars=max_nb_chars,
wrap_chars_after=wrap_chars_after,
content=content,
format_func=format_func,
raw=raw,
**kwargs,
)
# ************************************************
# ********************* ODS **********************
# ************************************************
@overload
def create_inner_ods_file(
storage: Optional[BaseStorage] = None,
basename: Optional[str] = None,
prefix: Optional[str] = None,
generator: Optional[Union[Faker, Generator, Provider]] = None,
data_columns: Optional[Dict[str, str]] = None,
num_rows: int = 10,
content: Optional[str] = None,
format_func: Callable[
[Union[Faker, Generator, Provider], str], str
] = DEFAULT_FORMAT_FUNC,
raw: bool = True,
**kwargs,
) -> BytesValue:
...
@overload
def create_inner_ods_file(
storage: Optional[BaseStorage] = None,
basename: Optional[str] = None,
prefix: Optional[str] = None,
generator: Optional[Union[Faker, Generator, Provider]] = None,
data_columns: Optional[Dict[str, str]] = None,
num_rows: int = 10,
content: Optional[str] = None,
format_func: Callable[
[Union[Faker, Generator, Provider], str], str
] = DEFAULT_FORMAT_FUNC,
**kwargs,
) -> StringValue:
...
[docs]def create_inner_ods_file(
storage: Optional[BaseStorage] = None,
basename: Optional[str] = None,
prefix: Optional[str] = None,
generator: Optional[Union[Faker, Generator, Provider]] = None,
data_columns: Optional[Dict[str, str]] = None,
num_rows: int = 10,
content: Optional[str] = None,
format_func: Callable[
[Union[Faker, Generator, Provider], str], str
] = DEFAULT_FORMAT_FUNC,
raw: bool = False,
**kwargs,
) -> Union[BytesValue, StringValue]:
"""Create inner ODS file."""
try:
from ..ods_file import OdsFileProvider
except ImportError as err:
raise err
return OdsFileProvider(generator).ods_file(
storage=storage,
basename=basename,
prefix=prefix,
data_columns=data_columns,
num_rows=num_rows,
content=content,
format_func=format_func,
raw=raw,
**kwargs,
)
# ************************************************
# ********************* ODT **********************
# ************************************************
@overload
def create_inner_odt_file(
storage: Optional[BaseStorage] = None,
basename: Optional[str] = None,
prefix: Optional[str] = None,
generator: Optional[Union[Faker, Generator, Provider]] = None,
max_nb_chars: int = DEFAULT_TEXT_MAX_NB_CHARS,
wrap_chars_after: Optional[int] = None,
content: Optional[str] = None,
format_func: Callable[
[Union[Faker, Generator, Provider], str], str
] = DEFAULT_FORMAT_FUNC,
raw: bool = True,
**kwargs,
) -> BytesValue:
...
@overload
def create_inner_odt_file(
storage: Optional[BaseStorage] = None,
basename: Optional[str] = None,
prefix: Optional[str] = None,
generator: Optional[Union[Faker, Generator, Provider]] = None,
max_nb_chars: int = DEFAULT_TEXT_MAX_NB_CHARS,
wrap_chars_after: Optional[int] = None,
content: Optional[str] = None,
format_func: Callable[
[Union[Faker, Generator, Provider], str], str
] = DEFAULT_FORMAT_FUNC,
**kwargs,
) -> StringValue:
...
[docs]def create_inner_odt_file(
storage: Optional[BaseStorage] = None,
basename: Optional[str] = None,
prefix: Optional[str] = None,
generator: Optional[Union[Faker, Generator, Provider]] = None,
max_nb_chars: int = DEFAULT_TEXT_MAX_NB_CHARS,
wrap_chars_after: Optional[int] = None,
content: Optional[str] = None,
format_func: Callable[
[Union[Faker, Generator, Provider], str], str
] = DEFAULT_FORMAT_FUNC,
raw: bool = False,
**kwargs,
) -> Union[BytesValue, StringValue]:
"""Create inner ODT file."""
try:
from ..odt_file import OdtFileProvider
except ImportError as err:
raise err
return OdtFileProvider(generator).odt_file(
storage=storage,
basename=basename,
prefix=prefix,
max_nb_chars=max_nb_chars,
wrap_chars_after=wrap_chars_after,
content=content,
format_func=format_func,
raw=raw,
**kwargs,
)
# ************************************************
# ********************* PDF **********************
# ************************************************
@overload
def create_inner_pdf_file(
storage: Optional[BaseStorage] = None,
basename: Optional[str] = None,
prefix: Optional[str] = None,
generator: Optional[Union[Faker, Generator, Provider]] = None,
max_nb_chars: int = DEFAULT_TEXT_MAX_NB_CHARS,
wrap_chars_after: Optional[int] = None,
content: Optional[str] = None,
pdf_generator_cls: Optional[Union[str, Type[BasePdfGenerator]]] = None,
pdf_generator_kwargs: Optional[Dict[str, Any]] = None,
format_func: Callable[
[Union[Faker, Generator, Provider], str], str
] = DEFAULT_FORMAT_FUNC,
raw: bool = True,
**kwargs,
) -> BytesValue:
...
@overload
def create_inner_pdf_file(
storage: Optional[BaseStorage] = None,
basename: Optional[str] = None,
prefix: Optional[str] = None,
generator: Optional[Union[Faker, Generator, Provider]] = None,
max_nb_chars: int = DEFAULT_TEXT_MAX_NB_CHARS,
wrap_chars_after: Optional[int] = None,
content: Optional[str] = None,
pdf_generator_cls: Optional[Union[str, Type[BasePdfGenerator]]] = None,
pdf_generator_kwargs: Optional[Dict[str, Any]] = None,
format_func: Callable[
[Union[Faker, Generator, Provider], str], str
] = DEFAULT_FORMAT_FUNC,
**kwargs,
) -> StringValue:
...
[docs]def create_inner_pdf_file(
storage: Optional[BaseStorage] = None,
basename: Optional[str] = None,
prefix: Optional[str] = None,
generator: Optional[Union[Faker, Generator, Provider]] = None,
max_nb_chars: int = DEFAULT_TEXT_MAX_NB_CHARS,
wrap_chars_after: Optional[int] = None,
content: Optional[str] = None,
pdf_generator_cls: Optional[Union[str, Type[BasePdfGenerator]]] = None,
pdf_generator_kwargs: Optional[Dict[str, Any]] = None,
format_func: Callable[
[Union[Faker, Generator, Provider], str], str
] = DEFAULT_FORMAT_FUNC,
raw: bool = False,
**kwargs,
) -> Union[BytesValue, StringValue]:
"""Create inner PDF file."""
try:
from ..pdf_file import PdfFileProvider
except ImportError as err:
raise err
return PdfFileProvider(generator).pdf_file(
storage=storage,
basename=basename,
prefix=prefix,
max_nb_chars=max_nb_chars,
wrap_chars_after=wrap_chars_after,
content=content,
pdf_generator_cls=pdf_generator_cls,
pdf_generator_kwargs=pdf_generator_kwargs,
format_func=format_func,
raw=raw,
**kwargs,
)
# Graphic PDF file
@overload
def create_inner_graphic_pdf_file(
storage: Optional[BaseStorage] = None,
basename: Optional[str] = None,
prefix: Optional[str] = None,
generator: Optional[Union[Faker, Generator, Provider]] = None,
size: Tuple[int, int] = (256, 256),
hue: Union[int, Sequence[int], str, None] = None,
luminosity: Optional[str] = None,
raw: bool = True,
**kwargs,
) -> BytesValue:
...
@overload
def create_inner_graphic_pdf_file(
storage: Optional[BaseStorage] = None,
basename: Optional[str] = None,
prefix: Optional[str] = None,
generator: Optional[Union[Faker, Generator, Provider]] = None,
size: Tuple[int, int] = (256, 256),
hue: Union[int, Sequence[int], str, None] = None,
luminosity: Optional[str] = None,
**kwargs,
) -> StringValue:
...
[docs]def create_inner_graphic_pdf_file(
storage: Optional[BaseStorage] = None,
basename: Optional[str] = None,
prefix: Optional[str] = None,
generator: Optional[Union[Faker, Generator, Provider]] = None,
size: Tuple[int, int] = (256, 256),
hue: Union[int, Sequence[int], str, None] = None,
luminosity: Optional[str] = None,
raw: bool = False,
**kwargs,
) -> Union[BytesValue, StringValue]:
"""Create inner graphic PDF file."""
try:
from ..pdf_file import GraphicPdfFileProvider
except ImportError as err:
raise err
return GraphicPdfFileProvider(generator).graphic_pdf_file(
storage=storage,
basename=basename,
prefix=prefix,
size=size,
hue=hue,
luminosity=luminosity,
raw=raw,
**kwargs,
)
# ************************************************
# ********************* PNG **********************
# ************************************************
@overload
def create_inner_png_file(
storage: Optional[BaseStorage] = None,
basename: Optional[str] = None,
prefix: Optional[str] = None,
generator: Optional[Union[Faker, Generator, Provider]] = None,
max_nb_chars: int = DEFAULT_IMAGE_MAX_NB_CHARS,
wrap_chars_after: Optional[int] = None,
content: Optional[str] = None,
format_func: Callable[
[Union[Faker, Generator, Provider], str], str
] = DEFAULT_FORMAT_FUNC,
raw: bool = True,
**kwargs,
) -> BytesValue:
...
@overload
def create_inner_png_file(
storage: Optional[BaseStorage] = None,
basename: Optional[str] = None,
prefix: Optional[str] = None,
generator: Optional[Union[Faker, Generator, Provider]] = None,
max_nb_chars: int = DEFAULT_IMAGE_MAX_NB_CHARS,
wrap_chars_after: Optional[int] = None,
content: Optional[str] = None,
format_func: Callable[
[Union[Faker, Generator, Provider], str], str
] = DEFAULT_FORMAT_FUNC,
**kwargs,
) -> StringValue:
...
[docs]def create_inner_png_file(
storage: Optional[BaseStorage] = None,
basename: Optional[str] = None,
prefix: Optional[str] = None,
generator: Optional[Union[Faker, Generator, Provider]] = None,
max_nb_chars: int = DEFAULT_IMAGE_MAX_NB_CHARS,
wrap_chars_after: Optional[int] = None,
content: Optional[str] = None,
format_func: Callable[
[Union[Faker, Generator, Provider], str], str
] = DEFAULT_FORMAT_FUNC,
raw: bool = False,
**kwargs,
) -> Union[BytesValue, StringValue]:
"""Create inner PNG file."""
try:
from ..png_file import PngFileProvider
except ImportError as err:
raise err
return PngFileProvider(generator).png_file(
storage=storage,
basename=basename,
prefix=prefix,
max_nb_chars=max_nb_chars,
wrap_chars_after=wrap_chars_after,
content=content,
format_func=format_func,
raw=raw,
**kwargs,
)
# Graphic PNG file
@overload
def create_inner_graphic_png_file(
storage: Optional[BaseStorage] = None,
basename: Optional[str] = None,
prefix: Optional[str] = None,
generator: Optional[Union[Faker, Generator, Provider]] = None,
size: Tuple[int, int] = (256, 256),
hue: Union[int, Sequence[int], str, None] = None,
luminosity: Optional[str] = None,
raw: bool = True,
**kwargs,
) -> BytesValue:
...
@overload
def create_inner_graphic_png_file(
storage: Optional[BaseStorage] = None,
basename: Optional[str] = None,
prefix: Optional[str] = None,
generator: Optional[Union[Faker, Generator, Provider]] = None,
size: Tuple[int, int] = (256, 256),
hue: Union[int, Sequence[int], str, None] = None,
luminosity: Optional[str] = None,
**kwargs,
) -> StringValue:
...
[docs]def create_inner_graphic_png_file(
storage: Optional[BaseStorage] = None,
basename: Optional[str] = None,
prefix: Optional[str] = None,
generator: Optional[Union[Faker, Generator, Provider]] = None,
size: Tuple[int, int] = (256, 256),
hue: Union[int, Sequence[int], str, None] = None,
luminosity: Optional[str] = None,
raw: bool = False,
**kwargs,
) -> Union[BytesValue, StringValue]:
"""Create inner graphic PNG file."""
try:
from ..png_file import GraphicPngFileProvider
except ImportError as err:
raise err
return GraphicPngFileProvider(generator).graphic_png_file(
storage=storage,
basename=basename,
prefix=prefix,
size=size,
hue=hue,
luminosity=luminosity,
raw=raw,
**kwargs,
)
# ************************************************
# ******************** PPTX **********************
# ************************************************
@overload
def create_inner_pptx_file(
storage: Optional[BaseStorage] = None,
basename: Optional[str] = None,
prefix: Optional[str] = None,
generator: Optional[Union[Faker, Generator, Provider]] = None,
max_nb_chars: int = DEFAULT_TEXT_MAX_NB_CHARS,
wrap_chars_after: Optional[int] = None,
content: Optional[str] = None,
format_func: Callable[
[Union[Faker, Generator, Provider], str], str
] = DEFAULT_FORMAT_FUNC,
raw: bool = True,
**kwargs,
) -> BytesValue:
...
@overload
def create_inner_pptx_file(
storage: Optional[BaseStorage] = None,
basename: Optional[str] = None,
prefix: Optional[str] = None,
generator: Optional[Union[Faker, Generator, Provider]] = None,
max_nb_chars: int = DEFAULT_TEXT_MAX_NB_CHARS,
wrap_chars_after: Optional[int] = None,
content: Optional[str] = None,
format_func: Callable[
[Union[Faker, Generator, Provider], str], str
] = DEFAULT_FORMAT_FUNC,
**kwargs,
) -> StringValue:
...
[docs]def create_inner_pptx_file(
storage: Optional[BaseStorage] = None,
basename: Optional[str] = None,
prefix: Optional[str] = None,
generator: Optional[Union[Faker, Generator, Provider]] = None,
max_nb_chars: int = DEFAULT_TEXT_MAX_NB_CHARS,
wrap_chars_after: Optional[int] = None,
content: Optional[str] = None,
format_func: Callable[
[Union[Faker, Generator, Provider], str], str
] = DEFAULT_FORMAT_FUNC,
raw: bool = False,
**kwargs,
) -> Union[BytesValue, StringValue]:
"""Create inner PPTX file."""
try:
from ..pptx_file import PptxFileProvider
except ImportError as err:
raise err
return PptxFileProvider(generator).pptx_file(
storage=storage,
basename=basename,
prefix=prefix,
max_nb_chars=max_nb_chars,
wrap_chars_after=wrap_chars_after,
content=content,
format_func=format_func,
raw=raw,
**kwargs,
)
# ************************************************
# *********** RandomFileFromDirProvider **********
# ************************************************
@overload
def create_inner_random_file_from_dir(
source_dir_path: str,
storage: Optional[BaseStorage] = None,
basename: Optional[str] = None,
prefix: Optional[str] = None,
generator: Optional[Union[Faker, Generator, Provider]] = None,
raw: bool = True,
**kwargs,
) -> BytesValue:
...
@overload
def create_inner_random_file_from_dir(
source_dir_path: str,
storage: Optional[BaseStorage] = None,
basename: Optional[str] = None,
prefix: Optional[str] = None,
generator: Optional[Union[Faker, Generator, Provider]] = None,
**kwargs,
) -> StringValue:
...
[docs]def create_inner_random_file_from_dir(
source_dir_path: str,
storage: Optional[BaseStorage] = None,
basename: Optional[str] = None,
prefix: Optional[str] = None,
generator: Optional[Union[Faker, Generator, Provider]] = None,
raw: bool = False,
**kwargs,
) -> Union[BytesValue, StringValue]:
"""Create inner random_file_from_dir file."""
try:
from faker_file.providers.random_file_from_dir import (
RandomFileFromDirProvider,
)
except ImportError as err:
raise err
return RandomFileFromDirProvider(generator).random_file_from_dir(
source_dir_path=source_dir_path,
storage=storage,
basename=basename,
prefix=prefix,
raw=raw,
**kwargs,
)
# ************************************************
# ********************* RTF **********************
# ************************************************
@overload
def create_inner_rtf_file(
storage: Optional[BaseStorage] = None,
basename: Optional[str] = None,
prefix: Optional[str] = None,
generator: Optional[Union[Faker, Generator, Provider]] = None,
max_nb_chars: int = DEFAULT_TEXT_MAX_NB_CHARS,
wrap_chars_after: Optional[int] = None,
content: Optional[str] = None,
format_func: Callable[
[Union[Faker, Generator, Provider], str], str
] = DEFAULT_FORMAT_FUNC,
raw: bool = True,
**kwargs,
) -> BytesValue:
...
@overload
def create_inner_rtf_file(
storage: Optional[BaseStorage] = None,
basename: Optional[str] = None,
prefix: Optional[str] = None,
generator: Optional[Union[Faker, Generator, Provider]] = None,
max_nb_chars: int = DEFAULT_TEXT_MAX_NB_CHARS,
wrap_chars_after: Optional[int] = None,
content: Optional[str] = None,
format_func: Callable[
[Union[Faker, Generator, Provider], str], str
] = DEFAULT_FORMAT_FUNC,
**kwargs,
) -> StringValue:
...
[docs]def create_inner_rtf_file(
storage: Optional[BaseStorage] = None,
basename: Optional[str] = None,
prefix: Optional[str] = None,
generator: Optional[Union[Faker, Generator, Provider]] = None,
max_nb_chars: int = DEFAULT_TEXT_MAX_NB_CHARS,
wrap_chars_after: Optional[int] = None,
content: Optional[str] = None,
format_func: Callable[
[Union[Faker, Generator, Provider], str], str
] = DEFAULT_FORMAT_FUNC,
raw: bool = False,
**kwargs,
) -> Union[BytesValue, StringValue]:
"""Create inner RTF file."""
try:
from ..rtf_file import RtfFileProvider
except ImportError as err:
raise err
return RtfFileProvider(generator).rtf_file(
storage=storage,
basename=basename,
prefix=prefix,
max_nb_chars=max_nb_chars,
wrap_chars_after=wrap_chars_after,
content=content,
format_func=format_func,
raw=raw,
**kwargs,
)
# ************************************************
# ********************* SVG **********************
# ************************************************
@overload
def create_inner_svg_file(
storage: Optional[BaseStorage] = None,
basename: Optional[str] = None,
prefix: Optional[str] = None,
generator: Optional[Union[Faker, Generator, Provider]] = None,
max_nb_chars: int = DEFAULT_IMAGE_MAX_NB_CHARS,
wrap_chars_after: Optional[int] = None,
content: Optional[str] = None,
format_func: Callable[
[Union[Faker, Generator, Provider], str], str
] = DEFAULT_FORMAT_FUNC,
raw: bool = True,
**kwargs,
) -> BytesValue:
...
@overload
def create_inner_svg_file(
storage: Optional[BaseStorage] = None,
basename: Optional[str] = None,
prefix: Optional[str] = None,
generator: Optional[Union[Faker, Generator, Provider]] = None,
max_nb_chars: int = DEFAULT_IMAGE_MAX_NB_CHARS,
wrap_chars_after: Optional[int] = None,
content: Optional[str] = None,
format_func: Callable[
[Union[Faker, Generator, Provider], str], str
] = DEFAULT_FORMAT_FUNC,
**kwargs,
) -> StringValue:
...
[docs]def create_inner_svg_file(
storage: Optional[BaseStorage] = None,
basename: Optional[str] = None,
prefix: Optional[str] = None,
generator: Optional[Union[Faker, Generator, Provider]] = None,
max_nb_chars: int = DEFAULT_IMAGE_MAX_NB_CHARS,
wrap_chars_after: Optional[int] = None,
content: Optional[str] = None,
format_func: Callable[
[Union[Faker, Generator, Provider], str], str
] = DEFAULT_FORMAT_FUNC,
raw: bool = False,
**kwargs,
) -> Union[BytesValue, StringValue]:
"""Create inner SVG file."""
try:
from ..svg_file import SvgFileProvider
except ImportError as err:
raise err
return SvgFileProvider(generator).svg_file(
storage=storage,
basename=basename,
prefix=prefix,
max_nb_chars=max_nb_chars,
wrap_chars_after=wrap_chars_after,
content=content,
format_func=format_func,
raw=raw,
**kwargs,
)
# ************************************************
# ********************* TAR **********************
# ************************************************
@overload
def create_inner_tar_file(
storage: Optional[BaseStorage] = None,
basename: Optional[str] = None,
prefix: Optional[str] = None,
generator: Optional[Union[Faker, Generator, Provider]] = None,
options: Optional[Dict[str, Any]] = None,
compression: Optional[str] = None,
raw: bool = True,
**kwargs,
) -> BytesValue:
...
@overload
def create_inner_tar_file(
storage: Optional[BaseStorage] = None,
basename: Optional[str] = None,
prefix: Optional[str] = None,
generator: Optional[Union[Faker, Generator, Provider]] = None,
options: Optional[Dict[str, Any]] = None,
compression: Optional[str] = None,
**kwargs,
) -> StringValue:
...
[docs]def create_inner_tar_file(
storage: Optional[BaseStorage] = None,
basename: Optional[str] = None,
prefix: Optional[str] = None,
generator: Optional[Union[Faker, Generator, Provider]] = None,
options: Optional[Dict[str, Any]] = None,
compression: Optional[str] = None,
raw: bool = False,
**kwargs,
) -> Union[BytesValue, StringValue]:
"""Create inner TAR file."""
try:
from ..tar_file import TarFileProvider
except ImportError as err:
raise err
return TarFileProvider(generator).tar_file(
storage=storage,
basename=basename,
prefix=prefix,
options=options,
compression=compression,
raw=raw,
**kwargs,
)
# ************************************************
# ********************* TXT **********************
# ************************************************
@overload
def create_inner_txt_file(
storage: Optional[BaseStorage] = None,
basename: Optional[str] = None,
prefix: Optional[str] = None,
generator: Optional[Union[Faker, Generator, Provider]] = None,
max_nb_chars: int = DEFAULT_TEXT_MAX_NB_CHARS,
wrap_chars_after: Optional[int] = None,
content: Optional[str] = None,
format_func: Callable[
[Union[Faker, Generator, Provider], str], str
] = DEFAULT_FORMAT_FUNC,
raw: bool = True,
**kwargs,
) -> BytesValue:
...
@overload
def create_inner_txt_file(
storage: Optional[BaseStorage] = None,
basename: Optional[str] = None,
prefix: Optional[str] = None,
generator: Optional[Union[Faker, Generator, Provider]] = None,
max_nb_chars: int = DEFAULT_TEXT_MAX_NB_CHARS,
wrap_chars_after: Optional[int] = None,
content: Optional[str] = None,
format_func: Callable[
[Union[Faker, Generator, Provider], str], str
] = DEFAULT_FORMAT_FUNC,
**kwargs,
) -> StringValue:
...
[docs]def create_inner_txt_file(
storage: Optional[BaseStorage] = None,
basename: Optional[str] = None,
prefix: Optional[str] = None,
generator: Optional[Union[Faker, Generator, Provider]] = None,
max_nb_chars: int = DEFAULT_TEXT_MAX_NB_CHARS,
wrap_chars_after: Optional[int] = None,
content: Optional[str] = None,
format_func: Callable[
[Union[Faker, Generator, Provider], str], str
] = DEFAULT_FORMAT_FUNC,
raw: bool = False,
**kwargs,
) -> Union[BytesValue, StringValue]:
"""Create inner TXT file."""
try:
from ..txt_file import TxtFileProvider
except ImportError as err:
raise err
return TxtFileProvider(generator).txt_file(
storage=storage,
basename=basename,
prefix=prefix,
max_nb_chars=max_nb_chars,
wrap_chars_after=wrap_chars_after,
content=content,
format_func=format_func,
raw=raw,
**kwargs,
)
# ************************************************
# ******************** WEBP **********************
# ************************************************
@overload
def create_inner_webp_file(
storage: Optional[BaseStorage] = None,
basename: Optional[str] = None,
prefix: Optional[str] = None,
generator: Optional[Union[Faker, Generator, Provider]] = None,
max_nb_chars: int = DEFAULT_IMAGE_MAX_NB_CHARS,
wrap_chars_after: Optional[int] = None,
content: Optional[str] = None,
format_func: Callable[
[Union[Faker, Generator, Provider], str], str
] = DEFAULT_FORMAT_FUNC,
raw: bool = True,
**kwargs,
) -> BytesValue:
...
@overload
def create_inner_webp_file(
storage: Optional[BaseStorage] = None,
basename: Optional[str] = None,
prefix: Optional[str] = None,
generator: Optional[Union[Faker, Generator, Provider]] = None,
max_nb_chars: int = DEFAULT_IMAGE_MAX_NB_CHARS,
wrap_chars_after: Optional[int] = None,
content: Optional[str] = None,
format_func: Callable[
[Union[Faker, Generator, Provider], str], str
] = DEFAULT_FORMAT_FUNC,
**kwargs,
) -> StringValue:
...
[docs]def create_inner_webp_file(
storage: Optional[BaseStorage] = None,
basename: Optional[str] = None,
prefix: Optional[str] = None,
generator: Optional[Union[Faker, Generator, Provider]] = None,
max_nb_chars: int = DEFAULT_IMAGE_MAX_NB_CHARS,
wrap_chars_after: Optional[int] = None,
content: Optional[str] = None,
format_func: Callable[
[Union[Faker, Generator, Provider], str], str
] = DEFAULT_FORMAT_FUNC,
raw: bool = False,
**kwargs,
) -> Union[BytesValue, StringValue]:
"""Create inner WEBP file."""
try:
from ..webp_file import WebpFileProvider
except ImportError as err:
raise err
return WebpFileProvider(generator).webp_file(
storage=storage,
basename=basename,
prefix=prefix,
max_nb_chars=max_nb_chars,
wrap_chars_after=wrap_chars_after,
content=content,
format_func=format_func,
raw=raw,
**kwargs,
)
# Graphic WEBP file
@overload
def create_inner_graphic_webp_file(
storage: Optional[BaseStorage] = None,
basename: Optional[str] = None,
prefix: Optional[str] = None,
generator: Optional[Union[Faker, Generator, Provider]] = None,
size: Tuple[int, int] = (256, 256),
hue: Union[int, Sequence[int], str, None] = None,
luminosity: Optional[str] = None,
raw: bool = True,
**kwargs,
) -> BytesValue:
...
@overload
def create_inner_graphic_webp_file(
storage: Optional[BaseStorage] = None,
basename: Optional[str] = None,
prefix: Optional[str] = None,
generator: Optional[Union[Faker, Generator, Provider]] = None,
size: Tuple[int, int] = (256, 256),
hue: Union[int, Sequence[int], str, None] = None,
luminosity: Optional[str] = None,
**kwargs,
) -> StringValue:
...
[docs]def create_inner_graphic_webp_file(
storage: Optional[BaseStorage] = None,
basename: Optional[str] = None,
prefix: Optional[str] = None,
generator: Optional[Union[Faker, Generator, Provider]] = None,
size: Tuple[int, int] = (256, 256),
hue: Union[int, Sequence[int], str, None] = None,
luminosity: Optional[str] = None,
raw: bool = False,
**kwargs,
) -> Union[BytesValue, StringValue]:
"""Create inner graphic WEBP file."""
try:
from ..webp_file import GraphicWebpFileProvider
except ImportError as err:
raise err
return GraphicWebpFileProvider(generator).graphic_webp_file(
storage=storage,
basename=basename,
prefix=prefix,
size=size,
hue=hue,
luminosity=luminosity,
raw=raw,
**kwargs,
)
# ************************************************
# ******************** XLSX **********************
# ************************************************
@overload
def create_inner_xlsx_file(
storage: Optional[BaseStorage] = None,
basename: Optional[str] = None,
prefix: Optional[str] = None,
generator: Optional[Union[Faker, Generator, Provider]] = None,
data_columns: Optional[Dict[str, str]] = None,
num_rows: int = 10,
content: Optional[str] = None,
format_func: Callable[
[Union[Faker, Generator, Provider], str], str
] = DEFAULT_FORMAT_FUNC,
raw: bool = True,
**kwargs,
) -> BytesValue:
...
@overload
def create_inner_xlsx_file(
storage: Optional[BaseStorage] = None,
basename: Optional[str] = None,
prefix: Optional[str] = None,
generator: Optional[Union[Faker, Generator, Provider]] = None,
data_columns: Optional[Dict[str, str]] = None,
num_rows: int = 10,
content: Optional[str] = None,
format_func: Callable[
[Union[Faker, Generator, Provider], str], str
] = DEFAULT_FORMAT_FUNC,
**kwargs,
) -> StringValue:
...
[docs]def create_inner_xlsx_file(
storage: Optional[BaseStorage] = None,
basename: Optional[str] = None,
prefix: Optional[str] = None,
generator: Optional[Union[Faker, Generator, Provider]] = None,
data_columns: Optional[Dict[str, str]] = None,
num_rows: int = 10,
content: Optional[str] = None,
format_func: Callable[
[Union[Faker, Generator, Provider], str], str
] = DEFAULT_FORMAT_FUNC,
raw: bool = False,
**kwargs,
) -> Union[BytesValue, StringValue]:
"""Create inner XLSX file."""
try:
from ..xlsx_file import XlsxFileProvider
except ImportError as err:
raise err
return XlsxFileProvider(generator).xlsx_file(
storage=storage,
basename=basename,
prefix=prefix,
data_columns=data_columns,
num_rows=num_rows,
content=content,
format_func=format_func,
raw=raw,
**kwargs,
)
# ************************************************
# ********************* XML **********************
# ************************************************
@overload
def create_inner_xml_file(
storage: Optional[BaseStorage] = None,
basename: Optional[str] = None,
prefix: Optional[str] = None,
generator: Optional[Union[Faker, Generator, Provider]] = None,
root_element: str = "root",
row_element: str = "row",
data_columns: Optional[Dict[str, str]] = None,
num_rows: int = 10,
content: Optional[str] = None,
encoding: Optional[str] = None,
format_func: Callable[
[Union[Faker, Generator, Provider], str], str
] = DEFAULT_FORMAT_FUNC,
raw: bool = True,
**kwargs,
) -> BytesValue:
...
@overload
def create_inner_xml_file(
storage: Optional[BaseStorage] = None,
basename: Optional[str] = None,
prefix: Optional[str] = None,
generator: Optional[Union[Faker, Generator, Provider]] = None,
root_element: str = "root",
row_element: str = "row",
data_columns: Optional[Dict[str, str]] = None,
num_rows: int = 10,
content: Optional[str] = None,
encoding: Optional[str] = None,
format_func: Callable[
[Union[Faker, Generator, Provider], str], str
] = DEFAULT_FORMAT_FUNC,
**kwargs,
) -> StringValue:
...
[docs]def create_inner_xml_file(
storage: Optional[BaseStorage] = None,
basename: Optional[str] = None,
prefix: Optional[str] = None,
generator: Optional[Union[Faker, Generator, Provider]] = None,
root_element: str = "root",
row_element: str = "row",
data_columns: Optional[Dict[str, str]] = None,
num_rows: int = 10,
content: Optional[str] = None,
encoding: Optional[str] = None,
format_func: Callable[
[Union[Faker, Generator, Provider], str], str
] = DEFAULT_FORMAT_FUNC,
raw: bool = False,
**kwargs,
) -> Union[BytesValue, StringValue]:
"""Create inner XML file."""
try:
from ..xml_file import XmlFileProvider
except ImportError as err:
raise err
return XmlFileProvider(generator).xml_file(
storage=storage,
basename=basename,
prefix=prefix,
root_element=root_element,
row_element=row_element,
data_columns=data_columns,
num_rows=num_rows,
content=content,
encoding=encoding,
format_func=format_func,
raw=raw,
**kwargs,
)
# ************************************************
# ********************* ZIP **********************
# ************************************************
@overload
def create_inner_zip_file(
storage: Optional[BaseStorage] = None,
basename: Optional[str] = None,
prefix: Optional[str] = None,
generator: Optional[Union[Faker, Generator, Provider]] = None,
options: Optional[Dict[str, Any]] = None,
raw: bool = True,
**kwargs,
) -> BytesValue:
...
@overload
def create_inner_zip_file(
storage: Optional[BaseStorage] = None,
basename: Optional[str] = None,
prefix: Optional[str] = None,
generator: Optional[Union[Faker, Generator, Provider]] = None,
options: Optional[Dict[str, Any]] = None,
**kwargs,
) -> StringValue:
...
[docs]def create_inner_zip_file(
storage: Optional[BaseStorage] = None,
basename: Optional[str] = None,
prefix: Optional[str] = None,
generator: Optional[Union[Faker, Generator, Provider]] = None,
options: Optional[Dict[str, Any]] = None,
raw: bool = False,
**kwargs,
) -> Union[BytesValue, StringValue]:
"""Create inner ZIP file."""
try:
from ..zip_file import ZipFileProvider
except ImportError as err:
raise err
return ZipFileProvider(generator).zip_file(
storage=storage,
basename=basename,
prefix=prefix,
options=options,
raw=raw,
**kwargs,
)
# ************************************************
# ******************** OTHER *********************
# ************************************************
[docs]def fuzzy_choice_create_inner_file(
func_choices: List[Tuple[Callable, Dict[str, Any]]],
**kwargs,
) -> Union[BytesValue, StringValue]:
"""Create inner file from given list of function choices.
:param func_choices: List of functions to choose from.
:return: StringValue.
Usage example:
.. code-block:: python
from faker import Faker
from faker_file.providers.helpers.inner import (
create_inner_docx_file,
create_inner_epub_file,
create_inner_txt_file,
fuzzy_choice_create_inner_file,
)
from faker_file.storages.filesystem import FileSystemStorage
FAKER = Faker()
STORAGE = FileSystemStorage()
kwargs = {"storage": STORAGE, "generator": FAKER}
file = fuzzy_choice_create_inner_file(
[
(create_inner_docx_file, kwargs),
(create_inner_epub_file, kwargs),
(create_inner_txt_file, kwargs),
]
)
You could use it in archives to make a variety of different file types
within the archive.
.. code-block:: python
from faker import Faker
from faker_file.providers.helpers.inner import (
create_inner_docx_file,
create_inner_epub_file,
create_inner_txt_file,
fuzzy_choice_create_inner_file,
)
from faker_file.providers.zip_file import ZipFileProvider
from faker_file.storages.filesystem import FileSystemStorage
FAKER = Faker()
FAKER.add_provider(ZipFileProvider)
STORAGE = FileSystemStorage()
kwargs = {"storage": STORAGE, "generator": FAKER}
file = FAKER.zip_file(
prefix="zzz_archive_",
options={
"count": 50,
"create_inner_file_func": fuzzy_choice_create_inner_file,
"create_inner_file_args": {
"func_choices": [
(create_inner_docx_file, kwargs),
(create_inner_epub_file, kwargs),
(create_inner_txt_file, kwargs),
],
},
"directory": "zzz",
}
)
"""
_func, _kwargs = choice(func_choices)
return _func(**_kwargs)
[docs]def list_create_inner_file(
func_list: List[Tuple[Callable, Dict[str, Any]]],
**kwargs,
) -> List[Union[BytesValue, StringValue]]:
"""Generates multiple files based on the provided list of functions
and arguments.
:param func_list: List of tuples, each containing a function to generate a
file and its arguments.
:return: List of generated file names.
Usage example:
.. code-block:: python
from faker import Faker
from faker_file.providers.helpers.inner import (
create_inner_docx_file,
create_inner_xml_file,
list_create_inner_file,
)
from faker_file.providers.zip_file import ZipFileProvider
from faker_file.storages.filesystem import FileSystemStorage
FAKER = Faker()
FAKER.add_provider(ZipFileProvider)
STORAGE = FileSystemStorage()
kwargs = {"storage": STORAGE, "generator": FAKER}
file = FAKER.zip_file(
basename="alice-looking-through-the-glass",
options={
"create_inner_file_func": list_create_inner_file,
"create_inner_file_args": {
"func_list": [
(create_inner_docx_file, {"basename": "doc"}),
(create_inner_xml_file, {"basename": "doc_metadata"}),
(create_inner_xml_file, {"basename": "doc_isbn"}),
],
},
}
)
Note, that while all other inner functions return
back `Union[BytesValue, StringValue]` value, `list_create_inner_file`
returns back a `List[Union[BytesValue, StringValue]]` value.
Notably, all inner functions were designed to support archives (such as
ZIP, TAR and EML, but the list may grow in the future). If the inner
function passed in the `create_inner_file_func` argument returns a List
of `Union[BytesValue, StringValue]` values, the `option` argument is being
ignored and generated files are simply limited to what has been passed
in the `func_list` list of tuples.
"""
created_files = []
for func, kwargs in func_list:
file = func(**kwargs)
created_files.append(file)
return created_files