Fix pre-commit issues

Author: Takishima

cmake_pc_hooks/_argparse.py

@@ -25,6 +25,8 @@
 
 import toml
 
+log = logging.getLogger(__name__)
+
 # ==============================================================================
 
 
@@ -110,7 +112,11 @@ def executable_path(path: str) -> Path:
 
 
 def _load_data_from_toml(
-    path: Path, section: str, *, path_must_exist: bool = True, section_must_exist: bool = True
+    path: Path,
+    section: str,
+    *,
+    path_must_exist: bool = True,
+    section_must_exist: bool = True,
 ) -> dict:
     """
     Load a TOML file and return the corresponding config dictionary.
@@ -127,23 +133,23 @@ def _load_data_from_toml(
         section_must_exist: Whether a missing section in the TOML file is considered an error or not
     """
     try:
-        with path.open(mode='r') as fd:
+        with path.open(mode='r', encoding='utf-8') as fd:
             config = toml.load(fd)
         if section:
             for sub_section in section.split('.'):
                 config = config[sub_section]
-            logging.debug('Loading data from %s table of %s', section, path)
+            log.debug('Loading data from %s table of %s', section, path)
         else:
             config = {key: value for key, value in config.items() if not isinstance(value, dict)}
-            logging.debug('Loading data from root table of %s', path)
+            log.debug('Loading data from root table of %s', path)
     except FileNotFoundError as err:
         if path_must_exist:
             raise TOMLFileNotFoundError(path) from err
-        logging.debug('TOML file %s does not exist (not an error)', str(path))
+        log.debug('TOML file %s does not exist (not an error)', str(path))
     except KeyError as err:
         if section_must_exist:
             raise TOMLSectionKeyError(section, path) from err
-        logging.debug('TOML file %s does not have a %s section (not an error)', str(path), section)
+        log.debug('TOML file %s does not have a %s section (not an error)', str(path), section)
     else:
         return config
     return {}
@@ -245,7 +251,9 @@ def parse_known_args(
 
         if self._default_config_name is not None:
             namespace = self._load_from_toml(
-                namespace=namespace, path=Path(self._default_config_name), path_must_exist=False
+                namespace=namespace,
+                path=Path(self._default_config_name),
+                path_must_exist=False,
             )
 
         namespace, args = super().parse_known_args(args=args, namespace=namespace)
@@ -265,11 +273,13 @@ def parse_known_args(
         if namespace.dump_toml:
             exclude_keys = {'positionals', 'dump_toml'}
             print(
-                toml.dumps({
-                    key: value
-                    for key, value in vars(namespace).items()
-                    if value != self._default_args[key] and key not in exclude_keys
-                })
+                toml.dumps(
+                    {
+                        key: value
+                        for key, value in vars(namespace).items()
+                        if value != self._default_args[key] and key not in exclude_keys
+                    }
+                )
             )
             sys.exit(0)
 
@@ -297,7 +307,10 @@ def _load_from_toml(  # noqa: PLR0913
             overridable_keys: List of keys that can be overridden by values in the TOML file
         """
         config = _load_data_from_toml(
-            path, section, path_must_exist=path_must_exist, section_must_exist=section_must_exist
+            path,
+            section,
+            path_must_exist=path_must_exist,
+            section_must_exist=section_must_exist,
         )
 
         for key, value in config.items():
@@ -309,9 +322,9 @@ def _load_from_toml(  # noqa: PLR0913
             if default_value is not None and not isinstance(value, type(default_value)):
                 raise TOMLTypeError(type(value), type(default_value), key)
             if overridable_keys is not None and key not in overridable_keys:
-                logging.debug('  skipping non-overridable key: "%s"', key)
+                log.debug('  skipping non-overridable key: "%s"', key)
                 continue
 
-            logging.debug('  setting %s = %s', key, value)
+            log.debug('  setting %s = %s', key, value)
             setattr(namespace, key, value)
         return namespace

cmake_pc_hooks/_call_process.py

@@ -22,6 +22,8 @@
 
 import attrs
 
+log = logging.getLogger(__name__)
+
 
 @attrs.define(slots=True)
 class History:  # pylint: disable=too-few-public-methods
@@ -64,9 +66,9 @@ def call_process(args: list, **kwargs: any) -> History:
     else:
         ret = History(sp_child.stdout.decode(), sp_child.stderr.decode(), sp_child.returncode)
 
-    logging.debug('command `%s` exited with %d', ' '.join(args), ret.returncode)
+    log.debug('command `%s` exited with %d', ' '.join(args), ret.returncode)
     for line in ret.stdout.split('\n'):
-        logging.debug('(stdout) %s', line)
+        log.debug('(stdout) %s', line)
     for line in ret.stderr.split('\n'):
-        logging.debug('(stderr) %s', line)
+        log.debug('(stderr) %s', line)
     return ret

cmake_pc_hooks/_cmake.py

@@ -32,6 +32,8 @@
 
 from . import _argparse, _call_process
 
+log = logging.getLogger(__name__)
+
 # ==============================================================================
 
 
@@ -267,7 +269,7 @@ def resolve_build_directory(self, build_dir_list=None, *, automatic_discovery=Tr
         build_dir_list = [] if build_dir_list is None else [Path(path) for path in build_dir_list]
         for build_dir in build_dir_list:
             if build_dir.exists() and Path(build_dir, 'CMakeCache.txt').exists():
-                logging.debug(
+                log.debug(
                     'Located valid build directory with CMakeCache.txt at: %s',
                     str(build_dir),
                 )
@@ -278,20 +280,20 @@ def resolve_build_directory(self, build_dir_list=None, *, automatic_discovery=Tr
         if automatic_discovery:
             for path in sorted(self.source_dir.glob('*')):
                 if path.is_dir() and (path / 'CMakeCache.txt').exists():
-                    logging.info('Automatic build dir discovery resulted in: %s', str(path))
+                    log.info('Automatic build dir discovery resulted in: %s', str(path))
                     self.build_dir = path
                     return
 
         if self.no_cmake_configure:
-            logging.info('Unable to locate a valid build directory. Will not be creating one')
+            log.info('Unable to locate a valid build directory. Will not be creating one')
             self.build_dir = None
             return
 
         if not build_dir_list:
             self.build_dir = self.source_dir / self.DEFAULT_BUILD_DIR
         else:
             self.build_dir = Path(build_dir_list[0]).resolve()
-        logging.info(
+        log.info(
             'Unable to locate a valid build directory. Will be creating one at %s',
             str(self.build_dir),
         )
@@ -379,11 +381,11 @@ def configure(self, command, *, clean_build=False):
             clean_build (bool): Clean build directory before calling CMake configure
         """
         if self.no_cmake_configure:
-            logging.debug('Not calling CMake configure')
+            log.debug('Not calling CMake configure')
             return
 
         if self.source_dir is None:
-            logging.error('No source dir was for CMake! Did you call `setup_cmake_args()`?')
+            log.error('No source dir was for CMake! Did you call `setup_cmake_args()`?')
             sys.exit(1)
 
         cmake_configure_lock_file = Path(self.build_dir, '_cmake_configure_lock')
@@ -396,7 +398,7 @@ def configure(self, command, *, clean_build=False):
         try:
             with cmake_configure_try_lock.acquire(blocking=False):  # noqa: SIM117
                 with cmake_configure_lock.write_lock():
-                    logging.debug(
+                    log.debug(
                         'Command %s with id %s is running CMake configure',
                         command,
                         os.getpid(),
@@ -408,23 +410,23 @@ def configure(self, command, *, clean_build=False):
                         ),
                         clean_build=clean_build,
                     )
-                    logging.debug(
+                    log.debug(
                         'Command %s with id %s is done running CMake configure',
                         command,
                         os.getpid(),
                     )
         except filelock.Timeout:
-            logging.debug(
+            log.debug(
                 'Command %s with id %s is not running CMake configure and waiting',
                 command,
                 os.getpid(),
             )
             with cmake_configure_lock.read_lock():
-                logging.debug('Command %s with id %s is done waiting', command, os.getpid())
+                log.debug('Command %s with id %s is done waiting', command, os.getpid())
                 returncode = 0
 
         if returncode != 0:
-            logging.error('CMake configure step failed. See output for more information.')
+            log.error('CMake configure step failed. See output for more information.')
             sys.exit(returncode)
 
         if self.cmake_trace_log is not None:
@@ -439,12 +441,14 @@ def _call_cmake(self, extra_args=None):
             [*command, str(self.source_dir), *self.cmake_args, *extra_args],
             cwd=str(self.build_dir),
         )
-        result.stdout = '\n'.join([
-            f'Running CMake with: {[*command, str(self.source_dir), *self.cmake_args]}',
-            f'  from within {self.build_dir}',
-            result.stdout,
-            '',
-        ])
+        result.stdout = '\n'.join(
+            [
+                f'Running CMake with: {[*command, str(self.source_dir), *self.cmake_args]}',
+                f'  from within {self.build_dir}',
+                result.stdout,
+                '',
+            ]
+        )
 
         return result
 
@@ -461,11 +465,13 @@ def _configure(self, lock_files, clean_build):
 
         extra_args = []
         if self.cmake_trace_log:
-            extra_args.extend([
-                '--trace-expand',
-                '--trace-format=json-v1',
-                f'--trace-redirect={self.cmake_trace_log}',
-            ])
+            extra_args.extend(
+                [
+                    '--trace-expand',
+                    '--trace-format=json-v1',
+                    f'--trace-redirect={self.cmake_trace_log}',
+                ]
+            )
 
         result = self._call_cmake(extra_args=extra_args)
 
@@ -480,16 +486,16 @@ def _configure(self, lock_files, clean_build):
         return result.returncode
 
     def _parse_cmake_trace_log(self):
-        logging.info('attempting to parse CMake trace log to detect calls to configure_file()')
+        log.info('attempting to parse CMake trace log to detect calls to configure_file()')
         self.cmake_configured_files = []
 
         if not self.cmake_trace_log:
-            logging.info('no trace log provided, aborting.')
+            log.info('no trace log provided, aborting.')
             return
 
         result = self._call_cmake(extra_args=['-N', '-LA'])
         if result.returncode != 0:
-            logging.error('failed to retrieve CMake cache variables')
+            log.error('failed to retrieve CMake cache variables')
             return
 
         cmake_cache_variables = {}
@@ -524,7 +530,7 @@ def _is_relevant_configure_file_call(json_data):
             input_file, configured_file = (Path(arg) for arg in configure_file_call['args'][:2])
             if not configured_file.is_absolute():
                 configured_file = self.build_dir / configured_file
-            logging.debug(
+            log.debug(
                 'detected call to configure_file(%s %s [...])',
                 str(input_file),
                 str(configured_file),

cmake_pc_hooks/_utils.py

@@ -31,6 +31,8 @@
 logging.basicConfig(level=_LOGLEVEL, format='%(levelname)-5s:cmake-pc-hooks:%(message)s')
 logging.getLogger('filelock').setLevel(logging.WARNING)
 
+log = logging.getLogger(__name__)
+
 
 class CMakePresetError(Exception):
     """Exception raised if a command line incompatibility with --preset is detected."""
@@ -88,8 +90,7 @@ def parse_args(self, args):
             '--read-json-db',
             action='store_true',
             help=(
-                'Run hooks on files found in compile_commands.json '
-                '(if found and in addition to files specified on CLI)'
+                'Run hooks on files found in compile_commands.json (if found and in addition to files specified on CLI)'
             ),
         )
 
@@ -137,7 +138,7 @@ def run(self):
             for filename in self.files:
                 self.run_command([filename])
         else:
-            logging.error('No files to process!')
+            log.error('No files to process!')
             sys.exit(1)
 
         has_errors = False
@@ -172,9 +173,9 @@ def _resolve_compilation_database(cmake_build_dir: Path, build_dir_list: list[Pa
         for build_dir in build_dir_list:
             path = Path(build_dir, 'compile_commands.json')
             if build_dir.exists() and path.exists():
-                logging.debug('Located valid compilation database at: %s', str(path))
+                log.debug('Located valid compilation database at: %s', str(path))
                 return path
-        logging.debug('No valid compilation database located')
+        log.debug('No valid compilation database located')
         return None
 
 

cmake_pc_hooks/clang_tidy.py

@@ -32,12 +32,13 @@ def __init__(self, args):
         self.parse_args(args)
         self.edit_in_place = '-fix' in self.args or '--fix-errors' in self.args
         self.handle_ddash_args()
+        self.log = logging.getLogger(__name__)
 
         compile_db = self._resolve_compilation_database(self.cmake.build_dir, self.build_dir_list)
         if not self.cmake.no_cmake_configure or compile_db:
             self.add_if_missing([f'-p={compile_db}'])
 
-    def _parse_output(self, result):  # noqa: PLR6301
+    def _parse_output(self, result):
         """
         Parse output and check whether some errors occurred.
 
@@ -51,8 +52,8 @@ def _parse_output(self, result):  # noqa: PLR6301
         if not result.stdout or 'non-user code' in result.stderr:
             result.stderr = ''
 
-        logging.debug('returncode %d', result.returncode)
-        logging.debug('parsing output from %s', result.stderr)
+        self.log.debug('returncode %d', result.returncode)
+        self.log.debug('parsing output from %s', result.stderr)
         return result.returncode != 0 or any(
             msg in result.stderr
             for msg in (

cmake_pc_hooks/cppcheck.py

@@ -38,6 +38,7 @@ def __init__(self, args):
         self.add_if_missing(['--error-exitcode=1'])
         # Enable all of the checks
         self.add_if_missing(['--enable=all'])
+        self.log = logging.getLogger(__name__)
 
         compile_db = self._resolve_compilation_database(self.cmake.build_dir, self.build_dir_list)
         if not self.cmake.no_cmake_configure or compile_db:
@@ -60,11 +61,11 @@ def _parse_output(self, result):
             False if no errors were detected, True in all other cases.
         """
         # Useless error see https://stackoverflow.com/questions/6986033
-        logging.debug('parsing output from %s', result.stderr)
+        self.log.debug('parsing output from %s', result.stderr)
         useless_error_part = 'Cppcheck cannot find all the include files'
-        result.stderr = ''.join([
-            line for line in result.stderr.splitlines(keepends=True) if useless_error_part not in line
-        ])
+        result.stderr = ''.join(
+            [line for line in result.stderr.splitlines(keepends=True) if useless_error_part not in line]
+        )
         self._clinters_compat()
         return result.returncode != 0