mirror of
https://github.com/HKUDS/nanobot.git
synced 2026-05-19 16:12:30 +00:00
352aaf0627
Reasoning surfacing was split across three branches in runner.py plus two separate streaming buffers (loop hook and runner progress stream), with three independent display-side gates in the CLI. This collapsed the policy into one source of truth and fixed two real bugs: - Structured `reasoning_content` was suppressed whenever the answer was streamed, because the runner gated emission on `streamed_content`. Providers don't stream `reasoning_content`; it only arrives on the final response, so the answer stream and the reasoning channel are independent. Added `streamed_reasoning` to `AgentHookContext` to track the right bit. - `channels.showReasoning` was subordinated to `sendProgress`. They are orthogonal — turning off progress streaming shouldn't silence reasoning. Reworked the CLI gates accordingly. Single-helper consolidation: - `extract_reasoning(reasoning_content, thinking_blocks, content)` returns `(reasoning_text, cleaned_content)` with a defined fallback order: dedicated field → Anthropic thinking_blocks → inline `<think>`/`<thought>` tags. Models that expose none of these short-circuit to `(None, content)` — zero overhead. - `IncrementalThinkExtractor` replaces the ad-hoc `emit_incremental_think` function and its hand-rolled "emitted cursor" state in both the loop hook and the runner progress stream. Also documented the new `showReasoning` channel option in docs/configuration.md and noted its independence from sendProgress. Co-authored-by: Cursor <cursoragent@cursor.com>
274 lines
11 KiB
Python
274 lines
11 KiB
Python
from nanobot.utils.helpers import extract_reasoning, extract_think, strip_think
|
||
|
||
|
||
class TestStripThinkTag:
|
||
"""Test <thought>...</thought> block stripping (Gemma 4 and similar models)."""
|
||
|
||
def test_closed_tag(self):
|
||
assert strip_think("Hello <thought>reasoning</thought> World") == "Hello World"
|
||
|
||
def test_unclosed_trailing_tag(self):
|
||
assert strip_think("<thought>ongoing...") == ""
|
||
|
||
def test_multiline_tag(self):
|
||
assert strip_think("<thought>\nline1\nline2\n</thought>End") == "End"
|
||
|
||
def test_tag_with_nested_angle_brackets(self):
|
||
text = "<thought>a < 3 and b > 2</thought>result"
|
||
assert strip_think(text) == "result"
|
||
|
||
def test_multiple_tag_blocks(self):
|
||
text = "A<thought>x</thought>B<thought>y</thought>C"
|
||
assert strip_think(text) == "ABC"
|
||
|
||
def test_tag_only_whitespace_inside(self):
|
||
assert strip_think("before<thought> </thought>after") == "beforeafter"
|
||
|
||
def test_self_closing_tag_not_matched(self):
|
||
assert strip_think("<thought/>some text") == "<thought/>some text"
|
||
|
||
def test_normal_text_unchanged(self):
|
||
assert strip_think("Just normal text") == "Just normal text"
|
||
|
||
def test_empty_string(self):
|
||
assert strip_think("") == ""
|
||
|
||
|
||
class TestStripThinkFalsePositive:
|
||
"""Ensure mid-content <think>/<thought> tags are NOT stripped (#3004)."""
|
||
|
||
def test_backtick_think_tag_preserved(self):
|
||
text = "*Think Stripping:* A new utility to strip `<think>` tags from output."
|
||
assert strip_think(text) == text
|
||
|
||
def test_prose_think_tag_preserved(self):
|
||
text = "The model emits <think> at the start of its response."
|
||
assert strip_think(text) == text
|
||
|
||
def test_code_block_think_tag_preserved(self):
|
||
text = 'Example:\n```\ntext = re.sub(r"<think>[\\s\\S]*", "", text)\n```\nDone.'
|
||
assert strip_think(text) == text
|
||
|
||
def test_backtick_thought_tag_preserved(self):
|
||
text = "Gemma 4 uses `<thought>` blocks for reasoning."
|
||
assert strip_think(text) == text
|
||
|
||
def test_prefix_unclosed_think_still_stripped(self):
|
||
assert strip_think("<think>reasoning without closing") == ""
|
||
|
||
def test_prefix_unclosed_think_with_whitespace(self):
|
||
assert strip_think(" <think>reasoning...") == ""
|
||
|
||
def test_prefix_unclosed_thought_still_stripped(self):
|
||
assert strip_think("<thought>reasoning without closing") == ""
|
||
|
||
|
||
class TestStripThinkMalformedLeaks:
|
||
"""Regression: Gemma 4's Ollama renderer occasionally emits a tag name
|
||
with no closing '>', running straight into the user-facing content
|
||
(e.g. `<think广场照明灯目前…`). The earlier regexes required '>' and
|
||
let these through."""
|
||
|
||
def test_malformed_think_no_gt_chinese(self):
|
||
assert strip_think("<think广场照明灯目前绑定在'照明灯'策略下") == (
|
||
"广场照明灯目前绑定在'照明灯'策略下"
|
||
)
|
||
|
||
def test_malformed_think_no_gt_english_with_space(self):
|
||
# English leak with a space after the tag name (common streaming form).
|
||
assert strip_think("<think The fountain opens at 09:00") == ("The fountain opens at 09:00")
|
||
|
||
def test_malformed_thought_no_gt(self):
|
||
assert strip_think("<thought广场照明灯") == "广场照明灯"
|
||
|
||
def test_thinker_word_preserved(self):
|
||
# `<thinker>` is a valid tag name variant; must not match.
|
||
assert strip_think("<thinker>content</thinker>") == "<thinker>content</thinker>"
|
||
|
||
def test_self_closing_preserved(self):
|
||
assert strip_think("<think/>ok") == "<think/>ok"
|
||
assert strip_think("<thought/>ok") == "<thought/>ok"
|
||
|
||
def test_orphan_closing_think_at_end_stripped(self):
|
||
# Typical leak: model opens `<think>` without closing; we strip the
|
||
# opener from the start, leaving an orphan `</think>` at the end.
|
||
assert strip_think("answer</think>") == "answer"
|
||
|
||
def test_orphan_closing_think_at_start_stripped(self):
|
||
assert strip_think("</think>answer") == "answer"
|
||
|
||
def test_channel_marker_at_start_stripped(self):
|
||
# Harmony / Gemma 4 channel markers leak at the start of a response.
|
||
assert strip_think("<channel|>喷泉策略：09:00 开启") == ("喷泉策略：09:00 开启")
|
||
assert strip_think("<|channel|>answer") == "answer"
|
||
|
||
def test_partial_trailing_think_tag_after_visible_text(self):
|
||
assert strip_think("喷泉策略说明 <thin") == "喷泉策略说明"
|
||
assert strip_think("answer <thought") == "answer"
|
||
assert strip_think("answer <think>") == "answer"
|
||
|
||
def test_partial_trailing_channel_marker_after_visible_text(self):
|
||
assert strip_think("喷泉策略说明 <|chan") == "喷泉策略说明"
|
||
assert strip_think("answer <channel") == "answer"
|
||
assert strip_think("answer <|channel|>") == "answer"
|
||
|
||
|
||
class TestStripThinkConservativePreserve:
|
||
"""Regression: the malformed-tag / orphan cleanup must NOT touch
|
||
legitimate prose or code that mentions these tokens literally, otherwise
|
||
`strip_think` (which runs before history is persisted, memory.py) will
|
||
silently rewrite the conversation transcript."""
|
||
|
||
def test_think_dash_variant_preserved(self):
|
||
assert strip_think("<think-foo>bar</think-foo>") == "<think-foo>bar</think-foo>"
|
||
|
||
def test_think_underscore_variant_preserved(self):
|
||
assert strip_think("<think_foo>bar</think_foo>") == "<think_foo>bar</think_foo>"
|
||
|
||
def test_think_numeric_variant_preserved(self):
|
||
assert strip_think("<think1>bar</think1>") == "<think1>bar</think1>"
|
||
|
||
def test_think_namespaced_variant_preserved(self):
|
||
assert strip_think("<think:foo>bar</think:foo>") == "<think:foo>bar</think:foo>"
|
||
|
||
def test_literal_close_think_in_prose_preserved(self):
|
||
# Mid-prose references to `</think>` in backticks or plain text must
|
||
# not be stripped; edge-only regex protects this.
|
||
text = "Use `</think>` to close a thinking block."
|
||
assert strip_think(text) == text
|
||
|
||
def test_literal_channel_marker_in_prose_preserved(self):
|
||
text = "The Harmony spec uses `<|channel|>` and `<channel|>` markers."
|
||
assert strip_think(text) == text
|
||
|
||
def test_literal_channel_marker_in_code_block_preserved(self):
|
||
text = "Example:\n```\nif line.startswith('<channel|>'):\n skip()\n```"
|
||
assert strip_think(text) == text
|
||
|
||
|
||
class TestExtractThink:
|
||
|
||
def test_no_think_tags(self):
|
||
thinking, clean = extract_think("Hello World")
|
||
assert thinking is None
|
||
assert clean == "Hello World"
|
||
|
||
def test_single_think_block(self):
|
||
text = "Hello <think>reasoning content\nhere</think> World"
|
||
thinking, clean = extract_think(text)
|
||
assert thinking == "reasoning content\nhere"
|
||
assert clean == "Hello World"
|
||
|
||
def test_single_thought_block(self):
|
||
text = "Hello <thought>reasoning content</thought> World"
|
||
thinking, clean = extract_think(text)
|
||
assert thinking == "reasoning content"
|
||
assert clean == "Hello World"
|
||
|
||
def test_multiple_think_blocks(self):
|
||
text = "A<think>first</think>B<thought>second</thought>C"
|
||
thinking, clean = extract_think(text)
|
||
assert thinking == "first\n\nsecond"
|
||
assert clean == "ABC"
|
||
|
||
def test_think_only_no_content(self):
|
||
text = "<think>just thinking</think>"
|
||
thinking, clean = extract_think(text)
|
||
assert thinking == "just thinking"
|
||
assert clean == ""
|
||
|
||
def test_unclosed_think_not_extracted(self):
|
||
# Unclosed blocks at start are stripped but NOT extracted
|
||
text = "<think>unclosed thinking..."
|
||
thinking, clean = extract_think(text)
|
||
assert thinking is None
|
||
assert clean == ""
|
||
|
||
def test_empty_think_block(self):
|
||
text = "Hello <think></think> World"
|
||
thinking, clean = extract_think(text)
|
||
# Empty blocks result in empty string after strip
|
||
assert thinking == ""
|
||
assert clean == "Hello World"
|
||
|
||
def test_think_with_whitespace_only(self):
|
||
text = "Hello <think> \n World"
|
||
thinking, clean = extract_think(text)
|
||
assert thinking is None
|
||
assert clean == "Hello <think> \n World"
|
||
|
||
def test_mixed_think_and_thought(self):
|
||
text = "Start<think>first reasoning</think>middle<thought>second reasoning</thought>End"
|
||
thinking, clean = extract_think(text)
|
||
assert thinking == "first reasoning\n\nsecond reasoning"
|
||
assert clean == "StartmiddleEnd"
|
||
|
||
def test_real_world_ollama_response(self):
|
||
text = """<think>
|
||
The user is asking about Python list comprehensions.
|
||
Let me explain the syntax and give examples.
|
||
</think>
|
||
|
||
List comprehensions in Python provide a concise way to create lists. Here's the syntax:
|
||
|
||
```python
|
||
[expression for item in iterable if condition]
|
||
```
|
||
|
||
For example:
|
||
```python
|
||
squares = [x**2 for x in range(10)]
|
||
```"""
|
||
thinking, clean = extract_think(text)
|
||
assert "list comprehensions" in thinking.lower()
|
||
assert "Let me explain" in thinking
|
||
assert "List comprehensions in Python" in clean
|
||
assert "<think>" not in clean
|
||
assert "</think>" not in clean
|
||
|
||
|
||
class TestExtractReasoning:
|
||
"""Single source of truth for reasoning extraction across all providers."""
|
||
|
||
def test_prefers_reasoning_content_and_strips_inline_think(self):
|
||
# Dedicated field wins; inline tags are still scrubbed from content.
|
||
reasoning, content = extract_reasoning(
|
||
"dedicated",
|
||
None,
|
||
"<think>inline</think>visible answer",
|
||
)
|
||
assert reasoning == "dedicated"
|
||
assert content == "visible answer"
|
||
|
||
def test_falls_back_to_thinking_blocks(self):
|
||
reasoning, content = extract_reasoning(
|
||
None,
|
||
[
|
||
{"type": "thinking", "thinking": "step 1"},
|
||
{"type": "thinking", "thinking": "step 2"},
|
||
{"type": "redacted_thinking"},
|
||
],
|
||
"hello",
|
||
)
|
||
assert reasoning == "step 1\n\nstep 2"
|
||
assert content == "hello"
|
||
|
||
def test_falls_back_to_inline_think_tags(self):
|
||
reasoning, content = extract_reasoning(
|
||
None, None, "<think>plan</think>answer"
|
||
)
|
||
assert reasoning == "plan"
|
||
assert content == "answer"
|
||
|
||
def test_no_reasoning_returns_none(self):
|
||
reasoning, content = extract_reasoning(None, None, "plain answer")
|
||
assert reasoning is None
|
||
assert content == "plain answer"
|
||
|
||
def test_empty_thinking_blocks_falls_through_to_inline(self):
|
||
reasoning, content = extract_reasoning(
|
||
None, [], "<think>plan</think>answer"
|
||
)
|
||
assert reasoning == "plan"
|
||
assert content == "answer"
|