[CalendarServer-changes] [12340] twext/trunk/twext/who/ldap

[source_changes at macosforge.org]

Revision: 12340
          http://trac.calendarserver.org//changeset/12340
Author:   wsanchez at apple.com
Date:     2014-01-14 13:34:59 -0800 (Tue, 14 Jan 2014)
Log Message:
-----------
Docs, make debug private.

Modified Paths:
--------------
    twext/trunk/twext/who/ldap/_service.py
    twext/trunk/twext/who/ldap/test/test_service.py

Modified: twext/trunk/twext/who/ldap/_service.py
===================================================================
--- twext/trunk/twext/who/ldap/_service.py	2014-01-14 21:18:37 UTC (rev 12339)
+++ twext/trunk/twext/who/ldap/_service.py	2014-01-14 21:34:59 UTC (rev 12340)
@@ -163,11 +163,45 @@
         tlsCACertificateFile=None,
         tlsCACertificateDirectory=None,
         useTLS=False,
-        debug=False,
         fieldNameToAttributeMap=DEFAULT_FIELDNAME_MAP,
         recordTypeToObjectClassMap=DEFAULT_RECORDTYPE_MAP,
         uidField=BaseFieldName.uid,
+        _debug=False,
     ):
+        """
+        @param url: The URL of the LDAP server to connect to.
+        @type url: L{unicode}
+
+        @param baseDN: The base DN for queries.
+        @type baseDN: L{unicode}
+
+        @param credentials: The credentials to use to authenticate with the
+            LDAP server.
+        @type credentials: L{IUsernamePassword}
+
+        @param timeout: A timeout, in seconds, for LDAP queries.
+        @type timeout: number
+
+        @param tlsCACertificateFile: ...
+        @type tlsCACertificateFile: L{FilePath}
+
+        @param tlsCACertificateDirectory: ...
+        @type tlsCACertificateDirectory: L{FilePath}
+
+        @param useTLS: Enable the use of TLS.
+        @type useTLS: L{bool}
+
+        @param fieldNameToAttributeMap: A mapping of field names to LDAP
+            attribute names.
+        @type fieldNameToAttributeMap: mapping with L{NamedConstant} keys and
+            L{unicode} values
+
+        @param recordTypeToObjectClassMap: A mapping of record types to LDAP
+            object classes.
+        @type recordTypeToObjectClassMap: mapping with L{NamedConstant} keys
+            and L{unicode} values
+        """
+
         self.url = url
         self._baseDN = baseDN
         self._credentials = credentials
@@ -185,7 +219,7 @@
 
         self._useTLS = useTLS
 
-        if debug:
+        if _debug:
             self._debug = 255
         else:
             self._debug = None

Modified: twext/trunk/twext/who/ldap/test/test_service.py
===================================================================
--- twext/trunk/twext/who/ldap/test/test_service.py	2014-01-14 21:18:37 UTC (rev 12339)
+++ twext/trunk/twext/who/ldap/test/test_service.py	2014-01-14 21:34:59 UTC (rev 12340)
@@ -155,7 +155,7 @@
             timeout=18,
             tlsCACertificateFile=FilePath("/path/to/cert"),
             tlsCACertificateDirectory=FilePath("/path/to/certdir"),
-            debug=True,
+            _debug=True,
         )
         connection = yield service._connect()
 
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <https://lists.macosforge.org/pipermail/calendarserver-changes/attachments/20140312/a60d108e/attachment.html>