feat: Adding linting rules to Ruff config, updating fixed file

Author: ecoussoux-ansys

doc/source/how-to/code/pyansys_logging.py

@@ -95,11 +95,11 @@ def log_to_stdout(self, level=LOG_LEVEL):
         self.logger = add_stdout_handler(self.logger, level=level)
         self.std_out_handler = self.logger.std_out_handler
 
-    def setLevel(self, level="DEBUG"):
+    def setlevel(self, level="DEBUG"):
         """Change the log level of the object and the attached handlers."""
-        self.logger.setLevel(level)
+        self.logger.setlevel(level)
         for each_handler in self.logger.handlers:
-            each_handler.setLevel(level)
+            each_handler.setlevel(level)
         self.level = level
 
 
@@ -194,7 +194,7 @@ def __init__(
 
         self.logger = logging.getLogger("pyproject_global")  # Creating default main logger.
         self.logger.addFilter(InstanceFilter())
-        self.logger.setLevel(level)
+        self.logger.setlevel(level)
         self.logger.propagate = True
         self.level = self.logger.level  # TODO: TO REMOVE
 
@@ -243,11 +243,11 @@ def log_to_stdout(self, level=LOG_LEVEL):
 
         self = add_stdout_handler(self, level=level)
 
-    def setLevel(self, level="DEBUG"):
+    def setlevel(self, level="DEBUG"):
         """Change the log level of the object and the attached handlers."""
-        self.logger.setLevel(level)
+        self.logger.setlevel(level)
         for each_handler in self.logger.handlers:
-            each_handler.setLevel(level)
+            each_handler.setlevel(level)
         self._level = level
 
     def _make_child_logger(self, suffix, level):
@@ -276,17 +276,17 @@ def _make_child_logger(self, suffix, level):
                     # loglevel if the specified log level is lower
                     # than the one of the global.
                     if each_handler.level > string_to_loglevel[level.upper()]:
-                        new_handler.setLevel(level)
+                        new_handler.setlevel(level)
 
                 logger.addHandler(new_handler)
 
         if level:
             if isinstance(level, str):
                 level = string_to_loglevel[level.upper()]
-            logger.setLevel(level)
+            logger.setlevel(level)
 
         else:
-            logger.setLevel(self.logger.level)
+            logger.setlevel(self.logger.level)
 
         logger.propagate = True
         return logger
@@ -395,7 +395,7 @@ def __del__(self):
                 for handler in self.logger.handlers:
                     handler.close()
                     self.logger.removeHandler(handler)
-            except Exception as e:
+            except Exception:
                 try:
                     if self.logger is not None:
                         self.logger.error("The logger was not deleted properly.")
@@ -426,7 +426,7 @@ def add_file_handler(logger, filename=FILE_NAME, level=LOG_LEVEL, write_headers=
     """
 
     file_handler = logging.FileHandler(filename)
-    file_handler.setLevel(level)
+    file_handler.setlevel(level)
     file_handler.setFormatter(logging.Formatter(FILE_MSG_FORMAT))
 
     if isinstance(logger, Logger):
@@ -463,7 +463,7 @@ def add_stdout_handler(logger, level=LOG_LEVEL, write_headers=False):
     """
 
     std_out_handler = logging.StreamHandler(sys.stdout)
-    std_out_handler.setLevel(level)
+    std_out_handler.setlevel(level)
     std_out_handler.setFormatter(PyProjectFormatter(STDOUT_MSG_FORMAT))
 
     if isinstance(logger, Logger):

ruff.toml

@@ -13,16 +13,18 @@ docstring-code-format = true
 [lint]
 select = [
     "E",    # pycodestyle, see https://docs.astral.sh/ruff/rules/#pycodestyle-e-w
-    "I",    # isort, see https://docs.astral.sh/ruff/rules/#isort-i
-]
-ignore = [
-    "D",    # pydocstyle, see https://docs.astral.sh/ruff/rules/#pydocstyle-d
     "F",    # pyflakes, see https://docs.astral.sh/ruff/rules/#pyflakes-f
+    "I",    # isort, see https://docs.astral.sh/ruff/rules/#isort-i
     "N",    # pep8-naming, see https://docs.astral.sh/ruff/rules/#pep8-naming-n
-    "PTH",  # flake8-use-pathlib, https://docs.astral.sh/ruff/rules/#flake8-use-pathlib-pth
     "TD",   # flake8-todos, https://docs.astral.sh/ruff/rules/#flake8-todos-td
     "W",    # pycodestyle, see https://docs.astral.sh/ruff/rules/#pycodestyle-e-w
 ]
+ignore = [
+    "D",     # pydocstyle, see https://docs.astral.sh/ruff/rules/#pydocstyle-d
+    "PTH",   # flake8-use-pathlib, https://docs.astral.sh/ruff/rules/#flake8-use-pathlib-pth
+    "TD002", # Missing author in TODOs comment
+    "TD003", # Missing issue link in TODOs comment
+]
 
 [lint.pydocstyle]
 convention = "numpy"