Format stubs with ruff

Author: tannewt

shared-bindings/_bleio/Adapter.c

@@ -62,6 +62,7 @@
 //|         Use `_bleio.adapter` to access the sole instance already available.
 //|         """
 //|         ...
+//|
 static mp_obj_t bleio_adapter_make_new(const mp_obj_type_t *type, size_t n_args, size_t n_kw, const mp_obj_t *all_args) {
     #if CIRCUITPY_BLEIO_HCI
     bleio_adapter_obj_t *self = common_hal_bleio_allocate_adapter_or_raise();
@@ -135,6 +136,7 @@ MP_PROPERTY_GETSET(bleio_adapter_address_obj,
 //|     """name of the BLE adapter used once connected.
 //|     The name is "CIRCUITPY" + the last four hex digits of ``adapter.address``,
 //|     to make it easy to distinguish multiple CircuitPython boards."""
+//|
 static mp_obj_t _bleio_adapter_get_name(mp_obj_t self) {
     return MP_OBJ_FROM_PTR(common_hal_bleio_adapter_get_name(self));
 }
@@ -161,7 +163,7 @@ MP_PROPERTY_GETSET(bleio_adapter_name_obj,
 //|         timeout: int = 0,
 //|         interval: float = 0.1,
 //|         tx_power: int = 0,
-//|         directed_to: Optional[Address] = None
+//|         directed_to: Optional[Address] = None,
 //|     ) -> None:
 //|         """Starts advertising until `stop_advertising` is called or if connectable, another device
 //|         connects to us.
@@ -181,6 +183,7 @@ MP_PROPERTY_GETSET(bleio_adapter_name_obj,
 //|         :param int tx_power: transmitter power while advertising in dBm
 //|         :param Address directed_to: peer to advertise directly to"""
 //|         ...
+//|
 static mp_obj_t bleio_adapter_start_advertising(mp_uint_t n_args, const mp_obj_t *pos_args, mp_map_t *kw_args) {
     bleio_adapter_obj_t *self = MP_OBJ_TO_PTR(pos_args[0]);
 
@@ -243,6 +246,7 @@ static MP_DEFINE_CONST_FUN_OBJ_KW(bleio_adapter_start_advertising_obj, 1, bleio_
 //|     def stop_advertising(self) -> None:
 //|         """Stop sending advertising packets."""
 //|         ...
+//|
 static mp_obj_t bleio_adapter_stop_advertising(mp_obj_t self_in) {
     bleio_adapter_obj_t *self = MP_OBJ_TO_PTR(self_in);
 
@@ -262,7 +266,7 @@ static MP_DEFINE_CONST_FUN_OBJ_1(bleio_adapter_stop_advertising_obj, bleio_adapt
 //|         interval: float = 0.1,
 //|         window: float = 0.1,
 //|         minimum_rssi: int = -80,
-//|         active: bool = True
+//|         active: bool = True,
 //|     ) -> Iterable[ScanEntry]:
 //|         """Starts a BLE scan and returns an iterator of results. Advertisements and scan responses are
 //|         filtered and returned separately.
@@ -282,6 +286,7 @@ static MP_DEFINE_CONST_FUN_OBJ_1(bleio_adapter_stop_advertising_obj, bleio_adapt
 //|         :returns: an iterable of `_bleio.ScanEntry` objects
 //|         :rtype: iterable"""
 //|         ...
+//|
 static mp_obj_t bleio_adapter_start_scan(size_t n_args, const mp_obj_t *pos_args, mp_map_t *kw_args) {
     enum { ARG_prefixes, ARG_buffer_size, ARG_extended, ARG_timeout, ARG_interval, ARG_window, ARG_minimum_rssi, ARG_active };
     static const mp_arg_t allowed_args[] = {
@@ -346,6 +351,7 @@ static MP_DEFINE_CONST_FUN_OBJ_KW(bleio_adapter_start_scan_obj, 1, bleio_adapter
 //|     def stop_scan(self) -> None:
 //|         """Stop the current scan."""
 //|         ...
+//|
 static mp_obj_t bleio_adapter_stop_scan(mp_obj_t self_in) {
     bleio_adapter_obj_t *self = MP_OBJ_TO_PTR(self_in);
 
@@ -381,6 +387,7 @@ MP_PROPERTY_GETTER(bleio_adapter_connected_obj,
 //|     connections: Tuple[Connection]
 //|     """Tuple of active connections including those initiated through
 //|     :py:meth:`_bleio.Adapter.connect`. (read-only)"""
+//|
 static mp_obj_t bleio_adapter_get_connections(mp_obj_t self) {
     return common_hal_bleio_adapter_get_connections(self);
 }
@@ -395,6 +402,7 @@ MP_PROPERTY_GETTER(bleio_adapter_connections_obj,
 //|         :param Address address: The address of the peripheral to connect to
 //|         :param float/int timeout: Try to connect for timeout seconds."""
 //|         ...
+//|
 static mp_obj_t bleio_adapter_connect(mp_uint_t n_args, const mp_obj_t *pos_args, mp_map_t *kw_args) {
     bleio_adapter_obj_t *self = MP_OBJ_TO_PTR(pos_args[0]);
 
@@ -418,6 +426,7 @@ static MP_DEFINE_CONST_FUN_OBJ_KW(bleio_adapter_connect_obj, 1, bleio_adapter_co
 //|         """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

@@ -26,6 +26,7 @@
 //|         :param int address_type: one of the integer values: `PUBLIC`, `RANDOM_STATIC`,
 //|           `RANDOM_PRIVATE_RESOLVABLE`, or `RANDOM_PRIVATE_NON_RESOLVABLE`."""
 //|         ...
+//|
 static mp_obj_t bleio_address_make_new(const mp_obj_type_t *type, size_t n_args, size_t n_kw, const mp_obj_t *all_args) {
     enum { ARG_address, ARG_address_type };
     static const mp_arg_t allowed_args[] = {
@@ -86,6 +87,7 @@ MP_PROPERTY_GETTER(bleio_address_address_bytes_obj,
 //|
 //|     One of the integer values: `PUBLIC`, `RANDOM_STATIC`, `RANDOM_PRIVATE_RESOLVABLE`,
 //|     or `RANDOM_PRIVATE_NON_RESOLVABLE`."""
+//|
 static mp_obj_t bleio_address_get_type(mp_obj_t self_in) {
     bleio_address_obj_t *self = MP_OBJ_TO_PTR(self_in);
 
@@ -99,6 +101,7 @@ MP_PROPERTY_GETTER(bleio_address_type_obj,
 //|     def __eq__(self, other: object) -> bool:
 //|         """Two Address objects are equal if their addresses and address types are equal."""
 //|         ...
+//|
 static mp_obj_t bleio_address_binary_op(mp_binary_op_t op, mp_obj_t lhs_in, mp_obj_t rhs_in) {
     switch (op) {
         // Two Addresses are equal if their address bytes and address_type are equal
@@ -124,6 +127,7 @@ static mp_obj_t bleio_address_binary_op(mp_binary_op_t op, mp_obj_t lhs_in, mp_o
 //|     def __hash__(self) -> int:
 //|         """Returns a hash for the Address data."""
 //|         ...
+//|
 static mp_obj_t bleio_address_unary_op(mp_unary_op_t op, mp_obj_t self_in) {
     switch (op) {
         // Two Addresses are equal if their address bytes and address_type are equal
@@ -166,6 +170,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) },

shared-bindings/_bleio/Attribute.c

@@ -19,6 +19,7 @@
 //|     def __init__(self) -> None:
 //|         """You cannot create an instance of :py:class:`~_bleio.Attribute`."""
 //|         ...
+//|
 
 static const mp_rom_map_elem_t bleio_attribute_locals_dict_table[] = {
 
@@ -42,6 +43,7 @@ static const mp_rom_map_elem_t bleio_attribute_locals_dict_table[] = {
 //|
 //|     SIGNED_WITH_MITM: int
 //|     """security_mode: authenticated data signing, without man-in-the-middle protection"""
+//|
 //|
     { MP_ROM_QSTR(MP_QSTR_NO_ACCESS),              MP_ROM_INT(SECURITY_MODE_NO_ACCESS) },
     { MP_ROM_QSTR(MP_QSTR_OPEN),                   MP_ROM_INT(SECURITY_MODE_OPEN) },

shared-bindings/_bleio/Characteristic.c

@@ -25,6 +25,7 @@
 //|         Remote Characteristic objects are created by `Connection.discover_remote_services()`
 //|         as part of remote Services."""
 //|         ...
+//|
 
 //|     @classmethod
 //|     def add_to_service(
@@ -38,7 +39,7 @@
 //|         max_length: int = 20,
 //|         fixed_length: bool = False,
 //|         initial_value: Optional[ReadableBuffer] = None,
-//|         user_description: Optional[str] = None
+//|         user_description: Optional[str] = None,
 //|     ) -> Characteristic:
 //|         """Create a new Characteristic object, and add it to this Service.
 //|
@@ -63,6 +64,7 @@
 //|
 //|         :return: the new Characteristic."""
 //|         ...
+//|
 static mp_obj_t bleio_characteristic_add_to_service(size_t n_args, const mp_obj_t *pos_args, mp_map_t *kw_args) {
     // class is arg[0], which we can ignore.
 
@@ -143,6 +145,7 @@ static MP_DEFINE_CONST_CLASSMETHOD_OBJ(bleio_characteristic_add_to_service_obj,
 //|     def deinit(self) -> None:
 //|         """Deinitialises the Characteristic and releases any hardware resources for reuse."""
 //|         ...
+//|
 static mp_obj_t bleio_characteristic_deinit(mp_obj_t self_in) {
     bleio_characteristic_obj_t *self = MP_OBJ_TO_PTR(self_in);
     common_hal_bleio_characteristic_deinit(self);
@@ -246,6 +249,7 @@ MP_PROPERTY_GETTER(bleio_characteristic_descriptors_obj,
 
 //|     service: Service
 //|     """The Service this Characteristic is a part of."""
+//|
 static mp_obj_t bleio_characteristic_get_service(mp_obj_t self_in) {
     bleio_characteristic_obj_t *self = MP_OBJ_TO_PTR(self_in);
     check_for_deinit(self);
@@ -264,6 +268,7 @@ MP_PROPERTY_GETTER(bleio_characteristic_service_obj,
 //|         :param float indicate: True if Characteristic should receive indications of remote writes
 //|         """
 //|         ...
+//|
 static mp_obj_t bleio_characteristic_set_cccd(mp_uint_t n_args, const mp_obj_t *pos_args, mp_map_t *kw_args) {
     bleio_characteristic_obj_t *self = MP_OBJ_TO_PTR(pos_args[0]);
     check_for_deinit(self);
@@ -312,6 +317,7 @@ static const mp_rom_map_elem_t bleio_characteristic_locals_dict_table[] = {
 //|
 //|     WRITE_NO_RESPONSE: int
 //|     """property: clients may write this characteristic; no response will be sent back"""
+//|
 //|
     { MP_ROM_QSTR(MP_QSTR_BROADCAST),         MP_ROM_INT(CHAR_PROP_BROADCAST) },
     { MP_ROM_QSTR(MP_QSTR_INDICATE),          MP_ROM_INT(CHAR_PROP_INDICATE) },

shared-bindings/_bleio/CharacteristicBuffer.c

@@ -37,6 +37,7 @@ static void raise_error_if_not_connected(bleio_characteristic_buffer_obj_t *self
 //|         :param int buffer_size: Size of ring buffer that stores incoming data coming from client.
 //|           Must be >= 1."""
 //|         ...
+//|
 static mp_obj_t bleio_characteristic_buffer_make_new(const mp_obj_type_t *type, size_t n_args, size_t n_kw, const mp_obj_t *all_args) {
     enum { ARG_characteristic, ARG_timeout, ARG_buffer_size, };
     static const mp_arg_t allowed_args[] = {
@@ -95,6 +96,7 @@ static void check_for_deinit(bleio_characteristic_buffer_obj_t *self) {
 //|         :return: the line read
 //|         :rtype: int or None"""
 //|         ...
+//|
 
 // These three methods are used by the shared stream methods.
 static mp_uint_t bleio_characteristic_buffer_read(mp_obj_t self_in, void *buf_in, mp_uint_t size, int *errcode) {
@@ -140,6 +142,7 @@ static mp_uint_t bleio_characteristic_buffer_ioctl(mp_obj_t self_in, mp_uint_t r
 
 //|     in_waiting: int
 //|     """The number of bytes in the input buffer, available to be read"""
+//|
 static mp_obj_t bleio_characteristic_buffer_obj_get_in_waiting(mp_obj_t self_in) {
     bleio_characteristic_buffer_obj_t *self = MP_OBJ_TO_PTR(self_in);
     check_for_deinit(self);
@@ -158,6 +161,7 @@ MP_PROPERTY_GETTER(bleio_characteristic_buffer_in_waiting_obj,
 //|     def reset_input_buffer(self) -> None:
 //|         """Discard any unread characters in the input buffer."""
 //|         ...
+//|
 static mp_obj_t bleio_characteristic_buffer_obj_reset_input_buffer(mp_obj_t self_in) {
     bleio_characteristic_buffer_obj_t *self = MP_OBJ_TO_PTR(self_in);
     check_for_deinit(self);
@@ -170,6 +174,7 @@ static MP_DEFINE_CONST_FUN_OBJ_1(bleio_characteristic_buffer_reset_input_buffer_
 //|         """Disable permanently."""
 //|         ...
 //|
+//|
 static mp_obj_t bleio_characteristic_buffer_deinit(mp_obj_t self_in) {
     bleio_characteristic_buffer_obj_t *self = MP_OBJ_TO_PTR(self_in);
     common_hal_bleio_characteristic_buffer_deinit(self);

shared-bindings/_bleio/Connection.c

@@ -56,6 +56,7 @@ void bleio_connection_ensure_connected(bleio_connection_obj_t *self) {
 //|     def disconnect(self) -> None:
 //|         """Disconnects from the remote peripheral. Does nothing if already disconnected."""
 //|         ...
+//|
 static mp_obj_t bleio_connection_disconnect(mp_obj_t self_in) {
     bleio_connection_obj_t *self = MP_OBJ_TO_PTR(self_in);
     // common_hal_bleio_connection_disconnect() does nothing if already disconnected.
@@ -71,6 +72,7 @@ static MP_DEFINE_CONST_FUN_OBJ_1(bleio_connection_disconnect_obj, bleio_connecti
 //|         **Limitation**: Currently ``bond``must be ``True``: bonding always occurs.
 //|         """
 //|         ...
+//|
 static mp_obj_t bleio_connection_pair(mp_uint_t n_args, const mp_obj_t *pos_args, mp_map_t *kw_args) {
     bleio_connection_obj_t *self = MP_OBJ_TO_PTR(pos_args[0]);
 
@@ -117,6 +119,7 @@ static MP_DEFINE_CONST_FUN_OBJ_KW(bleio_connection_pair_obj, 1, bleio_connection
 //|
 //|         :return: A tuple of `_bleio.Service` objects provided by the remote peripheral."""
 //|         ...
+//|
 static mp_obj_t bleio_connection_discover_remote_services(mp_uint_t n_args, const mp_obj_t *pos_args, mp_map_t *kw_args) {
     bleio_connection_obj_t *self = MP_OBJ_TO_PTR(pos_args[0]);
 
@@ -188,6 +191,7 @@ static MP_DEFINE_CONST_FUN_OBJ_1(bleio_connection_get_connection_interval_obj, b
 //|     But for a regular characteristic read or write, may be sent in multiple packets,
 //|     so this limit does not apply."""
 //|
+//|
 static mp_obj_t bleio_connection_get_max_packet_length(mp_obj_t self_in) {
     bleio_connection_obj_t *self = MP_OBJ_TO_PTR(self_in);
 

shared-bindings/_bleio/Descriptor.c

@@ -35,7 +35,7 @@
 //|         write_perm: int = Attribute.OPEN,
 //|         max_length: int = 20,
 //|         fixed_length: bool = False,
-//|         initial_value: ReadableBuffer = b""
+//|         initial_value: ReadableBuffer = b"",
 //|     ) -> Descriptor:
 //|         """Create a new Descriptor object, and add it to this Service.
 //|
@@ -55,6 +55,7 @@
 //|
 //|         :return: the new Descriptor."""
 //|         ...
+//|
 static mp_obj_t bleio_descriptor_add_to_characteristic(size_t n_args, const mp_obj_t *pos_args, mp_map_t *kw_args) {
     // class is arg[0], which we can ignore.
 
@@ -147,6 +148,7 @@ MP_PROPERTY_GETTER(bleio_descriptor_characteristic_obj,
 //|     value: bytearray
 //|     """The value of this descriptor."""
 //|
+//|
 static mp_obj_t bleio_descriptor_get_value(mp_obj_t self_in) {
     bleio_descriptor_obj_t *self = MP_OBJ_TO_PTR(self_in);
 

shared-bindings/_bleio/PacketBuffer.c

@@ -21,7 +21,7 @@
 //|         characteristic: Characteristic,
 //|         *,
 //|         buffer_size: int,
-//|         max_packet_size: Optional[int] = None
+//|         max_packet_size: Optional[int] = None,
 //|     ) -> None:
 //|         """Accumulates a Characteristic's incoming packets in a FIFO buffer and facilitates packet aware
 //|         outgoing writes. A packet's size is either the characteristic length or the maximum transmission
@@ -39,6 +39,7 @@
 //|         :param int max_packet_size: Maximum size of packets. Overrides value from the characteristic.
 //|           (Remote characteristics may not have the correct length.)"""
 //|         ...
+//|
 static mp_obj_t bleio_packet_buffer_make_new(const mp_obj_type_t *type, size_t n_args, size_t n_kw, const mp_obj_t *all_args) {
     enum { ARG_characteristic, ARG_buffer_size, ARG_max_packet_size };
     static const mp_arg_t allowed_args[] = {
@@ -79,6 +80,7 @@ static void check_for_deinit(bleio_packet_buffer_obj_t *self) {
 //|         :return: number of bytes read and stored into ``buf``
 //|         :rtype: int"""
 //|         ...
+//|
 static mp_obj_t bleio_packet_buffer_readinto(mp_obj_t self_in, mp_obj_t buffer_obj) {
     bleio_packet_buffer_obj_t *self = MP_OBJ_TO_PTR(self_in);
     check_for_deinit(self);
@@ -104,6 +106,7 @@ static MP_DEFINE_CONST_FUN_OBJ_2(bleio_packet_buffer_readinto_obj, bleio_packet_
 //|         :return: number of bytes written. May include header bytes when packet is empty.
 //|         :rtype: int"""
 //|         ...
+//|
 // TODO: Add a kwarg `merge=False` to dictate whether subsequent writes are merged into a pending
 // one.
 static mp_obj_t bleio_packet_buffer_write(mp_uint_t n_args, const mp_obj_t *pos_args, mp_map_t *kw_args) {
@@ -149,6 +152,7 @@ static MP_DEFINE_CONST_FUN_OBJ_KW(bleio_packet_buffer_write_obj, 1, bleio_packet
 //|     def deinit(self) -> None:
 //|         """Disable permanently."""
 //|         ...
+//|
 static mp_obj_t bleio_packet_buffer_deinit(mp_obj_t self_in) {
     bleio_packet_buffer_obj_t *self = MP_OBJ_TO_PTR(self_in);
     common_hal_bleio_packet_buffer_deinit(self);
@@ -175,6 +179,7 @@ MP_PROPERTY_GETTER(bleio_packet_buffer_incoming_packet_length_obj,
 //|     outgoing_packet_length: int
 //|     """Maximum length in bytes of a packet we are writing."""
 //|
+//|
 static mp_obj_t bleio_packet_buffer_get_outgoing_packet_length(mp_obj_t self_in) {
     bleio_packet_buffer_obj_t *self = MP_OBJ_TO_PTR(self_in);
 

shared-bindings/_bleio/ScanEntry.c

@@ -30,6 +30,7 @@
 //|         than the scan filtering which accepts any advertisements that match any of the prefixes
 //|         where ``match_all`` is False."""
 //|         ...
+//|
 static mp_obj_t bleio_scanentry_matches(mp_uint_t n_args, const mp_obj_t *pos_args, mp_map_t *kw_args) {
     bleio_scanentry_obj_t *self = MP_OBJ_TO_PTR(pos_args[0]);
 
@@ -97,6 +98,7 @@ MP_PROPERTY_GETTER(bleio_scanentry_connectable_obj,
 //|     scan_response: bool
 //|     """True if the entry was a scan response. (read-only)"""
 //|
+//|
 static mp_obj_t scanentry_get_scan_response(mp_obj_t self_in) {
     bleio_scanentry_obj_t *self = MP_OBJ_TO_PTR(self_in);
     return mp_obj_new_bool(common_hal_bleio_scanentry_get_scan_response(self));

shared-bindings/_bleio/ScanResults.c

@@ -40,6 +40,7 @@ static mp_obj_t scanresults_iternext(mp_obj_t self_in) {
 //|         """
 //|         ...
 //|
+//|
 
 MP_DEFINE_CONST_OBJ_TYPE(
     bleio_scanresults_type,