summaryrefslogtreecommitdiffstats
path: root/ipapython/ipaldap.py
diff options
context:
space:
mode:
authorPetr Spacek <pspacek@redhat.com>2014-06-18 17:31:53 +0200
committerMartin Kosek <mkosek@redhat.com>2014-06-20 12:38:58 +0200
commite821576129907d89a812edde45121d365a1f696d (patch)
treef250d12847c38f7a3cd5841f4a691f4098d8750c /ipapython/ipaldap.py
parent18744d1833452600b93da0156a112f4e8c0013b0 (diff)
downloadfreeipa-e821576129907d89a812edde45121d365a1f696d.tar.gz
freeipa-e821576129907d89a812edde45121d365a1f696d.tar.xz
freeipa-e821576129907d89a812edde45121d365a1f696d.zip
Clarify LDAPClient docstrings about get_entry, get_entries and find_entries
Reviewed-By: Martin Basti <mbasti@redhat.com>
Diffstat (limited to 'ipapython/ipaldap.py')
-rw-r--r--ipapython/ipaldap.py7
1 files changed, 6 insertions, 1 deletions
diff --git a/ipapython/ipaldap.py b/ipapython/ipaldap.py
index 677e4f807..21706cff0 100644
--- a/ipapython/ipaldap.py
+++ b/ipapython/ipaldap.py
@@ -1392,7 +1392,9 @@ class LDAPClient(object):
attrs_list=None):
"""Return a list of matching entries.
- Raises an error if the list is truncated by the server
+ :raises: errors.LimitsExceeded if the list is truncated by the server
+ :raises: errors.NotFound if result set is empty
+ or base_dn doesn't exist
:param base_dn: dn of the entry at which to start the search
:param scope: search scope, see LDAP docs (default ldap2.SCOPE_SUBTREE)
@@ -1426,6 +1428,9 @@ class LDAPClient(object):
search_refs -- allow search references to be returned
(default skips these entries)
paged_search -- search using paged results control
+
+ :raises: errors.NotFound if result set is empty
+ or base_dn doesn't exist
"""
if base_dn is None:
base_dn = DN()