Fix lint errors

Author: danlooo

.github/workflows/python-lint.yml

@@ -17,7 +17,7 @@ jobs:
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip
-          pip install pylint
+          pip install pylint pathtraits
       - name: Analysing the code with pylint
         run: |
           pylint $(git ls-files '*.py')

.gitignore

@@ -142,5 +142,5 @@ dmypy.json
 .DS_Store
 
 # etc
-run.sh
+/run.*
 *.db

analyze-db.py

@@ -1,3 +1,5 @@
+# pylint: disable-all
+
 import sqlite3
 import pandas as pd
 

pathtraits/db.py

@@ -38,6 +38,7 @@ def __init__(self, db_path):
         self.execute(init_path_index_query)
         self.update_traits()
 
+    # pylint: disable=R1710
     def execute(self, query):
         """
         Execute a SQLite query
@@ -74,7 +75,7 @@ def get(self, table, cols="*", condition=None, **kwargs):
             return None
 
         keys = map(lambda x: x[0], response.description)
-        res = {k: v for k, v in zip(keys, values)}
+        res = dict(zip(keys, values))
         return res
 
     def get_dict(self, path):

pathtraits/pathpair.py

@@ -41,18 +41,18 @@ def find(path):
             else:
                 object_path = path
             return PathPair(object_path, meta_path)
-        else:
-            object_path = path
-            for p in [
-                "meta.yml",
-                "meta.yaml",
-                ".meta.yml",
-                ".meta.yaml",
-                ".yml",
-                ".yaml",
-            ]:
-                meta_path = os.path.join(object_path, p)
-
-                if os.path.exists(meta_path):
-                    return PathPair(object_path, meta_path)
+
+        object_path = path
+        for p in [
+            "meta.yml",
+            "meta.yaml",
+            ".meta.yml",
+            ".meta.yaml",
+            ".yml",
+            ".yaml",
+        ]:
+            meta_path = os.path.join(object_path, p)
+
+            if os.path.exists(meta_path):
+                return PathPair(object_path, meta_path)
         return None

pathtraits/scan.py

@@ -1,16 +1,28 @@
-import inotify.adapters
-import os
+"""
+Module for scanning directories
+"""
+
 import logging
-from pathtraits.pathpair import *
-from pathtraits.db import *
+import os
 import re
 
+import inotify.adapters
+from pathtraits.pathpair import PathPair
+from pathtraits.db import TraitsDB
+
 logger = logging.getLogger(__name__)
 
 yaml_re = re.compile(r"(\.)?(meta)?\.(yaml|yml)$")
 
 
+# pylint: disable=W0102
 def scan_meta_yml(path, pathpairs=[]):
+    """
+    Scan a directory recursively for meta yml files and return PathPairs.
+
+    :param path: Root path to scan
+    :param pathpairs: list of pathpairs found so far (used for recursion)
+    """
     try:
         # faster than os.walk
         with os.scandir(path) as ents:
@@ -26,12 +38,19 @@ def scan_meta_yml(path, pathpairs=[]):
                     pair = PathPair(object_path, e.path)
                     pathpairs.append(pair)
         return pathpairs
-    except Exception as ex:
-        logger.error(f"skip {path}: {ex}")
+    except (FileNotFoundError, PermissionError, OSError) as ex:
+        logger.error("skip %s: %s", path, ex)
         return pathpairs
 
 
 def batch(path, db_path, verbose):
+    """
+    Update database once, searches for all directories recursively.
+
+    :param path: path to scan in batch mode recursively
+    :param db_path: path to the database
+    :param verbose: enable verbose logging
+    """
     if verbose:
         logging.basicConfig(level=logging.DEBUG)
 
@@ -44,6 +63,13 @@ def batch(path, db_path, verbose):
 
 
 def watch(path, db_path, verbose):
+    """
+    Update database continiously, watches for new or changed files.
+
+    :param path: path to watch recursively
+    :param db_path: path to the database
+    :param verbose: enable verbose logging
+    """
     if verbose:
         logging.basicConfig(level=logging.DEBUG)
 
@@ -57,13 +83,13 @@ def watch(path, db_path, verbose):
     for event in i.event_gen(yield_nones=False):
         (_, type_names, dir_path, filename) = event
 
-        if not type_names.__contains__("IN_CLOSE_WRITE"):
+        if not type_names.contains("IN_CLOSE_WRITE"):
             continue
 
         # watch afor both yml and object files
         # yml file might be created first and will be ignored
         path = os.path.join(dir_path, filename)
         pair = PathPair.find(path)
         if pair:
-            logger.debug(f"add pathpair: {pair}")
+            logger.debug("add pathpair: %s", pair)
             db.add_pathpair(pair)