Release history and notes¶
Sequence based identifiers are used for versioning (schema follows below):
major.minor[.revision]
It’s always safe to upgrade within the same minor version (for example, from 0.3 to 0.3.4).
Minor version changes might be backwards incompatible. Read the release notes carefully before upgrading (for example, when upgrading from 0.3.4 to 0.4).
All backwards incompatible changes are mentioned in this document.
0.15.5¶
2023-06-18
Minor fixes and documentation improvements.
0.15.4¶
2023-06-15
Improved
SFTPStorage
tests.Stop testing against Python 3.7.
Stop testing against Django 4.0.
0.15.3¶
2023-06-14
Add
SFTPStorage
and correspondent tests.
0.15.2¶
2023-06-08
Add optional
subject
argument to theEmlFileProvider
. Update tests accordingly.Add data integrity tests.
0.15.1¶
2023-06-06
Added
FileFromPathProvider
provider, which simply picks a file from path given. Add correspondentcreate_inner_file_from_path
inner function.
0.15¶
2023-06-05
Added
format_func
argument to most of the providers. This allows to control which formatter function will be used as a default formatter. Previously it has beenfaker.provider.Python.pystr_format
, which has been changed tofaker.provider.Python.parse
, since the latter is more convenient (as it does not transform characters like?
,!
,#
into something else usingbothify
method). To revert this behaviour, make sure to pass a callable functionfaker_file.base.pystr_format_func
informat_func
argument to each correspondent provider or inner function.Added
create_inner_random_file_from_dir
inner function.Tested against Django 4.2.
Stop testing against Django 2.2.
0.14.5¶
2023-05-11
Minor fixes in
xml_file
provider.
0.14.4¶
2023-05-11
Changed type of
data_columns
forxml_file
provider fromSequence[Tuple[str, str]]
toDict[str, str]
.In the
pdf_file
provider, changed default value ofpdf_generator_cls
from concretePdfkitPdfGenerator
value to its’ string representation faker_file.providers.pdf_file.generators.pdfkit_generator.PdfkitPdfGenerator.In the
mp3_file
provider, changed default value ofmp3_generator_cls
from concreteGttsMp3Generator
value to its’ string representation faker_file.providers.mp3_file.generators.gtts_generator.GttsMp3Generator.
0.14.3¶
2023-05-10
Minor fixes in the
GenericFileProvider
.
0.14.2¶
2023-05-09
Add
create_inner_generic_file
inner function.Add
generic_file
support to CLI.
0.14.1¶
2023-05-08
Add support for
list_create_inner_file
-like functions to theEML
file provider. If you are using CLI and CLI-completion, make sure to re-generate the completion file.Add
GenericFileProvider
provider to support generic file types.
0.14¶
2023-05-07
Note
This release introduces minor backwards incompatible changes.
A new argument
basename
has been added to all providers, inner functions and storage classes. If you have customized things or created your own providers, make sure to make appropriate changes in your code. See the source code for more implementation examples. If you are using CLI and CLI-completion, make sure to re-generate the completion file.A new inner function
list_create_inner_file
has been added, using which it’s possible to create just a list of given files (ignoringcount
value) using given arguments. The amount of files is determined by thefunc_list
(each pair(Callable, kwargs)
corresponds to a single file. BothZipFileProvider
andTarFileProvider
have been altered to reflect these changes.Added to support for
XML
files throughXmlFileProvider
.
0.13¶
2023-05-05
Note
This release introduces minor backwards incompatible changes.
Display full path to the created file in the CLI.
Added
DynamicTemplate
support forPDF
file. Thegenerate
method of theBasePdfGenerator
and classes derived from it, got two new arguments:data
(Dict[str, Any]
), andprovider
(Union[Faker, Generator, Provider]
). If you have implemented custom generators forPDF
(pdf_file
provider), make sure to reflect mentioned changes in your code.
0.12.6¶
2023-05-02
Added
DynamicTemplate
support forDOCX
andODT
files.
0.12.5¶
2023-04-24
Note
In memory of the victims of the Armenian Genocide.
Expose
mp3_generator_cls
andpdf_generator_cls
CLI options formp3_file
andpdf_file
respectively.Add
num_files
CLI option for all providers.
0.12.4¶
2023-04-22
Make it possible to load classes from strings for passing as arguments to
mp3_file
andpdf_file
providers.
0.12.3¶
2023-04-21
Fixes in CLI options.
0.12.2¶
2023-04-20
Fixes in CLI options.
0.12.1¶
2023-04-19
Added CLI options.
0.12¶
2023-02-24
Note, that this release introduces breaking changes!
Make it easy to use a different PDF library with
PdfFileProvider
by addingpdf_generator_cls
andpdf_generator_kwargs
optional arguments to thepdf_file
method. AddedReportlabPdfGenerator
class based on the famousreportlab
library. Default is stillPdfkitPdfGenerator
. Sinceencoding
was something specific forpdfkit
library, it was moved frompdf_file
method toPdfkitPdfGenerator
, to which it can be passed inpdf_generator_kwargs
. If you have passed theencoding
argument explicitly, make sure to make correspondent changes. Note, that using the newReportlabPdfGenerator
class could speed-up PDF generation by about 40 times.
0.11.5¶
2023-02-20
Fixes in typing of
CsvFileProvider
.Tuple[str, str]
becomesTuple[str, ...]
.
0.11.4¶
2023-02-16
Note
Release dedicated to my dear valentine - Anahit.
Added
filename
todata
property of values returned byMp3FileProvider
provider (StringValue
,BytesValue
).
0.11.3¶
2023-02-10
Moved several interface classes from one location to another. If you haven’t implemented custom generators, this won’t affect you. If you did, make sure to update your imports:
BaseTextAugmenter
has been moved fromfaker_file.providers.augment_file_from_dir.augmenters.base
tofaker_file.providers.base.text_augmenter
.BaseTextExtractor
has been moved fromfaker_file.providers.augment_file_from_dir.extractors.base
tofaker_file.providers.base.text_extractor
.BaseMp3Generator
has been moved fromfaker_file.providers.mp3_file.generators.base
tofaker_file.providers.base.mp3_generator
.
0.11.2¶
2023-02-07
Add
filename
todata
property of values returned by providers (StringValue
,BytesValue
).
0.11.1¶
2023-01-31
Documentation improvements.
MyPy fixes.
0.11¶
2023-01-25
Allow returning binary contents of the file by providing the
raw=True
argument (False
by default, works with all provider classes and inner functions). If you have subclassed or overriden provider classes or written custom inner functions, make sure to reflect the changes in your code.
0.10.12¶
2023-01-21
Add
TarFileProvider
andcreate_inner_tar_file
function.Add
OdpFileProvider
andcreate_inner_odp_file
function.
0.10.11¶
2023-01-20
Improve
EPUB
document layout.Improve
PDF
document layout.Minor documentation improvements.
0.10.10¶
2023-01-19
Allow passing
model_name
andaction
arguments to theContextualWordEmbeddingsAugmenter
.Replace
bert-base-cased
withbert-base-multilingual-cased
as a default model forContextualWordEmbeddingsAugmenter
.Improve
PPTX
document layout.Minor fixes in documentation.
0.10.9¶
2023-01-18
Add an installation directive
[common]
to install everything except ML libraries.Added testing of UTF8 content.
0.10.8¶
2023-01-16
Switch to PyPI releases of
gtts
.Stop testing against Django 3.0 and 3.1.
Documentation improvements.
Tests improvements.
0.10.7¶
2023-01-13
Add
OdtFileProvider
andcreate_inner_odt_file
function.Documentation improvements.
Async related deprecation fixes in
EdgeTtsMp3Generator
.Optimize example factories.
0.10.6¶
2023-01-11
Add
AugmentFileFromDirProvider
provider for making augmented copies of randomly picked files from given directory.Documentation improvements.
Fixes in setup.
0.10.5¶
2023-01-09
Add
fuzzy_choice_create_inner_file
inner function for easy diversion of files within archives (ZIP
,EML
).Documentation improvements.
Add
MaryTTS
example (another MP3 generator forMp3FileProvider
).
0.10.4¶
2023-01-08
Add missing
mp3_generator_kwargs
argument to thecreate_inner_mp3_file
function.Clean-up.
0.10.3¶
2023-01-07
Improvements of the Mp3FileProvider
module:
Pass active generator to the
Mp3FileProvider
in thegenerator
argument ifBaseMp3Generator
(and all implementations).Introduce
handle_kwargs
method in theBaseMp3Generator
to handle arbitrary provider specific tuning.Add
EdgeTtsMp3Generator
MP3 generator.Add
mp3_generator_kwargs
argument to theMp3FileProvider.mp3_file
method.
0.10.2¶
2023-01-06
Add
Mp3FileProvider
.Add
create_inner_mp3_file
inner function.
0.10.1¶
2023-01-05
Fixes in
ZipFileProvider
.
0.10¶
2023-01-04
Note, that this release introduces breaking changes!
Move all
create_inner_*_file
functions fromfaker_file.providers.zip_file
tofaker_file.providers.helpers.inner
module. Adjust your imports accordingly.Add
EmlFileProvider
.Add
create_inner_eml_file
inner function.
0.9.3¶
2023-01-03
Add
EpubFileProvider
provider.
0.9.2¶
2022-12-23
Add
RrfFileProvider
.Added
SQLAlchemy
factory example.
0.9.1¶
2022-12-19
Fixes in cloud storage.
Documentation fixes.
0.9¶
2022-12-17
Add optional
encoding
argument toCsvFileProvider
andPdfFileProvider
providers.Add
root_path
argument to cloud storages.Moved all image related code (
IcoFileProvider
,JpegFileProvider
,PngFileProvider
,SvgFileProvider
,WebpFileProvider
) toImageMixin
. Moved all tabular data related code (OdsFileProvider
,XlsxFileProvider
) toTabularDataMixin
.Documentation improvements.
0.8¶
2022-12-16
Note, that this release introduces breaking changes!
All file system based operations are moved to a separate abstraction layer of file storages. The following storages have been implemented:
FileSystemStorage
,PathyFileSystemStorage
,AWSS3Storage
,GoogleCloudStorage
andAzureStorage
. Theroot_path
andrel_path
params of the providers are deprecated in favour of storages. See the docs more usage examples.
0.7¶
2022-12-12
Added
RandomFileFromDirProvider
which picks a random file from directory given.Improved docs.
0.6¶
2022-12-11
Pass optional
generator
argument to inner functions of theZipFileProvider
.Added
create_inner_zip_file
inner function which allows to create nested ZIPs.Reached test coverage of 100%.
0.5¶
2022-12-10
Note, that this release introduces breaking changes!
Added ODS file support.
Switched to
tablib
for easy, non-variant support of various formats (XLSX, ODS).Silence
imgkit
logging output.ZipFileProvider allows to pass arbitrary arguments to inner functions. Put all your inner function arguments into a dictionary and pass it in create_inner_file_args key inside options argument. See the example below.
zip_file = ZipFileProvider(None).file( prefix="zzz_archive_", options={ "count": 5, "create_inner_file_func": create_inner_docx_file, "create_inner_file_args": { "prefix": "zzz_file_", "max_nb_chars": 1_024, "content": "{{date}}\r\n{{text}}\r\n{{name}}", }, "directory": "zzz", } )
0.4¶
2022-12-09
Note, that this release introduces breaking changes!
Remove the concept of content generators (and the correspondent
content_generator
arguments in implemented providers). Instead, allow usage of dynamic fixtures in the providedcontent
argument.Remove temporary files when creating ZIP archives.
Various improvements and fixes in docs.
0.3¶
2022-12-08
Add support for BIN, CSV and XLSX files.
Better visual representation of generated images and PDFs.
0.2¶
2022-12-07
Added support for ICO, JPEG, PNG, SVG and WEBP files.
Documentation improvements.
0.1¶
2022-12-06
Initial beta release.