1
- **************************************************************
2
- :py:mod: `ldap.async ` Stream-processing of large search results
3
- **************************************************************
1
+ ********************************************************************
2
+ :py:mod: `ldap.asyncsearch ` Stream-processing of large search results
3
+ ********************************************************************
4
4
5
- .. py :module :: ldap.async
5
+ .. py :module :: ldap.asyncsearch
6
6
:synopsis: Framework for stream-processing of large search results.
7
7
8
8
With newer Python versions one might want to consider using
9
9
:py:mod: `ldap.resiter ` instead.
10
10
11
11
12
+ .. versionchanged :: 3.0
13
+ In Python 3.7 ``async `` is a reserved keyword. The module
14
+ :py:mod: `ldap.async ` has been renamed to :py:mod: `ldap.asyncsearch `. The
15
+ old name :py:mod: `ldap.async ` is still available for backwards
16
+ compatibility.
17
+
18
+ .. deprecated :: 3.0
19
+ The old name :py:mod: `ldap.async ` is deprecated, but will not be removed
20
+ until Python 3.6 reaches end-of-life.
21
+
22
+
12
23
Classes
13
24
=======
14
25
15
- .. autoclass :: ldap.async .AsyncSearchHandler
26
+ .. autoclass :: ldap.asyncsearch .AsyncSearchHandler
16
27
:members:
17
28
18
- .. autoclass :: ldap.async .List
29
+ .. autoclass :: ldap.asyncsearch .List
19
30
:members:
20
31
21
- .. autoclass :: ldap.async .Dict
32
+ .. autoclass :: ldap.asyncsearch .Dict
22
33
:members:
23
34
24
- .. autoclass :: ldap.async .IndexedDict
35
+ .. autoclass :: ldap.asyncsearch .IndexedDict
25
36
:members:
26
37
27
- .. autoclass :: ldap.async .LDIFWriter
38
+ .. autoclass :: ldap.asyncsearch .LDIFWriter
28
39
:members:
29
40
30
- .. _ldap.async -example :
41
+ .. _ldap.asyncsearch -example :
31
42
32
43
Examples
33
44
========
34
45
35
- .. _ldap.async -example.List :
46
+ .. _ldap.asyncsearch -example.List :
36
47
37
- Using ldap.async .List
38
- ^^^^^^^^^^^^^^^^^^^^^
48
+ Using ldap.asyncsearch .List
49
+ ^^^^^^^^^^^^^^^^^^^^^^^^^^^
39
50
40
- This example demonstrates how to use class ldap.async .List for
51
+ This example demonstrates how to use class ldap.asyncsearch .List for
41
52
retrieving partial search results even though the exception
42
53
:exc: `ldap.SIZELIMIT_EXCEEDED ` was raised because a server side limit was hit. ::
43
54
44
- import sys,ldap,ldap.async
55
+ import sys,ldap,ldap.asyncsearch
45
56
46
- s = ldap.async .List(
57
+ s = ldap.asyncsearch .List(
47
58
ldap.initialize('ldap://localhost'),
48
59
)
49
60
@@ -67,17 +78,17 @@ retrieving partial search results even though the exception
67
78
)
68
79
)
69
80
70
- .. _ldap.async -example.LDIFWriter :
81
+ .. _ldap.asyncsearch -example.LDIFWriter :
71
82
72
- Using ldap.async .LDIFWriter
73
- ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
83
+ Using ldap.asyncsearch .LDIFWriter
84
+ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
74
85
75
- This example demonstrates how to use class ldap.async .LDIFWriter
86
+ This example demonstrates how to use class ldap.asyncsearch .LDIFWriter
76
87
for writing search results as LDIF to stdout. ::
77
88
78
- import sys,ldap,ldap.async
89
+ import sys,ldap,ldap.asyncsearch
79
90
80
- s = ldap.async .LDIFWriter(
91
+ s = ldap.asyncsearch .LDIFWriter(
81
92
ldap.initialize('ldap://localhost:1390'),
82
93
sys.stdout
83
94
)
0 commit comments