python-ldap: Add package stubs

Author: marlonsc

pyproject.toml

@@ -24,6 +24,7 @@ exclude = [
     ".git",
     ".mypy_cache",
     ".pytype",
+    "python-ldap",
 ]
 
 [tool.ruff.lint]

pyrightconfig.json

@@ -12,6 +12,7 @@
         "stubs/geopandas",
         // test cases use a custom config file
         "**/@tests/test_cases",
+        "python-ldap"
     ],
     "typeCheckingMode": "strict",
     // Allowed in base settings for incomplete stubs, checked in stricter settings

pyrightconfig.stricter.json

@@ -86,6 +86,7 @@
         "stubs/python-dateutil",
         "stubs/python-http-client",
         "stubs/python-jose",
+        "stubs/python-ldap",
         "stubs/pywin32",
         "stubs/pyxdg",
         "stubs/PyYAML",

python-ldap

@@ -0,0 +1 @@
+Subproject commit cbcbb6275ca8f4dc36eb2f131f37e2f03814a400

stubs/python-ldap/METADATA.toml

@@ -0,0 +1,11 @@
+version = "3.4.*"
+requires = ["types-pyasn1"]
+upstream_repository = "https://github.com/python-ldap/python-ldap"
+extra_description = """
+Type stubs for python-ldap, covering the public API as documented at
+https://www.python-ldap.org/doc/html/api.html.
+"""
+partial_stub = true
+
+[tool.stubtest]
+stubtest_requirements = ["python-ldap"]

stubs/python-ldap/ldap/__init__.pyi

@@ -0,0 +1,37 @@
+from typing import Any
+
+__version__: str
+__author__: str
+__license__: str
+
+LIBLDAP_API_INFO: Any
+OPT_NAMES_DICT: dict[Any, Any]
+OPT_ERROR_STRING: int
+OPT_DIAGNOSTIC_MESSAGE: int
+
+class LDAPLock:
+    def __init__(self, lock_class: Any = ..., desc: str = ...) -> None: ...
+    def acquire(self) -> None: ...
+    def release(self) -> None: ...
+
+_ldap_module_lock: LDAPLock
+
+def initialize(
+    uri: str,
+    trace_level: int = ...,
+    trace_file: Any = ...,
+    trace_stack_limit: Any = ...,
+    bytes_mode: Any = ...,
+    fileno: Any = ...,
+    **kwargs: Any,
+) -> Any: ...
+def get_option(option: Any) -> Any: ...
+def set_option(option: Any, invalue: Any) -> None: ...
+def escape_str(escape_func: Any, s: Any, *args: Any) -> Any: ...
+def strf_secs(secs: Any) -> Any: ...
+def strp_secs(dt_str: Any) -> Any: ...
+
+class NO_UNIQUE_ENTRY(Exception): ...
+class LDAPBytesWarning(Warning): ...
+
+from ldap.dn import explode_dn as explode_dn, explode_rdn as explode_rdn

stubs/python-ldap/ldap/async.pyi

@@ -0,0 +1,2 @@
+from ldap.asyncsearch import *
+from ldap.asyncsearch import __version__ as __version__

stubs/python-ldap/ldap/asyncsearch.pyi

@@ -0,0 +1,60 @@
+from typing import Any
+from ldap import __version__ as __version__
+
+SEARCH_RESULT_TYPES: set[int]
+ENTRY_RESULT_TYPES: set[int]
+
+class WrongResultType(Exception):
+
+    receivedResultType: Any
+    expectedResultTypes: Any
+    def __init__(self, *args: Any, **kwargs: Any) -> None: ...
+
+class AsyncSearchHandler:
+
+    beginResultsDropped: int
+    endResultBreak: int
+    def __init__(self, l: Any) -> None: ...
+    def startSearch(
+        self,
+        searchRoot: Any,
+        searchScope: Any,
+        filterStr: Any,
+        attrList: Any = ...,
+        attrsOnly: int = 0,
+        timeout: int = -1,
+        sizelimit: int = 0,
+        serverctrls: Any = ...,
+        clientctrls: Any = ...,
+    ) -> None: ...
+    def preProcessing(self) -> None: ...
+    def afterFirstResult(self) -> None: ...
+    def postProcessing(self) -> None: ...
+    def processResults(self, ignoreResultsNumber: int = 0, processResultsCount: int = 0, timeout: int = -1) -> bool: ...
+
+class List(AsyncSearchHandler):
+
+    allResults: list[Any]
+    def __init__(self, l: Any) -> None: ...
+
+class Dict(AsyncSearchHandler):
+
+    allEntries: dict[Any, Any]
+    def __init__(self, l: Any) -> None: ...
+
+class IndexedDict(Dict):
+
+    indexed_attrs: Any
+    index: Any
+    def __init__(self, l: Any, indexed_attrs: Any = ...) -> None: ...
+
+class FileWriter(AsyncSearchHandler):
+
+    headerStr: str
+    footerStr: str
+    def __init__(self, l: Any, f: Any, headerStr: str = "", footerStr: str = "") -> None: ...
+    def preProcessing(self) -> None: ...
+    def postProcessing(self) -> None: ...
+
+class LDIFWriter(FileWriter):
+    def __init__(self, l: Any, writer_obj: Any, headerStr: str = "", footerStr: str = "") -> None: ...

stubs/python-ldap/ldap/cidict.pyi

@@ -0,0 +1,24 @@
+from typing import Any
+
+class cidict(dict[Any, Any]):
+    def __init__(self, *args: Any, **kwargs: Any) -> None: ...
+    def __getitem__(self, key: Any) -> Any: ...
+    def __setitem__(self, key: Any, value: Any) -> None: ...
+    def __delitem__(self, key: Any) -> None: ...
+    def __contains__(self, key: Any) -> bool: ...
+    def get(self, key: Any, default: Any = ...) -> Any: ...
+    def setdefault(self, key: Any, default: Any = ...) -> Any: ...
+    def update(self, *args: Any, **kwargs: Any) -> None: ...
+    def pop(self, key: Any, default: Any = ...) -> Any: ...
+    def popitem(self) -> tuple[Any, Any]: ...
+    def clear(self) -> None: ...
+    def copy(self) -> cidict: ...
+    def keys(self) -> Any: ...
+    def items(self) -> Any: ...
+    def values(self) -> Any: ...
+    def __eq__(self, other: object) -> bool: ...
+    def __ne__(self, other: object) -> bool: ...
+
+def strlist_minus(a: Any, b: Any) -> Any: ...
+def strlist_intersection(a: Any, b: Any) -> Any: ...
+def strlist_union(a: Any, b: Any) -> Any: ...

stubs/python-ldap/ldap/compat.pyi

@@ -0,0 +1,9 @@
+from collections import UserDict
+from collections.abc import MutableMapping as MutableMapping
+from shutil import which as which
+from urllib.parse import quote as quote, quote_plus as quote_plus, unquote as unquote, urlparse as urlparse
+from urllib.request import urlopen as urlopen
+
+IterableUserDict = UserDict
+
+def reraise(exc_type, exc_value, exc_traceback) -> None: ...