Skip to content

Commit

Permalink
increment package version
Browse files Browse the repository at this point in the history
generate changelog
  • Loading branch information
zhPavel committed Feb 16, 2024
1 parent 0b13406 commit f9d1f60
Show file tree
Hide file tree
Showing 16 changed files with 83 additions and 50 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ An extremely flexible and configurable data model conversion library.

Install
```bash
pip install adaptix==3.0.0b1
pip install adaptix==3.0.0b2
```

Use for model loading and dumping.
Expand Down
75 changes: 75 additions & 0 deletions docs/changelog/changelog_body.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,81 @@
----------------------------------------------------


.. _v3.0.0b2:

`3.0.0b2 <https://github.com/reagento/adaptix/tree/v3.0.0b2>`_ -- 2024-02-16
============================================================================

.. _v3.0.0b2-Features:

Features
--------

- New **major** feature is out!
Added support for model conversion!
Now, you can generate boilerplate converter function by adaptix.
See :ref:`conversion tutorial <conversion-tutorial>` for details.
- Basic support for sqlalchemy models are added!
- Added enum support inside Literal. `#178 <https://github.com/reagento/adaptix/issues/178>`_
- Added flags support.

Now adaptix has two different ways to process flags: :func:`.flag_by_exact_value` (by default)
and :func:`.flag_by_member_names`. `#197 <https://github.com/reagento/adaptix/issues/197>`_
- Added defaultdict support. `#216 <https://github.com/reagento/adaptix/issues/216>`_
- Added support of mapping for :func:`.enum_by_name` provider. `#223 <https://github.com/reagento/adaptix/issues/223>`_
- Created the correct path (fixing python bug) for processing ``Required`` and ``NotRequired`` with stringified annotations
or ``from __future__ import annotations``. `#227 <https://github.com/reagento/adaptix/issues/227>`_

.. _v3.0.0b2-Breaking Changes:

Breaking Changes
----------------

- Due to refactoring of predicate system required for new features:

1. ``create_request_checker`` was renamed to ``create_loc_stack_checker``
2. ``LocStackPattern`` (class of ``P``) was renamed ``RequestPattern``
3. method ``RequestPattern.build_request_checker()`` was renamed to ``LocStackPattern.build_loc_stack_checker()``

.. _v3.0.0b2-Deprecations:

Deprecations
------------

- Standardize names inside :mod:`adaptix.load_error`. Import of old names will emit ``DeprecationWarning``.

.. list-table::
:header-rows: 1

* - Old name
- New name
* - ``MsgError``
- ``MsgLoadError``
* - ``ExtraFieldsError``
- ``ExtraFieldsLoadError``
* - ``ExtraItemsError``
- ``ExtraItemsLoadError``
* - ``NoRequiredFieldsError``
- ``NoRequiredFieldsLoadError``
* - ``NoRequiredItemsError``
- ``NoRequiredItemsLoadError``
* - ``ValidationError``
- ``ValidationLoadError``
* - ``BadVariantError``
- ``BadVariantLoadError``
* - ``DatetimeFormatMismatch``
- ``FormatMismatchLoadError``

.. _v3.0.0b2-Bug Fixes:

Bug Fixes
---------

- Fixed parameter shuffling on skipping optional field. `#229 <https://github.com/reagento/adaptix/issues/229>`_

----------------------------------------------------


.. _v3.0.0b1:

`3.0.0b1 <https://github.com/reagento/adaptix/tree/v3.0.0b1>`_ -- 2023-12-16
Expand Down
4 changes: 0 additions & 4 deletions docs/changelog/fragments/+conversion.feature.rst

This file was deleted.

23 changes: 0 additions & 23 deletions docs/changelog/fragments/+load_error_rename.deprecation.rst

This file was deleted.

5 changes: 0 additions & 5 deletions docs/changelog/fragments/+loc_stack.breaking.rst

This file was deleted.

1 change: 0 additions & 1 deletion docs/changelog/fragments/+sqlachemy.feature.rst

This file was deleted.

1 change: 0 additions & 1 deletion docs/changelog/fragments/178.feature.rst

This file was deleted.

4 changes: 0 additions & 4 deletions docs/changelog/fragments/197.feature.rst

This file was deleted.

1 change: 0 additions & 1 deletion docs/changelog/fragments/216.feature.rst

This file was deleted.

1 change: 0 additions & 1 deletion docs/changelog/fragments/223.feature.rst

This file was deleted.

1 change: 0 additions & 1 deletion docs/changelog/fragments/227.feature.rst

This file was deleted.

1 change: 0 additions & 1 deletion docs/changelog/fragments/229.bugfix.rst

This file was deleted.

2 changes: 1 addition & 1 deletion docs/changelog/template.rst.jinja2
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@

{% if definitions[category]['showcontent'] %}
{% for text, values in sections[section][category].items() %}
- {{ text }}{% if values %} ({{ values|join(', ') }}){% endif %}
- {{ text }}{% if values %} {{ values|join(', ') }}{% endif %}

{% endfor %}
{% else %}
Expand Down
6 changes: 3 additions & 3 deletions docs/common/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ Just use pip to install the library

.. code-block:: text
pip install adaptix==3.0.0b1
pip install adaptix==3.0.0b2
Integrations with 3-rd party libraries are turned on automatically,
Expand Down Expand Up @@ -33,5 +33,5 @@ So, this is valid installation variants:

.. code-block:: text
pip install adaptix[attrs-strict]==3.0.0b1
pip install adaptix[attrs, sqlalchemy-strict]==3.0.0b1
pip install adaptix[attrs-strict]==3.0.0b2
pip install adaptix[attrs, sqlalchemy-strict]==3.0.0b2
2 changes: 1 addition & 1 deletion docs/overview.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Installation

.. code-block:: text
pip install adaptix==3.0.0b1
pip install adaptix==3.0.0b2
Example
Expand Down
4 changes: 2 additions & 2 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ build-backend = 'setuptools.build_meta'

[project]
name = 'adaptix'
version = '3.0.0b1'
version = '3.0.0b2'
description = 'An extremely flexible and configurable data model conversion library'
readme = 'README.md'
requires-python = '>=3.8'
Expand Down Expand Up @@ -90,9 +90,9 @@ issue_format = '`#{issue} <https://github.com/reagento/adaptix/issues/{issue}>`_
directory = 'docs/changelog/fragments'

type = [
{ name = "Features", directory = "feature", showcontent = true },
{ name = "Breaking Changes", directory = "breaking", showcontent = true },
{ name = "Deprecations", directory = "deprecation", showcontent = true },
{ name = "Features", directory = "feature", showcontent = true },
{ name = "Bug Fixes", directory = "bugfix", showcontent = true },
{ name = "Other", directory = "other", showcontent = true },
]

0 comments on commit f9d1f60

Please sign in to comment.