From a686f2e360e960d17f4afe83a25d1ecae57f4efb Mon Sep 17 00:00:00 2001 From: py-mine-ci-bot <121461646+py-mine-ci-bot[bot]@users.noreply.github.com> Date: Fri, 30 Dec 2022 00:23:30 +0000 Subject: [PATCH] Prepare for release of version 0.2.0 --- CHANGELOG.md | 41 +++++++++++++++++++ changes/+custom_mock_mixin.internal.md | 2 - changes/+flake8.internal.md | 1 - changes/+missing_space.bugfix.md | 2 - changes/+packet_interactions.feature.md | 2 - changes/+tests_readme.internal.md | 1 - changes/+unpropagating_mock_mixin.internal.md | 1 - changes/13.documentation.md | 1 - changes/14.bugfix.md | 2 - changes/14.feature.md | 3 -- changes/14.internal.1.md | 1 - changes/14.internal.2.md | 1 - changes/15.internal.md | 1 - changes/6.internal.md | 6 --- changes/7.documentation.md | 1 - changes/7.internal.md | 1 - 16 files changed, 41 insertions(+), 26 deletions(-) delete mode 100644 changes/+custom_mock_mixin.internal.md delete mode 100644 changes/+flake8.internal.md delete mode 100644 changes/+missing_space.bugfix.md delete mode 100644 changes/+packet_interactions.feature.md delete mode 100644 changes/+tests_readme.internal.md delete mode 100644 changes/+unpropagating_mock_mixin.internal.md delete mode 100644 changes/13.documentation.md delete mode 100644 changes/14.bugfix.md delete mode 100644 changes/14.feature.md delete mode 100644 changes/14.internal.1.md delete mode 100644 changes/14.internal.2.md delete mode 100644 changes/15.internal.md delete mode 100644 changes/6.internal.md delete mode 100644 changes/7.documentation.md delete mode 100644 changes/7.internal.md diff --git a/CHANGELOG.md b/CHANGELOG.md index e69de29b..c180afa0 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -0,0 +1,41 @@ +## 0.2.0 (2022-12-30) + +### Features + +- [#14](https://github.com/py-mine/mcproto/issues/14): Add `__slots__` to most classes in the project + - All connection classes are now slotted + - Classes in `mcproto.utils.abc` are now slotted +- Separate packet interaction functions into `mcproto.packets.interactions`, (though they're reexported in + `mcproto.packets`, so no breaking changes) + +### Bugfixes + +- [#14](https://github.com/py-mine/mcproto/issues/14): Add missing `__slots__` to `ServerBoundPacket` and `ClientBoundPacket` subclasses, which inherited from slotted + `Packet`, but didn't themselves define `__slots__`, causing `__dict__` to be needlessly created. +- The error message produced by `RequiredParamsABCMixin` class when a required no MRO class variable isn't present now + includes a previously missing space, making it more readable. + +### Documentation Improvements + +- [#7](https://github.com/py-mine/mcproto/issues/7): Add and start keeping a changelog, managed by towncrier. +- [#13](https://github.com/py-mine/mcproto/issues/13): Add a security policy. + +### Internal Changes + +- [#6](https://github.com/py-mine/mcproto/issues/6): Rework deprecation system + - Drop support for date-based deprecations, versions work better + - Provide `deprecation_warn` function, which emits warnings directly, no need for a decorator + - Add a `SemanticVersion` class, supporting version comparisons + - If the project's version is already higher than the specified deprecation removal version, raise a DeprecationWarning + as a full exception (rather than just a warning). +- [#7](https://github.com/py-mine/mcproto/issues/7): Add towncrier for managing changelog +- [#14](https://github.com/py-mine/mcproto/issues/14): Add slotscheck, ensuring `__slots__` are defined properly everywhere. +- [#14](https://github.com/py-mine/mcproto/issues/14): Make `typing-extensions` a runtime dependency and use it directly, don't rely on `if typing.TYPE_CHECKING` blocks. +- [#15](https://github.com/py-mine/mcproto/issues/15): Add codespell tool, to automatically find spelling mistakes. +- Add README file into the `tests/` folder, explaining how we use unit-tests and some basics of testing. +- Add `CustomMockMixin` internal class, inheriting from `UnpropagatingMockMixin`, but also allowing to use `spec_set` as + class variable, as it will automatically pass it into `__init__` of the mock class. +- Add several new flake8 extensions, and rework flake8 config file +- Add support for specifying what child mock type to propagate in `UnpropagatingMockMixin` class (for unit-tests). + +--- diff --git a/changes/+custom_mock_mixin.internal.md b/changes/+custom_mock_mixin.internal.md deleted file mode 100644 index f5df4550..00000000 --- a/changes/+custom_mock_mixin.internal.md +++ /dev/null @@ -1,2 +0,0 @@ -Add `CustomMockMixin` internal class, inheriting from `UnpropagatingMockMixin`, but also allowing to use `spec_set` as -class variable, as it will automatically pass it into `__init__` of the mock class. diff --git a/changes/+flake8.internal.md b/changes/+flake8.internal.md deleted file mode 100644 index ad3d6507..00000000 --- a/changes/+flake8.internal.md +++ /dev/null @@ -1 +0,0 @@ -Add several new flake8 extensions, and rework flake8 config file diff --git a/changes/+missing_space.bugfix.md b/changes/+missing_space.bugfix.md deleted file mode 100644 index 680ed763..00000000 --- a/changes/+missing_space.bugfix.md +++ /dev/null @@ -1,2 +0,0 @@ -The error message produced by `RequiredParamsABCMixin` class when a required no MRO class variable isn't present now -includes a previously missing space, making it more readable. diff --git a/changes/+packet_interactions.feature.md b/changes/+packet_interactions.feature.md deleted file mode 100644 index 0d6d306b..00000000 --- a/changes/+packet_interactions.feature.md +++ /dev/null @@ -1,2 +0,0 @@ -Separate packet interaction functions into `mcproto.packets.interactions`, (though they're reexported in -`mcproto.packets`, so no breaking changes) diff --git a/changes/+tests_readme.internal.md b/changes/+tests_readme.internal.md deleted file mode 100644 index 230fd1ac..00000000 --- a/changes/+tests_readme.internal.md +++ /dev/null @@ -1 +0,0 @@ -Add README file into the `tests/` folder, explaining how we use unit-tests and some basics of testing. diff --git a/changes/+unpropagating_mock_mixin.internal.md b/changes/+unpropagating_mock_mixin.internal.md deleted file mode 100644 index 227f60ca..00000000 --- a/changes/+unpropagating_mock_mixin.internal.md +++ /dev/null @@ -1 +0,0 @@ -Add support for specifying what child mock type to propagate in `UnpropagatingMockMixin` class (for unit-tests). diff --git a/changes/13.documentation.md b/changes/13.documentation.md deleted file mode 100644 index f8e1df10..00000000 --- a/changes/13.documentation.md +++ /dev/null @@ -1 +0,0 @@ -Add a security policy. diff --git a/changes/14.bugfix.md b/changes/14.bugfix.md deleted file mode 100644 index 1e1b9520..00000000 --- a/changes/14.bugfix.md +++ /dev/null @@ -1,2 +0,0 @@ -Add missing `__slots__` to `ServerBoundPacket` and `ClientBoundPacket` subclasses, which inherited from slotted -`Packet`, but didn't themselves define `__slots__`, causing `__dict__` to be needlessly created. diff --git a/changes/14.feature.md b/changes/14.feature.md deleted file mode 100644 index 3f0ff26f..00000000 --- a/changes/14.feature.md +++ /dev/null @@ -1,3 +0,0 @@ -Add `__slots__` to most classes in the project - - All connection classes are now slotted - - Classes in `mcproto.utils.abc` are now slotted diff --git a/changes/14.internal.1.md b/changes/14.internal.1.md deleted file mode 100644 index c28dfa1a..00000000 --- a/changes/14.internal.1.md +++ /dev/null @@ -1 +0,0 @@ -Add slotscheck, ensuring `__slots__` are defined properly everywhere. diff --git a/changes/14.internal.2.md b/changes/14.internal.2.md deleted file mode 100644 index e844f65d..00000000 --- a/changes/14.internal.2.md +++ /dev/null @@ -1 +0,0 @@ -Make `typing-extensions` a runtime dependency and use it directly, don't rely on `if typing.TYPE_CHECKING` blocks. diff --git a/changes/15.internal.md b/changes/15.internal.md deleted file mode 100644 index 752ca9a3..00000000 --- a/changes/15.internal.md +++ /dev/null @@ -1 +0,0 @@ -Add codespell tool, to automatically find spelling mistakes. diff --git a/changes/6.internal.md b/changes/6.internal.md deleted file mode 100644 index abd8e0d8..00000000 --- a/changes/6.internal.md +++ /dev/null @@ -1,6 +0,0 @@ -Rework deprecation system -- Drop support for date-based deprecations, versions work better -- Provide `deprecation_warn` function, which emits warnings directly, no need for a decorator -- Add a `SemanticVersion` class, supporting version comparisons -- If the project's version is already higher than the specified deprecation removal version, raise a DeprecationWarning - as a full exception (rather than just a warning). diff --git a/changes/7.documentation.md b/changes/7.documentation.md deleted file mode 100644 index 2eb2e0e5..00000000 --- a/changes/7.documentation.md +++ /dev/null @@ -1 +0,0 @@ -Add and start keeping a changelog, managed by towncrier. diff --git a/changes/7.internal.md b/changes/7.internal.md deleted file mode 100644 index a9c79bdd..00000000 --- a/changes/7.internal.md +++ /dev/null @@ -1 +0,0 @@ -Add towncrier for managing changelog