ldap-resiter.rst 1.4 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152
  1. .. % $Id: ldap-resiter.rst,v 1.5 2011/08/27 15:43:06 stroeder Exp $
  2. :py:mod:`ldap.resiter` Generator for stream-processing of large search results
  3. ==============================================================================
  4. .. py:module:: ldap.resiter
  5. :synopsis: Generator for stream-processing of large search results.
  6. .. moduleauthor:: python-ldap project (see http://www.python-ldap.org/)
  7. .. _ldap.resiter-classes:
  8. .. py:class:: ResultProcessor
  9. This is a mix-in class to be used with class :py:class:`ldap.LDAPObject` or
  10. derived classes which has these methods:
  11. .. automethod:: ldap.resiter.ResultProcessor.allresults
  12. .. _ldap.resiter-example:
  13. Examples
  14. ========
  15. .. _ldap.resiter.ResultProcessor-example:
  16. Using ldap.resiter.ResultProcessor
  17. ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  18. This example demonstrates how to use mix-in class ldap.resiter.ResultProcessor for
  19. retrieving results formerly requested with :py:meth:`ldap.LDAPObject.search()` and
  20. processing them in a for-loop.
  21. ::
  22. import sys,ldap,ldap.resiter
  23. class MyLDAPObject(ldap.ldapobject.LDAPObject,ldap.resiter.ResultProcessor):
  24. pass
  25. l = MyLDAPObject('ldap://localhost')
  26. # Asynchronous search method
  27. msg_id = l.search('dc=stroeder,dc=com',ldap.SCOPE_SUBTREE,'(objectClass=*)')
  28. for res_type,res_data,res_msgid,res_controls in l.allresults(msg_id):
  29. for dn,entry in res_data:
  30. # process dn and entry
  31. print dn,entry['objectClass']