[clang] [libclang/python] Change all global variables to CAPS (PR #132930)
Jannick Kremer via cfe-commits
cfe-commits at lists.llvm.org
Tue Mar 25 06:02:32 PDT 2025
https://github.com/DeinAlptraum created https://github.com/llvm/llvm-project/pull/132930
None
>From f12efcc1c80f35f73934b90df7d4aaff8d2b0235 Mon Sep 17 00:00:00 2001
From: Jannick Kremer <jannick.kremer at mailbox.org>
Date: Tue, 25 Mar 2025 21:58:31 +0900
Subject: [PATCH] [libclang/python] Change all global variables to CAPS
---
clang/bindings/python/clang/cindex.py | 10 +++---
.../bindings/python/tests/cindex/test_cdb.py | 20 ++++++------
.../python/tests/cindex/test_cursor.py | 30 ++++++++---------
.../python/tests/cindex/test_index.py | 6 ++--
.../python/tests/cindex/test_location.py | 16 +++++-----
.../tests/cindex/test_translation_unit.py | 32 +++++++++----------
.../bindings/python/tests/cindex/test_type.py | 8 ++---
7 files changed, 61 insertions(+), 61 deletions(-)
diff --git a/clang/bindings/python/clang/cindex.py b/clang/bindings/python/clang/cindex.py
index 3dffa88e60193..2319534a6f121 100644
--- a/clang/bindings/python/clang/cindex.py
+++ b/clang/bindings/python/clang/cindex.py
@@ -2802,7 +2802,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.
-spelling_cache = {
+SPELLING_CACHE = {
# 0: CompletionChunk.Kind("Optional"),
# 1: CompletionChunk.Kind("TypedText"),
# 2: CompletionChunk.Kind("Text"),
@@ -2848,8 +2848,8 @@ def __repr__(self):
@CachedProperty
def spelling(self):
- if self.__kindNumber in spelling_cache:
- return spelling_cache[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)
)
@@ -3846,7 +3846,7 @@ def set_property(self, property, value):
fields_visit_callback = CFUNCTYPE(c_int, Cursor, py_object)
# Functions strictly alphabetical order.
-function_list: list[LibFunc] = [
+FUNCTION_LIST: list[LibFunc] = [
(
"clang_annotateTokens",
[TranslationUnit, POINTER(Token), c_uint, POINTER(Cursor)],
@@ -4125,7 +4125,7 @@ def register_functions(lib: CDLL, ignore_errors: bool) -> None:
def register(item: LibFunc) -> None:
register_function(lib, item, ignore_errors)
- for f in function_list:
+ for f in FUNCTION_LIST:
register(f)
diff --git a/clang/bindings/python/tests/cindex/test_cdb.py b/clang/bindings/python/tests/cindex/test_cdb.py
index 6e31119206168..757a14fbaef2c 100644
--- a/clang/bindings/python/tests/cindex/test_cdb.py
+++ b/clang/bindings/python/tests/cindex/test_cdb.py
@@ -10,7 +10,7 @@
import sys
from pathlib import Path
-inputs_dir = 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")
@@ -34,23 +34,23 @@ def test_create_fail(self):
def test_create(self):
"""Check we can load a compilation database"""
- CompilationDatabase.fromDirectory(inputs_dir)
+ CompilationDatabase.fromDirectory(INPUTS_DIR)
def test_lookup_succeed(self):
"""Check we get some results if the file exists in the db"""
- cdb = CompilationDatabase.fromDirectory(inputs_dir)
+ 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(inputs_dir))
+ 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(inputs_dir)
+ cdb = CompilationDatabase.fromDirectory(INPUTS_DIR)
cmds = cdb.getAllCompileCommands()
self.assertEqual(len(cmds), 3)
expected = [
@@ -100,7 +100,7 @@ def test_all_compilecommand(self):
def test_1_compilecommand(self):
"""Check file with single compile command"""
- cdb = CompilationDatabase.fromDirectory(inputs_dir)
+ cdb = CompilationDatabase.fromDirectory(INPUTS_DIR)
file = "/home/john.doe/MyProject/project.cpp"
cmds = cdb.getCompileCommands(file)
self.assertEqual(len(cmds), 1)
@@ -119,7 +119,7 @@ def test_1_compilecommand(self):
def test_2_compilecommand(self):
"""Check file with 2 compile commands"""
- cdb = CompilationDatabase.fromDirectory(inputs_dir)
+ cdb = CompilationDatabase.fromDirectory(INPUTS_DIR)
cmds = cdb.getCompileCommands("/home/john.doe/MyProject/project2.cpp")
self.assertEqual(len(cmds), 2)
expected = [
@@ -154,7 +154,7 @@ def test_2_compilecommand(self):
def test_compilecommand_iterator_stops(self):
"""Check that iterator stops after the correct number of elements"""
- cdb = CompilationDatabase.fromDirectory(inputs_dir)
+ cdb = CompilationDatabase.fromDirectory(INPUTS_DIR)
count = 0
for cmd in cdb.getCompileCommands("/home/john.doe/MyProject/project2.cpp"):
count += 1
@@ -162,7 +162,7 @@ def test_compilecommand_iterator_stops(self):
def test_compilationDB_references(self):
"""Ensure CompilationsCommands are independent of the database"""
- cdb = CompilationDatabase.fromDirectory(inputs_dir)
+ cdb = CompilationDatabase.fromDirectory(INPUTS_DIR)
cmds = cdb.getCompileCommands("/home/john.doe/MyProject/project.cpp")
del cdb
gc.collect()
@@ -170,7 +170,7 @@ def test_compilationDB_references(self):
def test_compilationCommands_references(self):
"""Ensure CompilationsCommand keeps a reference to CompilationCommands"""
- cdb = CompilationDatabase.fromDirectory(inputs_dir)
+ cdb = CompilationDatabase.fromDirectory(INPUTS_DIR)
cmds = cdb.getCompileCommands("/home/john.doe/MyProject/project.cpp")
del cdb
cmd0 = cmds[0]
diff --git a/clang/bindings/python/tests/cindex/test_cursor.py b/clang/bindings/python/tests/cindex/test_cursor.py
index 5f38b1fe0d825..82f40c60afa59 100644
--- a/clang/bindings/python/tests/cindex/test_cursor.py
+++ b/clang/bindings/python/tests/cindex/test_cursor.py
@@ -22,7 +22,7 @@
from .util import get_cursor, get_cursors, get_tu
-children_test = """\
+CHILDREN_TEST = """\
struct s0 {
int a;
int b;
@@ -42,7 +42,7 @@
}
"""
-parent_test = """\
+PARENT_TEST = """\
class C {
void f();
}
@@ -50,7 +50,7 @@ class C {
void C::f() { }
"""
-template_arg_test = """\
+TEMPLATE_ARG_TEST = """\
template <int kInt, typename T, bool kBool>
void foo();
@@ -58,7 +58,7 @@ class C {
void foo<-7, float, true>();
"""
-binops = """\
+BINOPS = """\
struct C {
int m;
};
@@ -119,7 +119,7 @@ class C {
class TestCursor(unittest.TestCase):
def test_get_children(self):
- tu = get_tu(children_test)
+ tu = get_tu(CHILDREN_TEST)
it = tu.cursor.get_children()
tu_nodes = list(it)
@@ -614,7 +614,7 @@ def test_underlying_type(self):
self.assertEqual(underlying.kind, TypeKind.INT)
def test_semantic_parent(self):
- tu = get_tu(parent_test, "cpp")
+ tu = get_tu(PARENT_TEST, "cpp")
curs = get_cursors(tu, "f")
decl = get_cursor(tu, "C")
self.assertEqual(len(curs), 2)
@@ -622,7 +622,7 @@ def test_semantic_parent(self):
self.assertEqual(curs[0].semantic_parent, decl)
def test_lexical_parent(self):
- tu = get_tu(parent_test, "cpp")
+ tu = get_tu(PARENT_TEST, "cpp")
curs = get_cursors(tu, "f")
decl = get_cursor(tu, "C")
self.assertEqual(len(curs), 2)
@@ -866,13 +866,13 @@ def test_get_arguments(self):
self.assertEqual(arguments[1].spelling, "j")
def test_get_num_template_arguments(self):
- tu = get_tu(template_arg_test, 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(template_arg_test, lang="cpp")
+ tu = get_tu(TEMPLATE_ARG_TEST, lang="cpp")
foos = get_cursors(tu, "foo")
self.assertEqual(
@@ -886,20 +886,20 @@ def test_get_template_argument_kind(self):
)
def test_get_template_argument_type(self):
- tu = get_tu(template_arg_test, 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(template_arg_test, 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(template_arg_test, 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)
@@ -931,7 +931,7 @@ def test_mangled_name(self):
)
def test_binop(self):
- tu = get_tu(binops, lang="cpp")
+ tu = get_tu(BINOPS, lang="cpp")
operators = {
# not exposed yet
@@ -1004,7 +1004,7 @@ def accumulate_cursors(cursor: Cursor, all_cursors: list):
all_cursors = accumulate_cursors(child, all_cursors)
return all_cursors
- tu = get_tu(children_test)
+ tu = get_tu(CHILDREN_TEST)
all_cursors = accumulate_cursors(tu.cursor, [])
cursor_hashes = set()
for cursor in all_cursors:
@@ -1028,7 +1028,7 @@ def test_has_attrs(self):
self.assertFalse(B.get_definition().has_attrs())
def test_specialized_template(self):
- tu = get_tu(template_arg_test, lang="cpp")
+ tu = get_tu(TEMPLATE_ARG_TEST, lang="cpp")
foos = get_cursors(tu, "foo")
prime_foo = foos[1].specialized_template
diff --git a/clang/bindings/python/tests/cindex/test_index.py b/clang/bindings/python/tests/cindex/test_index.py
index 46ae2da18aa04..f3d3ac00e5f7b 100644
--- a/clang/bindings/python/tests/cindex/test_index.py
+++ b/clang/bindings/python/tests/cindex/test_index.py
@@ -7,7 +7,7 @@
import unittest
-inputs_dir = os.path.join(os.path.dirname(__file__), "INPUTS")
+INPUTS_DIR = os.path.join(os.path.dirname(__file__), "INPUTS")
class TestIndex(unittest.TestCase):
@@ -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(inputs_dir, "hello.cpp"))
+ tu = index.parse(os.path.join(INPUTS_DIR, "hello.cpp"))
self.assertIsInstance(tu, TranslationUnit)
- tu = index.parse(None, ["-c", os.path.join(inputs_dir, "hello.cpp")])
+ tu = index.parse(None, ["-c", os.path.join(INPUTS_DIR, "hello.cpp")])
self.assertIsInstance(tu, TranslationUnit)
diff --git a/clang/bindings/python/tests/cindex/test_location.py b/clang/bindings/python/tests/cindex/test_location.py
index 19867877ea227..21c6169bb0a6f 100644
--- a/clang/bindings/python/tests/cindex/test_location.py
+++ b/clang/bindings/python/tests/cindex/test_location.py
@@ -16,7 +16,7 @@
from .util import get_cursor, get_tu
-base_input = "int one;\nint two;\n"
+BASE_INPUT = "int one;\nint two;\n"
class TestLocation(unittest.TestCase):
@@ -26,7 +26,7 @@ def assert_location(self, loc, line, column, offset):
self.assertEqual(loc.offset, offset)
def test_location(self):
- tu = get_tu(base_input)
+ tu = get_tu(BASE_INPUT)
one = get_cursor(tu, "one")
two = get_cursor(tu, "two")
@@ -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" + base_input)
+ tu = get_tu("\n" + BASE_INPUT)
one = get_cursor(tu, "one")
two = get_cursor(tu, "two")
@@ -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(" " + base_input)
+ tu = get_tu(" " + BASE_INPUT)
one = get_cursor(tu, "one")
two = get_cursor(tu, "two")
@@ -57,7 +57,7 @@ def test_location(self):
# define the expected location ourselves and see if it matches
# the returned location
- tu = get_tu(base_input)
+ tu = get_tu(BASE_INPUT)
file = File.from_name(tu, "t.c")
location = SourceLocation.from_position(tu, file, 1, 5)
@@ -83,20 +83,20 @@ def test_location(self):
self.assertTrue(verified)
def test_extent(self):
- tu = get_tu(base_input)
+ 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(
- base_input[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(
- base_input[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")
diff --git a/clang/bindings/python/tests/cindex/test_translation_unit.py b/clang/bindings/python/tests/cindex/test_translation_unit.py
index 9387358f88ea2..272cf05bed7b7 100644
--- a/clang/bindings/python/tests/cindex/test_translation_unit.py
+++ b/clang/bindings/python/tests/cindex/test_translation_unit.py
@@ -24,7 +24,7 @@
from .util import get_cursor, get_tu
-inputs_dir = os.path.join(os.path.dirname(__file__), "INPUTS")
+INPUTS_DIR = os.path.join(os.path.dirname(__file__), "INPUTS")
@contextmanager
@@ -51,26 +51,26 @@ def save_tu_pathlike(tu):
class TestTranslationUnit(unittest.TestCase):
def test_spelling(self):
- path = os.path.join(inputs_dir, "hello.cpp")
+ path = os.path.join(INPUTS_DIR, "hello.cpp")
tu = TranslationUnit.from_source(path)
self.assertEqual(tu.spelling, path)
def test_cursor(self):
- path = os.path.join(inputs_dir, "hello.cpp")
+ path = os.path.join(INPUTS_DIR, "hello.cpp")
tu = get_tu(path)
c = tu.cursor
self.assertIsInstance(c, Cursor)
self.assertIs(c.kind, CursorKind.TRANSLATION_UNIT)
def test_parse_arguments(self):
- path = os.path.join(inputs_dir, "parse_arguments.c")
+ path = os.path.join(INPUTS_DIR, "parse_arguments.c")
tu = TranslationUnit.from_source(path, ["-DDECL_ONE=hello", "-DDECL_TWO=hi"])
spellings = [c.spelling for c in tu.cursor.get_children()]
self.assertEqual(spellings[-2], "hello")
self.assertEqual(spellings[-1], "hi")
def test_reparse_arguments(self):
- path = os.path.join(inputs_dir, "parse_arguments.c")
+ path = os.path.join(INPUTS_DIR, "parse_arguments.c")
tu = TranslationUnit.from_source(path, ["-DDECL_ONE=hello", "-DDECL_TWO=hi"])
tu.reparse()
spellings = [c.spelling for c in tu.cursor.get_children()]
@@ -150,10 +150,10 @@ def eq(expected, actual):
else:
self.assert_normpaths_equal(expected[1], actual.include.name)
- src = os.path.join(inputs_dir, "include.cpp")
- h1 = os.path.join(inputs_dir, "header1.h")
- h2 = os.path.join(inputs_dir, "header2.h")
- h3 = os.path.join(inputs_dir, "header3.h")
+ src = os.path.join(INPUTS_DIR, "include.cpp")
+ h1 = os.path.join(INPUTS_DIR, "header1.h")
+ h2 = os.path.join(INPUTS_DIR, "header2.h")
+ h3 = os.path.join(INPUTS_DIR, "header3.h")
inc = [(src, h1), (h1, h3), (src, h2), (h2, h3)]
tu = TranslationUnit.from_source(src)
@@ -161,10 +161,10 @@ def eq(expected, actual):
eq(i[0], i[1])
def test_inclusion_directive(self):
- src = os.path.join(inputs_dir, "include.cpp")
- h1 = os.path.join(inputs_dir, "header1.h")
- h2 = os.path.join(inputs_dir, "header2.h")
- h3 = os.path.join(inputs_dir, "header3.h")
+ src = os.path.join(INPUTS_DIR, "include.cpp")
+ h1 = os.path.join(INPUTS_DIR, "header1.h")
+ h2 = os.path.join(INPUTS_DIR, "header2.h")
+ h3 = os.path.join(INPUTS_DIR, "header3.h")
inc = [h1, h3, h2, h3, h1]
tu = TranslationUnit.from_source(
@@ -244,7 +244,7 @@ def test_load_pathlike(self):
del tu2
def test_index_parse(self):
- path = os.path.join(inputs_dir, "hello.cpp")
+ path = os.path.join(INPUTS_DIR, "hello.cpp")
index = Index.create()
tu = index.parse(path)
self.assertIsInstance(tu, TranslationUnit)
@@ -341,7 +341,7 @@ def test_get_tokens_gc(self):
gc.collect() # Just in case.
def test_fail_from_source(self):
- path = os.path.join(inputs_dir, "non-existent.cpp")
+ path = os.path.join(INPUTS_DIR, "non-existent.cpp")
try:
tu = TranslationUnit.from_source(path)
except TranslationUnitLoadError:
@@ -349,7 +349,7 @@ def test_fail_from_source(self):
self.assertEqual(tu, None)
def test_fail_from_ast_file(self):
- path = os.path.join(inputs_dir, "non-existent.ast")
+ path = os.path.join(INPUTS_DIR, "non-existent.ast")
try:
tu = TranslationUnit.from_ast_file(path)
except TranslationUnitLoadError:
diff --git a/clang/bindings/python/tests/cindex/test_type.py b/clang/bindings/python/tests/cindex/test_type.py
index 7b929065dec04..a9473e1dc2458 100644
--- a/clang/bindings/python/tests/cindex/test_type.py
+++ b/clang/bindings/python/tests/cindex/test_type.py
@@ -18,7 +18,7 @@
from .util import get_cursor, get_cursors, get_tu
-struct_input = """\
+STRUCT_INPUT = """\
typedef int I;
@@ -36,7 +36,7 @@
"""
-constarray_input = """
+CONSTARRAY_INPUT = """
struct teststruct {
void *A[2];
};
@@ -45,7 +45,7 @@
class TestType(unittest.TestCase):
def test_a_struct(self):
- tu = get_tu(struct_input)
+ tu = get_tu(STRUCT_INPUT)
teststruct = get_cursor(tu, "teststruct")
self.assertIsNotNone(teststruct, "Could not find teststruct.")
@@ -143,7 +143,7 @@ def test_references(self):
t.get_declaration()
def testConstantArray(self):
- tu = get_tu(constarray_input)
+ tu = get_tu(CONSTARRAY_INPUT)
teststruct = get_cursor(tu, "teststruct")
self.assertIsNotNone(teststruct, "Didn't find teststruct??")
More information about the cfe-commits
mailing list