summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorMichael Merickel <michael@merickel.org>2016-12-24 16:17:25 -0600
committerMichael Merickel <michael@merickel.org>2016-12-24 16:23:57 -0600
commitc22270f6bcbb8e43ac53140a2f30afe3059194db (patch)
tree020c21d358eb0d426fa1c9d0ba828ce32c8536b5 /docs
parent086f760c28497282fa9b4d25cc1cd7d1ab4fde91 (diff)
downloadpyramid-c22270f6bcbb8e43ac53140a2f30afe3059194db.tar.gz
pyramid-c22270f6bcbb8e43ac53140a2f30afe3059194db.tar.bz2
pyramid-c22270f6bcbb8e43ac53140a2f30afe3059194db.zip
reorganize the whatsnew doc to look more like older versions (< 1.5)
Diffstat (limited to 'docs')
-rw-r--r--docs/whatsnew-1.8.rst143
1 files changed, 73 insertions, 70 deletions
diff --git a/docs/whatsnew-1.8.rst b/docs/whatsnew-1.8.rst
index 9ec3bb23c..e666f0cd1 100644
--- a/docs/whatsnew-1.8.rst
+++ b/docs/whatsnew-1.8.rst
@@ -7,57 +7,47 @@ incompatibilities between the two versions and deprecations added to
:app:`Pyramid` 1.8, as well as software dependency changes and notable
documentation additions.
-Backwards Incompatibilities
----------------------------
+Major Feature Additions
+-----------------------
-- Following the Pyramid deprecation period (1.6 -> 1.8),
- daemon support for pserve has been removed. This includes removing the
- daemon commands (start, stop, restart, status) as well as the following
- arguments: ``--daemon``, ``--pid-file``, ``--log-file``,
- ``--monitor-restart``, ``--status``, ``--user``, ``--group``,
- ``--stop-daemon``
+- Added :meth:`pyramid.config.Configurator.add_exception_view` and the
+ :func:`pyramid.view.exception_view_config` decorator. It is now possible
+ using these methods or via the new ``exception_only=True`` option to
+ :meth:`pyramid.config.Configurator.add_view` to add a view which will only
+ be matched when handling an exception. Previously, any exception views were
+ also registered for a traversal context that inherited from the exception
+ class which prevented any exception-only optimizations.
+ See https://github.com/Pylons/pyramid/pull/2660
- To run your server as a daemon you should use a process manager instead of
- pserve.
+- ``pserve --reload`` now uses the
+ `hupper <http://docs.pylonsproject.org/projects/hupper/en/latest/>`_
+ library to monitor file changes. This comes with many improvements:
- See https://github.com/Pylons/pyramid/pull/2615
+ - If the `watchdog <http://pythonhosted.org/watchdog/>`_ package is
+ installed then monitoring will be done using inotify instead of
+ cpu and disk-intensive polling.
-- Change static view to avoid setting the ``Content-Encoding`` response header
- to an encoding guessed using Python's ``mimetypes`` module. This was causing
- clients to decode the content of gzipped files when downloading them. The
- client would end up with a ``foo.txt.gz`` file on disk that was already
- decoded, thus should really be ``foo.txt``. Also, the ``Content-Encoding``
- should only have been used if the client itself broadcast support for the
- encoding via ``Accept-Encoding`` request headers.
- See https://github.com/Pylons/pyramid/pull/2810
+ - The monitor is now a separate process that will not crash and starts up
+ before any of your code.
-- ``pcreate`` is now interactive by default. You will be prompted if a file
- already exists with different content. Previously if there were similar
- files it would silently skip them unless you specified ``--interactive``
- or ``--overwrite``.
- See https://github.com/Pylons/pyramid/pull/2775
+ - The monitor will not restart the process after a crash until a file is
+ saved.
-- Support for the ``IContextURL`` interface that was deprecated in Pyramid 1.3
- has been removed. See https://github.com/Pylons/pyramid/pull/2822
+ - The monitor works on windows.
-- Settings are no longer accessible as attributes on the settings object
- (e.g. ``request.registry.settings.foo``). This was deprecated in Pyramid 1.2.
- See https://github.com/Pylons/pyramid/pull/2823
+ - You can now trigger a reload manually from a pyramid view or any other
+ code via ``hupper.get_reloader().trigger_reload()``. Kind of neat.
-- Removed undocumented argument ``cachebust_match`` from
- ``pyramid.static.static_view``. This argument was shipped accidentally
- in Pyramid 1.6. See https://github.com/Pylons/pyramid/pull/2681
+ - You can trigger a reload by issuing a ``SIGHUP`` to the monitor process.
-Feature Additions
------------------
+ See https://github.com/Pylons/pyramid/pull/2805
+
+Minor Feature Additions
+-----------------------
- Python 3.6 compatibility.
https://github.com/Pylons/pyramid/issues/2835
-- ``pcreate`` learned about --package-name to allow you to create a new project
- in an existing folder with a different package name than the project name.
- See https://github.com/Pylons/pyramid/pull/2783
-
- The ``_get_credentials`` private method of
:class:`pyramid.authentication.BasicAuthAuthenticationPolicy`
has been extracted into standalone function
@@ -75,15 +65,6 @@ Feature Additions
automatically invoke the ``closer`` and pop threadlocals off of the stack
to prevent memory leaks. See https://github.com/Pylons/pyramid/pull/2760
-- Added :meth:`pyramid.config.Configurator.add_exception_view` and the
- :func:`pyramid.view.exception_view_config` decorator. It is now possible
- using these methods or via the new ``exception_only=True`` option to
- :meth:`pyramid.config.Configurator.add_view` to add a view which will only
- be matched when handling an exception. Previously, any exception views were
- also registered for a traversal context that inherited from the exception
- class which prevented any exception-only optimizations.
- See https://github.com/Pylons/pyramid/pull/2660
-
- Added the ``exception_only`` boolean to
:class:`pyramid.interfaces.IViewDeriverInfo` which can be used by view
derivers to determine if they are wrapping a view which only handles
@@ -106,29 +87,6 @@ Feature Additions
using the ``PYRAMID_CSRF_TRUSTED_ORIGINS`` environment variable similar to
other settings. See https://github.com/Pylons/pyramid/pull/2823
-- ``pserve --reload`` now uses the
- `hupper <http://docs.pylonsproject.org/projects/hupper/en/latest/>`_
- library to monitor file changes. This comes with many improvements:
-
- - If the `watchdog <http://pythonhosted.org/watchdog/>`_ package is
- installed then monitoring will be done using inotify instead of
- cpu and disk-intensive polling.
-
- - The monitor is now a separate process that will not crash and starts up
- before any of your code.
-
- - The monitor will not restart the process after a crash until a file is
- saved.
-
- - The monitor works on windows.
-
- - You can now trigger a reload manually from a pyramid view or any other
- code via ``hupper.get_reloader().trigger_reload()``. Kind of neat.
-
- - You can trigger a reload by issuing a ``SIGHUP`` to the monitor process.
-
- See https://github.com/Pylons/pyramid/pull/2805
-
- A new ``[pserve]`` section is supported in your config files with a
``watch_files`` key that can configure ``pserve --reload`` to monitor custom
file paths. See https://github.com/Pylons/pyramid/pull/2827
@@ -147,6 +105,51 @@ Feature Additions
``--help`` output as well as enabling nicer documentation of their options.
See https://github.com/Pylons/pyramid/pull/2864
+Backwards Incompatibilities
+---------------------------
+
+- Following the Pyramid deprecation period (1.6 -> 1.8),
+ daemon support for pserve has been removed. This includes removing the
+ daemon commands (start, stop, restart, status) as well as the following
+ arguments: ``--daemon``, ``--pid-file``, ``--log-file``,
+ ``--monitor-restart``, ``--status``, ``--user``, ``--group``,
+ ``--stop-daemon``
+
+ To run your server as a daemon you should use a process manager instead of
+ pserve.
+
+ See https://github.com/Pylons/pyramid/pull/2615
+
+- Change static view to avoid setting the ``Content-Encoding`` response header
+ to an encoding guessed using Python's ``mimetypes`` module. This was causing
+ clients to decode the content of gzipped files when downloading them. The
+ client would end up with a ``foo.txt.gz`` file on disk that was already
+ decoded, thus should really be ``foo.txt``. Also, the ``Content-Encoding``
+ should only have been used if the client itself broadcast support for the
+ encoding via ``Accept-Encoding`` request headers.
+ See https://github.com/Pylons/pyramid/pull/2810
+
+- ``pcreate`` learned about ``--package-name`` to allow you to create a new
+ project in an existing folder with a different package name than the project
+ name. See https://github.com/Pylons/pyramid/pull/2783
+
+- ``pcreate`` is now interactive by default. You will be prompted if a file
+ already exists with different content. Previously if there were similar
+ files it would silently skip them unless you specified ``--interactive``
+ or ``--overwrite``.
+ See https://github.com/Pylons/pyramid/pull/2775
+
+- Support for the ``IContextURL`` interface that was deprecated in Pyramid 1.3
+ has been removed. See https://github.com/Pylons/pyramid/pull/2822
+
+- Settings are no longer accessible as attributes on the settings object
+ (e.g. ``request.registry.settings.foo``). This was deprecated in Pyramid 1.2.
+ See https://github.com/Pylons/pyramid/pull/2823
+
+- Removed undocumented argument ``cachebust_match`` from
+ ``pyramid.static.static_view``. This argument was shipped accidentally
+ in Pyramid 1.6. See https://github.com/Pylons/pyramid/pull/2681
+
Deprecations
------------