Method queue_pop

couchbase/collection.py:1760–1793

Remove and return the first item queue. .. warning:: This method is deprecated and will be removed in the 4.7.0 version. Use :meth:`.CouchbaseQueue.pop` instead. Args: key (str): The key for the queue document. **kwargs (Dict[str, An

(self, key: str, **kwargs: object)

        return self.list_prepend(key, value, create=create, **kwargs)

    def queue_pop(self, key: str, **kwargs: object) -> OperationResult:
        """Remove and return the first item queue.

        .. warning::
            This method is deprecated and will be removed in the 4.7.0 version.  Use :meth:`.CouchbaseQueue.pop`
            instead.

        Args:
            key (str): The key for the queue document.
            **kwargs (Dict[str, Any]): keyword arguments that can be used as optional parameters
                for this operation.

        Returns:
            :class:`~couchbase.result.OperationResult`: An instance of :class:`~couchbase.result.OperationResult`.

        Raises:
            :class:`~couchbase.exceptions.DocumentNotFoundException`: If the key provided does not exist
                on the server.
        """
        while True:
            try:
                itm = self.list_get(key, -1, **kwargs)
            except IndexError:
                raise QueueEmpty

            kwargs.update({k: v for k, v in getattr(
                itm, '__dict__', {}).items() if k in {'cas'}})
            try:
                self.list_remove(key, -1, **kwargs)
                return itm
            except DocumentExistsException:
                pass
            except IndexError:
                raise QueueEmpty

    def queue_size(self, key: str) -> int:
        """Get the length of a queue.