Function deserialize_entity_key

sdk/python/feast/infra/key_encoding_utils.py:193–268

Deserialize entity key from a bytestring. This function can only be used with entity_key_serialization_version > 2. Args: entity_key_serialization_version: version of the entity key serialization serialized_entity_key: serialized entity key bytes Returns: EntityKeyProto

(
    serialized_entity_key: bytes, entity_key_serialization_version=3
)

def deserialize_entity_key(
    serialized_entity_key: bytes, entity_key_serialization_version=3
) -> EntityKeyProto:
    """
    Deserialize entity key from a bytestring. This function can only be used with entity_key_serialization_version > 2.
    Args:
        entity_key_serialization_version: version of the entity key serialization
        serialized_entity_key: serialized entity key bytes

    Returns: EntityKeyProto

    """
    if entity_key_serialization_version < 3:
        # Not raising the error, keeping it in warning state for reserialization purpose
        # We should remove this after few releases
        warnings.warn(
            "Deserialization of entity key with version < 3 is removed. Please use version 3 by setting entity_key_serialization_version=3."
            "To reserializa your online store featrues refer -  https://github.com/feast-dev/feast/blob/master/docs/how-to-guides/entity-reserialization-of-from-v2-to-v3.md"
        )
    # Optimized deserialization using memoryview for zero-copy slicing
    buffer = memoryview(serialized_entity_key)
    pos = 0
    keys = []
    values = []

    # Read number of keys
    if len(buffer) < pos + 4:
        raise ValueError(
            "Invalid serialized entity key: insufficient data for key count"
        )
    num_keys = struct.unpack("<I", buffer[pos : pos + 4])[0]
    pos += 4

    # Process all keys uniformly
    for _ in range(num_keys):
        if len(buffer) < pos + 8:  # Need at least 8 bytes for type + length
            raise ValueError(
                "Invalid serialized entity key: insufficient data for key metadata"
            )

        key_type, key_length = struct.unpack("<2I", buffer[pos : pos + 8])
        pos += 8

        if key_type == ValueType.STRING:
            if len(buffer) < pos + key_length:
                raise ValueError(
                    "Invalid serialized entity key: insufficient data for key"
                )
            key = struct.unpack(f"<{key_length}s", buffer[pos : pos + key_length])[0]
            keys.append(key.decode("utf-8").rstrip("\x00"))
            pos += key_length
        else:
            raise ValueError(f"Unsupported key type: {key_type}")

    # Process values with bounds checking
    while pos < len(buffer):
        if len(buffer) < pos + 8:  # Need at least 8 bytes for type + length
            raise ValueError(