blob: b9aa8731d7c56bea70686242de9f43039e1d3f09 [file] [log] [blame]
:py:mod:`airflow.models.expandinput`
====================================
.. py:module:: airflow.models.expandinput
Module Contents
---------------
Classes
~~~~~~~
.. autoapisummary::
airflow.models.expandinput.DictOfListsExpandInput
airflow.models.expandinput.ListOfDictsExpandInput
Functions
~~~~~~~~~
.. autoapisummary::
airflow.models.expandinput.get_mappable_types
airflow.models.expandinput.get_map_type_key
airflow.models.expandinput.create_expand_input
Attributes
~~~~~~~~~~
.. autoapisummary::
airflow.models.expandinput.ExpandInput
airflow.models.expandinput.OperatorExpandArgument
airflow.models.expandinput.OperatorExpandKwargsArgument
airflow.models.expandinput.EXPAND_INPUT_EMPTY
.. py:data:: ExpandInput
.. py:data:: OperatorExpandArgument
.. py:data:: OperatorExpandKwargsArgument
.. py:function:: get_mappable_types()
.. py:exception:: NotFullyPopulated(missing)
Bases: :py:obj:`RuntimeError`
Raise when ``get_map_lengths`` cannot populate all mapping metadata.
This is generally due to not all upstream tasks have finished when the
function is called.
.. py:method:: __str__()
Return str(self).
.. py:class:: DictOfListsExpandInput
Bases: :py:obj:`NamedTuple`
Storage type of a mapped operator's mapped kwargs.
This is created from ``expand(**kwargs)``.
.. py:attribute:: value
:annotation: :dict[str, OperatorExpandArgument]
.. py:method:: get_parse_time_mapped_ti_count()
.. py:method:: get_total_map_length(run_id, *, session)
.. py:method:: resolve(context, session)
.. py:class:: ListOfDictsExpandInput
Bases: :py:obj:`NamedTuple`
Storage type of a mapped operator's mapped kwargs.
This is created from ``expand_kwargs(xcom_arg)``.
.. py:attribute:: value
:annotation: :OperatorExpandKwargsArgument
.. py:method:: get_parse_time_mapped_ti_count()
.. py:method:: get_total_map_length(run_id, *, session)
.. py:method:: resolve(context, session)
.. py:data:: EXPAND_INPUT_EMPTY
.. py:function:: get_map_type_key(expand_input)
.. py:function:: create_expand_input(kind, value)