From b8aca8f1a0b7d17a01e0c27d245db0e2f0b9ea70 Mon Sep 17 00:00:00 2001 From: Bob Halley Date: Sun, 15 Jan 2023 08:36:56 -0800 Subject: [PATCH] Add deprecation note about the Resolver nameserver attribute. --- doc/resolver-class.rst | 8 ++++++-- doc/whatsnew.rst | 10 +++++++++- 2 files changed, 15 insertions(+), 3 deletions(-) diff --git a/doc/resolver-class.rst b/doc/resolver-class.rst index c491492a..5bf01e37 100644 --- a/doc/resolver-class.rst +++ b/doc/resolver-class.rst @@ -14,6 +14,10 @@ The dns.resolver.Resolver and dns.resolver.Answer Classes A ``list`` of ``str``, each item containing an IPv4 or IPv6 address. + This field is planned to become a property in dnspython 2.4. Writing to this + field other than by direct assignment is deprecated, and so is depending on the + mutability and form of the iterable returned when it is read. + .. attribute:: search A ``list`` of dns.name.Name objects. If the query name is a @@ -55,7 +59,7 @@ The dns.resolver.Resolver and dns.resolver.Answer Classes An object implementing the caching protocol, e.g. a ``dns.resolver.Cache`` or a ``dns.resolver.LRUCache``. The default is ``None``, in which case there is no local caching. - + .. attribute:: retry_servfail A ``bool``. Should we retry a nameserver if it says ``SERVFAIL``? @@ -75,7 +79,7 @@ The dns.resolver.Resolver and dns.resolver.Answer Classes A ``dns.name.Name`` or ``None``, the name of the TSIG key to use; defaults to ``None``. The key must be defined in the keyring. - + .. attribute:: keyalgorithm A ``dns.name.Name`` or ``str``, the TSIG algorithm to use. diff --git a/doc/whatsnew.rst b/doc/whatsnew.rst index 58934516..54d3847b 100644 --- a/doc/whatsnew.rst +++ b/doc/whatsnew.rst @@ -3,9 +3,12 @@ What's New in dnspython ======================= -2.3.0 (in development) +2.4.0 (in development) ---------------------- +2.3.0 +----- + * Python 3.7 or newer is required. * Type annotations are now integrated with the source code and cover @@ -36,6 +39,11 @@ What's New in dnspython * Curio asynchronous I/O support is deprecated as of this release and will be removed in a future release. +* The resolver object's ``nameserver`` field is planned to become a property in + dnspython 2.4. Writing to this field other than by direct assignment is deprecated, + and so is depending on the mutability and form of the iterable returned when it is + read. + 2.2.1 ----- -- 2.47.3