:py:mod:`whist_core.session.distribution`
=========================================

.. py:module:: whist_core.session.distribution

.. autoapi-nested-parse::

   Wraps player's team assignment.



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

Classes
~~~~~~~

.. autoapisummary::

   whist_core.session.distribution.DistributionEntry
   whist_core.session.distribution.Distribution




.. py:class:: DistributionEntry


   Bases: :py:obj:`pydantic.BaseModel`

   Player to team assignment.

   .. py:attribute:: player_index
      :type: int

      

   .. py:attribute:: team_id
      :type: int

      


.. py:class:: Distribution


   Bases: :py:obj:`pydantic.BaseModel`

   All player to team assignment.

   .. py:attribute:: entries
      :type: list[DistributionEntry]
      :value: []

      

   .. py:method:: __iter__()

      Iterates over all entries.


   .. py:method:: __len__()

      Returns the list of entries.


   .. py:method:: __getitem__(item: int) -> DistributionEntry

      Gets on specific entry.
      :param item: index of the item


   .. py:method:: add(entry: DistributionEntry) -> None

      Adds a new entry to the list.
      :param entry: to be added
      :return: None