Skip to content

Commit 2920ac2

Browse files
committed
Doc: Link to bytes mode from text-string arguments in the ldap module
1 parent ef0c514 commit 2920ac2

File tree

1 file changed

+21
-1
lines changed

1 file changed

+21
-1
lines changed

Doc/reference/ldap.rst

Lines changed: 21 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -697,6 +697,9 @@ and wait for and return with the server's result, or with
697697

698698
*serverctrls* and *clientctrls* like described in section :ref:`ldap-controls`.
699699

700+
The *dn* argument, and mod_type (second item) of *modlist* are text strings;
701+
see :ref:`bytes_mode`.
702+
700703

701704
.. py:method:: LDAPObject.bind(who, cred, method) -> int
702705
@@ -738,6 +741,8 @@ and wait for and return with the server's result, or with
738741

739742
*serverctrls* and *clientctrls* like described in section :ref:`ldap-controls`.
740743

744+
The *dn* and *attr* arguments are text strings; see :ref:`bytes_mode`.
745+
741746
.. note::
742747

743748
A design fault in the LDAP API prevents *value*
@@ -758,6 +763,8 @@ and wait for and return with the server's result, or with
758763

759764
*serverctrls* and *clientctrls* like described in section :ref:`ldap-controls`.
760765

766+
The *dn* argument is text string; see :ref:`bytes_mode`.
767+
761768

762769
.. py:method:: LDAPObject.extop(extreq[,serverctrls=None[,clientctrls=None]]]) -> int
763770
@@ -811,6 +818,9 @@ and wait for and return with the server's result, or with
811818
You might want to look into sub-module :py:mod:`ldap.modlist` for
812819
generating *modlist*.
813820

821+
The *dn* argument, and mod_type (second item) of *modlist* are text strings;
822+
see :ref:`bytes_mode`.
823+
814824

815825
.. py:method:: LDAPObject.modrdn(dn, newrdn [, delold=1]) -> int
816826
@@ -827,6 +837,8 @@ and wait for and return with the server's result, or with
827837
This operation is emulated by :py:meth:`rename()` and :py:meth:`rename_s()` methods
828838
since the modrdn2* routines in the C library are deprecated.
829839

840+
The *dn* and *newrdn* arguments are text strings; see :ref:`bytes_mode`.
841+
830842

831843
.. py:method:: LDAPObject.passwd(user, oldpw, newpw [, serverctrls=None [, clientctrls=None]]) -> int
832844
@@ -845,6 +857,8 @@ and wait for and return with the server's result, or with
845857

846858
The asynchronous version returns the initiated message id.
847859

860+
The *user*, *oldpw* and *newpw* arguments are text strings; see :ref:`bytes_mode`.
861+
848862
.. seealso::
849863

850864
:rfc:`3062` - LDAP Password Modify Extended Operation
@@ -866,6 +880,8 @@ and wait for and return with the server's result, or with
866880

867881
*serverctrls* and *clientctrls* like described in section :ref:`ldap-controls`.
868882

883+
The *dn* and *newdn* arguments are text strings; see :ref:`bytes_mode`.
884+
869885

870886
.. py:method:: LDAPObject.result([msgid=RES_ANY [, all=1 [, timeout=None]]]) -> 2-tuple
871887
@@ -1016,12 +1032,13 @@ and wait for and return with the server's result, or with
10161032

10171033
*serverctrls* and *clientctrls* like described in section :ref:`ldap-controls`.
10181034

1035+
The *who* and *cred* arguments are text strings; see :ref:`bytes_mode`.
1036+
10191037
.. versionchanged:: 3.0
10201038

10211039
:meth:`~LDAPObject.simple_bind` and :meth:`~LDAPObject.simple_bind_s`
10221040
now accept ``None`` for *who* and *cred*, too.
10231041

1024-
10251042
.. py:method:: LDAPObject.search(base, scope [,filterstr='(objectClass=*)' [, attrlist=None [, attrsonly=0]]]) ->int
10261043
10271044
.. py:method:: LDAPObject.search_s(base, scope [,filterstr='(objectClass=*)' [, attrlist=None [, attrsonly=0]]]) ->list|None
@@ -1074,6 +1091,9 @@ and wait for and return with the server's result, or with
10741091
or :py:meth:`search_ext_s()` (client-side search limit). If non-zero
10751092
not more than *sizelimit* results are returned by the server.
10761093

1094+
The *base* and *filterstr* arguments, and *attrlist* contents,
1095+
are text strings; see :ref:`bytes_mode`.
1096+
10771097
.. versionchanged:: 3.0
10781098

10791099
``filterstr=None`` is equivalent to ``filterstr='(objectClass=*)'``.

0 commit comments

Comments
 (0)
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy