Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/pytoolz/toolz

A functional standard library for Python.
https://github.com/pytoolz/toolz

Last synced: 3 days ago
JSON representation

A functional standard library for Python.

Awesome Lists containing this project

README 

        
Toolz

=====



|Build Status| |Coverage Status| |Version Status|



A set of utility functions for iterators, functions, and dictionaries.



See the PyToolz documentation at https://toolz.readthedocs.io



LICENSE

-------



New BSD. See `License File `__.



Install

-------



``toolz`` is on the Python Package Index (PyPI):



::



    pip install toolz



Structure and Heritage

----------------------



``toolz`` is implemented in three parts:



|literal itertoolz|_, for operations on iterables. Examples: ``groupby``,

``unique``, ``interpose``,



|literal functoolz|_, for higher-order functions. Examples: ``memoize``,

``curry``, ``compose``,



|literal dicttoolz|_, for operations on dictionaries. Examples: ``assoc``,

``update-in``, ``merge``.



.. |literal itertoolz| replace:: ``itertoolz``

.. _literal itertoolz: https://github.com/pytoolz/toolz/blob/master/toolz/itertoolz.py



.. |literal functoolz| replace:: ``functoolz``

.. _literal functoolz: https://github.com/pytoolz/toolz/blob/master/toolz/functoolz.py



.. |literal dicttoolz| replace:: ``dicttoolz``

.. _literal dicttoolz: https://github.com/pytoolz/toolz/blob/master/toolz/dicttoolz.py



These functions come from the legacy of functional languages for list

processing. They interoperate well to accomplish common complex tasks.



Read our `API

Documentation `__ for

more details.



Example

-------



This builds a standard wordcount function from pieces within ``toolz``:



.. code:: python



    >>> def stem(word):

    ...     """ Stem word to primitive form """

    ...     return word.lower().rstrip(",.!:;'-\"").lstrip("'\"")



    >>> from toolz import compose, frequencies

    >>> from toolz.curried import map

    >>> wordcount = compose(frequencies, map(stem), str.split)



    >>> sentence = "This cat jumped over this other cat!"

    >>> wordcount(sentence)

    {'this': 2, 'cat': 2, 'jumped': 1, 'over': 1, 'other': 1}



Dependencies

------------



``toolz`` supports Python 3.8+ with a common codebase.

It is pure Python and requires no dependencies beyond the standard

library.



It is, in short, a lightweight dependency.



CyToolz

-------



The ``toolz`` project has been reimplemented in `Cython `__.

The ``cytoolz`` project is a drop-in replacement for the Pure Python

implementation.

See `CyToolz GitHub Page `__ for more

details.



See Also

--------



-  `Underscore.js `__: A similar library for

   JavaScript

-  `Enumerable `__: A

   similar library for Ruby

-  `Clojure `__: A functional language whose

   standard library has several counterparts in ``toolz``

-  `itertools `__: The

   Python standard library for iterator tools

-  `functools `__: The

   Python standard library for function tools



Contributions Welcome

---------------------



``toolz`` aims to be a repository for utility functions, particularly

those that come from the functional programming and list processing

traditions. We welcome contributions that fall within this scope.



We also try to keep the API small to keep ``toolz`` manageable.  The ideal

contribution is significantly different from existing functions and has

precedent in a few other functional systems.



Please take a look at our

`issue page `__

for contribution ideas.



Community

---------



See our `mailing list `__.

We're friendly.



.. |Build Status| image:: https://github.com/pytoolz/toolz/actions/workflows/test.yml/badge.svg?branch=master

   :target: https://github.com/pytoolz/toolz/actions

.. |Coverage Status| image:: https://codecov.io/gh/pytoolz/toolz/graph/badge.svg?token=4ZFc9dwKqY

   :target: https://codecov.io/gh/pytoolz/toolz

.. |Version Status| image:: https://badge.fury.io/py/toolz.svg

   :target: https://badge.fury.io/py/toolz