fleche.query
============

.. py:module:: fleche.query


Classes
-------

.. autoapisummary::

   fleche.query.QueryIterator


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

.. py:class:: QueryIterator

   Bases: :py:obj:`Iterable`\ [\ :py:obj:`fleche.call.LazyCall`\ ]


   Iterator that adds some convenience to plain iterators over calls of query result.

   :param calls: (iterable of call.LazyCall): underlying results of the query


   .. py:attribute:: calls
      :type:  Iterable[fleche.call.LazyCall]


   .. py:method:: __iter__() -> Iterator[fleche.call.LazyCall]


   .. py:method:: table(arguments: Iterable[str] = (), results=False) -> pandas.DataFrame

      Return a pandas DataFrame summarizing queried calls.

      Arguments and results are elided.

      The DataFrame index will be the lookup key (digest) of each call.
      Columns are:
          - `name`: the function name
          - `module`: the module name
          - 'result`: if `results` argument is `True`
          - metadata fields are flattened and added as columns directly

      If given argument names collide with any of the above columns, the are prefixed by 'a_'.
      Only requested arguments are loaded from cache.

      :param arguments: add the given arguments (of the queried calls) as columns to the table
      :type arguments: iterable of str
      :param results: if True, add results of queried calls to table
      :type results: bool

      :returns: table of all calls on cache
      :rtype: :class:`pandas.DataFrame`



   .. py:method:: results() -> Iterable[Any]

      Returns an iterable over the results of queried calls.