Bonsai

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

Changed
~~~~~~~

- Asynchronous connection process during socket initialisation is disabled
by default on every platform. It caused TLS errors on newer Ubuntus (18.04+).
Use set_connect_async explicitly to enable it.
- LDAPClient's server_chase_referrals is set to False automatically before
starting a paged_search.
- Using urllib.parse for LDAPURL, instead of regular expressions.

Fixed
~~~~~

- Freeing resources allocated by the LDAP structure during LDAPConnection's
deallocation. (Issue 45)
- Package name in documentation. (Thanks to ikreb7)

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

Added
~~~~~

- The get_result coroutines to AIOLDAPConnection and TornadoLDAPConnection.
- LDAPI example to docs. (Thanks to senfomat)

Fixed
~~~~~

- Raising ConnectionError instead of ValueError of invalid file descriptor
with AIOLDAPConnection when the server is unreachable. (Issue 27)
- Raising SizeLimitError when the query hits either the client-side or the
server-side limit, fix condition check when acquiring next page. (Issue 31)
- Race condition for open method of ThreadedConnectionPool and AIOConnectionPool.

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

Changed
~~~~~~~
- Drop support for Python 3.4. From further releases 3.4 related codes will
be removed (some asyncio related code has already changed), and the module
will require 3.5 or newer Python to be built.
- Add gevent and tornado as extra requirements for setup.py.

Added
~~~~~

- New set_connect_async function to disable/enable asynchronous connection
process during socket initialisation. (Thanks to tck42)
- New connection pool classes: simple ConnectionPool, ThreadedConnectionPool
that can be shared between threads and AIOConnectionPool for asyncio tasks.

Fixed
~~~~~

- Defining PY_SSIZE_T_CLEAN and changing parameter size variables from int to
Py_ssize_t for Python 3.8.

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

Changed
~~~~~~~

- Separate basic search functionality to three different methods in
LDAPConnection: search, paged_search and virtual_list_search.
- LDAPEntry's DN is listed among its attributes under the dn key.
- LDAPClient's set_credentials method uses optional named parameters instead
of tuples.
- LDAPClient's credentials property returns a dict instead of a tuple.
- LDAPURL's filter property and the filter parameters of LDAPConnection's
search methods are renamed to filter_exp.
- The representation of LDAPEntry honours the last call of its
change_attribute method better than previously.
- Drop Heimdal support for advanced Kerberos capabilities (at least
temporarily).
- The get_tls_impl_name, get_vendor_info, has_krb5_support, and set_debug
functions are moved to the utils submodule.

Added
~~~~~

- LDIFReader and LDIFWriter objects for handling LDIF format.
- The delete_old_rdn parameter for LDAPEntry's rename method. (Issue 17)
- Kerberos keytab support for set_credentials (Thanks to Mirraz).
- Utils submodule with escape_filter_exp and escape_attribute_value
functions. (Issue 18)
- An exclude_dn keyword-only argument to LDAPEntry's keys, items and
values methods to exclude the dn key and value from the return values.
- Support for ldapi connection in LDAPURL and LDAPConnection.
- BaseLDAPConnection as a super class for all connection classes.
- Type annotations for several methods.

Fixed
~~~~~

- Several reference counting errors that caused memory leaks. (Issue 19)
- Escaping brackets in LDAPURL's regular expressions. (Issue 22)
- Missing ManageDsaIT control during LDAPConnection's delete.
- Honouring timeout settings for network connections, but only on
Linux with newer OpenLDAP than 2.4.43. (Issue 21)
- Typo in documentation (Thanks to magnuswatn).

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

Changed
~~~~~~~

- LDAPError messages have the original LDAP error codes.
- TLS initialisation is separated from LDAP struct initialisation.

Added
~~~~~

- Async with support for AIOLDAPConnection. (Issue 12)
- New set_debug module function that enables debug mode.

Fixed
~~~~~

- Signalling after LDAP initialisation is failed.
- Using TLS settings while getting the root DSE in get_rootDSE method.

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

Changed
~~~~~~~

- Python 3.3 is no longer considered to be supported. The package won't be
tested with 3.3 anymore.
- The LDAPSearchIter object is automatically acquiring the next page during
iteration for paged LDAP search by default.
- Installing the package from source on Mac OS X became simpler with
setup.cfg (Thanks to LukeXuan).
- When recursive is True, LDAPConnection.delete uses LDAP_SERVER_TREE_DELETE
control (if it is possible).
- LDAPClient.url property became writeable.

Added
~~~~~

- LDAPClient.set_auto_page_acquire and auto_page_acquire property for
enabling/disabling automatic page acquiring during paged LDAP search.
- LDAPEntry.change_attribute and LDAPEntry.clear_attribute_changes methods
for handling LDAP attributes with explicit modification operation types.
- Async iterator (async for) support for LDAPSearchIter.
- LDAPClient.server_chase_referrals property to set chasing LDAP referrals
by the server.
- LDAPReference object for handling LDAP referrals.
- LDAPURL.__eq__ method to check LDAPURL objects and string equality.
- LDAPClient.set_url method to set url attribute.
- LDAPClient.set_managedsait method to support LDAP ManageDsaIT control
during search, add and modify operations.

Fixed
~~~~~

- The value validation of LDAPDN's __setitem__ method.
- The missing asyncio.coroutine decorators of AIOLDAPConnection's methods.
- IPv6 parsing for LDAPURL.