[python-ldap] Move _ldap to ldap._ldap

Alphix · Alphix · commit d7699f8f07c6 · 2025-08-15T00:06:31.000+02:00
This is necessary in order for type checking due to: python/typing#1333 Given that _ldap is an internal module, this change is hopefully ok.
diff --git a/Doc/fake_ldap_module_for_documentation.py b/Doc/fake_ldap_module_for_documentation.py
@@ -1,21 +1,21 @@
 """
-A module that mocks `_ldap` for the purposes of generating documentation
+A module that mocks `ldap._ldap` for the purposes of generating documentation
 
-This module provides placeholders for the contents of `_ldap`, making it
-possible to generate documentation even _ldap is not compiled.
+This module provides placeholders for the contents of `ldap._ldap`, making it
+possible to generate documentation even if ldap._ldap is not compiled.
 It should also make the documentation independent of which features are
 available in the system OpenLDAP library.
 
 The overly long module name will show up in AttributeError messages,
-hinting that this is not the actual _ldap.
+hinting that this is not the actual ldap._ldap.
 
 See https://www.python-ldap.org/ for details.
 """
 
 import sys
 
-# Cause `import _ldap` to import this module instead of the actual `_ldap`.
-sys.modules['_ldap'] = sys.modules[__name__]
+# Cause `import ldap._ldap` to import this module instead of the actual module.
+sys.modules['ldap._ldap'] = sys.modules[__name__]
 
 from constants import CONSTANTS
 from pkginfo import __version__
diff --git a/Lib/ldap/__init__.py b/Lib/ldap/__init__.py
@@ -34,10 +34,10 @@
   _trace_file = sys.stderr
   _trace_stack_limit = None
 
-import _ldap
+import ldap._ldap as _ldap
 assert _ldap.__version__==__version__, \
        ImportError(f'ldap {__version__} and _ldap {_ldap.__version__} version mismatch!')
-from _ldap import *
+from ldap._ldap import *
 # call into libldap to initialize it right now
 LIBLDAP_API_INFO = _ldap.get_option(_ldap.OPT_API_INFO)
 
diff --git a/Lib/ldap/_ldap.pyi b/Lib/ldap/_ldap.pyi
diff --git a/Lib/ldap/controls/__init__.py b/Lib/ldap/controls/__init__.py
@@ -10,7 +10,7 @@
 
 from ldap.pkginfo import __version__
 
-import _ldap
+import ldap._ldap as _ldap
 assert _ldap.__version__==__version__, \
        ImportError(f'ldap {__version__} and _ldap {_ldap.__version__} version mismatch!')
 
diff --git a/Lib/ldap/controls/libldap.py b/Lib/ldap/controls/libldap.py
@@ -7,7 +7,7 @@
 
 from ldap.pkginfo import __version__
 
-import _ldap
+import ldap._ldap as _ldap
 assert _ldap.__version__==__version__, \
        ImportError(f'ldap {__version__} and _ldap {_ldap.__version__} version mismatch!')
 
diff --git a/Lib/ldap/dn.py b/Lib/ldap/dn.py
@@ -5,7 +5,7 @@
 """
 from ldap.pkginfo import __version__
 
-import _ldap
+import ldap._ldap as _ldap
 assert _ldap.__version__==__version__, \
        ImportError(f'ldap {__version__} and _ldap {_ldap.__version__} version mismatch!')
 
diff --git a/Lib/ldap/functions.py b/Lib/ldap/functions.py
@@ -1,5 +1,5 @@
 """
-functions.py - wraps functions of module _ldap
+functions.py - wraps functions of module ldap._ldap
 
 See https://www.python-ldap.org/ for details.
 """
@@ -14,7 +14,9 @@
   'strf_secs','strp_secs',
 ]
 
-import sys,pprint,time,_ldap,ldap
+import sys,pprint,time
+import ldap._ldap as _ldap
+import ldap
 from calendar import timegm
 
 from ldap import LDAPError
diff --git a/Lib/ldap/ldapobject.py b/Lib/ldap/ldapobject.py
@@ -1,5 +1,5 @@
 """
-ldapobject.py - wraps class _ldap.LDAPObject
+ldapobject.py - wraps class ldap._ldap.LDAPObject
 
 See https://www.python-ldap.org/ for details.
 """
@@ -36,7 +36,9 @@
   # Tracing is only supported in debugging mode
   import traceback
 
-import sys,time,pprint,_ldap,ldap,ldap.sasl,ldap.functions
+import sys,time,pprint
+import ldap._ldap as _ldap
+import ldap, ldap.sasl, ldap.functions
 import warnings
 
 from ldap.schema import SCHEMA_ATTRS
diff --git a/Lib/slapdtest/_slapdtest.py b/Lib/slapdtest/_slapdtest.py
@@ -19,7 +19,7 @@
 from types import TracebackType
 from typing_extensions import Self
 
-# Switch off processing .ldaprc or ldap.conf before importing _ldap
+# Switch off processing .ldaprc or ldap.conf before importing ldap._ldap
 os.environ['LDAPNOINIT'] = '1'
 
 import ldap
diff --git a/MANIFEST.in b/MANIFEST.in
@@ -2,7 +2,7 @@ include MANIFEST.in Makefile CHANGES INSTALL LICENCE README TODO
 include tox.ini .coveragerc
 include Modules/*.c Modules/*.h
 include Lib/ldap/py.typed
-include Lib/_ldap.pyi
+include Lib/ldap/_ldap.pyi
 recursive-include Build *.cfg*
 recursive-include Lib *.py
 recursive-include Demo *.py
diff --git a/Tests/t_cext.py b/Tests/t_cext.py
@@ -13,13 +13,13 @@
 os.environ['LDAPNOINIT'] = '1'
 
 # import the plain C wrapper module
-import _ldap
+import ldap._ldap as _ldap
 from slapdtest import SlapdTestCase, requires_tls, requires_init_fd
 
 
 class TestLdapCExtension(SlapdTestCase):
     """
-    These tests apply only to the _ldap module and therefore bypass the
+    These tests apply only to the ldap._ldap module and therefore bypass the
     LDAPObject wrapper completely.
     """
 
diff --git a/setup.cfg b/setup.cfg
@@ -20,7 +20,7 @@ defines = HAVE_SASL HAVE_TLS
 
 extra_compile_args =
 extra_objects =
-extra_files = .:Lib/_ldap.pyi
+extra_files = ./ldap/:Lib/ldap/_ldap.pyi
 
 # Uncomment this if your libldap is not thread-safe and you need libldap_r
 # instead
diff --git a/setup.py b/setup.py
@@ -102,7 +102,7 @@ class OpenLDAP2:
   #-- C extension modules
   ext_modules = [
     Extension(
-      '_ldap',
+      'ldap._ldap',
       [
         'Modules/LDAPObject.c',
         'Modules/ldapcontrol.c',
