Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Enhance prompt template formatting: support nested placeholders and unpaired braces handling #1653

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

dcstrange
Copy link

以下是针对你提出的所有代码修改的完整 Git 提交说明,包含中英文版本。


提交说明(中文)

标题

增强模板格式化功能,支持嵌套结构占位符与未成对花括号处理

详细描述

  1. 新增功能

    • 支持嵌套结构占位符(如 {data[key]}{obj.attr}),这些占位符将被保留原样,不被 str.format() 解析。
    • 引入未成对花括号的处理逻辑:
      • 未闭合的 { 转换为普通字符 {{
      • 单独的 } 转换为普通字符 }}
      • 确保未成对的花括号不会触发解析错误。
  2. 修复问题

    • 修复嵌套结构占位符在模板中被错误解析的问题。
    • 修复未成对花括号导致 str.format() 抛出异常的问题。
  3. 具体修改

    • 新增 _replace_unpaired_braces 方法,使用正则表达式检测未成对的 {},并将其替换为普通字符,确保模板完整性。
    • 修改 SafeFormatter.format 方法,调用 _replace_unpaired_braces 预处理模板,避免未成对花括号干扰格式化流程。
    • 优化嵌套结构的正则匹配逻辑,将匹配到的嵌套占位符(如 {data[key]})转义为普通文本 {{data[key]}},避免解析。
  4. 测试覆盖

    • 测试未成对的 {}
      • {abc -> {abc(被保留为普通字符)。
      • abc} -> abc}(被保留为普通字符)。
    • 测试嵌套占位符:
      • {data[key]} -> 被保留原样。
    • 测试合法占位符的正常解析:
      • {name} -> 被替换为传入的数据值。
    • 测试混合场景:
      • {abc}def} -> {abc}def}
      • Hello {name}, Welcome {place}! -> Hello Alice, Welcome Wonderland!(假设传入数据)。

提交说明(英文)

Title

Enhance template formatting: support nested placeholders and unpaired braces handling

Description

  1. New Features:

    • Added support for nested placeholders (e.g., {data[key]} and {obj.attr}), which are preserved as plain text and will not be parsed by str.format().
    • Introduced handling for unpaired curly braces:
      • Unclosed { is converted to a plain character {{.
      • Lone } is converted to a plain character }}.
      • Ensures unpaired braces do not cause parsing errors.
  2. Bug Fixes:

    • Fixed an issue where nested placeholders were incorrectly parsed or caused errors.
    • Fixed an issue where unpaired curly braces triggered str.format() exceptions.
  3. Changes:

    • Added _replace_unpaired_braces method, which uses regular expressions to detect unpaired { or } and replaces them with plain characters, maintaining template integrity.
    • Updated SafeFormatter.format to call _replace_unpaired_braces for pre-processing templates, preventing unpaired braces from interfering with formatting.
    • Improved regex logic for nested placeholders to escape them as plain text {{data[key]}}, avoiding unnecessary parsing.
  4. Test Coverage:

    • Tested unpaired braces:
      • {abc -> {abc (retained as plain text).
      • abc} -> abc} (retained as plain text).
    • Tested nested placeholders:
      • {data[key]} -> preserved as is.
    • Tested valid placeholders for correct replacement:
      • {name} -> replaced with the value from input data.
    • Tested mixed scenarios:
      • {abc}def} -> {abc}def}.
      • Hello {name}, Welcome {place}! -> Hello Alice, Welcome Wonderland! (assuming input data provided).

提交示例

标题:

增强模板格式化功能,支持嵌套结构占位符与未成对花括号处理 / Enhance template formatting: support nested placeholders and unpaired braces handling

详细描述:

添加了对未成对花括号的处理逻辑,确保未成对的 `{` 或 `}` 不再触发解析错误,而是被替换为普通字符。此外,支持嵌套结构占位符(如 `{data[key]}`),这些占位符将被保留原样而不解析。优化了模板格式化逻辑,增强了健壮性,并增加了全面的测试覆盖。

英文:

Added handling for unpaired curly braces to ensure that unpaired `{` or `}` no longer cause parsing errors but are instead replaced with plain characters. Additionally, added support for nested placeholders (e.g., `{data[key]}`), which are preserved as plain text without parsing. Improved template formatting logic, enhanced robustness, and added comprehensive test coverage.

如果你对提交说明有其他要求或需要进一步优化,请随时告诉我!

详细描述
新增功能:
支持嵌套结构占位符(如 {data[key]} 和 {obj.attr}),这些占位符将被保留原样,不被 str.format() 解析。
引入未成对花括号的处理逻辑:
未闭合的 { 转换为普通字符 {{。
单独的 } 转换为普通字符 }}。
确保未成对的花括号不会触发解析错误。
修复问题:
修复嵌套结构占位符在模板中被错误解析的问题。
修复未成对花括号导致 str.format() 抛出异常的问题。
具体修改:
新增 _replace_unpaired_braces 方法,使用正则表达式检测未成对的 { 或 },并将其替换为普通字符,确保模板完整性。
修改 SafeFormatter.format 方法,调用 _replace_unpaired_braces 预处理模板,避免未成对花括号干扰格式化流程。
优化嵌套结构的正则匹配逻辑,将匹配到的嵌套占位符(如 {data[key]})转义为普通文本 {{data[key]}},避免解析。
测试覆盖:
测试未成对的 { 和 }:
{abc -> {abc(被保留为普通字符)。
abc} -> abc}(被保留为普通字符)。
测试嵌套占位符:
{data[key]} -> 被保留原样。
测试合法占位符的正常解析:
{name} -> 被替换为传入的数据值。
测试混合场景:
{abc}def} -> {abc}def}。
Hello {name}, Welcome {place}! -> Hello Alice, Welcome Wonderland!(假设传入数据)。
@dcstrange dcstrange requested review from a team as code owners January 23, 2025 03:19

@dcstrange please read the following Contributor License Agreement(CLA). If you agree with the CLA, please reply with the following information.

@microsoft-github-policy-service agree [company="{your company}"]

Options:

  • (default - no company specified) I have sole ownership of intellectual property rights to my Submissions and I am not making Submissions in the course of work for my employer.
@microsoft-github-policy-service agree
  • (when company given) I am making Submissions in the course of work for my employer (or my employer has intellectual property rights in my Submissions by contract or applicable law). I have permission from my employer to make Submissions and enter into this Agreement on behalf of my employer. By signing below, the defined term “You” includes me and my employer.
@microsoft-github-policy-service agree company="Microsoft"
Contributor License Agreement

Contribution License Agreement

This Contribution License Agreement (“Agreement”) is agreed to by the party signing below (“You”),
and conveys certain license rights to Microsoft Corporation and its affiliates (“Microsoft”) for Your
contributions to Microsoft open source projects. This Agreement is effective as of the latest signature
date below.

  1. Definitions.
    “Code” means the computer software code, whether in human-readable or machine-executable form,
    that is delivered by You to Microsoft under this Agreement.
    “Project” means any of the projects owned or managed by Microsoft and offered under a license
    approved by the Open Source Initiative (www.opensource.org).
    “Submit” is the act of uploading, submitting, transmitting, or distributing code or other content to any
    Project, including but not limited to communication on electronic mailing lists, source code control
    systems, and issue tracking systems that are managed by, or on behalf of, the Project for the purpose of
    discussing and improving that Project, but excluding communication that is conspicuously marked or
    otherwise designated in writing by You as “Not a Submission.”
    “Submission” means the Code and any other copyrightable material Submitted by You, including any
    associated comments and documentation.
  2. Your Submission. You must agree to the terms of this Agreement before making a Submission to any
    Project. This Agreement covers any and all Submissions that You, now or in the future (except as
    described in Section 4 below), Submit to any Project.
  3. Originality of Work. You represent that each of Your Submissions is entirely Your original work.
    Should You wish to Submit materials that are not Your original work, You may Submit them separately
    to the Project if You (a) retain all copyright and license information that was in the materials as You
    received them, (b) in the description accompanying Your Submission, include the phrase “Submission
    containing materials of a third party:” followed by the names of the third party and any licenses or other
    restrictions of which You are aware, and (c) follow any other instructions in the Project’s written
    guidelines concerning Submissions.
  4. Your Employer. References to “employer” in this Agreement include Your employer or anyone else
    for whom You are acting in making Your Submission, e.g. as a contractor, vendor, or agent. If Your
    Submission is made in the course of Your work for an employer or Your employer has intellectual
    property rights in Your Submission by contract or applicable law, You must secure permission from Your
    employer to make the Submission before signing this Agreement. In that case, the term “You” in this
    Agreement will refer to You and the employer collectively. If You change employers in the future and
    desire to Submit additional Submissions for the new employer, then You agree to sign a new Agreement
    and secure permission from the new employer before Submitting those Submissions.
  5. Licenses.
  • Copyright License. You grant Microsoft, and those who receive the Submission directly or
    indirectly from Microsoft, a perpetual, worldwide, non-exclusive, royalty-free, irrevocable license in the
    Submission to reproduce, prepare derivative works of, publicly display, publicly perform, and distribute
    the Submission and such derivative works, and to sublicense any or all of the foregoing rights to third
    parties.
  • Patent License. You grant Microsoft, and those who receive the Submission directly or
    indirectly from Microsoft, a perpetual, worldwide, non-exclusive, royalty-free, irrevocable license under
    Your patent claims that are necessarily infringed by the Submission or the combination of the
    Submission with the Project to which it was Submitted to make, have made, use, offer to sell, sell and
    import or otherwise dispose of the Submission alone or with the Project.
  • Other Rights Reserved. Each party reserves all rights not expressly granted in this Agreement.
    No additional licenses or rights whatsoever (including, without limitation, any implied licenses) are
    granted by implication, exhaustion, estoppel or otherwise.
  1. Representations and Warranties. You represent that You are legally entitled to grant the above
    licenses. You represent that each of Your Submissions is entirely Your original work (except as You may
    have disclosed under Section 3). You represent that You have secured permission from Your employer to
    make the Submission in cases where Your Submission is made in the course of Your work for Your
    employer or Your employer has intellectual property rights in Your Submission by contract or applicable
    law. If You are signing this Agreement on behalf of Your employer, You represent and warrant that You
    have the necessary authority to bind the listed employer to the obligations contained in this Agreement.
    You are not expected to provide support for Your Submission, unless You choose to do so. UNLESS
    REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING, AND EXCEPT FOR THE WARRANTIES
    EXPRESSLY STATED IN SECTIONS 3, 4, AND 6, THE SUBMISSION PROVIDED UNDER THIS AGREEMENT IS
    PROVIDED WITHOUT WARRANTY OF ANY KIND, INCLUDING, BUT NOT LIMITED TO, ANY WARRANTY OF
    NONINFRINGEMENT, MERCHANTABILITY, OR FITNESS FOR A PARTICULAR PURPOSE.
  2. Notice to Microsoft. You agree to notify Microsoft in writing of any facts or circumstances of which
    You later become aware that would make Your representations in this Agreement inaccurate in any
    respect.
  3. Information about Submissions. You agree that contributions to Projects and information about
    contributions may be maintained indefinitely and disclosed publicly, including Your name and other
    information that You submit with Your Submission.
  4. Governing Law/Jurisdiction. This Agreement is governed by the laws of the State of Washington, and
    the parties consent to exclusive jurisdiction and venue in the federal courts sitting in King County,
    Washington, unless no federal subject matter jurisdiction exists, in which case the parties consent to
    exclusive jurisdiction and venue in the Superior Court of King County, Washington. The parties waive all
    defenses of lack of personal jurisdiction and forum non-conveniens.
  5. Entire Agreement/Assignment. This Agreement is the entire agreement between the parties, and
    supersedes any and all prior agreements, understandings or communications, written or oral, between
    the parties relating to the subject matter hereof. This Agreement may be assigned by Microsoft.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant