Add function is_standard_uuid128 to utils (#27)

setup.cfg

@@ -125,6 +125,7 @@ rst-roles =
 rst-directives =
     envvar,
     exception,
+    versionadded,
 rst-substitutions =
     version,
 extend_ignore = E203, W503

src/bluetooth_numbers/utils.py

@@ -74,7 +74,7 @@ def uuid128_to_uuid16(uuid128: UUID) -> int:
     """Convert a 128-bit standard Bluetooth UUID to a 16-bit UUID.
 
     Args:
-        uuid128 (~uuid.UUID): A 128-bit standard Bluetooth UUID.
+        uuid128 (~uuid.UUID): A 128-bit Bluetooth UUID.
 
     Raises:
         NonStandardUUIDError: If `uuid128` is not a 128-bit standard Bluetooth UUID.
@@ -84,18 +84,40 @@ def uuid128_to_uuid16(uuid128: UUID) -> int:
 
     Example:
         >>> from bluetooth_numbers.utils import uuid128_to_uuid16, uint16_to_hex
+        >>> from uuid import UUID
         >>> uint16_to_hex(uuid128_to_uuid16(UUID('00001800-0000-1000-8000-00805f9b34fb')))
         '0x1800'
     """
-    # Test whether the 128-bit UUID is a standard Bluetooth UUID
+    if is_standard_uuid128(uuid128):
+        # Extract the 16-bit UUID
+        return int.from_bytes(uuid128.bytes[2:4], "big")
+
+    raise NonStandardUUIDError(uuid128)
+
+
+def is_standard_uuid128(uuid128: UUID) -> bool:
+    """Check whether a 128-bit Bluetooth UUID is a standard UUID.
+
+    Args:
+        uuid128 (~uuid.UUID): A 128-bit Bluetooth UUID.
+
+    Returns:
+        bool: ``True`` if `uuid128` is a standard Bluetooth UUID, ``False`` otherwise.
+
+    Examples:
+        >>> from bluetooth_numbers.utils import is_standard_uuid128
+        >>> from uuid import UUID
+        >>> is_standard_uuid128(UUID('00001800-0000-1000-8000-00805f9b34fb'))
+        True
+        >>> is_standard_uuid128(UUID('bfc46884-ea75-416b-8154-29c5d0b0a087'))
+        False
+
+    .. versionadded:: 1.1.0
+    """
     uuid128_bytearray = bytearray(uuid128.bytes)
     uuid128_bytearray[2:4] = b"\x00\x00"
     uuid128_masked = UUID(bytes=bytes(uuid128_bytearray))
-    if uuid128_masked != BASE_UUID:
-        raise NonStandardUUIDError(uuid128_masked)
-
-    # If it is, extract the 16-bit UUID
-    return int.from_bytes(uuid128.bytes[2:4], "big")
+    return uuid128_masked == BASE_UUID
 
 
 def uuid16_to_uuid128(uuid16: int) -> UUID:

tests/test_utils.py

@@ -10,6 +10,7 @@
 )
 from bluetooth_numbers.utils import (
     is_normalized_oui,
+    is_standard_uuid128,
     is_uint16,
     normalize_oui,
     uint16_to_hex,
@@ -158,6 +159,24 @@ def test_invalid_uuid16_to_uuid128(uuid16: int) -> None:
         uuid16_to_uuid128(uuid16)
 
 
+@pytest.mark.parametrize(
+    "uuid128, standard",
+    [
+        (UUID("00001800-0000-1000-8000-00805F9B34FB"), True),
+        (UUID("0000FD6F-0000-1000-8000-00805F9B34FB"), True),
+        (UUID("bfc46884-ea75-416b-8154-29c5d0b0a087"), False),
+        (UUID("00001800-0000-1000-8000-00805F9B34FC"), False),
+    ],
+)
+def test_is_standard_uuid128(uuid128: UUID, standard: bool) -> None:
+    """Test the is_standard_uuid128 function.
+
+    It should return ``True`` for a 128-bit standard Bluetooth UUID,
+    ``False`` otherwise.
+    """
+    assert is_standard_uuid128(uuid128) == standard
+
+
 @pytest.mark.parametrize(
     "uuid128, uuid16",
     [