Keun Soo Yim | dc15686 | 2017-12-22 18:58:57 -0800 | [diff] [blame] | 1 | .. image:: https://travis-ci.org/agronholm/pythonfutures.svg?branch=master |
| 2 | :target: https://travis-ci.org/agronholm/pythonfutures |
| 3 | :alt: Build Status |
| 4 | |
| 5 | This is a backport of the `concurrent.futures`_ standard library module to Python 2. |
| 6 | |
| 7 | It should not be installed on Python 3, although there should be no harm in doing so, as the |
| 8 | standard library takes precedence over third party libraries. |
| 9 | |
| 10 | To conditionally require this library only on Python 2, you can do this in your ``setup.py``: |
| 11 | |
| 12 | .. code-block:: python |
| 13 | |
| 14 | setup( |
| 15 | ... |
| 16 | extras_require={ |
| 17 | ':python_version == "2.7"': ['futures'] |
| 18 | } |
| 19 | ) |
| 20 | |
| 21 | Or, using the newer syntax: |
| 22 | |
| 23 | .. code-block:: python |
| 24 | |
| 25 | setup( |
| 26 | ... |
| 27 | install_requires={ |
| 28 | 'futures; python_version == "2.7"' |
| 29 | } |
| 30 | ) |
| 31 | |
| 32 | .. warning:: The ``ProcessPoolExecutor`` class has known (unfixable) problems on Python 2 and |
| 33 | should not be relied on for mission critical work. |
| 34 | |
| 35 | .. _concurrent.futures: https://docs.python.org/library/concurrent.futures.html |