rename variables

Author: Matt Land

adafruit_imageload/pnm/__init__.py

@@ -34,7 +34,12 @@
 
 
 def load(file, header, *, bitmap=None, palette=None):
-    # Read the header
+    """
+    Scan for netpbm format info, skip over comments, and and delegate to a submodule
+    to do the actual data loading.
+    Formats P1, P4 have two space padded pieces of information: width and height.
+    All other formats have three: width, height, and max color value.
+    """
     magic_number = header[:2]
     file.seek(2)
     pnm_header = []

adafruit_imageload/pnm/pgm/__init__.py

@@ -100,6 +100,9 @@ def load(file, magic_number, header, *, bitmap=None, palette=None):
 
 
 def build_palette(palette_class, palette_colors):
+    """
+    construct the Palette, and populate it with the set of palette_colors
+    """
     palette = palette_class(len(palette_colors))
     for counter, color in enumerate(palette_colors):
         palette[counter] = bytes([color, color, color])

adafruit_imageload/tests/test_pbm_load.py

@@ -24,9 +24,9 @@ def test_load_works_p1_ascii(self):
             "images",
             "netpbm_p1_mono_ascii.pbm",
         )
-        with open(test_file, "rb") as f:
+        with open(test_file, "rb") as file:
             bitmap, palette = pnm.load(
-                f, b"P1", bitmap=Bitmap_C_Interface, palette=Palette_C_Interface
+                file, b"P1", bitmap=Bitmap_C_Interface, palette=Palette_C_Interface
             )
         self.assertTrue(isinstance(bitmap, Bitmap_C_Interface), bitmap)
         self.assertEqual(1, bitmap.colors)
@@ -57,9 +57,9 @@ def test_load_works_p4_binary(self):
             "images",
             "netpbm_p4_mono_binary.pbm",
         )
-        with open(test_file, "rb") as f:
+        with open(test_file, "rb") as file:
             bitmap, palette = pnm.load(
-                f, b"P4", bitmap=Bitmap_C_Interface, palette=Palette_C_Interface
+                file, b"P4", bitmap=Bitmap_C_Interface, palette=Palette_C_Interface
             )
         self.assertEqual(1, palette.num_colors)
         palette.validate()
@@ -79,9 +79,9 @@ def test_load_works_p4_binary_high_res(self):
             "images",
             "netpbm_p4_mono_large.pbm",
         )
-        with open(test_file, "rb") as f:
+        with open(test_file, "rb") as file:
             bitmap, palette = pnm.load(
-                f, b"P4", bitmap=Bitmap_C_Interface, palette=Palette_C_Interface
+                file, b"P4", bitmap=Bitmap_C_Interface, palette=Palette_C_Interface
             )
         self.assertTrue(isinstance(bitmap, Bitmap_C_Interface))
         self.assertEqual(1, bitmap.colors)

adafruit_imageload/tests/test_pgm_load.py

@@ -14,9 +14,9 @@ def test_load_works_p2_ascii(self):
             "images",
             "netpbm_p2_ascii.pgm",
         )
-        with open(test_file, "rb") as f:
+        with open(test_file, "rb") as file:
             bitmap, palette = pnm.load(
-                f, b"P2", bitmap=Bitmap_C_Interface, palette=Palette_C_Interface
+                file, b"P2", bitmap=Bitmap_C_Interface, palette=Palette_C_Interface
             )
         self.assertTrue(isinstance(bitmap, Bitmap_C_Interface), bitmap)
         self.assertEqual(6, bitmap.colors)
@@ -36,9 +36,9 @@ def test_load_works_p5_binary(self):
             "images",
             "netpbm_p5_binary.pgm",
         )
-        with open(test_file, "rb") as f:
+        with open(test_file, "rb") as file:
             bitmap, palette = pnm.load(
-                f, b"P5", bitmap=Bitmap_C_Interface, palette=Palette_C_Interface
+                file, b"P5", bitmap=Bitmap_C_Interface, palette=Palette_C_Interface
             )
         self.assertTrue(isinstance(bitmap, Bitmap_C_Interface), bitmap)
 

adafruit_imageload/tests/test_ppm_load.py

@@ -38,9 +38,9 @@ def test_load_works_p6_binary(self):
             "images",
             "netpbm_p6_binary.ppm",
         )
-        with open(test_file, "rb") as f:
+        with open(test_file, "rb") as file:
             bitmap, palette = pnm.load(
-                f, b"P6", bitmap=Bitmap_C_Interface, palette=Palette_C_Interface
+                file, b"P6", bitmap=Bitmap_C_Interface, palette=Palette_C_Interface
             )
         self.assertEqual(6, palette.num_colors)
         palette.validate()