A simple connector pool for python-ldap and related LDAP libraries.
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Colleen Murphy 01d0eb3807 Add py37 tox env 1 month ago
doc Replacing the HTTP protocal with HTTPS in index.rst. 5 months ago
ldappool Allow pool status to be printed as a table 5 months ago
releasenotes/source Fix releasenotes build 4 months ago
.gitignore Switch to stestr 9 months ago
.gitreview add .gitreview and fix ldappool gate 2 years ago
.stestr.conf Switch to stestr 9 months ago
.zuul.yaml add python 3.7 unit test job 2 months ago
CHANGES.rst starting 1.1 7 years ago
CONTRIBUTORS preparing 1.0 7 years ago
MANIFEST.in preparing 1.0 7 years ago
README.rst Allow pool status to be printed as a table 5 months ago
lower-constraints.txt Allow pool status to be printed as a table 5 months ago
requirements.txt Allow pool status to be printed as a table 5 months ago
setup.cfg Change openstack-dev to openstack-discuss 4 months ago
setup.py Updated from global requirements 2 years ago
test-requirements.txt Bump to hacking 1.1.x 9 months ago
tox.ini Add py37 tox env 1 month ago

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