[PATCH v2] gen_compile_commands.py: fix path resolve with symlinks in it

From: Jialu Xu
Date: Mon Dec 04 2023 - 21:17:34 EST


When symbolic links are involved in the path, os.path.abspath might not
resolve the symlinks and instead return the absolute path with the
symlinks intact.

Use pathlib.Path resolve() instead of os.path.abspath()

Signed-off-by: Jialu Xu <xujialu@xxxxxxxxx>
---
scripts/clang-tools/gen_compile_commands.py | 6 ++++--
1 file changed, 4 insertions(+), 2 deletions(-)

diff --git a/scripts/clang-tools/gen_compile_commands.py b/scripts/clang-tools/gen_compile_commands.py
index 180952fb91c1b..99e28b7152c19 100755
--- a/scripts/clang-tools/gen_compile_commands.py
+++ b/scripts/clang-tools/gen_compile_commands.py
@@ -11,6 +11,7 @@ import argparse
import json
import logging
import os
+from pathlib import Path
import re
import subprocess
import sys
@@ -172,8 +173,9 @@ def process_line(root_directory, command_prefix, file_path):
# by Make, so this code replaces the escaped version with '#'.
prefix = command_prefix.replace('\#', '#').replace('$(pound)', '#')

- # Use os.path.abspath() to normalize the path resolving '.' and '..' .
- abs_path = os.path.abspath(os.path.join(root_directory, file_path))
+ # Make the path absolute, resolving all symlinks on the way and also normalizing it.
+ # Convert Path object to a string because 'PosixPath' is not JSON serializable.
+ abs_path = str(Path(root_directory, file_path).resolve())
if not os.path.exists(abs_path):
raise ValueError('File %s not found' % abs_path)
return {
--
2.39.2