Tweak black_bindings

Originally, black_bindings found each contiguous "//|" block and sent
it to black independently. This was slower than it needed to be.

Instead, swap the comment prefix: when running black, take off
"//|" prefixes and put "##|" prefixes on all un-prefixed lines.
Then, after black is run, do the opposite operation

This more than doubles the overall speed of "pre-commit run --all",
from 3m20s to 55s CPU time on my local machine (32.5s to under 10s
"elapsed" time)

It also causes a small amount of churn in the bindings, because
black now sees enough context to know whether one 'def' follows another
or ends the 'def's in a 'class'. In the latter case, it adds an extra
newline, which becomes a "//|" line.

I'm less sure why a trailing comma was omitted before down in
rp2pio/StateMachine.c but let's roll with it.

Author: jepler

ports/atmel-samd/bindings/samd/Clock.c

@@ -35,6 +35,7 @@
 //|
 //|     They are fixed by the hardware so they cannot be constructed on demand. Instead, use
 //|     ``samd.clock`` to reference the desired clock."""
+//|
 
 STATIC void samd_clock_print(const mp_print_t *print, mp_obj_t self_in, mp_print_kind_t kind) {
     samd_clock_obj_t *self = MP_OBJ_TO_PTR(self_in);
@@ -92,6 +93,7 @@ MP_PROPERTY_GETTER(samd_clock_frequency_obj,
 
 //|     calibration: int
 //|     """Clock calibration. Not all clocks can be calibrated."""
+//|
 STATIC mp_obj_t samd_clock_get_calibration(mp_obj_t self_in) {
     samd_clock_obj_t *self = MP_OBJ_TO_PTR(self_in);
     return mp_obj_new_int_from_uint(clock_get_calibration(self->type, self->index));

ports/broadcom/bindings/videocore/Framebuffer.c

@@ -98,6 +98,7 @@ MP_PROPERTY_GETTER(videocore_framebuffer_width_obj,
 
 //|     height: int
 //|     """The height of the display, in pixels"""
+//|
 STATIC mp_obj_t videocore_framebuffer_get_height(mp_obj_t self_in) {
     videocore_framebuffer_obj_t *self = (videocore_framebuffer_obj_t *)self_in;
     check_for_deinit(self);

ports/espressif/bindings/esp32_camera/Camera.c

@@ -928,6 +928,7 @@ MP_PROPERTY_GETTER(esp32_camera_camera_grab_mode_obj,
 
 //|     framebuffer_count: int
 //|     """True if double buffering is used"""
+//|
 STATIC mp_obj_t esp32_camera_camera_get_framebuffer_count(const mp_obj_t self_in) {
     esp32_camera_camera_obj_t *self = MP_OBJ_TO_PTR(self_in);
     check_for_deinit(self);

ports/espressif/bindings/esp32_camera/__init__.c

@@ -54,6 +54,7 @@
 //|
 //|     LATEST: GrabMode
 //|     """Except when 1 frame buffer is used, queue will always contain the last ``fb_count`` frames"""
+//|
 
 MAKE_ENUM_VALUE(esp32_camera_grab_mode_type, grab_mode, WHEN_EMPTY, CAMERA_GRAB_WHEN_EMPTY);
 MAKE_ENUM_VALUE(esp32_camera_grab_mode_type, grab_mode, LATEST, CAMERA_GRAB_LATEST);
@@ -82,6 +83,7 @@ camera_grab_mode_t validate_grab_mode(mp_obj_t obj, qstr arg_name) {
 //|
 //|     JPEG: PixelFormat
 //|     """A compressed format"""
+//|
 
 MAKE_ENUM_VALUE(esp32_camera_pixel_format_type, pixel_format, RGB565, PIXFORMAT_RGB565);
 MAKE_ENUM_VALUE(esp32_camera_pixel_format_type, pixel_format, GRAYSCALE, PIXFORMAT_GRAYSCALE);
@@ -169,6 +171,7 @@ pixformat_t validate_pixel_format(mp_obj_t obj, qstr arg_name) {
 //|
 //|     QSXGA: FrameSize
 //|     """2560x1920"""
+//|
 
 MAKE_ENUM_VALUE(esp32_camera_frame_size_type, frame_size, R96X96, FRAMESIZE_96X96);
 MAKE_ENUM_VALUE(esp32_camera_frame_size_type, frame_size, R240X240, FRAMESIZE_240X240);
@@ -237,6 +240,7 @@ framesize_t validate_frame_size(mp_obj_t obj, qstr arg_name) {
 //|     GAIN_32X: GainCeiling
 //|     GAIN_64X: GainCeiling
 //|     GAIN_128X: GainCeiling
+//|
 
 MAKE_ENUM_VALUE(esp32_camera_gain_ceiling_type, gain_ceiling, GAIN_2X, GAINCEILING_2X);
 MAKE_ENUM_VALUE(esp32_camera_gain_ceiling_type, gain_ceiling, GAIN_4X, GAINCEILING_4X);

ports/espressif/bindings/espidf/__init__.c

@@ -41,6 +41,7 @@
 //| def heap_caps_get_total_size() -> int:
 //|     """Return the total size of the ESP-IDF, which includes the CircuitPython heap."""
 //|     ...
+//|
 
 STATIC mp_obj_t espidf_heap_caps_get_total_size(void) {
     return MP_OBJ_NEW_SMALL_INT(heap_caps_get_total_size(MALLOC_CAP_8BIT));
@@ -50,6 +51,7 @@ MP_DEFINE_CONST_FUN_OBJ_0(espidf_heap_caps_get_total_size_obj, espidf_heap_caps_
 //| def heap_caps_get_free_size() -> int:
 //|     """Return total free memory in the ESP-IDF heap."""
 //|     ...
+//|
 
 STATIC mp_obj_t espidf_heap_caps_get_free_size(void) {
     return MP_OBJ_NEW_SMALL_INT(heap_caps_get_free_size(MALLOC_CAP_8BIT));
@@ -59,6 +61,7 @@ MP_DEFINE_CONST_FUN_OBJ_0(espidf_heap_caps_get_free_size_obj, espidf_heap_caps_g
 //| def heap_caps_get_largest_free_block() -> int:
 //|     """Return the size of largest free memory block in the ESP-IDF heap."""
 //|     ...
+//|
 
 STATIC mp_obj_t espidf_heap_caps_get_largest_free_block(void) {
     return MP_OBJ_NEW_SMALL_INT(heap_caps_get_largest_free_block(MALLOC_CAP_8BIT));
@@ -70,6 +73,7 @@ MP_DEFINE_CONST_FUN_OBJ_0(espidf_heap_caps_get_largest_free_block_obj, espidf_he
 //|
 //|     This is necessary when upgrading from CircuitPython 6.3.0 or earlier to CircuitPython 7.0.0, because the
 //|     layout of data in nvs has changed. The old data will be lost when you perform this operation."""
+//|
 STATIC mp_obj_t espidf_erase_nvs(void) {
     ESP_ERROR_CHECK(nvs_flash_deinit());
     ESP_ERROR_CHECK(nvs_flash_erase());
@@ -105,6 +109,7 @@ const mp_obj_type_t mp_type_espidf_IDFError = {
 //|     """Raised when an ESP IDF memory allocation fails."""
 //|
 //|     ...
+//|
 NORETURN void mp_raise_espidf_MemoryError(void) {
     nlr_raise(mp_obj_new_exception(&mp_type_espidf_MemoryError));
 }
@@ -120,13 +125,15 @@ const mp_obj_type_t mp_type_espidf_MemoryError = {
 
 //| def get_total_psram() -> int:
 //|     """Returns the number of bytes of psram detected, or 0 if psram is not present or not configured"""
+//|
 STATIC mp_obj_t espidf_get_total_psram(void) {
     return MP_OBJ_NEW_SMALL_INT(common_hal_espidf_get_total_psram());
 }
 MP_DEFINE_CONST_FUN_OBJ_0(espidf_get_total_psram_obj, espidf_get_total_psram);
 
 //| def get_reserved_psram() -> int:
 //|     """Returns number of bytes of psram reserved for use by esp-idf, either a board-specific default value or the value defined in ``/.env``."""
+//|
 STATIC mp_obj_t espidf_get_reserved_psram(void) {
     return MP_OBJ_NEW_SMALL_INT(common_hal_espidf_get_reserved_psram());
 }

ports/raspberrypi/bindings/cyw43/__init__.c

@@ -38,6 +38,7 @@
 //|     Cannot be constructed at runtime, but may be the type of a pin object
 //|     in :py:mod:`board`. A `CywPin` can be used as a DigitalInOut, but not with other
 //|     peripherals such as `PWMOut`."""
+//|
 const mp_obj_type_t cyw43_pin_type = {
     { &mp_type_type },
     .flags = MP_TYPE_FLAG_EXTENDED,
@@ -57,6 +58,7 @@ const mp_obj_type_t cyw43_pin_type = {
 //|     Besides this value, there appears to be no other public documentation
 //|     of the values that can be used.
 //|     """
+//|
 STATIC mp_obj_t cyw43_set_power_management(const mp_obj_t value_in) {
     mp_int_t value = mp_obj_get_int(value_in);
     cyw43_wifi_pm(&cyw43_state, value);

ports/raspberrypi/bindings/rp2pio/StateMachine.c

@@ -359,7 +359,7 @@ MP_DEFINE_CONST_FUN_OBJ_1(rp2pio_statemachine_stop_obj, rp2pio_statemachine_stop
 //|         *,
 //|         start: int = 0,
 //|         end: Optional[int] = None,
-//|         swap: bool = False
+//|         swap: bool = False,
 //|     ) -> None:
 //|         """Write the data contained in ``buffer`` to the state machine. If the buffer is empty, nothing happens.
 //|
@@ -419,7 +419,7 @@ MP_DEFINE_CONST_FUN_OBJ_KW(rp2pio_statemachine_write_obj, 2, rp2pio_statemachine
 //|         once: Optional[ReadableBuffer] = None,
 //|         *,
 //|         loop: Optional[ReadableBuffer] = None,
-//|         swap: bool = False
+//|         swap: bool = False,
 //|     ) -> None:
 //|         """Write data to the TX fifo in the background, with optional looping.
 //|
@@ -564,7 +564,7 @@ const mp_obj_property_t rp2pio_statemachine_pending_obj = {
 //|         *,
 //|         start: int = 0,
 //|         end: Optional[int] = None,
-//|         swap: bool = False
+//|         swap: bool = False,
 //|     ) -> None:
 //|         """Read into ``buffer``. If the number of bytes to read is 0, nothing happens. The buffer
 //|         includes any data added to the fifo even if it was added before this was called.
@@ -628,7 +628,7 @@ MP_DEFINE_CONST_FUN_OBJ_KW(rp2pio_statemachine_readinto_obj, 2, rp2pio_statemach
 //|         out_start: int = 0,
 //|         out_end: Optional[int] = None,
 //|         in_start: int = 0,
-//|         in_end: Optional[int] = None
+//|         in_end: Optional[int] = None,
 //|     ) -> None:
 //|         """Write out the data in ``buffer_out`` while simultaneously reading data into ``buffer_in``.
 //|         The lengths of the slices defined by ``buffer_out[out_start:out_end]`` and ``buffer_in[in_start:in_end]``
@@ -788,6 +788,7 @@ MP_PROPERTY_GETTER(rp2pio_statemachine_rxstall_obj,
 
 //|     in_waiting: int
 //|     """The number of words available to readinto"""
+//|
 
 STATIC mp_obj_t rp2pio_statemachine_obj_get_in_waiting(mp_obj_t self_in) {
     rp2pio_statemachine_obj_t *self = MP_OBJ_TO_PTR(self_in);

ports/raspberrypi/bindings/rp2pio/__init__.c

@@ -42,6 +42,7 @@
 //| def pins_are_sequential(pins: List[microcontroller.Pin]) -> bool:
 //|     """Return True if the pins have sequential GPIO numbers, False otherwise"""
 //|     ...
+//|
 STATIC mp_obj_t rp2pio_pins_are_sequential(const mp_obj_t pins) {
     size_t len;
     mp_obj_t *items;

shared-bindings/_bleio/Adapter.c

@@ -62,6 +62,7 @@
 //|     The Adapter can do both parts of this process: it can scan for other device
 //|     advertisements and it can advertise its own data. Furthermore, Adapters can accept incoming
 //|     connections and also initiate connections."""
+//|
 
 //|     def __init__(
 //|         self, *, uart: busio.UART, rts: digitalio.DigitalInOut, cts: digitalio.DigitalInOut
@@ -435,6 +436,7 @@ STATIC MP_DEFINE_CONST_FUN_OBJ_KW(bleio_adapter_connect_obj, 1, bleio_adapter_co
 //|     def erase_bonding(self) -> None:
 //|         """Erase all bonding information stored in flash memory."""
 //|         ...
+//|
 STATIC mp_obj_t bleio_adapter_erase_bonding(mp_obj_t self_in) {
     bleio_adapter_obj_t *self = MP_OBJ_TO_PTR(self_in);
 

shared-bindings/_bleio/Address.c

@@ -36,6 +36,7 @@
 
 //| class Address:
 //|     """Encapsulates the address of a BLE device."""
+//|
 
 //|     def __init__(self, address: ReadableBuffer, address_type: int) -> None:
 //|         """Create a new Address object encapsulating the address value.
@@ -185,6 +186,7 @@ STATIC void bleio_address_print(const mp_print_t *print, mp_obj_t self_in, mp_pr
 //|
 //|     RANDOM_PRIVATE_NON_RESOLVABLE: int
 //|     """A randomly generated address that changes on every connection."""
+//|
 STATIC const mp_rom_map_elem_t bleio_address_locals_dict_table[] = {
     { MP_ROM_QSTR(MP_QSTR_address_bytes),                 MP_ROM_PTR(&bleio_address_address_bytes_obj) },
     { MP_ROM_QSTR(MP_QSTR_type),                          MP_ROM_PTR(&bleio_address_type_obj) },