Skip to content

[libclang/python] Change all global variables to snake case #132378

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.

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
Mar 22, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
10 changes: 5 additions & 5 deletions clang/bindings/python/clang/cindex.py
Original file line number Diff line number Diff line change
Expand Up @@ -2786,7 +2786,7 @@ class _CXUnsavedFile(Structure):
# Functions calls through the python interface are rather slow. Fortunately,
# for most symboles, we do not need to perform a function call. Their spelling
# never changes and is consequently provided by this spelling cache.
SpellingCache = {
spelling_cache = {
# 0: CompletionChunk.Kind("Optional"),
# 1: CompletionChunk.Kind("TypedText"),
# 2: CompletionChunk.Kind("Text"),
Expand Down Expand Up @@ -2832,8 +2832,8 @@ def __repr__(self):

@CachedProperty
def spelling(self):
if self.__kindNumber in SpellingCache:
return SpellingCache[self.__kindNumber]
if self.__kindNumber in spelling_cache:
return spelling_cache[self.__kindNumber]
return _CXString.from_result(
conf.lib.clang_getCompletionChunkText(self.cs, self.key)
)
Expand Down Expand Up @@ -3830,7 +3830,7 @@ def set_property(self, property, value):
fields_visit_callback = CFUNCTYPE(c_int, Cursor, py_object)

# Functions strictly alphabetical order.
functionList: list[LibFunc] = [
function_list: list[LibFunc] = [
(
"clang_annotateTokens",
[TranslationUnit, POINTER(Token), c_uint, POINTER(Cursor)],
Expand Down Expand Up @@ -4108,7 +4108,7 @@ def register_functions(lib: CDLL, ignore_errors: bool) -> None:
def register(item: LibFunc) -> None:
register_function(lib, item, ignore_errors)

for f in functionList:
for f in function_list:
register(f)


Expand Down
20 changes: 10 additions & 10 deletions clang/bindings/python/tests/cindex/test_cdb.py
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
import sys
from pathlib import Path

kInputsDir = os.path.join(os.path.dirname(__file__), "INPUTS")
inputs_dir = os.path.join(os.path.dirname(__file__), "INPUTS")


@unittest.skipIf(sys.platform == "win32", "TODO: Fix these tests on Windows")
Expand All @@ -34,23 +34,23 @@ def test_create_fail(self):

def test_create(self):
"""Check we can load a compilation database"""
CompilationDatabase.fromDirectory(kInputsDir)
CompilationDatabase.fromDirectory(inputs_dir)

def test_lookup_succeed(self):
"""Check we get some results if the file exists in the db"""
cdb = CompilationDatabase.fromDirectory(kInputsDir)
cdb = CompilationDatabase.fromDirectory(inputs_dir)
cmds = cdb.getCompileCommands("/home/john.doe/MyProject/project.cpp")
self.assertNotEqual(len(cmds), 0)

def test_lookup_succeed_pathlike(self):
"""Same as test_lookup_succeed, but with PathLikes"""
cdb = CompilationDatabase.fromDirectory(Path(kInputsDir))
cdb = CompilationDatabase.fromDirectory(Path(inputs_dir))
cmds = cdb.getCompileCommands(Path("/home/john.doe/MyProject/project.cpp"))
self.assertNotEqual(len(cmds), 0)

def test_all_compilecommand(self):
"""Check we get all results from the db"""
cdb = CompilationDatabase.fromDirectory(kInputsDir)
cdb = CompilationDatabase.fromDirectory(inputs_dir)
cmds = cdb.getAllCompileCommands()
self.assertEqual(len(cmds), 3)
expected = [
Expand Down Expand Up @@ -100,7 +100,7 @@ def test_all_compilecommand(self):

def test_1_compilecommand(self):
"""Check file with single compile command"""
cdb = CompilationDatabase.fromDirectory(kInputsDir)
cdb = CompilationDatabase.fromDirectory(inputs_dir)
file = "/home/john.doe/MyProject/project.cpp"
cmds = cdb.getCompileCommands(file)
self.assertEqual(len(cmds), 1)
Expand All @@ -119,7 +119,7 @@ def test_1_compilecommand(self):

def test_2_compilecommand(self):
"""Check file with 2 compile commands"""
cdb = CompilationDatabase.fromDirectory(kInputsDir)
cdb = CompilationDatabase.fromDirectory(inputs_dir)
cmds = cdb.getCompileCommands("/home/john.doe/MyProject/project2.cpp")
self.assertEqual(len(cmds), 2)
expected = [
Expand Down Expand Up @@ -154,23 +154,23 @@ def test_2_compilecommand(self):

def test_compilecommand_iterator_stops(self):
"""Check that iterator stops after the correct number of elements"""
cdb = CompilationDatabase.fromDirectory(kInputsDir)
cdb = CompilationDatabase.fromDirectory(inputs_dir)
count = 0
for cmd in cdb.getCompileCommands("/home/john.doe/MyProject/project2.cpp"):
count += 1
self.assertLessEqual(count, 2)

def test_compilationDB_references(self):
"""Ensure CompilationsCommands are independent of the database"""
cdb = CompilationDatabase.fromDirectory(kInputsDir)
cdb = CompilationDatabase.fromDirectory(inputs_dir)
cmds = cdb.getCompileCommands("/home/john.doe/MyProject/project.cpp")
del cdb
gc.collect()
cmds[0].directory

def test_compilationCommands_references(self):
"""Ensure CompilationsCommand keeps a reference to CompilationCommands"""
cdb = CompilationDatabase.fromDirectory(kInputsDir)
cdb = CompilationDatabase.fromDirectory(inputs_dir)
cmds = cdb.getCompileCommands("/home/john.doe/MyProject/project.cpp")
del cdb
cmd0 = cmds[0]
Expand Down
26 changes: 13 additions & 13 deletions clang/bindings/python/tests/cindex/test_cursor.py
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@

from .util import get_cursor, get_cursors, get_tu

kInput = """\
children_test = """\
struct s0 {
int a;
int b;
Expand All @@ -41,23 +41,23 @@
}
"""

kParentTest = """\
parent_test = """\
class C {
void f();
}

void C::f() { }
"""

kTemplateArgTest = """\
template_arg_test = """\
template <int kInt, typename T, bool kBool>
void foo();

template<>
void foo<-7, float, true>();
"""

kBinops = """\
binops = """\
struct C {
int m;
};
Expand Down Expand Up @@ -118,7 +118,7 @@ class C {

class TestCursor(unittest.TestCase):
def test_get_children(self):
tu = get_tu(kInput)
tu = get_tu(children_test)

it = tu.cursor.get_children()
tu_nodes = list(it)
Expand Down Expand Up @@ -613,15 +613,15 @@ def test_underlying_type(self):
self.assertEqual(underlying.kind, TypeKind.INT)

def test_semantic_parent(self):
tu = get_tu(kParentTest, "cpp")
tu = get_tu(parent_test, "cpp")
curs = get_cursors(tu, "f")
decl = get_cursor(tu, "C")
self.assertEqual(len(curs), 2)
self.assertEqual(curs[0].semantic_parent, curs[1].semantic_parent)
self.assertEqual(curs[0].semantic_parent, decl)

def test_lexical_parent(self):
tu = get_tu(kParentTest, "cpp")
tu = get_tu(parent_test, "cpp")
curs = get_cursors(tu, "f")
decl = get_cursor(tu, "C")
self.assertEqual(len(curs), 2)
Expand Down Expand Up @@ -865,13 +865,13 @@ def test_get_arguments(self):
self.assertEqual(arguments[1].spelling, "j")

def test_get_num_template_arguments(self):
tu = get_tu(kTemplateArgTest, lang="cpp")
tu = get_tu(template_arg_test, lang="cpp")
foos = get_cursors(tu, "foo")

self.assertEqual(foos[1].get_num_template_arguments(), 3)

def test_get_template_argument_kind(self):
tu = get_tu(kTemplateArgTest, lang="cpp")
tu = get_tu(template_arg_test, lang="cpp")
foos = get_cursors(tu, "foo")

self.assertEqual(
Expand All @@ -885,20 +885,20 @@ def test_get_template_argument_kind(self):
)

def test_get_template_argument_type(self):
tu = get_tu(kTemplateArgTest, lang="cpp")
tu = get_tu(template_arg_test, lang="cpp")
foos = get_cursors(tu, "foo")

self.assertEqual(foos[1].get_template_argument_type(1).kind, TypeKind.FLOAT)

def test_get_template_argument_value(self):
tu = get_tu(kTemplateArgTest, lang="cpp")
tu = get_tu(template_arg_test, lang="cpp")
foos = get_cursors(tu, "foo")

self.assertEqual(foos[1].get_template_argument_value(0), -7)
self.assertEqual(foos[1].get_template_argument_value(2), True)

def test_get_template_argument_unsigned_value(self):
tu = get_tu(kTemplateArgTest, lang="cpp")
tu = get_tu(template_arg_test, lang="cpp")
foos = get_cursors(tu, "foo")

self.assertEqual(foos[1].get_template_argument_unsigned_value(0), 2**32 - 7)
Expand Down Expand Up @@ -930,7 +930,7 @@ def test_mangled_name(self):
)

def test_binop(self):
tu = get_tu(kBinops, lang="cpp")
tu = get_tu(binops, lang="cpp")

operators = {
# not exposed yet
Expand Down
6 changes: 3 additions & 3 deletions clang/bindings/python/tests/cindex/test_index.py
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@

import unittest

kInputsDir = os.path.join(os.path.dirname(__file__), "INPUTS")
inputs_dir = os.path.join(os.path.dirname(__file__), "INPUTS")


class TestIndex(unittest.TestCase):
Expand All @@ -19,7 +19,7 @@ def test_create(self):
def test_parse(self):
index = Index.create()
self.assertIsInstance(index, Index)
tu = index.parse(os.path.join(kInputsDir, "hello.cpp"))
tu = index.parse(os.path.join(inputs_dir, "hello.cpp"))
self.assertIsInstance(tu, TranslationUnit)
tu = index.parse(None, ["-c", os.path.join(kInputsDir, "hello.cpp")])
tu = index.parse(None, ["-c", os.path.join(inputs_dir, "hello.cpp")])
self.assertIsInstance(tu, TranslationUnit)
16 changes: 8 additions & 8 deletions clang/bindings/python/tests/cindex/test_location.py
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@

from .util import get_cursor, get_tu

baseInput = "int one;\nint two;\n"
base_input = "int one;\nint two;\n"


class TestLocation(unittest.TestCase):
Expand All @@ -26,7 +26,7 @@ def assert_location(self, loc, line, column, offset):
self.assertEqual(loc.offset, offset)

def test_location(self):
tu = get_tu(baseInput)
tu = get_tu(base_input)
one = get_cursor(tu, "one")
two = get_cursor(tu, "two")

Expand All @@ -37,7 +37,7 @@ def test_location(self):
self.assert_location(two.location, line=2, column=5, offset=13)

# adding a linebreak at top should keep columns same
tu = get_tu("\n" + baseInput)
tu = get_tu("\n" + base_input)
one = get_cursor(tu, "one")
two = get_cursor(tu, "two")

Expand All @@ -48,7 +48,7 @@ def test_location(self):
self.assert_location(two.location, line=3, column=5, offset=14)

# adding a space should affect column on first line only
tu = get_tu(" " + baseInput)
tu = get_tu(" " + base_input)
one = get_cursor(tu, "one")
two = get_cursor(tu, "two")

Expand All @@ -57,7 +57,7 @@ def test_location(self):

# define the expected location ourselves and see if it matches
# the returned location
tu = get_tu(baseInput)
tu = get_tu(base_input)

file = File.from_name(tu, "t.c")
location = SourceLocation.from_position(tu, file, 1, 5)
Expand All @@ -83,20 +83,20 @@ def test_location(self):
self.assertTrue(verified)

def test_extent(self):
tu = get_tu(baseInput)
tu = get_tu(base_input)
one = get_cursor(tu, "one")
two = get_cursor(tu, "two")

self.assert_location(one.extent.start, line=1, column=1, offset=0)
self.assert_location(one.extent.end, line=1, column=8, offset=7)
self.assertEqual(
baseInput[one.extent.start.offset : one.extent.end.offset], "int one"
base_input[one.extent.start.offset : one.extent.end.offset], "int one"
)

self.assert_location(two.extent.start, line=2, column=1, offset=9)
self.assert_location(two.extent.end, line=2, column=8, offset=16)
self.assertEqual(
baseInput[two.extent.start.offset : two.extent.end.offset], "int two"
base_input[two.extent.start.offset : two.extent.end.offset], "int two"
)

file = File.from_name(tu, "t.c")
Expand Down
Loading