ds_protocol_http_py_lib.models
==============================

.. py:module:: ds_protocol_http_py_lib.models

.. autoapi-nested-parse::

   **File:** ``models.py``
   **Region:** ``ds_protocol_http_py_lib``

   Typed helper models used by the HTTP dataset layer.



Classes
-------

.. autoapisummary::

   ds_protocol_http_py_lib.models.Files


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

.. py:class:: Files

   Bases: :py:obj:`ds_common_serde_py_lib.Serializable`


   Multipart file descriptor for `HttpDatasetSettings.files`.


   .. py:attribute:: field
      :type:  str
      :value: 'file'


      Multipart form field name (e.g. ``"file"`` or ``"upload"``).


   .. py:attribute:: filename
      :type:  str

      Filename sent as the multipart part name.


   .. py:attribute:: content
      :type:  bytes | str

      File payload sent as multipart file content.


   .. py:attribute:: content_type
      :type:  str | None
      :value: None


      Optional content-type for the multipart part.


   .. py:method:: to_requests_file_tuple() -> tuple[str, bytes | str] | tuple[str, bytes | str, str]

      Convert into a `requests` multipart file tuple.

      Tuple shapes supported by `requests`:
      - ``(filename, fileobj)``
      - ``(filename, fileobj, content_type)``