Method _parse_spellcheck_resp3

redis/commands/search/commands.py:641–677

Parse RESP3 FT.SPELLCHECK response into unified format. RESP3 format: {"results": {"term": [{"suggestion": score}, ...], ...}} Unified format (matches RESP2 parsed output): {"term": [{"score": score_str, "suggestion": suggestion}, ...], ...}

(self, res, **kwargs)

    # ---- RESP3 spellcheck parser ----

    def _parse_spellcheck_resp3(self, res, **kwargs):
        """Parse RESP3 FT.SPELLCHECK response into unified format.

        RESP3 format:
            {"results": {"term": [{"suggestion": score}, ...], ...}}
        Unified format (matches RESP2 parsed output):
            {"term": [{"score": score_str, "suggestion": suggestion}, ...], ...}
        """
        if not isinstance(res, dict):
            return self._parse_spellcheck(res, **kwargs)
        # On RESP3 connections with decode_responses=False the server's map
        # keys arrive as bytes, so normalise the structural ``results`` key
        # to a string before lookup.  Mirrors ``Result.from_resp3``.
        res = {str_if_bytes(k): v for k, v in res.items()}
        corrections = {}
        results = res.get("results", {})
        for term, suggestions in results.items():
            if not suggestions:
                continue
            term_corrections = []
            for suggestion_dict in suggestions:
                for suggestion, score in suggestion_dict.items():
                    # Normalize score to match RESP2's string form: RESP3
                    # returns a float (e.g. ``0.0``) but RESP2 returns the
                    # string ``"0"``.
                    score_str = str(score)
                    if score_str.endswith(".0"):
                        score_str = score_str[:-2]
                    # Preserve ``suggestion`` as-is so it keeps the
                    # ``decode_responses`` shape RESP2 would produce
                    # (``str`` when decoded, ``bytes`` otherwise).
                    term_corrections.append(
                        {"score": score_str, "suggestion": suggestion}
                    )
            if term_corrections:
                corrections[term] = term_corrections
        return corrections

    # ---- RESP3 profile parsers ----