data_structures.queues.queue_by_list
====================================

.. py:module:: data_structures.queues.queue_by_list

.. autoapi-nested-parse::

   Queue represented by a Python list



Attributes
----------

.. autoapisummary::

   data_structures.queues.queue_by_list._T


Classes
-------

.. autoapisummary::

   data_structures.queues.queue_by_list.QueueByList


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

.. py:class:: QueueByList(iterable: collections.abc.Iterable[_T] | None = None)

   Bases: :py:obj:`Generic`\ [\ :py:obj:`_T`\ ]


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

      >>> len(QueueByList())
      0
      >>> from string import ascii_lowercase
      >>> len(QueueByList(ascii_lowercase))
      26
      >>> queue = QueueByList()
      >>> for i in range(1, 11):
      ...     queue.put(i)
      >>> len(queue)
      10
      >>> for i in range(2):
      ...   queue.get()
      1
      2
      >>> len(queue)
      8



   .. py:method:: __repr__() -> str

      >>> queue = QueueByList()
      >>> queue
      Queue(())
      >>> str(queue)
      'Queue(())'
      >>> queue.put(10)
      >>> queue
      Queue((10,))
      >>> queue.put(20)
      >>> queue.put(30)
      >>> queue
      Queue((10, 20, 30))



   .. py:method:: get() -> _T

      Get `item` from the Queue

      >>> queue = QueueByList((10, 20, 30))
      >>> queue.get()
      10
      >>> queue.put(40)
      >>> queue.get()
      20
      >>> queue.get()
      30
      >>> len(queue)
      1
      >>> queue.get()
      40
      >>> queue.get()
      Traceback (most recent call last):
          ...
      IndexError: Queue is empty



   .. py:method:: get_front() -> _T

      Get the front item from the Queue

      >>> queue = QueueByList((10, 20, 30))
      >>> queue.get_front()
      10
      >>> queue
      Queue((10, 20, 30))
      >>> queue.get()
      10
      >>> queue.get_front()
      20



   .. py:method:: put(item: _T) -> None

      Put `item` to the Queue

      >>> queue = QueueByList()
      >>> queue.put(10)
      >>> queue.put(20)
      >>> len(queue)
      2
      >>> queue
      Queue((10, 20))



   .. py:method:: rotate(rotation: int) -> None

      Rotate the items of the Queue `rotation` times

      >>> queue = QueueByList([10, 20, 30, 40])
      >>> queue
      Queue((10, 20, 30, 40))
      >>> queue.rotate(1)
      >>> queue
      Queue((20, 30, 40, 10))
      >>> queue.rotate(2)
      >>> queue
      Queue((40, 10, 20, 30))



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



.. py:data:: _T