Make pylint-compliant. Remove some uneeded files

Author: jepler

README.md

@@ -14,12 +14,6 @@ One directory above the root of this repo.
 
 With that pointed at a learn guide repo you can run:
 
-```
-python get_bundle_data.py
-```
-to download `latest_bundle_data.json`
-
-Once this file is present run
 ```
 python create_requirement_images.py
 ```

create_requirement_images.py

@@ -1,5 +1,9 @@
 #!/usr/bin/env python3
 
+"""
+Create requirement screenshots for learn guide projects
+"""
+
 # SPDX-FileCopyrightText: 2021 foamyguy
 #
 # SPDX-License-Identifier: MIT
@@ -63,63 +67,68 @@
     "json": file_icon,
 }
 
-for img in FILE_TYPE_ICON_MAP.values():
-    img.load()
+# If this is not done, the images fail to load in the subprocesses.
+for file_icon in FILE_TYPE_ICON_MAP.values():
+    file_icon.load()
+
 
+def generate_requirement_image(
+    learn_guide_project,
+):  # pylint: disable=too-many-statements
+    """Generate a single requirement image"""
 
-def generate_requirement_image(learn_guide_project):
     def make_line(
         requirement_name, position=(0, 0), icon=None, hidden=False, triangle_icon=None
-    ):
+    ):  # pylint: disable=too-many-branches
         if triangle_icon:
-            im.paste(
+            img.paste(
                 triangle_icon,
                 (position[0] - 24, position[1] + (LINE_SPACING - 24) // 2),
                 mask=triangle_icon,
             )
-        if icon == None:
+        if icon is None:
             if requirement_name.endswith(".mpy") or requirement_name.endswith(".py"):
                 if hidden:
-                    im.paste(
+                    img.paste(
                         file_hidden_icon,
                         (position[0], position[1] + (LINE_SPACING - 24) // 2),
                         mask=file_hidden_icon,
                     )
                 else:
-                    im.paste(
+                    img.paste(
                         file_icon,
                         (position[0], position[1] + (LINE_SPACING - 24) // 2),
                         mask=file_icon,
                     )
 
             elif "." in requirement_name[-5:]:
                 if hidden:
-                    im.paste(
+                    img.paste(
                         file_empty_hidden_icon,
                         (position[0], position[1] + (LINE_SPACING - 24) // 2),
                         mask=file_empty_icon,
                     )
                 else:
-                    im.paste(
+                    img.paste(
                         file_empty_icon,
                         (position[0], position[1] + (LINE_SPACING - 24) // 2),
                         mask=file_empty_icon,
                     )
             else:
                 if hidden:
-                    im.paste(
+                    img.paste(
                         folder_hidden_icon,
                         (position[0], position[1] + (LINE_SPACING - 24) // 2),
                         mask=folder_hidden_icon,
                     )
                 else:
-                    im.paste(
+                    img.paste(
                         folder_icon,
                         (position[0], position[1] + (LINE_SPACING - 24) // 2),
                         mask=folder_icon,
                     )
         else:
-            im.paste(
+            img.paste(
                 icon, (position[0], position[1] + (LINE_SPACING - 24) // 2), mask=icon
             )
 
@@ -193,10 +202,7 @@ def make_header(position, learn_guide_project):
         for i, file in enumerate(sorted(project_files_to_draw)):
             cur_file_extension = file.split(".")[-1]
 
-            if cur_file_extension in FILE_TYPE_ICON_MAP:
-                cur_file_icon = FILE_TYPE_ICON_MAP[cur_file_extension]
-            else:
-                cur_file_icon = file_empty_icon
+            cur_file_icon = FILE_TYPE_ICON_MAP.get(cur_file_extension, file_empty_icon)
             make_line(
                 file,
                 (position[0] + INDENT_SIZE, position[1] + (LINE_SPACING * (6 + i))),
@@ -305,8 +311,8 @@ def make_libraries(libraries, position):
             + len(final_list_to_render) * LINE_SPACING
             + (project_files_count) * LINE_SPACING
         )
-        im = Image.new("RGB", (OUT_WIDTH, image_height), "#303030")
-        draw = ImageDraw.Draw(im)
+        img = Image.new("RGB", (OUT_WIDTH, image_height), "#303030")
+        draw = ImageDraw.Draw(img)
 
         make_background_highlights(
             7 + len(final_list_to_render) + project_files_count,
@@ -319,9 +325,9 @@ def make_libraries(libraries, position):
             (PADDING, PADDING + (LINE_SPACING * (7 + project_files_count))),
         )
 
-        im.save("generated_images/{}.png".format(learn_guide_project))
-    except SyntaxError as e:
-        print(e)
+        img.save("generated_images/{}.png".format(learn_guide_project))
+    except SyntaxError as exc:
+        print(exc)
         traceback.print_exc()
         print("SyntaxError finding imports for {}".format(learn_guide_project))
 

get_bundle_data.py

@@ -1,11 +1,16 @@
 # SPDX-FileCopyrightText: 2021 foamyguy
+# SPDX-FileCopyrightText: 2019 Nicholas Tollervey, written for Adafruit Industries
 #
 # SPDX-License-Identifier: MIT
 
-import requests
+"""
+Get the list of required libraries based on a file's imports
+"""
+
 import json
 import os
 import findimports
+import requests
 
 BUNDLE_DATA = "latest_bundle_data.json"
 BUNDLE_TAG = "latest_bundle_tag.json"
@@ -18,30 +23,17 @@
 
 
 def get_bundle(tag):
-    url = f"https://adafruit-circuit-python.s3.amazonaws.com/bundles/adafruit/adafruit-circuitpython-bundle-{tag}.json"
+    """Download the given bundle's data to BUNDLE_DATA"""
+    url = f"https://adafruit-circuit-python.s3.amazonaws.com/bundles/adafruit/adafruit-circuitpython-bundle-{tag}.json"  # pylint: disable=line-too-long
     print(f"get bundle metadata from {url}")
     r = requests.get(url)
-    with open(BUNDLE_DATA, "wb") as f:
-        f.write(r.content)
+    with open(BUNDLE_DATA, "wb") as bundle_file:
+        bundle_file.write(r.content)
 
 
 LATEST_BUNDLE_VERSION = ""
 
 
-def get_latest_tag():
-    """
-    Find the value of the latest tag for the Adafruit CircuitPython library
-    bundle.
-    :return: The most recent tag value for the project.
-    """
-    global LATEST_BUNDLE_VERSION
-    if not LATEST_BUNDLE_VERSION:
-        LATEST_BUNDLE_VERSION = get_latest_release_from_url(
-            "https://github.com/adafruit/Adafruit_CircuitPython_Bundle/releases/latest"
-        )
-    return LATEST_BUNDLE_VERSION
-
-
 def get_latest_release_from_url(url):
     """
     Find the tag name of the latest release by using HTTP HEAD and decoding the redirect.
@@ -65,7 +57,7 @@ def get_latest_tag():
     bundle.
     :return: The most recent tag value for the project.
     """
-    global LATEST_BUNDLE_VERSION
+    global LATEST_BUNDLE_VERSION  # pylint: disable=global-statement
     if LATEST_BUNDLE_VERSION == "":
         LATEST_BUNDLE_VERSION = get_latest_release_from_url(
             "https://github.com/adafruit/Adafruit_CircuitPython_Bundle/releases/latest"
@@ -85,7 +77,7 @@ def ensure_latest_bundle():
         with open(BUNDLE_TAG, encoding="utf-8") as data:
             try:
                 old_tag = json.load(data)["tag"]
-            except json.decoder.JSONDecodeError as ex:
+            except json.decoder.JSONDecodeError as _:
                 # Sometimes (why?) the JSON file becomes corrupt. In which case
                 # log it and carry on as if setting up for first time.
                 print(f"Could not parse {BUNDLE_TAG:r}")
@@ -95,7 +87,7 @@ def ensure_latest_bundle():
             get_bundle(tag)
             with open(BUNDLE_TAG, "w", encoding="utf-8") as data:
                 json.dump({"tag": tag}, data)
-        except requests.exceptions.HTTPError as ex:
+        except requests.exceptions.HTTPError as _:
             # See #20 for reason this this
             print(
                 (
@@ -115,6 +107,7 @@ def ensure_latest_bundle():
 
 
 def get_files_for_project(project_name):
+    """Get the set of files for a learn project"""
     found_files = set()
     project_dir = "{}/{}/".format(LEARN_GUIDE_REPO, project_name)
     for file in os.listdir(project_dir):
@@ -130,6 +123,7 @@ def get_files_for_project(project_name):
 
 
 def get_libs_for_project(project_name):
+    """Get the set of libraries for a learn project"""
     found_libs = set()
     found_imports = []
     project_dir = "{}{}/".format(LEARN_GUIDE_REPO, project_name)
@@ -147,20 +141,19 @@ def get_libs_for_project(project_name):
 
 
 def get_learn_guide_projects():
+    """Get the list of all folders in the learn guide"""
     return os.listdir(LEARN_GUIDE_REPO)
 
 
 def get_learn_guide_cp_projects():
+    """Get the list of all circuitpython projects, according to some heuristics"""
     cp_projects = []
 
-    def has_py_file(dir):
-        dir_files = os.listdir(dir)
+    def has_py_file(location):
+        dir_files = os.listdir(location)
         for file in dir_files:
             if file.endswith(".py"):
-                if ".circuitpython.skip" not in dir_files:
-                    return True
-                else:
-                    return False
+                return ".circuitpython.skip" not in dir_files
         return False
 
     all_projects = get_learn_guide_projects()