Hello,
Clarify LDAPClient docstrings about get_entry, get_entries and find_entries.
BTW what is the purpose of size_limit in LDAPClient.get_entry()?
def get_entry(self, dn, attrs_list=None, time_limit=None,
size_limit=None)
--
Petr^2 Spacek
From 0b6e1940f05b02c1aae0f390239b79396e8b1391 Mon Sep 17 00:00:00 2001
From: Petr Spacek <pspa...@redhat.com>
Date: Wed, 18 Jun 2014 17:31:53 +0200
Subject: [PATCH] Clarify LDAPClient docstrings about get_entry, get_entries
and find_entries
---
ipapython/ipaldap.py | 7 ++++++-
1 file changed, 6 insertions(+), 1 deletion(-)
diff --git a/ipapython/ipaldap.py b/ipapython/ipaldap.py
index 677e4f8071b2303c9beeb0a58972684814ecc382..21706cff08a0d8be07db8a1b5fdb0367c10ad53d 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()
--
1.9.3
_______________________________________________
Freeipa-devel mailing list
Freeipa-devel@redhat.com
https://www.redhat.com/mailman/listinfo/freeipa-devel
