Metadata-Version: 1.1
Name: filequeue
Version: 0.3.1
Summary: A thread-safe queue object which is interchangeable with the stdlib Queue. Any overflow goes into a compressed file to keep excessive amounts of queued items out of memory
Home-page: http://pypi.python.org/pypi/filequeue
Author: Paul Wiseman
Author-email: poalman@gmail.com
License: BSD
Description: .. contents::
        
        Overview
        ========
        
        .. role:: mod(emphasis)
        
        :mod:`filequeue` is a Python library that provides a thread-safe queue which is a subclass of ``Queue.Queue`` from the stdlib.
        
        ``filequeue.FileQueue`` will overflow into a compressed file if the number of items exceeds maxsize, instead of blocking or raising ``Full`` like the regular ``Queue.Queue``.
        
        There is also ``filequeue.PriorityFileQueue`` and ``filequeue.LifoFileQueue`` implementations.
        
        **Note** ``filequeue.FileQueue`` and ``filequeue.LifoFileQueue`` will only behave the same as ``Queue.Queue`` and ``Queue.LifoQueue`` respectively if they are initialised with ``maxsize=0`` (the default). See ``__init__`` docstring for details (``help(FileQueue)``)
        
        **Note** ``filequeue.PriorityFileQueue`` won't currently work exactly the same as a straight out replacement for ``Queue.PriorityQueue``. The interface is very slightly different (extra optional kw argument on ``put`` and ``__init__``), although it will work it won't behave the same. It might still be useful to people though and hopefully I'll be able to address this in a future version.
        
        Requirements:
        
        - Python 2.5+ or Python 3.x
        
        Why?
        ----
        
        The motivation came from wanting to queue a lot of work, without consuming lots of memory.
        
        The interface of ``filequeue.FileQueue`` matches that of ``Queue.Queue`` (or ``queue.Queue`` in python 3.x). With the idea being that most people will use ``Queue.Queue``, and can swap in a ``filequeue.FileQueue`` only if the memory usage becomes an issue. (Same applies for ``filequeue.LifoFileQueue``)
        
        Licence
        -------
        
        Made available as-is under the BSD Licence.
        
        Issues
        ------
        Any issues please post on the `github page <https://github.com/GP89/FileQueue/issues>`_.
        
        Changelog
        =========
        
        0.3.1 (2013-01-10)
        ------------------
        
        - Added unittests from the ``LifoFileQueue``.
        
        0.3.0 (2013-01-10)
        ------------------
        
        - Added ``LifoFileQueue`` implementation that returns the most recently added items first.
        
        - Reverted the file type from gzip to a regular file for the time being.
        
        0.2.3 (2012-11-27)
        ------------------
        
        - Fix for ``PriorityFileQueue`` where it wasn't returning items in the correct order according to the priority.
        
        - Added ``import *`` into ``__init__.py`` to make the namespace a bit nicer.
        
        - Added the unit tests from stdlibs ``Queue`` (quickly edited out the full checks and ``LifoQueue`` tests).
        
        0.2.2 (2012-11-27)
        ------------------
        
        - Initial public release.
Keywords: queue thread-safe file gzip
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Topic :: Utilities
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.5
Classifier: Programming Language :: Python :: 2.6
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.0
Classifier: Programming Language :: Python :: 3.1
Classifier: Programming Language :: Python :: 3.2
Classifier: Programming Language :: Python :: 3.3
Classifier: License :: OSI Approved :: BSD License
