faker-file

• Add SFTPStorage and correspondent tests.

• Add optional subject argument to the EmlFileProvider. Update
  tests accordingly.
• Add data integrity tests.

• Added FileFromPathProvider provider, which simply picks a file
  from path given. Add correspondent create_inner_file_from_path
  inner function.

• 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 been faker.provider.Python.pystr_format, which has
  been changed to faker.provider.Python.parse, since the latter is
  more convenient (as it does not transform characters
  like ?, !, # into something else using bothify method).
  To revert this behaviour, make sure to pass a callable
  function faker_file.base.pystr_format_func in format_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.

• Minor fixes in xml_file provider.

• Changed type of data_columns for xml_file provider from
  Sequence[Tuple[str, str]] to Dict[str, str].
• In the pdf_file provider, changed default value of pdf_generator_cls
  from concrete PdfkitPdfGenerator value to its' string representation
  faker_file.providers.pdf_file.generators.pdfkit_generator.PdfkitPdfGenerator.
• In the mp3_file provider, changed default value of mp3_generator_cls
  from concrete GttsMp3Generator value to its' string representation
  faker_file.providers.mp3_file.generators.gtts_generator.GttsMp3Generator.

• Minor fixes in the GenericFileProvider.

• Add create_inner_generic_file inner function.
• Add generic_file support to CLI.

• Add support for list_create_inner_file-like functions to the EML
  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.

    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.
• A new inner function list_create_inner_file has been added, using which
  it's possible to create just a list of given files (ignoring count value)
  using given arguments. The amount of files is determined by
  the func_list (each pair (Callable, kwargs) corresponds to a single
  file. Both ZipFileProvider and TarFileProvider have been altered to
  reflect these changes.
• Added to support for XML files through XmlFileProvider.

    This release introduces minor backwards incompatible changes.

• Display full path to the created file in the CLI.
• Added DynamicTemplate support for PDF file. The generate method of the BasePdfGenerator and classes derived from it, got two new arguments: data (Dict[str, Any]), and provider (Union[Faker, Generator, Provider]). If you have implemented custom generators for PDF (pdf_file provider), make sure to reflect mentioned changes in your code.

• Added DynamicTemplate support for DOCX and ODT files.

In memory of the victims of the Genocide of Armenians.

• Expose mp3_generator_cls and pdf_generator_cls CLI options
  for mp3_file and pdf_file respectively.
• Add num_files CLI option for all providers.

• Make it possible to load classes from strings for passing as arguments to mp3_file and pdf_file providers.

• Fixes in CLI options.

• Fixes in CLI options.

• Added CLI options.

Note, that this release introduces breaking changes!

• Make it easy to use a different PDF library with PdfFileProvider by adding pdf_generator_cls and pdf_generator_kwargs optional arguments to the pdf_file method. Added ReportlabPdfGenerator class based on the famous reportlab library. Default is still PdfkitPdfGenerator.
  Since encoding was something specific for pdfkit library, it was moved from pdf_file method to PdfkitPdfGenerator, to which it can be passed in pdf_generator_kwargs.
  If you have passed the encoding argument explicitly, make sure to make correspondent changes. Note, that using the new ReportlabPdfGenerator class could speed-up PDF generation by about 40 times.

• Fixes in typing of CsvFileProvider. Tuple[str, str] becomes Tuple[str, ...].

Release dedicated to my dear valentine - Anahit.

• Added filename to data property of values returned by Mp3FileProvider provider (StringValue, BytesValue).