From dd3fff44b19d1d4caed8c3b12bb19c67d2cb6655 Mon Sep 17 00:00:00 2001 From: Peter Odding Date: Mon, 2 Mar 2020 00:12:14 +0100 Subject: [PATCH] Release 7.3: Support for deprecating positional arguments --- CHANGELOG.rst | 32 ++++++++++++++++++++++++-------- humanfriendly/__init__.py | 4 ++-- 2 files changed, 26 insertions(+), 10 deletions(-) diff --git a/CHANGELOG.rst b/CHANGELOG.rst index deccfbc..0288eb5 100644 --- a/CHANGELOG.rst +++ b/CHANGELOG.rst @@ -11,6 +11,21 @@ Changelog`_. This project adheres to `semantic versioning`_. .. _Keep a Changelog: http://keepachangelog.com/ .. _semantic versioning: http://semver.org/ +`Release 7.3`_ (2020-03-02) +--------------------------- + +**Enhancements:** + +Added the :func:`humanfriendly.deprecation.deprecate_args()` decorator function +which makes it easy to switch from positional arguments to keyword arguments +without dropping backwards compatibility. + +.. note:: I'm still working on the humanfriendly 8.0 release which was going to + break backwards compatibility in several ways if it wasn't for the + tools provided by the new :mod:`humanfriendly.deprecation` module. + +.. _Release 7.3: https://github.com/xolox/python-humanfriendly/compare/7.2...7.3 + `Release 7.2`_ (2020-03-01) --------------------------- @@ -19,14 +34,15 @@ Changelog`_. This project adheres to `semantic versioning`_. Support for backwards compatible aliases that emit deprecation warnings (:mod:`humanfriendly.deprecation`). -I'm currently working on several large refactorings that involve moving things -around between modules and dreaded having to extend the existing maze of -(almost but not quite) cyclic import dependencies between modules. This new -functionality will be adopted to untangle the existing maze in the coming -release, which will bump the major version number due to this very large change -in how backwards compatibility is implemented. It is my hope that this new -functionality will prove to be robust enough to unburden me from the less -elegant aspects of preserving backwards compatibility 😁. +.. note:: I'm currently working on several large refactorings that involve + moving things around between modules and dreaded having to extend the + existing maze of (almost but not quite) cyclic import dependencies + between modules. This new functionality will be adopted to untangle + the existing maze in the upcoming humanfriendly 8.0 release, which + bumps the major version number due to this very large change in how + backwards compatibility is implemented. It is my hope that this new + functionality will prove to be robust enough to unburden me from the + less elegant aspects of preserving backwards compatibility 😁. **Documentation:** diff --git a/humanfriendly/__init__.py b/humanfriendly/__init__.py index 4928671..7ea3f56 100644 --- a/humanfriendly/__init__.py +++ b/humanfriendly/__init__.py @@ -1,7 +1,7 @@ # Human friendly input/output in Python. # # Author: Peter Odding -# Last Change: March 1, 2020 +# Last Change: March 2, 2020 # URL: https://humanfriendly.readthedocs.io """The main module of the `humanfriendly` package.""" @@ -93,7 +93,7 @@ ) # Semi-standard module versioning. -__version__ = '7.2' +__version__ = '7.3' # Spinners are redrawn at most this many seconds. minimum_spinner_interval = 0.2