Type annotations for libclang, Python bindings

linux4life798 · December 31, 2023, 10:15pm

Hi all, I opened an issue to implement type annotations. Please check it out and add any extra thoughts over there!

[clang/python] Add type annotation to libclang Python binding

opened 08:59PM - 31 Dec 23 UTC

clang

The libclang Python binding needs type annotations. Type annotations are importa…nt for libraries because they enable the IDE to help users learn the API and steer them in the correct direction through code completions. Furthermore, they allow the IDEs + static checkers to identify a large range of misuse errors. This topic has been discussed a bit in [DeinAlptraum's conversation on Discourse](https://discourse.llvm.org/t/type-annotations-for-libclang-python-bindings/70644). --- There are a few issues that would need to be addressed before we can simply merge type annotations into the python files. 1. The straightforward way to implement type annotations requires Python 3, but the main [cindex.py still makes mention of Python 2](https://github.com/llvm/llvm-project/blob/90c397fc56b7a04dd53cdad8103de1ead9686104/clang/bindings/python/clang/cindex.py#L113-L124). We should be dropping Python 2 support. 2. Type annotations have evolved a bit throughout Python 3 (ex. shift from using `List[str]` to `list[str]` OR `Optional[str]` to `str | None`). Using the newer syntax/style may make the library incompatible with earlier versions of Python 3. So, we need to figure out a reasonable Python 3 version cutoff and implement CI checks to ensure compatibility with the earliest version we want to support. Python 3.7 might be a good cutoff. This aligns with [Debian buster](https://wiki.debian.org/Python#Supported_Python_Versions). Helpful Resources: * https://discourse.llvm.org/t/type-annotations-for-libclang-python-bindings/70644/9 * https://github.com/llvm/llvm-project/commit/83768e66108f583dcb2807a04662cfb9709ab2cf * https://typing.readthedocs.io/en/latest/source/best_practices.html * https://docs.python.org/3/whatsnew/3.7.html#pep-560-core-support-for-typing-module-and-generic-types * https://peps.python.org/pep-0585 * https://stackoverflow.com/questions/63939138/is-there-a-way-to-use-python-3-9-type-hinting-in-its-previous-versions

Topic		Replies	Views
Python bindings overhaul Clang Frontend	4	104	February 2, 2012
issue with libclang and Python bindings Clang Frontend	1	118	November 6, 2017
Python bindings and status of clang-c API Clang Frontend	4	104	January 27, 2011
Seeking maintainers of the clang-c interface and the cindex Python wrapper Clang Frontend	3	85	December 3, 2019
Python 3 support for clang.cindex Clang Frontend	0	110	October 27, 2016

Type annotations for libclang, Python bindings

Related topics