From 4bb803c6b1bf5c0bb0d474b72b43c9a4074c8b38 Mon Sep 17 00:00:00 2001 From: Lex Date: Mon, 18 Mar 2024 23:05:47 +0800 Subject: [PATCH] Fix changelog typos and clarity --- CHANGES.rst | 13 ++++++------- 1 file changed, 6 insertions(+), 7 deletions(-) diff --git a/CHANGES.rst b/CHANGES.rst index 0b6205f1..ee21c940 100644 --- a/CHANGES.rst +++ b/CHANGES.rst @@ -3,14 +3,13 @@ Changed ~~~~~~~~ -- Access session interfaces with ``flask_session.redis.RedisSessionInterface`` (`2bc7df `_). -- Deprecate pickle. It is still available to read existing sessions, but will be removed in 1.0.0. All sessions will convert to msgspec upon first interaction with 0.1.0 (`c7f8ce `_) +- Access session interfaces via subfolder, for example ``flask_session.redis.RedisSessionInterface`` (`2bc7df `_). +- Deprecate ``pickle`` in favor of ``msgspec``, which is configured with ``SESSION_SERIALIZATION_FORMAT`` to choose between ``'json'`` and ``'msgpack'``. All sessions will convert to msgspec upon first interaction with 0.7.0. Pickle is still available to read existing sessions, but will be removed in 1.0.0. (`c7f8ce `_, `c7f8ce `_) - Deprecate ``SESSION_USE_SIGNER`` (`a5dba7 `_). - Deprecate :class:`flask_session.filesystem.FileSystemSessionInterface` in favor of the broader :class:`flask_session.cachelib.CacheLibSessionInterface` (`2bc7df `_). Added ~~~~~~~ -- Use msgpack for serialization, along with ``SESSION_SERIALIZATION_FORMAT`` to choose between ``'json'`` and ``'msgpack'`` (`c7f8ce `_). - All sessions that are accessed or modified while using 0.7.0 will convert to msgspec. Once using 1.0.0, any sessions that are still in pickle will be cleared upon access. - Add time-to-live expiration for MongoDB (`9acee3 `_). - Add retry for SQL based storage (`#211 `_). @@ -18,16 +17,16 @@ Added - Add type hints (`7d7d58 `_). - Add logo and additional documentation. - Add vary cookie header when session modified or accessed as per flask's built-in session (`7ab698 `_). -- Add regenerate method to session interface to mitigate fixation (`#27 `_, `#39 `_)(`80df63 `_). +- Add regenerate method to session interface to mitigate fixation (`#27 `_, `#39 `_)(`80df63 `_). Removed ~~~~~~~~~~ -- Remove null session in favour of specific exception messages (`d7ed1c `_). +- Remove null session in favour of relevant exception messages (`#107 `_, `#182 `_)(`d7ed1c `_). - Drop support for Python 3.7 which is end-of-life and precludes use of msgspec (`bd7e5b `_). Fixed ~~~~~ -- Prevent sid reuse on storage miss (`#76 `_). +- Prevent session identifier reuse on storage miss (`#76 `_). - Abstraction to improve consistency between backends. - Enforce ``PERMANENT_SESSION_LIFETIME`` as expiration consistently for all backends (`#81 `_)(`86895b `_). - Specifically include backend session interfaces in public API and document usage (`#210 `_). @@ -67,7 +66,7 @@ Fixed 0.5.0 - 2023-05-11 -------------- +------------------- - Drop support for Python < 3.7. - Switch to ``pyproject.toml`` and Flit for packaging.