org.forms.fields
================

.. py:module:: org.forms.fields


Classes
-------

.. autoapisummary::

   org.forms.fields.HtmlField
   org.forms.fields.UploadOrLinkExistingFileField
   org.forms.fields.UploadOrSelectExistingFileField
   org.forms.fields.UploadOrSelectExistingMultipleFilesField


Functions
---------

.. autoapisummary::

   org.forms.fields.file_choices_from_collection


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

.. py:class:: HtmlField(*args: Any, **kwargs: Any)

   Bases: :py:obj:`onegov.form.fields.HtmlField`


   A textfield with html with integrated sanitation and annotation,
   cleaning the html and adding extra information including setting the
   image size by querying the database.



   .. py:method:: pre_validate(form: onegov.form.Form) -> None

      Override if you need field-level validation. Runs before any other
      validators.

      :param form: The form the field belongs to.



.. py:function:: file_choices_from_collection(collection: onegov.file.FileCollection[Any]) -> list[tuple[str, str]]

.. py:class:: UploadOrLinkExistingFileField(*args: Any, file_collection: type[onegov.file.FileCollection[Any]] = FileCollection, file_type: str = 'general', allow_duplicates: bool = False, _collection: onegov.file.FileCollection[Any] | None = None, **kwargs: Any)

   Bases: :py:obj:`onegov.form.fields.UploadFileWithORMSupport`


   An extension of :class:`onegov.form.fields.UploadFileWithORMSupport`
   which will select existing uploaded files to link from a given
   :class:`onegov.file.FileCollection` class in addition to uploading
   new files.

   This class is mostly useful in conjunction with
   :class:`onegov.org.forms.fields.UploadOrSelectExistingMultipleFilesField`
   if you want to link or upload only a single file, then you should
   use :class:`onegov.org.forms.fields.UploadOrSelectExistingFileField`.



   .. py:attribute:: existing_file
      :type:  onegov.file.File | None


   .. py:attribute:: widget


   .. py:attribute:: allow_duplicates
      :value: False



   .. py:attribute:: collection
      :value: None



   .. py:method:: populate_obj(obj: object, name: str) -> None

      Populates `obj.<name>` with the field's data.

      :note: This is a destructive operation. If `obj.<name>` already exists,
             it will be overridden. Use with caution.



   .. py:method:: create() -> onegov.file.File | None


.. py:class:: UploadOrSelectExistingFileField(*args: Any, file_collection: type[onegov.file.FileCollection[Any]] = FileCollection, file_type: str = 'general', allow_duplicates: bool = False, _choices: list[tuple[str, str]] | None = None, **kwargs: Any)

   Bases: :py:obj:`UploadOrLinkExistingFileField`


   An extension of :class:`onegov.form.fields.UploadFileWithORMSupport`
   to allow selecting existing uploaded files from a given
   :class:`onegov.file.FileCollection` class in addition to uploading
   new files.

   :param file_collection:
       The file collection class to use, should be a subclass of
       :class:`onegov.file.FileCollection`.

   :param file_type:
       The polymoprhic type to use and to filter for.

   :param allow_duplicates:
       Prevents duplicates if set to false. Rather than throw an error
       it will link to the existing file and discard the new file.



   .. py:attribute:: widget


   .. py:attribute:: choices
      :value: None



   .. py:method:: process_formdata(valuelist: list[onegov.form.types.RawFormValue]) -> None

      Process data received over the wire from a form.

      This will be called during form construction with data supplied
      through the `formdata` argument.

      :param valuelist: A list of strings to process.



.. py:class:: UploadOrSelectExistingMultipleFilesField(*args: Any, file_collection: type[onegov.file.FileCollection[Any]] = FileCollection, file_type: str = 'general', allow_duplicates: bool = False, **kwargs: Any)

   Bases: :py:obj:`onegov.form.fields.UploadMultipleFilesWithORMSupport`


   An extension of
   :class:`onegov.form.fields.UploadMultipleFilesWithORMSupport` to
   allow selecting existing uploaded files from a given
   :class:`onegov.file.FileCollection` class in addition to uploading
   new files.

   :param file_collection:
       The file collection class to use, should be a subclass of
       :class:`onegov.file.FileCollection`.

   :param file_type:
       The polymoprhic type to use and to filter for.

   :param allow_duplicates:
       Prevents duplicates if set to false. Rather than throw an error
       it will link to the existing file and discard the new file.



   .. py:attribute:: widget


   .. py:attribute:: upload_field_class


   .. py:attribute:: upload_widget


   .. py:attribute:: collection


   .. py:attribute:: choices


   .. py:method:: process_formdata(valuelist: list[onegov.form.types.RawFormValue]) -> None

      Process data received over the wire from a form.

      This will be called during form construction with data supplied
      through the `formdata` argument.

      :param valuelist: A list of strings to process.