Skip to content

Commit

Permalink
Add deprecation note about the Resolver nameserver attribute.
Browse files Browse the repository at this point in the history
  • Loading branch information
rthalley committed Jan 15, 2023
1 parent 6b5c063 commit e8d475f
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 7 deletions.
8 changes: 6 additions & 2 deletions doc/resolver-class.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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``?
Expand All @@ -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.
Expand Down
10 changes: 5 additions & 5 deletions doc/whatsnew.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,6 @@
What's New in dnspython
=======================

2.3.0 (in development)
----------------------

* TBD

2.3.0
-----

Expand Down Expand Up @@ -41,6 +36,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
-----

Expand Down

0 comments on commit e8d475f

Please sign in to comment.