Skip to content

[libclang/python] Return None instead of null cursors from Token.cursor #163183

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Oct 13, 2025
Merged

[libclang/python] Return None instead of null cursors from Token.cursor #163183

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9065665
[libclang/python] Return None instead of null cursors from Token.cursor
DeinAlptraum Oct 13, 2025
6bfaa7b
Remove superfluous print and fix comment
DeinAlptraum Oct 13, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions clang/bindings/python/clang/cindex.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3939,6 +3939,8 @@ def cursor(self):
cursor._tu = self._tu

conf.lib.clang_annotateTokens(self._tu, byref(self), 1, byref(cursor))
if cursor.is_null():
return None

return cursor

Expand Down
6 changes: 6 additions & 0 deletions clang/bindings/python/tests/cindex/test_tokens.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,3 +53,9 @@ def test_token_extent(self):

self.assertEqual(extent.start.offset, 4)
self.assertEqual(extent.end.offset, 7)

def test_null_cursor(self):
"""Ensure that the cursor property converts null cursors to None"""
tu = get_tu("int i = 5;")
tokens = list(tu.get_tokens(extent=tu.cursor.extent))
self.assertEqual(tokens[-1].cursor, None)
1 change: 1 addition & 0 deletions clang/docs/ReleaseNotes.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -136,6 +136,7 @@ Clang Frontend Potentially Breaking Changes

Clang Python Bindings Potentially Breaking Changes
--------------------------------------------------
- Return ``None`` instead of null cursors from ``Token.cursor``
- TypeKind ``ELABORATED`` is not used anymore, per clang AST changes removing
ElaboratedTypes. The value becomes unused, and all the existing users should
expect the former underlying type to be reported instead.
Expand Down
Loading