mirror of
https://github.com/infiniflow/ragflow.git
synced 2026-06-29 23:41:12 +08:00
### What problem does this PR solve? Markdown extraction currently applies custom delimiters before respecting fenced code blocks. When a delimiter such as a newline is configured, fenced code can be split into separate chunks, and longer outer fences can be closed incorrectly by shorter nested fences. This PR keeps the fix intentionally narrow for the Markdown chunking discussion in #15482: - preserve fenced code blocks when delimiter-based extraction is used - support both backtick and tilde fences - respect fence length so longer outer fences can contain shorter inner fences - keep delimiter splitting unchanged outside fenced blocks Refs #15482 ### Type of change - [x] Bug Fix (non-breaking change which fixes an issue) ### Testing - `ruff check deepdoc/parser/markdown_parser.py test/unit_test/deepdoc/parser/test_markdown_parser.py` - `python3 run_tests.py -t test/unit_test/deepdoc/parser/test_markdown_parser.py`
386 lines
14 KiB
Python
386 lines
14 KiB
Python
# -*- coding: utf-8 -*-
|
|
#
|
|
# Copyright 2025 The InfiniFlow Authors. All Rights Reserved.
|
|
#
|
|
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
# you may not use this file except in compliance with the License.
|
|
# You may obtain a copy of the License at
|
|
#
|
|
# http://www.apache.org/licenses/LICENSE-2.0
|
|
#
|
|
# Unless required by applicable law or agreed to in writing, software
|
|
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
# See the License for the specific language governing permissions and
|
|
# limitations under the License.
|
|
#
|
|
|
|
import logging
|
|
import re
|
|
|
|
from markdown import markdown
|
|
|
|
|
|
class RAGFlowMarkdownParser:
|
|
def __init__(self, chunk_token_num=128):
|
|
self.chunk_token_num = int(chunk_token_num)
|
|
|
|
def extract_tables_and_remainder(self, markdown_text, separate_tables=True):
|
|
tables = []
|
|
working_text = markdown_text
|
|
|
|
def replace_tables_with_rendered_html(pattern, table_list, render=True):
|
|
new_text = ""
|
|
last_end = 0
|
|
for match in pattern.finditer(working_text):
|
|
raw_table = match.group()
|
|
table_list.append(raw_table)
|
|
if separate_tables:
|
|
# Skip this match (i.e., remove it)
|
|
new_text += working_text[last_end : match.start()] + "\n\n"
|
|
else:
|
|
# Replace with rendered HTML
|
|
html_table = markdown(raw_table, extensions=["markdown.extensions.tables"]) if render else raw_table
|
|
new_text += working_text[last_end : match.start()] + html_table + "\n\n"
|
|
last_end = match.end()
|
|
new_text += working_text[last_end:]
|
|
return new_text
|
|
|
|
if "|" in markdown_text: # for optimize performance
|
|
# Standard Markdown table
|
|
border_table_pattern = re.compile(
|
|
r"""
|
|
(?:\n|^)
|
|
(?:\|.*?\|.*?\|.*?\n)
|
|
(?:\|(?:\s*[:-]+[-| :]*\s*)\|.*?\n)
|
|
(?:\|.*?\|.*?\|.*?\n)+
|
|
""",
|
|
re.VERBOSE,
|
|
)
|
|
working_text = replace_tables_with_rendered_html(border_table_pattern, tables, render=separate_tables)
|
|
|
|
# Borderless Markdown table
|
|
no_border_table_pattern = re.compile(
|
|
r"""
|
|
(?:\n|^)
|
|
(?:\S.*?\|.*?\n)
|
|
(?:(?:\s*[:-]+[-| :]*\s*).*?\n)
|
|
(?:\S.*?\|.*?\n)+
|
|
""",
|
|
re.VERBOSE,
|
|
)
|
|
working_text = replace_tables_with_rendered_html(no_border_table_pattern, tables, render=separate_tables)
|
|
|
|
# Replace any TAGS e.g. <table ...> to <table>
|
|
TAGS = ["table", "td", "tr", "th", "tbody", "thead", "div"]
|
|
table_with_attributes_pattern = re.compile(rf"<(?:{'|'.join(TAGS)})[^>]*>", re.IGNORECASE)
|
|
|
|
def replace_tag(m):
|
|
tag_name = re.match(r"<(\w+)", m.group()).group(1)
|
|
return "<{}>".format(tag_name)
|
|
|
|
working_text = re.sub(table_with_attributes_pattern, replace_tag, working_text)
|
|
|
|
if "<table>" in working_text.lower(): # for optimize performance
|
|
# HTML table extraction - handle possible html/body wrapper tags
|
|
html_table_pattern = re.compile(
|
|
r"""
|
|
(?:\n|^)
|
|
\s*
|
|
(?:
|
|
# case1: <html><body><table>...</table></body></html>
|
|
(?:<html[^>]*>\s*<body[^>]*>\s*<table[^>]*>.*?</table>\s*</body>\s*</html>)
|
|
|
|
|
# case2: <body><table>...</table></body>
|
|
(?:<body[^>]*>\s*<table[^>]*>.*?</table>\s*</body>)
|
|
|
|
|
# case3: only<table>...</table>
|
|
(?:<table[^>]*>.*?</table>)
|
|
)
|
|
\s*
|
|
(?=\n|$)
|
|
""",
|
|
re.VERBOSE | re.DOTALL | re.IGNORECASE,
|
|
)
|
|
|
|
def replace_html_tables():
|
|
nonlocal working_text
|
|
new_text = ""
|
|
last_end = 0
|
|
for match in html_table_pattern.finditer(working_text):
|
|
raw_table = match.group()
|
|
tables.append(raw_table)
|
|
if separate_tables:
|
|
new_text += working_text[last_end : match.start()] + "\n\n"
|
|
else:
|
|
new_text += working_text[last_end : match.start()] + raw_table + "\n\n"
|
|
last_end = match.end()
|
|
new_text += working_text[last_end:]
|
|
working_text = new_text
|
|
|
|
replace_html_tables()
|
|
|
|
return working_text, tables
|
|
|
|
|
|
class MarkdownElementExtractor:
|
|
def __init__(self, markdown_content):
|
|
self.markdown_content = markdown_content
|
|
self.lines = markdown_content.split("\n")
|
|
|
|
def get_delimiters(self, delimiters):
|
|
toks = re.findall(r"`([^`]+)`", delimiters)
|
|
toks = sorted(set(toks), key=lambda x: -len(x))
|
|
return "|".join(re.escape(t) for t in toks if t)
|
|
|
|
def _get_fence_marker(self, line):
|
|
match = re.match(r"^[ \t]{0,3}(?P<fence>`{3,}|~{3,})(?:.*)$", line)
|
|
if not match:
|
|
return None
|
|
fence = match.group("fence")
|
|
return fence[0], len(fence)
|
|
|
|
def _is_closing_fence(self, line, fence_char, fence_len):
|
|
pattern = r"^[ \t]{0,3}" + re.escape(fence_char) + r"{" + str(fence_len) + r",}\s*$"
|
|
return re.match(pattern, line) is not None
|
|
|
|
def _line_start_offsets(self, text):
|
|
offsets = []
|
|
offset = 0
|
|
for line in self.lines:
|
|
offsets.append(offset)
|
|
offset += len(line) + 1
|
|
return offsets
|
|
|
|
def _fenced_code_ranges(self, text):
|
|
ranges = []
|
|
line_offsets = self._line_start_offsets(text)
|
|
|
|
i = 0
|
|
while i < len(self.lines):
|
|
marker = self._get_fence_marker(self.lines[i])
|
|
if not marker:
|
|
i += 1
|
|
continue
|
|
|
|
fence_char, fence_len = marker
|
|
start_pos = line_offsets[i]
|
|
end_line = len(self.lines) - 1
|
|
for j in range(i + 1, len(self.lines)):
|
|
if self._is_closing_fence(self.lines[j], fence_char, fence_len):
|
|
end_line = j
|
|
break
|
|
|
|
end_pos = min(len(text), line_offsets[end_line] + len(self.lines[end_line]))
|
|
ranges.append((start_pos, end_pos))
|
|
i = end_line + 1
|
|
|
|
return ranges
|
|
|
|
def _append_delimited_section(self, sections, text, start, end, include_meta):
|
|
part = text[start:end]
|
|
if not part or not part.strip():
|
|
return
|
|
if include_meta:
|
|
sections.append(
|
|
{
|
|
"content": part.strip(),
|
|
"start_line": text.count("\n", 0, start),
|
|
"end_line": text.count("\n", 0, end),
|
|
}
|
|
)
|
|
else:
|
|
sections.append(part.strip())
|
|
|
|
def _extract_delimited_elements(self, text, delimiters, include_meta=False):
|
|
sections = []
|
|
pattern = re.compile(delimiters)
|
|
protected_ranges = self._fenced_code_ranges(text)
|
|
if protected_ranges:
|
|
logging.debug("markdown_parser: detected %d fenced ranges for delimiter extraction", len(protected_ranges))
|
|
protected_idx = 0
|
|
last_end = 0
|
|
|
|
for match in pattern.finditer(text):
|
|
while protected_idx < len(protected_ranges) and protected_ranges[protected_idx][1] <= match.start():
|
|
protected_idx += 1
|
|
|
|
if protected_idx < len(protected_ranges):
|
|
start, end = protected_ranges[protected_idx]
|
|
if start <= match.start() < end:
|
|
logging.debug(
|
|
"markdown_parser: skipped delimiter match at pos=%d delimiter=%r inside fenced range %s",
|
|
match.start(),
|
|
match.group(),
|
|
(start, end),
|
|
)
|
|
continue
|
|
|
|
self._append_delimited_section(sections, text, last_end, match.start(), include_meta)
|
|
last_end = match.end()
|
|
|
|
self._append_delimited_section(sections, text, last_end, len(text), include_meta)
|
|
return sections
|
|
|
|
def extract_elements(self, delimiter=None, include_meta=False):
|
|
"""Extract individual elements (headers, code blocks, lists, etc.)"""
|
|
sections = []
|
|
|
|
i = 0
|
|
dels = ""
|
|
if delimiter:
|
|
dels = self.get_delimiters(delimiter)
|
|
if len(dels) > 0:
|
|
text = "\n".join(self.lines)
|
|
return self._extract_delimited_elements(text, dels, include_meta)
|
|
while i < len(self.lines):
|
|
line = self.lines[i]
|
|
|
|
if re.match(r"^#{1,6}\s+.*$", line):
|
|
# header
|
|
element = self._extract_header(i)
|
|
sections.append(element if include_meta else element["content"])
|
|
i = element["end_line"] + 1
|
|
elif self._get_fence_marker(line):
|
|
# code block
|
|
element = self._extract_code_block(i)
|
|
sections.append(element if include_meta else element["content"])
|
|
i = element["end_line"] + 1
|
|
elif re.match(r"^\s*[-*+]\s+.*$", line) or re.match(r"^\s*\d+\.\s+.*$", line):
|
|
# list block
|
|
element = self._extract_list_block(i)
|
|
sections.append(element if include_meta else element["content"])
|
|
i = element["end_line"] + 1
|
|
elif line.strip().startswith(">"):
|
|
# blockquote
|
|
element = self._extract_blockquote(i)
|
|
sections.append(element if include_meta else element["content"])
|
|
i = element["end_line"] + 1
|
|
elif line.strip():
|
|
# text block (paragraphs and inline elements until next block element)
|
|
element = self._extract_text_block(i)
|
|
sections.append(element if include_meta else element["content"])
|
|
i = element["end_line"] + 1
|
|
else:
|
|
i += 1
|
|
|
|
if include_meta:
|
|
sections = [section for section in sections if section["content"].strip()]
|
|
else:
|
|
sections = [section for section in sections if section.strip()]
|
|
return sections
|
|
|
|
def _extract_header(self, start_pos):
|
|
return {
|
|
"type": "header",
|
|
"content": self.lines[start_pos],
|
|
"start_line": start_pos,
|
|
"end_line": start_pos,
|
|
}
|
|
|
|
def _extract_code_block(self, start_pos):
|
|
end_pos = start_pos
|
|
content_lines = [self.lines[start_pos]]
|
|
fence_char, fence_len = self._get_fence_marker(self.lines[start_pos])
|
|
|
|
# Find the end of the code block
|
|
for i in range(start_pos + 1, len(self.lines)):
|
|
content_lines.append(self.lines[i])
|
|
end_pos = i
|
|
if self._is_closing_fence(self.lines[i], fence_char, fence_len):
|
|
break
|
|
|
|
return {
|
|
"type": "code_block",
|
|
"content": "\n".join(content_lines),
|
|
"start_line": start_pos,
|
|
"end_line": end_pos,
|
|
}
|
|
|
|
def _extract_list_block(self, start_pos):
|
|
end_pos = start_pos
|
|
content_lines = []
|
|
|
|
i = start_pos
|
|
while i < len(self.lines):
|
|
line = self.lines[i]
|
|
# check if this line is a list item or continuation of a list
|
|
if (
|
|
re.match(r"^\s*[-*+]\s+.*$", line)
|
|
or re.match(r"^\s*\d+\.\s+.*$", line)
|
|
or (i > start_pos and not line.strip())
|
|
or (i > start_pos and re.match(r"^\s{2,}[-*+]\s+.*$", line))
|
|
or (i > start_pos and re.match(r"^\s{2,}\d+\.\s+.*$", line))
|
|
or (i > start_pos and re.match(r"^\s+\w+.*$", line))
|
|
):
|
|
content_lines.append(line)
|
|
end_pos = i
|
|
i += 1
|
|
else:
|
|
break
|
|
|
|
return {
|
|
"type": "list_block",
|
|
"content": "\n".join(content_lines),
|
|
"start_line": start_pos,
|
|
"end_line": end_pos,
|
|
}
|
|
|
|
def _extract_blockquote(self, start_pos):
|
|
end_pos = start_pos
|
|
content_lines = []
|
|
|
|
i = start_pos
|
|
while i < len(self.lines):
|
|
line = self.lines[i]
|
|
if line.strip().startswith(">") or (i > start_pos and not line.strip()):
|
|
content_lines.append(line)
|
|
end_pos = i
|
|
i += 1
|
|
else:
|
|
break
|
|
|
|
return {
|
|
"type": "blockquote",
|
|
"content": "\n".join(content_lines),
|
|
"start_line": start_pos,
|
|
"end_line": end_pos,
|
|
}
|
|
|
|
def _extract_text_block(self, start_pos):
|
|
"""Extract a text block (paragraphs, inline elements) until next block element"""
|
|
end_pos = start_pos
|
|
content_lines = [self.lines[start_pos]]
|
|
|
|
i = start_pos + 1
|
|
while i < len(self.lines):
|
|
line = self.lines[i]
|
|
# stop if we encounter a block element
|
|
if re.match(r"^#{1,6}\s+.*$", line) or self._get_fence_marker(line) or re.match(r"^\s*[-*+]\s+.*$", line) or re.match(r"^\s*\d+\.\s+.*$", line) or line.strip().startswith(">"):
|
|
break
|
|
elif not line.strip():
|
|
# check if the next line is a block element
|
|
if i + 1 < len(self.lines) and (
|
|
re.match(r"^#{1,6}\s+.*$", self.lines[i + 1])
|
|
or self._get_fence_marker(self.lines[i + 1])
|
|
or re.match(r"^\s*[-*+]\s+.*$", self.lines[i + 1])
|
|
or re.match(r"^\s*\d+\.\s+.*$", self.lines[i + 1])
|
|
or self.lines[i + 1].strip().startswith(">")
|
|
):
|
|
break
|
|
else:
|
|
content_lines.append(line)
|
|
end_pos = i
|
|
i += 1
|
|
else:
|
|
content_lines.append(line)
|
|
end_pos = i
|
|
i += 1
|
|
|
|
return {
|
|
"type": "text_block",
|
|
"content": "\n".join(content_lines),
|
|
"start_line": start_pos,
|
|
"end_line": end_pos,
|
|
}
|