Merge pull request #30 from freelawproject/ruff

chore: Move formatting and linting to Ruff

Author: albertisfu

.pre-commit-config.yaml

@@ -9,13 +9,9 @@ repos:
     -   id: check-yaml
     -   id: check-added-large-files
 
--   repo: https://github.com/psf/black
-    rev: 25.1.0  # Use the latest stable version
-    hooks:
-    -   id: black
-
--   repo: https://github.com/PyCQA/isort
-    rev: 6.0.1
-    hooks:
-    -   id: isort
-        name: isort (python)
+- repo: https://github.com/astral-sh/ruff-pre-commit
+  rev: v0.11.8
+  hooks:
+    - id: ruff
+      args: [ --fix ]
+    - id: ruff-format

judge_pics/scrapers/cand_judges.py

@@ -13,7 +13,7 @@
 
 token = ""
 if token:
-    headers = {"Authorization": "Token %s" % token}
+    headers = {"Authorization": f"Token {token}"}
 else:
     print(
         "Warning: No CourtListener token used. You'll run out of free "
@@ -60,8 +60,7 @@ def make_slug(name: str) -> str | None:
 
     try:
         result_json = requests.get(
-            "https://www.courtlistener.com/api/rest/v4/search/?type=p&name=%s&court=cand"
-            % name,
+            f"https://www.courtlistener.com/api/rest/v4/search/?type=p&name={name}&court=cand",
             headers=headers,
             timeout=10,
         ).json()
@@ -76,24 +75,18 @@ def make_slug(name: str) -> str | None:
         return None
 
     if result_json["count"] > 1:
-        print(
-            "Warning: Got back %s results for %s"
-            % (
-                result_json["count"],
-                name,
-            )
-        )
+        print(f"Warning: Got back {result_json['count']} results for {name}")
         return None
     if result_json["count"] < 1:
-        print("Warning: Got back no results for %s" % name)
+        print(f"Warning: Got back no results for {name}")
         name_parts = name.split()
         if len(name_parts) == 2:
             return f"{name_parts[1].lower()}-{name_parts[0].lower()}"
         return None
 
     result_id = result_json["results"][0]["id"]
     result_json = requests.get(
-        "https://www.courtlistener.com/api/rest/v4/people/?id=%s" % result_id,
+        f"https://www.courtlistener.com/api/rest/v4/people/?id={result_id}",
         headers=headers,
         timeout=10,
     ).json()
@@ -145,7 +138,6 @@ def run_things():
             judge_info.append((name, url))
 
     for judge_name, judge_link in judge_info:
-
         try:
             judge_r = requests.get(judge_link, timeout=10)
         except Timeout:
@@ -165,7 +157,7 @@ def run_things():
                 '//div[@class = "judge_portrait"]//img/@src'
             )[0]
         except IndexError:
-            print("Failed to find image for %s" % judge_link)
+            print(f"Failed to find image for {judge_link}")
             continue
 
         try:
@@ -197,12 +189,15 @@ def run_things():
                 "hash": img_hash,
             }
 
-    json.dump(
-        judge_pics,
-        open(os.path.join(judge_root, "judges.json"), "w", encoding="utf-8"),
-        sort_keys=True,
-        indent=2,
-    )
+    with open(
+        os.path.join(judge_root, "judges.json"), "w", encoding="utf-8"
+    ) as fp:
+        json.dump(
+            judge_pics,
+            fp,
+            sort_keys=True,
+            indent=2,
+        )
 
 
 if __name__ == "__main__":

judge_pics/scrapers/dc_circuit_judges.py

@@ -81,7 +81,7 @@ def run_things():
                     )[0]
                     full_img_src = root_url + img_path
                 except IndexError:
-                    print("Failed to find image for %s" % full_url)
+                    print(f"Failed to find image for {full_url}")
                     continue
             except Timeout:
                 print(
@@ -122,12 +122,15 @@ def run_things():
                 "hash": img_hash,
             }
 
-    json.dump(
-        judge_pics,
-        open(os.path.join(judge_root, "judges.json"), "w", encoding="utf-8"),
-        sort_keys=True,
-        indent=2,
-    )
+    with open(
+        os.path.join(judge_root, "judges.json"), "w", encoding="utf-8"
+    ) as fp:
+        json.dump(
+            judge_pics,
+            fp,
+            sort_keys=True,
+            indent=2,
+        )
 
 
 if __name__ == "__main__":

judge_pics/search.py

@@ -54,7 +54,7 @@ def portrait(
     person: Union[str, int], size: SIZES = ImageSizes.ORIGINAL
 ) -> Optional[str]:
     """Get URL for portait on free.law"""
-    if type(person) == int:
+    if isinstance(person, int):
         paths = [x for x in judges if x["person"] == person]
         if len(paths) > 0:
             return f"https://portraits.free.law/v2/{size.value}/{paths[0]['path']}.jpeg"

judge_pics/update.py

@@ -69,7 +69,7 @@ def update_judge_json(
         raise ValueError("Judge already exists")
     strip_metadata_from_file(filename)
     sha_hash = get_hash_from_file(filename)
-    if any([x["hash"] == sha_hash for x in judges_json]):
+    if any(x["hash"] == sha_hash for x in judges_json):
         raise ValueError(
             f"Image with hash '{sha_hash}' already exists in the database"
         )

judge_pics/upload.py

@@ -70,13 +70,13 @@ def validate_json() -> bool:
     with Path(ROOT_DIR, "data", "people.json").open(encoding="utf-8") as f:
         judges = json.load(f)
 
-    judges_in_json = [f'{v["path"]}.jpeg' for v in judges]
+    judges_in_json = [f"{v['path']}.jpeg" for v in judges]
 
     portraits = [
         x.split("/")[-1] for x in glob.glob(f"{ROOT_DIR}/data/orig/*.jpeg")
     ]
 
-    missing_judges = sorted(list(set(judges_in_json) ^ set(portraits)))
+    missing_judges = sorted(set(judges_in_json) ^ set(portraits))
     if not missing_judges:
         return True
 
@@ -102,7 +102,7 @@ def find_new_portraits(access_key: str, secret_key: str) -> list:
         x.split("/")[-1] for x in glob.glob(f"{ROOT_DIR}/data/orig/*.jpeg")
     ]
     judges_to_upload = set(aws_portraits) ^ set(local_portraits)
-    return sorted(list(judges_to_upload))
+    return sorted(judges_to_upload)
 
 
 def main(access_key: str, secret_key: str) -> None:

pyproject.toml

@@ -1,7 +1,36 @@
-[tool.black]
-line-length = 79
-include = '''.*\.pyi?$'''
-
 [build-system]
 requires = ["setuptools >= 40.8.0", "wheel"]
 build-backend = "setuptools.build_meta"
+
+[tool.ruff]
+line-length = 79
+lint.select = [
+  # flake8-bugbear
+  "B",
+  # flake8-comprehensions
+  "C4",
+  # pycodestyle
+  "E",
+  # Pyflakes errors
+  "F",
+  # isort
+  "I",
+  # flake8-simplify
+  "SIM",
+  # flake8-tidy-imports
+  "TID",
+  # pyupgrade
+  "UP",
+  # Pyflakes warnings
+  "W",
+]
+lint.ignore = [
+  # flake8-bugbear opinionated rules
+  "B9",
+  # line-too-long
+  "E501",
+  # suppressible-exception
+  "SIM105",
+  # if-else-block-instead-of-if-exp
+  "SIM108",
+]