ruff it

Author: simontoens

README.md

@@ -183,3 +183,14 @@ See [this example](examples/dep-overrides).
 ## CI setup
 
 [This document](docs/ci.md) goes over the CI setup.
+
+
+## Linting
+
+pomgen uses [ruff](https://github.com/astral-sh/ruff). Follow the installation instructions, then run:
+
+```
+ruff check src tests
+```
+
+Currently, we just use the default ruff linting configuration.

src/common/argsupport.py

@@ -54,7 +54,7 @@ def get_all_packages(repository_root_path, packages_str, verbose=False):
                     if prefix_match or package.endswith(exclusion_path):
                         break
             else:
-                if not package in all_packages:
+                if package not in all_packages:
                     all_packages.add(package)
                     packages_list.append(package)
 

src/crawl/artifactprocessor.py

@@ -12,7 +12,6 @@
 helps with testing.
 """
 
-from common import logger
 from common import mdfiles
 from crawl import git
 from crawl import releasereason

src/crawl/bazel.py

@@ -14,7 +14,6 @@
 from common import logger
 from common import mdfiles
 from common.os_util import run_cmd
-from common import logger
 from collections import defaultdict
 from crawl import dependency
 import os
@@ -166,7 +165,6 @@ def _parse_pinned(mvn_install_name, pinned_file_path, verbose=False):
     """
     if verbose:
         logger.debug("Processing pinned file [%s]" % pinned_file_path)
-    result = []
     with open(pinned_file_path, "r") as f:
         content = f.read()
     install_json = json.loads(content)
@@ -197,7 +195,6 @@ def _parse_pinned(mvn_install_name, pinned_file_path, verbose=False):
             coord_wo_vers_to_dep[coord_wo_vers] = _DepWithDirects(dep)
 
     # for each top level dependency, find and associate direct transitives
-    deps_with_directs = []
     for coord_wo_vers, dep in coord_wo_vers_to_dep.items():
         direct_dep_coords_wo_vers = direct_deps_json.get(coord_wo_vers, [])
         dep.directs = _get_direct_deps(direct_dep_coords_wo_vers,

src/crawl/buildpom.py

@@ -12,7 +12,6 @@
 from common import code
 from common import mdfiles
 from common import pomgenmode
-from common import version as versionm
 import os
 
 

src/crawl/crawler.py

@@ -13,10 +13,8 @@
 from crawl import bazel
 from crawl import pom
 from crawl import pomparser
-from crawl import workspace
 from crawl.releasereason import ReleaseReason
 import difflib
-import os
 
 
 class Node:
@@ -193,7 +191,6 @@ def _register_dependencies_with_pomgen_instances(self, target_to_transitive_clos
 
         # register the transitive closure of dependencies belonging to the
         # artifact
-        deps = self._get_crawled_packages_as_deps()
         for p in self.pomgens:
 
             target_key = self._get_target_key(p.artifact_def.bazel_package, p.dependency)
@@ -242,7 +239,7 @@ def _get_unprocessed_packages(self):
         missing_packages = []
         for artifact_def in all_artifacts:
             library_path = artifact_def.library_path
-            if not library_path in processed_libraries:
+            if library_path not in processed_libraries:
                 processed_libraries.add(library_path)
                 all_library_packages = set(bazel.query_all_artifact_packages(self.workspace.repo_root_path, library_path))
                 missing_packages += all_library_packages.difference(all_packages_already_processed)
@@ -400,7 +397,7 @@ def _flatten_and_dedupe(self, list_of_lists):
         processed = set()
         for li in list_of_lists:
             for item in li:
-                if not item in processed:
+                if item not in processed:
                     flattened.append(item)
                     processed.add(item)
         return flattened

src/crawl/dependency.py

@@ -282,7 +282,7 @@ def _init_target(clazz, bazel_package, bazel_target):
     def _use_previously_released_artifact(self):
         if self._artifact_def.requires_release is not None:
             # better to be explicit here: requires_release has been set
-            if self._artifact_def.requires_release == False:
+            if self._artifact_def.requires_release == False: # noqa: E712
                 return True
         return False
 

src/crawl/dependencymd.py

@@ -68,14 +68,14 @@ def get_classifier(self, dependency):
     def register_transitives(self, dependency, transitives):
         key = self._get_key(dependency)
         assert key is not None, "no key for dependency: [%s]" % dependency
-        assert not key in self._dep_to_transitives, "duplicate key [%s] for dependency [%s]" % (key, dependency)
+        assert key not in self._dep_to_transitives, "duplicate key [%s] for dependency [%s]" % (key, dependency)
         self._dep_to_transitives[key] = transitives
         self._dep_key_to_dependency[key] = dependency
 
     def register_exclusions(self, dependency, exclusions):
         key = self._get_key(dependency)
         assert key is not None, "no key for dependency: [%s]" % dependency
-        assert not key in self._dep_to_exclusions, "duplicate key [%s] for dependency [%s]" % (key, dependency)
+        assert key not in self._dep_to_exclusions, "duplicate key [%s] for dependency [%s]" % (key, dependency)
         self._dep_to_exclusions[key] = exclusions
 
     def clear(self):

src/crawl/pom.py

@@ -11,7 +11,6 @@
 import copy
 from crawl import bazel
 from crawl import pomparser
-from crawl import workspace
 import os
 import re
 
@@ -643,7 +642,7 @@ def gen(self, pomcontenttype):
         # we assume the template specified <packaging>jar</packaging>
         # there's room for improvement here for sure
         expected_packaging = "<packaging>jar</packaging>"
-        if not expected_packaging in content:
+        if expected_packaging not in content:
             raise Exception("The pom template must have %s" % expected_packaging)
         content = content.replace(expected_packaging, expected_packaging.replace("jar", "pom"))
 
@@ -700,9 +699,9 @@ def _sort(s):
     Converts the specified set to a list, and returns the list, sorted.
     """
     assert isinstance(s, set), "Expected a set"
-    l = list(s)
-    l.sort()
-    return l
+    the_list = list(s)
+    the_list.sort()
+    return the_list
 
 
 # this method delegates to bazel query to get the value of a bazel target's 

src/crawl/pomparser.py

@@ -62,7 +62,7 @@ def indent_xml(xml_content, indent):
             current_indent -= INDENT
             handled_indent = True
         indented_xml += (' '*current_indent) + line + os.linesep
-        if not handled_indent and line.startswith("<") and not "</" in line:
+        if not handled_indent and line.startswith("<") and "</" not in line:
             current_indent += INDENT
             handled_indent = True
     return indented_xml
@@ -121,7 +121,7 @@ def get_parsed_deps_set_missing_from(self, *args):
                 specified.add((d.group_id, d.artifact_id))
         missing = set()
         for d in self._dependencies:
-            if not ((d.group_id, d.artifact_id)) in specified:
+            if ((d.group_id, d.artifact_id)) not in specified:
                 missing.add(d)
         return missing
 
@@ -211,7 +211,7 @@ def _import_lxml():
     try:
         from lxml import etree
         return etree
-    except ImportError as ex:
+    except ImportError:
         print("Module lxml is not installed, please execute the following in your environment:")
         print("pip3 install --user lxml")
         return None