[python-ldap] Integrate typing into the build/CI system

Alphix · Alphix · commit ea6b62530a69 · 2025-08-15T00:06:31.000+02:00
diff --git a/Lib/ldap/py.typed b/Lib/ldap/py.typed
diff --git a/MANIFEST.in b/MANIFEST.in
@@ -1,6 +1,8 @@
 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
 recursive-include Build *.cfg*
 recursive-include Lib *.py
 recursive-include Demo *.py
diff --git a/setup.cfg b/setup.cfg
@@ -20,6 +20,7 @@ defines = HAVE_SASL HAVE_TLS
 
 extra_compile_args =
 extra_objects =
+extra_files = .:Lib/_ldap.pyi
 
 # Uncomment this if your libldap is not thread-safe and you need libldap_r
 # instead
@@ -49,3 +50,14 @@ python_files = t_*.py
 filterwarnings =
     error
     ignore::ldap.LDAPBytesWarning
+
+# mypy, https://mypy.readthedocs.io/en/latest/
+[mypy]
+strict = True
+files = Lib/
+
+[mypy-pyasn1.*]
+ignore_missing_imports = True
+
+[mypy-pyasn1_modules.*]
+ignore_missing_imports = True
diff --git a/setup.py b/setup.py
@@ -139,7 +139,6 @@ class OpenLDAP2:
   py_modules = [
     'ldapurl',
     'ldif',
-
   ],
   packages = [
     'ldap',
@@ -150,11 +149,13 @@ class OpenLDAP2:
     'slapdtest.certs',
   ],
   package_dir = {'': 'Lib',},
+  package_data = {'ldap': ['py.typed'],},
   data_files = LDAP_CLASS.extra_files,
   include_package_data=True,
   install_requires=[
     'pyasn1 >= 0.3.7',
     'pyasn1_modules >= 0.1.5',
+    'typing_extensions >= 0.4.1',
   ],
   zip_safe=False,
   python_requires='>=3.9',
diff --git a/tox.ini b/tox.ini
@@ -5,16 +5,16 @@
 
 [tox]
 # Note: when updating Python versions, also change setup.py and .github/worlflows/*
-envlist = py{39,310,311,312},py3-nosasltls,doc,py3-trace,pypy3.9
+envlist = py{39,310,311,312},py3-nosasltls,doc,mypy,py3-trace,pypy3.9
 minver = 1.8
 
 [gh-actions]
 python =
-    3.9: py39, py3-trace, doc, py3-nosasltls
-    3.10: py310
-    3.11: py311
-    3.12: py312
-    3.13: py313
+    3.9: py39, py3-trace, doc, py3-nosasltls, mypy
+    3.10: py310, mypy
+    3.11: py311, mypy
+    3.12: py312, mypy
+    3.13: py313, mypy
     pypy3.9: pypy3.9
     pypy3.10: pypy3.10
 
@@ -41,6 +41,7 @@ deps =
     {[testenv]deps}
     pyasn1
     pyasn1_modules
+    typing_extensions
 passenv = {[testenv]passenv}
 setenv =
     CI_DISABLED=LDAPI:SASL:TLS
@@ -90,6 +91,12 @@ basepython = pypy3
 deps = pytest
 commands = {envpython} -m pytest {posargs}
 
+[testenv:mypy]
+basepython = python3
+deps = mypy
+commands =
+    {envpython} -m mypy --config-file {toxinidir}/setup.cfg {posargs}
+
 [testenv:doc]
 basepython = python3
 deps =
