You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Use the full module in ldap.ldapobject.LDAPObject Doc
Previously, the class showed up as ldap.LDAPObject, which is wrong.
Note that the documentation on Read the Docs is currently not building (see #260). The SimpleLDAPObject and ReconnectLDAPObject entries show up fine with current master, but not on the published docs.
Clarify and improve documentation of ldap.ldapobject.LDAPObject
Originally, ldap.ldapobject.LDAPObject was meant as a read/write alias of the "default" connection class.
However, setting module attributes is bad practice (action at distance): it affects all users of python-ldap, some of which might not be aware of each other.
Clarify that:
initialize() is a thin wrapper around calling LDAPObject(),
it is fine and recommnended to instantiate LDAPObject-like classes directly, and
it is possible, but not recommended, to set ldap.ldapobject.LDAPObject to another class.
Originally, `ldap.ldapobject.LDAPObject` was meant as a read/write
alias of the "default" connection class.
However, setting module attributes is bad practice (action at distance):
it affects all users of python-ldap, some of which might not be aware
of each other.
Clarify that:
* `initialize()` is a thin wrapper around calling `LDAPObject()`,
* it is fine and recommnended to instantiate LDAPObject-like classes
directly, and
* it is possible, but not recommended, to set
`ldap.ldapobject.LDAPObject` to another class.
encukou
changed the title
Doc: Use the full module in ldap.ldapobject.LDAPObject
Doc: Clarify and improve documentation of ldap.ldapobject.LDAPObject
Jan 30, 2019
Originally, ldap.ldapobject.LDAPObject was meant as a read/write alias of the "default" connection class.
However, setting module attributes is bad practice (action at distance): it affects all users of python-ldap, some of which might not be aware of each other.
Clarify that:
* initialize() is a thin wrapper around calling LDAPObject(),
* it is fine and recommnended to instantiate LDAPObject-like classes directly, and
* it is possible, but not recommended, to set ldap.ldapobject.LDAPObject to another class.
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Use the full module in ldap.ldapobject.LDAPObject Doc
Previously, the class showed up as
ldap.LDAPObject, which is wrong.Note that the documentation on Read the Docs is currently not building (see #260). TheSimpleLDAPObjectandReconnectLDAPObjectentries show up fine with current master, but not on the published docs.Fixes: #256
Clarify and improve documentation of ldap.ldapobject.LDAPObject
Originally,
ldap.ldapobject.LDAPObjectwas meant as a read/write alias of the "default" connection class.However, setting module attributes is bad practice (action at distance): it affects all users of python-ldap, some of which might not be aware of each other.
Clarify that:
initialize()is a thin wrapper around callingLDAPObject(),ldap.ldapobject.LDAPObjectto another class.Fixes: #205