add and test insert() method; update docs

Author: CedarGroveStudios

cedargrove_paletteslice/paletteslice_acme.py

@@ -84,18 +84,6 @@ def __setitem__(self, key, value):
         self._reference_list[key] = working_list
         self._create_new_palette(self._reference_list)
 
-    def __delitem__(self, key):
-        """UNTESTED:
-        Delete a slice from the primary class displayio.Palette. Permanently modifies
-        reference_list and palette.
-        Usage is ``del PaletteSlice[key]``. ONLY WORKS IN REPL
-
-        param slice key: The target slice object to delete from the new color palette."""
-        """self._reference_list = del self._reference_list[key]
-        self._create_new_palette(self._reference_list)"""
-        # pylint: disable = (unnecessary-pass)
-        pass
-
     def __contains__(self, color):
         """Determine if reference_list contains the singleton color. Returns True or False.
         Usage is ``color in PaletteSlice.palette``.
@@ -152,8 +140,7 @@ def extend(self, add_list):
         self._create_new_palette(self._reference_list)
 
     def insert(self, key, color):
-        """UNTESTED:
-        Insert an opaque color value into the primary class palette at
+        """Insert an opaque color value into the primary class palette at
         slice object key. Permanently modifies reference_list and palette.
         Usage is ``PaletteSlice.insert(key, color)``.
 

examples/paletteslice_acme_simpletest.py

@@ -65,70 +65,96 @@ def print_palette(new_palette):
 # Test of append()
 print("\n" + ("=" * 15))
 print("TEST append()")
-test = 0xF0F0F0
-print(f"  value to insert: {test:#08x}")
+test_value = 0xF0F0F0
+print(f"  value to append: {test_value:#08x}")
 
 (last_color, last_transparency) = pal_sliceable.reference_list[-1]
 length = len(pal_sliceable)
 print(
     f"length BEFORE append: {length} last item: {last_color:#08x} {last_transparency}"
 )
 
-pal_sliceable.append(test)
+pal_sliceable.append(test_value)
 
 (last_color, last_transparency) = pal_sliceable.reference_list[-1]
 length = len(pal_sliceable)
 print(
     f"length  AFTER append: {length} last item: {last_color:#08x} {last_transparency}"
 )
 
+# Test of insert()
+print("\n" + ("=" * 15))
+print("TEST insert()")
+test_value = 0xA0A0A0
+test_index = 100
+print(f"  value to insert: {test_value:#08x} at index: {test_index}")
+
+(old_color, old_transparency) = pal_sliceable.reference_list[test_index]
+length = len(pal_sliceable)
+print(f"length BEFORE insert: {length} item: {old_color:#08x} {old_transparency}")
+
+pal_sliceable.insert(test_index, test_value)
+
+(new_color, new_transparency) = pal_sliceable.reference_list[test_index]
+length = len(pal_sliceable)
+print(f"length  AFTER insert: {length} item: {new_color:#08x} {new_transparency}")
+
 # Test of is_transparent(), make_transparent(), make_opaque()
 print("\n" + ("=" * 15))
-test = -1  # Index to test
+test_value = -1  # Index to test
 print("TEST is_transparent(), make_transparent(), make_opaque()")
-print(f"  index value for test: {test}")
-print(f"  is_transparent: {pal_sliceable.is_transparent(test)}")
-pal_sliceable.make_transparent(test)
-print(f"AFTER make_transparent -> is_transparent: {pal_sliceable.is_transparent(test)}")
-pal_sliceable.make_opaque(test)
-print(f"AFTER make_opaque      -> is_transparent: {pal_sliceable.is_transparent(test)}")
+print(f"  index value for test: {test_value}")
+print(f"  is_transparent: {pal_sliceable.is_transparent(test_value)}")
+pal_sliceable.make_transparent(test_value)
+print(
+    f"AFTER make_transparent -> is_transparent: {pal_sliceable.is_transparent(test_value)}"
+)
+pal_sliceable.make_opaque(test_value)
+print(
+    f"AFTER make_opaque      -> is_transparent: {pal_sliceable.is_transparent(test_value)}"
+)
 
 # Test of count()
 print("\n" + ("=" * 15))
 print("TEST count()")
-test = 0xFFFFFF  # Color value for search
-print(f"  color value for search: {test:#08x}")
+test_value = 0xFFFFFF  # Color value for search
+print(f"  color value for search: {test_value:#08x}")
 
-print(f"number of occurrences: {pal_sliceable.count(test)}")
+print(f"number of occurrences: {pal_sliceable.count(test_value)}")
 
 # Test of index()
 print("\n" + ("=" * 15))
 print("TEST index()")
-test = 0xFFFFF0  # Color value for search
-print(f"  color value for search: {test:#08x}")
+test_value = 0xFFFFF0  # Color value for search
+print(f"  color value for search: {test_value:#08x}")
+
+print(f"first index found: {pal_sliceable.index(test_value)}")
 
-print(f"first index found: {pal_sliceable.index(test)}")
+test_value = 0xFFFFFF  # Color value for search
+print(f"  color value for search: {test_value:#08x}")
+
+print(f"first index found: {pal_sliceable.index(test_value)}")
 
 # Test of pop()
 print("\n" + ("=" * 15))
 print("TEST pop()")
-test = -1  # Remove last item
-print(f"  index to pop: {test}")
+test_value = -1  # Remove last item
+print(f"  index to pop: {test_value}")
 
 print(f"  length BEFORE pop: {len(pal_sliceable)}")
-print(f"value removed: {pal_sliceable.pop(test):#08x}")
+print(f"value removed: {pal_sliceable.pop(test_value):#08x}")
 print(f"  length  AFTER pop: {len(pal_sliceable)}")
 
 # Test of __contains__
 print("\n" + ("=" * 15))
 print("TEST __contains__")
-test = 0
-print(f"  value to find: {test}")
+test_value = 0
+print(f"  value to find: {test_value}")
 
-if test in pal_sliceable:
-    print(f"< {test} > in pal_sliceable (True)")
+if test_value in pal_sliceable:
+    print(f"< {test_value} > in pal_sliceable (True)")
 else:
-    print(f"< {test} > NOT in pal_sliceable (False)")
+    print(f"< {test_value} > NOT in pal_sliceable (False)")
 
 # Place the test image into a tile and append to the primary display group
 test_tile = displayio.TileGrid(test_bitmap, pixel_shader=test_palette_source)
@@ -142,11 +168,13 @@ def print_palette(new_palette):
 
 # Show the test image and label
 display.show(primary_group)
+print("\n" + ("=" * 15))
 print("TEST of source image")
 slice_label.text = "PALETTE SLICE: source image and palette"
 time.sleep(2)
 
 # Continuous random slice test
+print("\n" + ("=" * 15))
 print("TEST of random slices")
 while True:
     # Create a random slice object; prohibit step == 0