Metadata-Version: 1.2
Name: gentools
Version: 0.4.0
Summary: tools for generators, generator functions, and generator-based coroutines
Home-page: https://github.com/ariebovenberg/gentools
Author: Arie Bovenberg
Author-email: a.c.bovenberg@gmail.com
License: MIT
Description: Gentools
        ========
        
        .. image:: https://img.shields.io/pypi/v/gentools.svg
            :target: https://pypi.python.org/pypi/gentools
        
        .. image:: https://img.shields.io/pypi/l/gentools.svg
            :target: https://pypi.python.org/pypi/gentools
        
        .. image:: https://img.shields.io/pypi/pyversions/gentools.svg
            :target: https://pypi.python.org/pypi/gentools
        
        .. image:: https://travis-ci.org/ariebovenberg/gentools.svg?branch=master
            :target: https://travis-ci.org/ariebovenberg/gentools
        
        .. image:: https://coveralls.io/repos/github/ariebovenberg/gentools/badge.svg?branch=master
            :target: https://coveralls.io/github/ariebovenberg/gentools?branch=master
        
        .. image:: https://readthedocs.org/projects/gentools/badge/?version=latest
            :target: http://gentools.readthedocs.io/en/latest/?badge=latest
            :alt: Documentation Status
        
        .. image:: https://api.codeclimate.com/v1/badges/a4879e2c20282c1ac386/maintainability
            :target: https://codeclimate.com/github/ariebovenberg/gentools/maintainability
            :alt: Maintainability
        
        
        Tools for generators, generator functions, and generator-based coroutines.
        
        Installation
        ------------
        
        .. code-block:: bash
        
           pip install gentools
        
        Examples
        --------
        
        - Make generator functions reusable:
        
        .. code-block:: python
        
           >>> @reusable
           ... def countdown(value, step):
           ...     while value > 0:
           ...         yield value
           ...         value -= step
        
           >>> from_3 = countdown(3, step=1)
           >>> list(from_3)
           [3, 2, 1]
           >>> list(from_3)
           [3, 2, 1]
           >>> isinstance(from_3, countdown)  # generator func is wrapped in a class
           True
           >>> from_3.step  # attribute access to arguments
           1
           >>> from_3.replace(value=5)  # create new instance with replaced fields
           countdown(value=5, step=1)  # descriptive repr()
        
        - map a generator's ``yield``, ``send``, and ``return`` values:
        
        .. code-block:: python
        
           >>> @map_return('final value: {}'.format)
           ... @map_send(int)
           ... @map_yield('the current max is: {}'.format)
           ... def my_max(value):
           ...     while value < 100:
           ...         newvalue = yield value
           ...         if newvalue > value:
           ...             value = newvalue
           ...     return value
        
           >>> gen = my_max(5)
           >>> next(gen)
           'the current max is: 5'
           >>> gen.send(11.3)
           'the current max is: 11'
           >>> gen.send(104)
           StopIteration('final value: 104')
        
        - relay a generator's yield/send interactions through another generator:
        
        .. code-block:: python
        
           >>> def try_until_positive(outvalue):
           ...     value = yield outvalue
           ...     while value < 0:
           ...         value = yield 'not positive, try again'
           ...     return value
        
           >>> @relay(try_until_positive)
           ... def my_max(value):
           ...     while value < 100:
           ...         newvalue = yield value
           ...         if newvalue > value:
           ...             value = newvalue
           ...     return value
        
           >>> gen = my_max(5)
           >>> next(gen)
           5
           >>> gen.send(-4)
           'not positive, try again'
           >>> gen.send(-1)
           'not positive, try again'
           >>> gen.send(8)
           8
           >>> gen.send(104)
           StopIteration(104)
        
        
        Release history
        ---------------
        
        development
        +++++++++++
        
        0.4.0 (2018-01-24)
        ++++++++++++++++++
        
        - rename ``pipe`` to ``relay``.
        
        0.3.1 (2018-01-23)
        ++++++++++++++++++
        
        - fix copy issue in reusable generator ``.replace()``
        
        0.3.0 (2018-01-22)
        ++++++++++++++++++
        
        - make reusable generators callable as methods
        
        0.2.2 (2018-01-21)
        ++++++++++++++++++
        
        - updates to readme
        
        0.2.0 (2018-01-21)
        ++++++++++++++++++
        
        - reorganized modules, improved docs, renamed functions.
        
        0.1.0 (2018-01-17)
        ++++++++++++++++++
        
        - initial release
        
Keywords: generators,itertools
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Requires-Python: >=3.4
