api_24sea.datasignals.planning
==============================

.. py:module:: api_24sea.datasignals.planning

.. autoapi-nested-parse::

   Shared request planning for DataSignals client facades.



Classes
-------

.. autoapisummary::

   api_24sea.datasignals.planning.DataRequest
   api_24sea.datasignals.planning.DataRequestPlan


Functions
---------

.. autoapisummary::

   api_24sea.datasignals.planning.get_group_locations
   api_24sea.datasignals.planning.get_group_site_name
   api_24sea.datasignals.planning.plan_data_requests


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

.. py:class:: DataRequest

   Describe one DataSignals data endpoint request.


.. py:class:: DataRequestPlan

   Describe ordered requests and their concurrency limits.


.. py:function:: get_group_locations(group: pandas.DataFrame) -> List[str]

   Return stable unique locations from a grouped metrics DataFrame.


.. py:function:: get_group_site_name(site: object) -> str

   Return a grouped site key as a string.


.. py:function:: plan_data_requests(grouped_metrics: Iterable[Tuple[object, pandas.DataFrame]], start_timestamp: Union[str, datetime.datetime], end_timestamp: Union[str, datetime.datetime], selected_metrics: Optional[pandas.DataFrame]) -> DataRequestPlan

   Create an ordered request plan for a DataSignals data query.

   Parameters
   ----------
   grouped_metrics : iterable of tuple
       Metric groups keyed by site.
   start_timestamp, end_timestamp : str or datetime.datetime
       Full query range.
   selected_metrics : pandas.DataFrame or None
       Metrics selected for the query.

   Returns
   -------
   DataRequestPlan
       Ordered requests and the calculated concurrency limit.