django/daphne
1
1
Fork 0
mirror of https://github.com/django/daphne.git synced 2025-10-31 15:57:25 +03:00
Code Issues Packages Projects Releases Wiki Activity

Flesh out release notes

Browse Source
This commit is contained in:
Andrew Godwin 2017-01-08 18:29:58 -08:00
parent aa3af5031c
commit ec0b124c6e
2 changed files with 44 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
docs/binding.rst
View File

@ -1,11 +1,6 @@
Data Binding
============
.. warning::
Data Binding is new and might change slightly in the
upcoming weeks, and so don't consider this API totally stable yet.
The Channels data binding framework automates the process of tying Django
models into frontend views, such as javascript-powered website UIs. It provides
a quick and flexible way to generate messages on Groups for model changes

46
docs/releases/1.0.0.rst
View File

@ -1,8 +1,18 @@
1.0.0 Release Notes
===================
.. note::
These release notes are in development. Channels 1.0.0 is not yet released.
.. contents:: Table of Contents
:depth: 1
Channels 1.0.0 brings together a number of design changes, some breaking changes,
into our first fully stable release.
It was unfortunately not possible to make all of the changes backwards
compatible, though most code should not be too affected and the fixes are
generally quite easy.
You **must also update Daphne** to at least 1.0.0 to have this release of
Channels work correctly.
Major Features
@ -19,6 +29,8 @@ while they send over a message on ``websocket.connect``, and your application
must either accept or reject the connection before the handshake is completed
and messages can be received.
You **must** update Daphne to at least 1.0.0 to make this work correctly.
This has several advantages:
* You can now reject WebSockets before they even finish connecting, giving
@ -99,6 +111,34 @@ wish to use it. It needs some extra initial setup and uses a database for
persistance; see :doc:`/delay` for more information.
Minor Changes
-------------
* Serializers can now specify fields as ``__all__`` to auto-include all fields,
and ``exclude`` to remove certain unwanted fields.
* ``runserver`` respects ``FORCE_SCRIPT_NAME``
* Websockets can now be closed with a specific code by calling ``close(status=4000)``
* ``enforce_ordering`` no longer has a ``slight`` mode (because of the accept
flow changes), and is more efficient with session saving.
* ``runserver`` respects ``--nothreading`` and only launches one worker, takes
a ``--http-timeout`` option if you want to override it from the default ``60``,
* A new ``@channel_and_http_session`` decorator rehydrates the HTTP session out
of the channel session if you want to access it inside receive consumers.
* Streaming responses no longer have a chance of being cached.
* ``request.META['SERVER_PORT']`` is now always a string.
* ``http.disconnect`` now has a ``path`` key so you can route it.
* Test client now has a ``send_and_consume`` method.
Backwards Incompatible Changes
------------------------------
@ -123,6 +163,8 @@ in the handshaking phase forever and you'll never get any messages.
All built-in Channels consumers (e.g. in the generic consumers) have been
upgraded to do this.
You **must** update Daphne to at least 1.0.0 to make this work correctly.
Databinding group_names
~~~~~~~~~~~~~~~~~~~~~~~