#!/usr/bin/env python3
# -*- coding: utf-8 -*-
# ######################################################################
# Copyright (C) 2016-2018  Fridolin Pokorny, fridolin.pokorny@gmail.com
# This file is part of Selinon project.
# ######################################################################
"""A queue that respect timestamps of records that were pushed into it."""

import heapq


[docs]class TimeQueue:
    """A queue that respect timestamps of records that were pushed into it."""

    class _TimeQueueItem:
        """TimeQueue internal item."""

        def __init__(self, time, record):
            """Instantiate item for TimeQueue.

            :param time: timestamp of record
            :param record: record that should be stored
            """
            self.time = time
            self.record = record

        def __lt__(self, other):  # noqa
            return self.time < other.time

        def __repr__(self):
            """Representation for nice logs/debug.

            :return: item representation
            """
            return "%s(%s, %s)" % (self.__class__.__name__, self.time, self.record)

    def __init__(self):
        """Init time queue."""
        self._queue = []

[docs]    def push(self, time, record):
        """Push record with the given timestamp to queue.

        :param time: time of the record
        :param record: record to be pushed
        """
        heapq.heappush(self._queue, self._TimeQueueItem(time, record))

[docs]    def pop(self):
        """Remove and return the top record in the queue.

        :return: time and record tuple that were stored
        """
        result = heapq.heappop(self._queue)
        return result.time, result.record

[docs]    def top(self):
        """Return the top record in the queue, do not remove it from the queue.

        :return: time and record tuple that were stored
        """
        result = self._queue[0]
        return result.time, result.record

[docs]    def is_empty(self):
        """Check queue emptiness.

        :return: True if queue is empty
        """
        return len(self._queue) == 0

    def __repr__(self):
        """Queue representation.

        :return: a string representation for this queue.
        """
        return repr(self._queue)