file.filters
============

.. py:module:: file.filters


Attributes
----------

.. autoapisummary::

   file.filters.log


Classes
-------

.. autoapisummary::

   file.filters.ConditionalFilter
   file.filters.OnlyIfImage
   file.filters.OnlyIfPDF
   file.filters.WithThumbnailFilter
   file.filters.WithPDFThumbnailFilter


Module Contents
---------------

.. py:data:: log

.. py:class:: ConditionalFilter(filter: depot.fields.interfaces.FileFilter)

   Bases: :py:obj:`depot.fields.interfaces.FileFilter`


   A depot filter that's only run if a condition is met. The condition
   is defined by overriding the :meth:``meets_condition`` returns True.



   .. py:attribute:: filter


   .. py:method:: meets_condition(uploaded_file: depot.fields.upload.UploadedFile) -> bool
      :abstractmethod:



   .. py:method:: on_save(uploaded_file: depot.fields.upload.UploadedFile) -> None

      Filters are required to provide their own implementation



.. py:class:: OnlyIfImage(filter: depot.fields.interfaces.FileFilter)

   Bases: :py:obj:`ConditionalFilter`


   A conditional filter that runs the passed filter only if the
   uploaded file is an image.



   .. py:method:: meets_condition(uploaded_file: depot.fields.upload.UploadedFile) -> bool


.. py:class:: OnlyIfPDF(filter: depot.fields.interfaces.FileFilter)

   Bases: :py:obj:`ConditionalFilter`


   A conditional filter that runs the passed filter only if the
   uploaded file is a pdf.



   .. py:method:: meets_condition(uploaded_file: depot.fields.upload.UploadedFile) -> bool


.. py:class:: WithThumbnailFilter(name: str, size: tuple[int, int], format: str)

   Bases: :py:obj:`depot.fields.interfaces.FileFilter`


   Uploads a thumbnail together with the file.

   Takes for granted that the file is an image.

   The resulting uploaded file will provide an additional property
   ``thumbnail_name``, which will contain the id and the path to the
   thumbnail. The name is replaced with the name given to the filter.

   .. warning::

       Requires Pillow library

   Note: This has been copied from Depot and adjusted for our use. Changes
   include a different storage format, no storage of the url and replacement
   of thumbnails instead of recreation (if possible).



   .. py:attribute:: quality
      :value: 90



   .. py:attribute:: name


   .. py:attribute:: size


   .. py:attribute:: format


   .. py:method:: generate_thumbnail(fp: IO[bytes]) -> tuple[io.BytesIO, tuple[str, str]]


   .. py:method:: store_thumbnail(uploaded_file: depot.fields.upload.UploadedFile, fp: IO[bytes], thumbnail_size: tuple[str, str] | None = None) -> None


   .. py:method:: on_save(uploaded_file: depot.fields.upload.UploadedFile) -> None

      Filters are required to provide their own implementation



.. py:class:: WithPDFThumbnailFilter(name: str, size: tuple[int, int], format: str)

   Bases: :py:obj:`WithThumbnailFilter`


   Uploads a preview thumbnail as PNG together with the file.

   This is basically the PDF implementation for `WithThumbnailFilter`.

   .. warning::

       Requires the presence of ghostscript (gs binary) on the PATH.



   .. py:attribute:: downscale_factor
      :value: 4



   .. py:method:: generate_preview(fp: _typeshed.SupportsRead[bytes]) -> io.BytesIO


   .. py:method:: generate_thumbnail(fp: _typeshed.SupportsRead[bytes]) -> tuple[io.BytesIO, tuple[str, str]]