Skip to content

Commit fdbac4a

Browse files
authored
Update release notes for 6.0 release (#1211)
1 parent 369f461 commit fdbac4a

File tree

1 file changed

+15
-3
lines changed

1 file changed

+15
-3
lines changed

docs/release_notes.rst

Lines changed: 15 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,14 +3,16 @@
33
Release Notes
44
=============
55

6-
Unreleased
7-
----------
6+
6.0
7+
---
88

99
This is a major release and contains breaking changes. Please read the notes below carefully.
1010

11+
Breaking changes:
12+
1113
* :py:class:`~pynamodb.attributes.BinaryAttribute` and :py:class:`~pynamodb.attributes.BinarySetAttribute` have undergone breaking changes:
1214

13-
* 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.
15+
* 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.
1416
If your codebase uses :py:class:`~pynamodb.attributes.BinaryAttribute` or :py:class:`~pynamodb.attributes.BinarySetAttribute`,
1517
go over the attribute declarations and mark them accordingly.
1618
* 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
2022
* Python 3.6 is no longer supported.
2123
* :meth:`Index.count <pynamodb.indexes.Index.count>`, :meth:`Index.query <pynamodb.indexes.Index.query>`,
2224
and :meth:`Indexn.scan <pynamodb.indexes.Index.scan>` are now instance methods.
25+
* :py:class:`~pynamodb.settings.OperationSettings` has been removed
26+
27+
Other major changes:
28+
29+
* We are now compatible with `opentelemetry botocore instrumentation <https://github.com/open-telemetry/opentelemetry-python-contrib/tree/main/instrumentation/opentelemetry-instrumentation-botocore>`_.
30+
* We've reduced our usage of botocore private APIs (:pr:`1079`). On multiple occasions, new versions
31+
of botocore broke PynamoDB, and this change lessens the likelihood of that happening in the future
32+
by reducing (albeit not eliminating) our reliance on private botocore APIs.
2333

2434
Other changes in this release:
2535

2636
* :meth:`~pynamodb.models.Model.save`, :meth:`~pynamodb.models.Model.update`, :meth:`~pynamodb.models.Model.delete_item`,
2737
and :meth:`~pynamodb.models.Model.delete` now accept a ``add_version_condition`` parameter.
2838
See :ref:`optimistic_locking_version_condition` for more details.
39+
* :meth:`~pynamodb.models.Model.batch_get`, has guard rails defending against items without a hash_key and range_key.
40+
* :meth:`~pynamodb.attributes.Attribute.set`, can remove attribute by assigning an empty value in the update expression.
2941

3042

3143
v5.3.2

0 commit comments

Comments
 (0)