You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/release_notes.rst
+15-3Lines changed: 15 additions & 3 deletions
Original file line number
Diff line number
Diff line change
@@ -3,14 +3,16 @@
3
3
Release Notes
4
4
=============
5
5
6
-
Unreleased
7
-
----------
6
+
6.0
7
+
---
8
8
9
9
This is a major release and contains breaking changes. Please read the notes below carefully.
10
10
11
+
Breaking changes:
12
+
11
13
* :py:class:`~pynamodb.attributes.BinaryAttribute` and :py:class:`~pynamodb.attributes.BinarySetAttribute` have undergone breaking changes:
12
14
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.
14
16
If your codebase uses :py:class:`~pynamodb.attributes.BinaryAttribute` or :py:class:`~pynamodb.attributes.BinarySetAttribute`,
15
17
go over the attribute declarations and mark them accordingly.
16
18
* 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
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.
0 commit comments