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.
OpenStack Proposal Bot 90aaa0831e Updated from global requirements 1 year ago
doc Switch from oslosphinx to openstackdocstheme 1 year ago
ldappool Don't call start_tls_s() twice 2 years ago
.gitignore additional files to ignore in .gitignore 2 years ago
.gitreview add .gitreview and fix ldappool gate 2 years ago
.testr.conf Add support for tox unit testing 2 years 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 update README to reflect actual ldap dependency 2 years ago
requirements.txt Updated from global requirements 2 years ago
setup.cfg Turn on warning-is-error for sphinx build 1 year ago
setup.py Updated from global requirements 2 years ago
test-requirements.txt Updated from global requirements 1 year ago
tox.ini Avoid tox_install.sh for constraints support 1 year ago

README.rst

ldappool

A simple connector pool for pyldap.

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 pyldap 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://github.com/pyldap/pyldap/ for details on how to use a connector.

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 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

History

Prior to v2.0.0 ldappool required python-ldap. As of v2.0.0 this library now required pyldap, a python 3 compatible fork of python-ldap.