Merge pull request #164 from kevincar/119-inconsistent-spelling-of-writable

Fix inconsistent spelling of writable

Author: kevincar

bless/backends/attribute.py

@@ -3,6 +3,6 @@
 
 class GATTAttributePermissions(Flag):
     readable = 0x1
-    writeable = 0x2
+    writable = 0x2
     read_encryption_required = 0x4
     write_encryption_required = 0x8

bless/backends/characteristic.py

@@ -58,15 +58,15 @@ def _properties_to_bleak(
 
 class BlessGATTCharacteristic(BleakGATTCharacteristic):
     """
-    Extension of the BleakGATTCharacteristic to allow for writeable values
+    Extension of the BleakGATTCharacteristic to allow for writable values
     """
 
     def __init__(
         self,
         uuid: Union[str, UUID],
         properties: GATTCharacteristicProperties,
         permissions: GATTAttributePermissions,
-        value: Optional[bytearray]
+        value: Optional[bytearray],
     ):
         """
         Instantiates a new GATT Characteristic but is not yet assigned to any

bless/backends/descriptor.py

@@ -26,15 +26,15 @@ class GATTDescriptorProperties(Flag):
 
 class BlessGATTDescriptor(BleakGATTDescriptor):
     """
-    Extension of the BleakGATTDescriptor to allow for writeable values
+    Extension of the BleakGATTDescriptor to allow for writable values
     """
 
     def __init__(
         self,
         uuid: Union[str, UUID],
         properties: GATTDescriptorProperties,
         permissions: GATTAttributePermissions,
-        value: Optional[bytearray]
+        value: Optional[bytearray],
     ):
         """
         Instantiates a new GATT Descriptor but is not yet assigned to any

docs/usage.rst

@@ -22,7 +22,7 @@ Create a server, add a GATT tree, then start advertising:
                    ),
                    "Permissions": (
                        GATTAttributePermissions.readable
-                       | GATTAttributePermissions.writeable
+                       | GATTAttributePermissions.writable
                    ),
                    "Value": None,
                }

examples/gattserver.py

@@ -62,7 +62,7 @@ async def run(loop):
                 ),
                 "Permissions": (
                     GATTAttributePermissions.readable
-                    | GATTAttributePermissions.writeable
+                    | GATTAttributePermissions.writable
                 ),
                 "Value": None,
             }

examples/gattserver_notify.py

@@ -2,6 +2,7 @@
 Example for a BLE 4.0 Server using a GATT dictionary of services and
 characteristics, plus explicit notifications to subscribed centrals.
 """
+
 import sys
 import logging
 import asyncio
@@ -54,7 +55,7 @@ async def run(loop):
                 ),
                 "Permissions": (
                     GATTAttributePermissions.readable
-                    | GATTAttributePermissions.writeable
+                    | GATTAttributePermissions.writable
                 ),
                 "Value": None,
             }

examples/server.py

@@ -1,6 +1,7 @@
 """
 Example for a BLE 4.0 Server
 """
+
 import sys
 import logging
 import asyncio
@@ -58,7 +59,7 @@ async def run(loop):
         | GATTCharacteristicProperties.write
         | GATTCharacteristicProperties.indicate
     )
-    permissions = GATTAttributePermissions.readable | GATTAttributePermissions.writeable
+    permissions = GATTAttributePermissions.readable | GATTAttributePermissions.writable
     await server.add_new_characteristic(
         my_service_uuid, my_char_uuid, char_flags, None, permissions
     )

test/backends/test_server.py

@@ -85,7 +85,7 @@ async def test_server(self):
         )
         value: Optional[bytearray] = None
         permissions: GATTAttributePermissions = (
-            GATTAttributePermissions.readable | GATTAttributePermissions.writeable
+            GATTAttributePermissions.readable | GATTAttributePermissions.writable
         )
 
         if use_encrypted:

test/backends/winrt/test_serviceprovider.py

@@ -107,9 +107,7 @@ def advertisement_status_changed(
             if args.status == 2:
                 start_event.set()
 
-        def read(
-                sender: GattLocalCharacteristic,
-                args: GattReadRequestedEventArgs):
+        def read(sender: GattLocalCharacteristic, args: GattReadRequestedEventArgs):
             print("Read")
             deferral: Deferral = args.get_deferral()
             value = self.val
@@ -120,20 +118,20 @@ def read(
             async def f():
                 nonlocal request
                 request = await args.get_request_async()
+
             asyncio.run(f())
             request.respond_with_value(writer.detach_buffer())
             deferral.complete()
 
-        def write(
-                sender: GattLocalCharacteristic,
-                args: GattWriteRequestedEventArgs):
+        def write(sender: GattLocalCharacteristic, args: GattWriteRequestedEventArgs):
             print("WRITE")
             deferral: Deferral = args.get_deferral()
             request: GattWriteRequest
 
             async def f():
                 nonlocal request
                 request = await args.get_request_async()
+
             asyncio.run(f())
             reader: DataReader = DataReader.from_buffer(request.value)
             n_bytes: int = reader.unconsumed_buffer_length
@@ -156,9 +154,7 @@ def subscribe(sender: GattLocalCharacteristic, args: Any):
         service_provider_result: GattServiceProviderResult = (
             await GattServiceProvider.create_async(service_uuid)
         )
-        service_provider: GattServiceProvider = (
-                service_provider_result.service_provider
-                )
+        service_provider: GattServiceProvider = service_provider_result.service_provider
         service_provider.add_advertisement_status_changed(advertisement_status_changed)
 
         new_service: GattLocalService = service_provider.service
@@ -173,8 +169,7 @@ def subscribe(sender: GattLocalCharacteristic, args: Any):
         )
 
         permissions: GATTAttributePermissions = (
-            GATTAttributePermissions.readable |
-            GATTAttributePermissions.writeable
+            GATTAttributePermissions.readable | GATTAttributePermissions.writable
         )
 
         read_parameters: GattLocalCharacteristicParameters = (

test/test_bleak_v1_compatibility.py

@@ -54,7 +54,7 @@ async def test_add_characteristic(self):
             | GATTCharacteristicProperties.notify
         )
         permissions = (
-            GATTAttributePermissions.readable | GATTAttributePermissions.writeable
+            GATTAttributePermissions.readable | GATTAttributePermissions.writable
         )
 
         await server.add_new_characteristic(
@@ -114,7 +114,7 @@ async def test_add_gatt_tree(self):
                     ),
                     "Permissions": (
                         GATTAttributePermissions.readable
-                        | GATTAttributePermissions.writeable
+                        | GATTAttributePermissions.writable
                     ),
                     "Value": bytearray(b"test"),
                 }
@@ -142,7 +142,7 @@ async def test_characteristic_value(self):
             GATTCharacteristicProperties.read | GATTCharacteristicProperties.write
         )
         permissions = (
-            GATTAttributePermissions.readable | GATTAttributePermissions.writeable
+            GATTAttributePermissions.readable | GATTAttributePermissions.writable
         )
 
         await server.add_new_characteristic(
@@ -175,7 +175,7 @@ async def test_characteristic_properties(self):
             | GATTCharacteristicProperties.notify
         )
         permissions = (
-            GATTAttributePermissions.readable | GATTAttributePermissions.writeable
+            GATTAttributePermissions.readable | GATTAttributePermissions.writable
         )
 
         await server.add_new_characteristic(