From fdbac4a4bdcef24f8b4f2b6e5eafa5cdf171e990 Mon Sep 17 00:00:00 2001 From: Ilya Priven Date: Tue, 19 Dec 2023 00:21:31 -0500 Subject: [PATCH] Update release notes for 6.0 release (#1211) --- docs/release_notes.rst | 18 +++++++++++++++--- 1 file changed, 15 insertions(+), 3 deletions(-) diff --git a/docs/release_notes.rst b/docs/release_notes.rst index dcf101c1..8bfb4fbb 100644 --- a/docs/release_notes.rst +++ b/docs/release_notes.rst @@ -3,14 +3,16 @@ Release Notes ============= -Unreleased ----------- +6.0 +--- This is a major release and contains breaking changes. Please read the notes below carefully. +Breaking changes: + * :py:class:`~pynamodb.attributes.BinaryAttribute` and :py:class:`~pynamodb.attributes.BinarySetAttribute` have undergone breaking changes: - * The attributes' internal encoding has changed. To prevent this change going unnoticed, :code:`legacy_encoding` have been made required: see :doc:`upgrading_binary` for details. + * The attributes' internal encoding has changed. To prevent this change going unnoticed, a new required :code:`legacy_encoding` parameter was added: see :doc:`upgrading_binary` for details. If your codebase uses :py:class:`~pynamodb.attributes.BinaryAttribute` or :py:class:`~pynamodb.attributes.BinarySetAttribute`, go over the attribute declarations and mark them accordingly. * When using binary attributes, the return value of :meth:`~pynamodb.models.Model.serialize` will no longer be JSON-serializable @@ -20,12 +22,22 @@ This is a major release and contains breaking changes. Please read the notes bel * Python 3.6 is no longer supported. * :meth:`Index.count `, :meth:`Index.query `, and :meth:`Indexn.scan ` are now instance methods. +* :py:class:`~pynamodb.settings.OperationSettings` has been removed + +Other major changes: + +* We are now compatible with `opentelemetry botocore instrumentation `_. +* We've reduced our usage of botocore private APIs (:pr:`1079`). On multiple occasions, new versions + of botocore broke PynamoDB, and this change lessens the likelihood of that happening in the future + by reducing (albeit not eliminating) our reliance on private botocore APIs. Other changes in this release: * :meth:`~pynamodb.models.Model.save`, :meth:`~pynamodb.models.Model.update`, :meth:`~pynamodb.models.Model.delete_item`, and :meth:`~pynamodb.models.Model.delete` now accept a ``add_version_condition`` parameter. See :ref:`optimistic_locking_version_condition` for more details. +* :meth:`~pynamodb.models.Model.batch_get`, has guard rails defending against items without a hash_key and range_key. +* :meth:`~pynamodb.attributes.Attribute.set`, can remove attribute by assigning an empty value in the update expression. v5.3.2