From a4a8fbf784fbf735e3fa3a7bcafc00de8764bb5c Mon Sep 17 00:00:00 2001 From: pavel Date: Mon, 2 Sep 2024 22:17:35 +0300 Subject: [PATCH] Add changelog and increment library version --- README.md | 2 +- docs/changelog/changelog_body.rst | 41 +++++++++++++++++++ .../+TypedDictAt38Warning.breaking.rst | 1 - docs/changelog/fragments/+drop38.breaking.rst | 1 - .../fragments/+hide-traceback.feature.rst | 3 -- .../fragments/+not-a-model-hint.feature.rst | 1 - .../fragments/+provider-routing.other.rst | 2 - docs/changelog/fragments/281.feature.rst | 1 - docs/changelog/fragments/286.feature.rst | 1 - docs/changelog/fragments/288.feature.rst | 2 - docs/changelog/fragments/318.feature.rst | 1 - docs/common/installation.rst | 2 +- docs/overview.rst | 2 +- pyproject.toml | 4 +- 14 files changed, 46 insertions(+), 18 deletions(-) delete mode 100644 docs/changelog/fragments/+TypedDictAt38Warning.breaking.rst delete mode 100644 docs/changelog/fragments/+drop38.breaking.rst delete mode 100644 docs/changelog/fragments/+hide-traceback.feature.rst delete mode 100644 docs/changelog/fragments/+not-a-model-hint.feature.rst delete mode 100644 docs/changelog/fragments/+provider-routing.other.rst delete mode 100644 docs/changelog/fragments/281.feature.rst delete mode 100644 docs/changelog/fragments/286.feature.rst delete mode 100644 docs/changelog/fragments/288.feature.rst delete mode 100644 docs/changelog/fragments/318.feature.rst diff --git a/README.md b/README.md index fd807d4d..4b9a104d 100644 --- a/README.md +++ b/README.md @@ -25,7 +25,7 @@ An extremely flexible and configurable data model conversion library. Install ```bash -pip install adaptix==3.0.0b7 +pip install adaptix==3.0.0b8 ``` Use for model loading and dumping. diff --git a/docs/changelog/changelog_body.rst b/docs/changelog/changelog_body.rst index b60850bb..42f18fa7 100644 --- a/docs/changelog/changelog_body.rst +++ b/docs/changelog/changelog_body.rst @@ -1,6 +1,47 @@ ---------------------------------------------------- +.. _v3.0.0b8: + +`3.0.0b8 `__ -- 2024-09-02 +============================================================================= + +.. _v3.0.0b8-Features: + +Features +-------- + +- Add new :func:`.datetime_by_timestamp` and :func:`.date_by_timestamp` provider factories. `#281 `__ +- Add :func:`.datetime_by_format` to public API. `#286 `__ +- Add :func:`.type_tools.exec_type_checking` function + to deal with cyclic references by executing ``if TYPE_CHECKING:`` constructs. `#288 `__ +- Add support for bytes inside literal, for example ``Literal[b"abc"]``. `#318 `__ +- The library shows a hint if one class is a model and the other is not. +- Traceback of ``CannotProvide`` is hidden (it is raised when loader, dumper, or converter can not be created). + It simplifies error messages to users. + You can show traceback by disabling ``hide_traceback`` parameter of ``Retort``. + +.. _v3.0.0b8-Breaking Changes: + +Breaking Changes +---------------- + +- Drop support of Python 3.8. +- ``TypedDictAt38Warning`` is removed. + +.. _v3.0.0b8-Other: + +Other +----- + +- Refactor internal provider routing system. It becomes more simple and readable. + Also, internal caching is added. + This led to a 40% speedup in loader generation for medium models + and up to 4x speedup for large models with many recursive types. + +---------------------------------------------------- + + .. _v3.0.0b7: `3.0.0b7 `__ -- 2024-06-10 diff --git a/docs/changelog/fragments/+TypedDictAt38Warning.breaking.rst b/docs/changelog/fragments/+TypedDictAt38Warning.breaking.rst deleted file mode 100644 index 819c62fa..00000000 --- a/docs/changelog/fragments/+TypedDictAt38Warning.breaking.rst +++ /dev/null @@ -1 +0,0 @@ -`TypedDictAt38Warning` is removed diff --git a/docs/changelog/fragments/+drop38.breaking.rst b/docs/changelog/fragments/+drop38.breaking.rst deleted file mode 100644 index 1731ef5a..00000000 --- a/docs/changelog/fragments/+drop38.breaking.rst +++ /dev/null @@ -1 +0,0 @@ -Drop support of Python 3.8 diff --git a/docs/changelog/fragments/+hide-traceback.feature.rst b/docs/changelog/fragments/+hide-traceback.feature.rst deleted file mode 100644 index cc6d361f..00000000 --- a/docs/changelog/fragments/+hide-traceback.feature.rst +++ /dev/null @@ -1,3 +0,0 @@ -Traceback of ``CannotProvide`` is hidden (it is raised when loader, dumper, or converter can not be created). -It simplifies error messages to users. -You can show traceback by disabling ``hide_traceback`` parameter of ``Retort`` diff --git a/docs/changelog/fragments/+not-a-model-hint.feature.rst b/docs/changelog/fragments/+not-a-model-hint.feature.rst deleted file mode 100644 index 139d70b5..00000000 --- a/docs/changelog/fragments/+not-a-model-hint.feature.rst +++ /dev/null @@ -1 +0,0 @@ -The library shows a hint if one class is a model and the other is not. diff --git a/docs/changelog/fragments/+provider-routing.other.rst b/docs/changelog/fragments/+provider-routing.other.rst deleted file mode 100644 index b0265f35..00000000 --- a/docs/changelog/fragments/+provider-routing.other.rst +++ /dev/null @@ -1,2 +0,0 @@ -Refactor internal provider routing system. It becomes more simple and readable. -The loader generation has been accelerated by 20%. diff --git a/docs/changelog/fragments/281.feature.rst b/docs/changelog/fragments/281.feature.rst deleted file mode 100644 index 112f2b61..00000000 --- a/docs/changelog/fragments/281.feature.rst +++ /dev/null @@ -1 +0,0 @@ -Add new :func:`.datetime_by_timestamp` and :func:`.date_by_timestamp`. diff --git a/docs/changelog/fragments/286.feature.rst b/docs/changelog/fragments/286.feature.rst deleted file mode 100644 index 0d30915f..00000000 --- a/docs/changelog/fragments/286.feature.rst +++ /dev/null @@ -1 +0,0 @@ -Add public api for :func:`.datetime_by_format`. diff --git a/docs/changelog/fragments/288.feature.rst b/docs/changelog/fragments/288.feature.rst deleted file mode 100644 index c5d7b985..00000000 --- a/docs/changelog/fragments/288.feature.rst +++ /dev/null @@ -1,2 +0,0 @@ -Add public api for :func:`.type_tools.exec_type_checking` -to deal with cyclic references by executing ``if TYPE_CHECKING:`` constructs diff --git a/docs/changelog/fragments/318.feature.rst b/docs/changelog/fragments/318.feature.rst deleted file mode 100644 index 33363870..00000000 --- a/docs/changelog/fragments/318.feature.rst +++ /dev/null @@ -1 +0,0 @@ -Add support for bytes inside literal ``Literal[b"abc"]`` diff --git a/docs/common/installation.rst b/docs/common/installation.rst index a36cf60a..57eded5e 100644 --- a/docs/common/installation.rst +++ b/docs/common/installation.rst @@ -2,7 +2,7 @@ Just use pip to install the library .. code-block:: text - pip install adaptix==3.0.0b7 + pip install adaptix==3.0.0b8 Integrations with 3-rd party libraries are turned on automatically, diff --git a/docs/overview.rst b/docs/overview.rst index ba52b577..728cb09e 100644 --- a/docs/overview.rst +++ b/docs/overview.rst @@ -16,7 +16,7 @@ Installation .. code-block:: text - pip install adaptix==3.0.0b7 + pip install adaptix==3.0.0b8 Example diff --git a/pyproject.toml b/pyproject.toml index 29a90c71..4f4091ec 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,10 +1,10 @@ [build-system] -requires = ['setuptools==69.1.0'] +requires = ['setuptools==74.1.0'] build-backend = 'setuptools.build_meta' [project] name = 'adaptix' -version = '3.0.0b7' +version = '3.0.0b8' description = 'An extremely flexible and configurable data model conversion library' readme = 'README.md' requires-python = '>=3.9'