form.forms.named_file
=====================

.. py:module:: form.forms.named_file


Classes
-------

.. autoapisummary::

   form.forms.named_file.NamedFileForm


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

.. py:class:: NamedFileForm(formdata: webob.multidict.MultiDict[str, Any] | None = None, obj: object | None = None, prefix: str = '', data: dict[str, Any] | None = None, meta: dict[str, Any] | None = None, *, extra_filters: collections.abc.Mapping[str, collections.abc.Sequence[Any]] | None = None, **kwargs: Any)

   Bases: :py:obj:`onegov.form.Form`


   Base class for handling database models using named files with forms.

   Example::

       class MyModel(AssociatedFiles):
           pdf = NamedFile()

       class MyForm(NamedFileForm):
           pdf = UploadField('PDF')

       @MyApp.form(model=MyCollection, form=MyForm, ...)
       def add(self, request, form):

           if form.submitted(request):
               self.add(**form.get_useful_data())
               ...
           ...

       @MyApp.form(model=MyModel, form=MyForm, ...)
       def edit(self, request, form):

           if form.submitted(request):
               form.populate_obj(self)
               ...

           form.process(obj=self)
           ...



   .. py:property:: file_fields
      :type: dict[str, onegov.form.fields.UploadField]



   .. py:method:: get_useful_data(exclude: collections.abc.Collection[str] | None = None) -> dict[str, Any]

      Returns the form data in a dictionary, by default excluding data
      that should not be stored in the db backend.




   .. py:method:: populate_obj(obj: object, exclude: collections.abc.Collection[str] | None = None, include: collections.abc.Collection[str] | None = None) -> None

      A reimplementation of wtforms populate_obj function with the addage
      of optional include/exclude filters.

      If neither exclude nor include is passed, the function works like it
      does in wtforms. Otherwise fields are considered which are included
      but not excluded.




   .. py:method:: process_obj(obj: object) -> None

      Called by :meth:`process` if an object was passed.

      Do *not* use this function directly. To process an object, you should
      call ``form.process(obj=obj)`` instead.