A simple connector pool for python-ldap and related LDAP libraries.
Go to file
Zuul bfe51dd28e Merge "Bump hacking" 2024-03-08 15:32:19 +00:00
doc Switch to newer openstackdocstheme and reno versions 2020-05-30 18:37:12 +02:00
ldappool fix small typo in BackendError class 2023-07-03 15:53:32 +02:00
releasenotes Switch to newer openstackdocstheme and reno versions 2020-05-30 18:37:12 +02:00
.gitignore Switch to stestr 2018-07-17 08:17:25 +07:00
.gitreview OpenDev Migration Patch 2019-04-19 19:40:48 +00:00
.stestr.conf Switch to stestr 2018-07-17 08:17:25 +07:00
.zuul.yaml Update CI to use unversioned jobs template 2022-07-16 22:58:20 +09:00
CHANGES.rst starting 1.1 2012-02-27 23:08:32 +01:00
CONTRIBUTORS preparing 1.0 2012-02-27 23:05:12 +01:00
MANIFEST.in preparing 1.0 2012-02-27 23:05:12 +01:00
README.rst Allow pool status to be printed as a table 2018-11-02 06:43:16 -07:00
bindep.txt Add bindep.txt 2019-07-03 12:29:11 -07:00
requirements.txt Remove usage of six library 2023-05-23 10:30:49 +02:00
setup.cfg Remove deprecated pbr options 2023-12-20 11:44:39 +09:00
setup.py Cleanup py27 support 2020-04-05 09:37:51 +02:00
test-requirements.txt Bump hacking 2024-01-27 23:06:21 +09:00
tox.ini Fix pep8 gate 2023-05-05 08:59:21 -07:00

README.rst

ldappool

A simple connector pool for python-ldap.

The pool keeps LDAP connectors alive and let you reuse them, drastically reducing the time spent to initiate a ldap connection.

The pool has useful features like:

  • transparent reconnection on failures or server restarts
  • configurable pool size and connectors timeouts
  • configurable max lifetime for connectors
  • a context manager to simplify acquiring and releasing a connector

You need python-ldap in order to use this library

Quickstart

To work with the pool, you just need to create it, then use it as a context manager with the connection method:

from ldappool import ConnectionManager

cm = ConnectionManager('ldap://localhost')

with cm.connection('uid=adminuser,ou=logins,dc=mozilla', 'password') as conn:
    .. do something with conn ..

The connector returned by connection is a LDAPObject, that's binded to the server. See https://pypi.org/project/python-ldap/ for details on how to use a connector.

It is possible to check the state of the pool by representing the pool as a string:

from ldappool import ConnectionManager

cm = ConnectionManager('ldap://localhost', size=2)

.. do something with cm ..

print(cm)

This will result in output similar to this table:

+--------------+-----------+----------+------------------+--------------------+------------------------------+
| Slot (2 max) | Connected |  Active  |       URI        | Lifetime (600 max) |           Bind DN            |
+--------------+-----------+----------+------------------+--------------------+------------------------------+
|      1       | connected | inactive | ldap://localhost |  0.00496101379395  | uid=tuser,dc=example,dc=test |
|      2       | connected | inactive | ldap://localhost |  0.00532603263855  | uid=tuser,dc=example,dc=test |
+--------------+-----------+----------+------------------+--------------------+------------------------------+

ConnectionManager options

Here are the options you can use when instanciating the pool:

  • uri: ldap server uri [mandatory]
  • bind: default bind that will be used to bind a connector. default: None
  • passwd: default password that will be used to bind a connector. default: None
  • size: pool size. default: 10
  • retry_max: number of attempts when a server is down. default: 3
  • retry_delay: delay in seconds before a retry. default: .1
  • use_tls: activate TLS when connecting. default: False
  • timeout: connector timeout. default: -1
  • use_pool: activates the pool. If False, will recreate a connector each time. default: True

The uri option will accept a comma or whitespace separated list of LDAP server URIs to allow for failover behavior when connection errors are encountered. Connections will be attempted against the servers in order, with retry_max attempts per URI before failing over to the next server.

The connection method takes two options:

  • bind: bind used to connect. If None, uses the pool default's. default: None
  • passwd: password used to connect. If None, uses the pool default's. default: None