Source

circuits / RELEASE.rst

Full commit
James Mills bc3b327 







James Mills 909a429 
James Mills bc3b327 
James Mills 909a429 
James Mills bc3b327 




James Mills fcc2fda 

James Mills 2c331f2 










James Mills 63814ec 
James Mills f4fba92 
James Mills 63814ec 
James Mills bc3b327 

James Mills 63814ec 

James Mills fcc2fda 


James Mills 74a1a98 









James Mills 909a429 







James Mills 74a1a98 
James Mills d6c61fe 
James Mills 909a429 

James Mills 74a1a98 
James Mills 18f0db0 
James Mills 74a1a98 

James Mills 909a429 

James Mills 18f0db0 
James Mills 74a1a98 
James Mills 909a429 
James Mills 6400c2a 






James Mills 909a429 
James Mills 6400c2a 












Release Notes - circuits-1.6 (oceans)
-------------------------------------


Python 3 Support
................

This is the third attempt at getting Python 3 support for circuits working
while still maintaining Python 2 compatibility. This release finally adds
full support for Python 3 as well as maintaining compatibility with Python
2.6 and 2.7 with the same code-base.

.. note::
   Python 2.5 support has been dropped as of this release and will no
   longer be supported in future. There may be a maintenance branch
   specifically for Python 2.5 if required.


Greenlet Support
................

circuits now includes two new primitives which work by integrating
`greenlet <http://pypi.python.org/pypi/greenlet>`_.

- ``.waitEvent(...)`` -- Wait for the given event to complete.
- ``.callEvent(...)`` -- Call event handlers for the given event.

.. note:: These new primitives add (*as long as greenlet is installed*) the ability to write semi-synchronous code in your event handlers while still taking full advantage of the asynchronous and component framework that circuits has to offer.

Code Coverage
.............

circuits now has 80% test coverage on all supported versions of Python
including Python 2.6, Python 2.7 and Python 3.2


Features
........

- Added an example WebSockets server using circuits.web
- Added support for specifying a ``Poll`` instance to use when using the
  ``@future`` decorator to create "future" event handlers.
- Added ``add_section``, ``has_section`` and ``set`` methods to
  ``app.config.Config`` Component.
- Added support for running test suite with distutils ``python setup.py
  test``.
- Added a ``_on_signal`` event handler on the ``BaseEnvironment`` Component
  so that environments can be reloaded by listening to ``SIGHUP`` signals.
- Added support for using absolute paths in ``app.env.Environment``.
- Added support in circuits.web ``HTTP`` protocol to limit the no. of
  header fragments. This prevents OOM exploits.
- Added a ticks limit to waitEvent
- Added deprecation warnings for .push .add and .remove methods
- NEW ``Loader`` Component in ``circuits.core`` for simple plugin support.
- NEW ``app.env`` and ``app.config`` modules including a new ``app.startup``
  modules integrating a common startup for applications.
- NEW ``KQueue`` poller


Bug Fixes
.........

- Fixed Issue #17
- Renamed ``circuits.web.main`` module to ``circuits.web.__main__`` so that
  ``python -m circuits.web`` just works.
- Fixed ``Server.host`` and ``Server.port`` properties in
  ``circuits.net.sockets``.
- Fixed Issue #19
- Fixed ``app.Daemon`` Component to correctly open the stderr file.
- Fixed triggering of ``Success`` events.
- Fixed duplicate broadcast handler in ``UDPServer``
- Fixed duplicate ``Disconnect`` event from being triggered twice on
  ``Client`` socket components.
- Removed dynamic timeout code from ``Select`` poller.
- Fixed a bug in the circuits.web ``HTTP`` protocol where headers were
  not being buffered per client.
- Fixes a missing Event ``Closed()`` not being triggered for ``UDPServer``.
- Make underlying ``UDPServer`` socket reusable by setting ``SO_REUSEADDR``
- Fixes Server socket being discarded twice on close + disconnect
- Socket.write now expects bytes (bytes for python3 and str for python2)
- Better handling of encoding in HTTP Component (allow non utf-8 encoding)
- Always encode http headers in utf-8
- Fixes error after getting socket.ERRCONNREFUSED
- Allows TCPClient to bind to a specific port
- Improved docs
- Handles closing of udpserver socket when no client is connected
- Adds an unregister handler for components
- Allows utils.kill to work from a different thread
- Fixes bug when handling "*" in channels and targets
- Fixes a bug that could occur when unregistering components
- Fixes for CPU usage problems when using circuits with no I/O pollers
  and using a Timer for timed events