Skip to content

Commit

Permalink
Doc: Link to bytes mode from text-string arguments in the ldap module
Browse files Browse the repository at this point in the history
  • Loading branch information
Petr Viktorin committed Feb 12, 2018
1 parent ef0c514 commit 2920ac2
Showing 1 changed file with 21 additions and 1 deletion.
22 changes: 21 additions & 1 deletion Doc/reference/ldap.rst
Original file line number Diff line number Diff line change
Expand Up @@ -697,6 +697,9 @@ and wait for and return with the server's result, or with

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

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


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

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

The *dn* and *attr* arguments are text strings; see :ref:`bytes_mode`.

.. note::

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

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

The *dn* argument is text string; see :ref:`bytes_mode`.


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

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


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

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


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

The asynchronous version returns the initiated message id.

The *user*, *oldpw* and *newpw* arguments are text strings; see :ref:`bytes_mode`.

.. seealso::

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

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

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


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

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

The *who* and *cred* arguments are text strings; see :ref:`bytes_mode`.

.. versionchanged:: 3.0

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


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

The *base* and *filterstr* arguments, and *attrlist* contents,
are text strings; see :ref:`bytes_mode`.

.. versionchanged:: 3.0

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

0 comments on commit 2920ac2

Please sign in to comment.