feat: add utility method for getting attributes as map (#354)

src/aioslsk/distributed.py

@@ -494,6 +494,7 @@ async def _on_distributed_child_depth(
     @on_message(DistributedSearchRequest.Request)
     async def _on_distributed_search_request(
             self, message: DistributedSearchRequest.Request, connection: PeerConnection):
+
         await self.send_messages_to_children(message)
 
     @on_message(DistributedServerSearchRequest.Request)

src/aioslsk/protocol/primitives.py

@@ -31,6 +31,7 @@
       has been fully parsed. If not it will parse this field
 """
 from dataclasses import dataclass, field, Field, fields, is_dataclass
+import enum
 import hashlib
 import logging
 import socket
@@ -64,6 +65,14 @@ def serialize(self, *args, **kwargs) -> bytes:
         ...
 
 
+class AttributeKey(enum.Enum):
+    BITRATE = 0
+    DURATION = 1
+    VBR = 2
+    SAMPLE_RATE = 4
+    BIT_DEPTH = 5
+
+
 def decode_string(value: bytes) -> str:
     try:
         return value.decode('utf-8')
@@ -473,6 +482,19 @@ def serialize(self) -> bytes:
             array(self.attributes).serialize(Attribute)
         )
 
+    def get_attribute_map(self) -> dict[AttributeKey, int]:
+        """Converts the attribute list to a dictionary. The resulting dictionary
+        will only contain known attributes and attributes present in the list
+        """
+        attribute_dict = {}
+        for attr in self.attributes:
+            try:
+                attribute_dict[AttributeKey(attr.key)] = attr.value
+            except ValueError:
+                pass
+
+        return attribute_dict
+
 
 @dataclass(frozen=True, order=True)
 class DirectoryData(ProtocolDataclass):

src/aioslsk/tasks.py

@@ -76,6 +76,7 @@ async def runner(self):
 
 
 class Timer:
+    """Re-schedulable timer which runs a callback after completion"""
 
     def __init__(self, timeout: float, callback: TaskCoroutine):
         self.timeout: float = timeout

src/aioslsk/utils.py

@@ -41,6 +41,7 @@ def get_duration(attributes: list[Attribute]) -> str:
 
 
 def get_attribute_string(attributes: list[Attribute]) -> str:
+    """Returns an attributes list to a string (excludes duration)"""
     attr_str = []
     for attr in attributes:
         if attr.key == 0:

tests/unit/protocol/test_primitives.py

@@ -3,7 +3,14 @@
 from typing import ClassVar
 import pytest
 
-from aioslsk.protocol.primitives import decode_string, uint32, MessageDataclass
+from aioslsk.protocol.primitives import (
+    decode_string,
+    Attribute,
+    AttributeKey,
+    FileData,
+    MessageDataclass,
+    uint32,
+)
 
 
 logger = logging.getLogger()
@@ -53,3 +60,26 @@ def test_whenDeserialize_fieldWithoutType_shouldRaise(self):
         data = bytes.fromhex('04000000010000000100000030')
         with pytest.raises(Exception):
             FieldWithoutType.deserialize(0, data)
+
+
+class TestFileData:
+
+    def test_getAttributeMap(self):
+        attrs = [
+            Attribute(0, 320),
+            Attribute(1, 120),
+            Attribute(2, 1),
+            Attribute(4, 44100),
+            Attribute(5, 24),
+            # Unknown value
+            Attribute(10, 10)
+        ]
+        file_data = FileData(1, 'test', 2, '', attrs)
+
+        assert file_data.get_attribute_map() == {
+            AttributeKey.BITRATE: 320,
+            AttributeKey.DURATION: 120,
+            AttributeKey.VBR: 1,
+            AttributeKey.SAMPLE_RATE: 44100,
+            AttributeKey.BIT_DEPTH: 24
+        }