DESCRIPTION.rst 2.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172
  1. ===========
  2. selectors34
  3. ===========
  4. *selectors34* is a backport of the selectors module from Python 3.4. The
  5. selectors module written by Charles-François Natali. This port is based on
  6. Victor Stinner's ``trollius/selectors.py`` port.
  7. Installation and Usage
  8. ----------------------
  9. To install *selectors34* via pip::
  10. $ pip install selectors34
  11. For best compatibility for Python 3.4, import *selectors34* like::
  12. try:
  13. import selectors
  14. except ImportError:
  15. import selectors34 as selectors
  16. Project Details
  17. ---------------
  18. :Documentation: https://docs.python.org/3/library/selectors.html
  19. :PyPI: https://pypi.python.org/pypi/selectors34
  20. :Issue tracker: https://bugs.python.org/ (upstream)
  21. :Issue tracker: https://github.com/berkerpeksag/selectors34/issues
  22. :Supported versions: Python 2.6, 2.7 and 3.3
  23. :License: Python Software Foundation License
  24. :Build status:
  25. .. image:: https://travis-ci.org/berkerpeksag/selectors34.svg?branch=master
  26. :target: https://travis-ci.org/berkerpeksag/selectors34
  27. Release management
  28. ------------------
  29. #. Bump version number in ``setup.py``
  30. #. Update ``CHANGELOG.rst``
  31. #. Run tests via ``tox``
  32. #. Install requirements to make a release: ``pip install -r requirements-dev.txt``
  33. #. Make a new release on the PyPI test server: ``make test-release``
  34. #. Create a tag: ``git tag X.Y.X``
  35. #. Make the actual release: ``make release``
  36. Changelog
  37. =========
  38. 1.1 (released on 2015-07-15)
  39. ----------------------------
  40. * Issues #23209, #23225: ``selectors.BaseSelector.get_key()`` now raises a
  41. ``RuntimeError`` if the selector is closed. And
  42. ``selectors.BaseSelector.close()`` now clears its internal reference to the
  43. selector mapping to break a reference cycle.
  44. (Initial patch written by Martin Richard and backported by Victor Stinner.)
  45. * Issues #23209, #23225: ``selectors.BaseSelector.close()`` now clears its
  46. internal reference to the selector mapping to break a reference cycle.
  47. (Initial patch written by Martin Richard and backported by Victor Stinner.)
  48. * Issue #23009: Make sure ``EpollSelecrtor.select()`` works when no FD is
  49. registered.
  50. (Backported by Victor Stinner.)
  51. 1.0 (released on 2015-02-05)
  52. ----------------------------
  53. * Initial release.