Merge pull request #1927 from opentensor/refactoring/opendansor/synap…

…se-required-hash-field-refactoring

Refactor: Fix naming in Synapse comment for required hash field

bittensor/synapse.py

@@ -20,7 +20,6 @@
 import base64
 import json
 import sys
-import typing
 import warnings
 
 from pydantic import (
@@ -31,7 +30,7 @@
     model_validator,
 )
 import bittensor
-from typing import Optional, Any, Dict
+from typing import Optional, Any, Dict, ClassVar, Tuple
 
 
 def get_size(obj, seen=None) -> int:
@@ -482,7 +481,7 @@ def set_name_type(cls, values) -> dict:
         repr=False,
     )
 
-    required_hash_fields: typing.ClassVar[typing.Tuple[str, ...]] = ()
+    required_hash_fields: ClassVar[Tuple[str, ...]] = ()
 
     _extract_total_size = field_validator("total_size", mode="before")(cast_int)
 
@@ -676,7 +675,7 @@ def body_hash(self) -> str:
 
         Process:
 
-        1. Iterates over each required field as specified in ``required_fields_hash``.
+        1. Iterates over each required field as specified in ``required_hash_fields``.
         2. Concatenates the string representation of these fields.
         3. Applies SHA3-256 hashing to the concatenated string to produce a unique fingerprint of the data.
 

tests/unit_tests/test_synapse.py

@@ -16,11 +16,9 @@
 # DEALINGS IN THE SOFTWARE.
 import json
 import base64
-import typing
-from typing import Optional
-
 import pytest
 import bittensor
+from typing import Optional, ClassVar
 
 
 def test_parse_headers_to_inputs():
@@ -239,7 +237,7 @@ class HashedSynapse(bittensor.Synapse):
     b: int
     c: Optional[int] = None
     d: Optional[list[str]] = None
-    required_hash_fields: typing.ClassVar[tuple[str, ...]] = ("a", "b", "d")
+    required_hash_fields: ClassVar[tuple[str, ...]] = ("a", "b", "d")
 
 
 @pytest.mark.parametrize("synapse_cls", [LegacyHashedSynapse, HashedSynapse])