httk.optimade.model.results
===========================

.. py:module:: httk.optimade.model.results


Classes
-------

.. autoapisummary::

   httk.optimade.model.results.ResultRow
   httk.optimade.model.results.QueryResults
   httk.optimade.model.results.QueryFunction


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

.. py:class:: ResultRow

   One entry result: its attribute values plus per-entry envelope data.


   .. py:attribute:: values
      :type:  dict[str, Any]


   .. py:attribute:: relationships
      :type:  dict[str, list[dict[str, Any]]]


   .. py:attribute:: property_metadata
      :type:  dict[str, Any]


.. py:class:: QueryResults

   Bases: :py:obj:`Protocol`


   The results of a query against a backend, as consumed by the entry endpoints.

   Iteration yields one :class:`~httk.optimade.model.results.ResultRow` per entry; its ``values`` map
   OPTIMADE response-field names to values, and the ``id`` and ``type`` keys
   are always present.


   .. py:attribute:: more_data_available
      :type:  bool


   .. py:method:: count() -> int


.. py:class:: QueryFunction

   Bases: :py:obj:`Protocol`


   The callback seam through which the request engine runs queries on a backend.