Skip to content

Python: Fix replacing binary content data URIs - #14605

Open
Captain (po-et) wants to merge 1 commit into
microsoft:mainfrom
po-et:fix/python-replace-data-uri
Open

Captain (po-et) wants to merge 1 commit into
microsoft:mainfrom
po-et:fix/python-replace-data-uri

Conversation

@po-et

Copy link
Copy Markdown

Motivation and Context

Replacing ImageContent.data_uri after the object already contains data can raise a base64 error or store the entire URI as the payload. The MIME type also stays at its previous value. This affects applications that update an existing image before sending it to a multimodal model.

image = ImageContent(data=b"old_image", mime_type="image/jpeg", data_format="base64")
image.data_uri = "data:image/png;base64,bmV3X2ltYWdl"
# Expected: image.data == b"new_image", image.mime_type == "image/png"

Description

Always parse a replacement URI with DataUri.from_data_uri, as initialization and the first assignment already do. This replaces the payload, format and MIME type together. Parsing completes before assignment, so an invalid replacement leaves the previous content intact. The separate data setter and the data URI parser are unchanged.

Eight regressions cover replacing base64, bytes and ndarray-backed content with base64 or plain-text URIs, invalid replacement, and the ImageContent.to_dict() request payload. All eight fail on the base revision and pass with this fix.

Validation

  • All contents unit tests: 402 passed.
  • Repository-configured pre-commit checks for the three changed files: all applicable hooks passed.
  • Independent Codex code review and rerun of the eight replacement regressions passed.
  • git diff --check passed.

Validated on Python 3.12.14 / macOS arm64. The complete optional-provider test suite and live model calls were not run.

Contribution Checklist

  • The change follows the contribution guidelines and configured formatting checks.
  • Added regression tests and ran the affected contents unit suite.
  • No public API signature changes.

AI disclosure: OpenAI Codex assisted with investigation, implementation, tests and independent review.

@po-et
Captain (po-et) requested a review from a team as a code owner October 15, 2026 16:05
Copilot AI balanced review requested due to automatic review settings October 15, 2026 16:05
@po-et
Captain (po-et) deployed to github-app-auth October 15, 2026 16:05 — with GitHub Actions Active
@po-et
Captain (po-et) deployed to github-app-auth October 15, 2026 16:05 — with GitHub Actions Active
@semantic-kernel-automation semantic-kernel-automation Bot added the python Pull requests for the Python Semantic Kernel label Oct 15, 2026
@microsoft-github-policy-service

Copy link
Copy Markdown

Captain (@po-et) 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.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟢 Approval recommended

The focused fix reuses established parsing behavior, includes targeted regression coverage, and has no identified blocking issues.

0 open findings

What changed in this PR

Fixes replacement of existing Python binary content through data_uri, keeping the payload, format, and MIME type consistent.

Changes:

  • Uses the existing URI parser for every assignment.
  • Adds eight regression cases covering replacements, invalid-input preservation, and image request serialization.
File Description
python/​tests/​unit/​contents/​test_image_content.py Verifies image replacement and request serialization.
python/​tests/​unit/​contents/​test_binary_content.py Covers replacement formats and invalid-input preservation.
python/​semantic_kernel/​contents/​binary_content.py Parses replacement URIs before assigning content.

🧠 Review effort: Balanced


💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Community review. This does not clear the merge gate.

The fix works and I think it is correct. I found one small gap, described last.

What I ran (upstream/main at 7a92cd4, a separate worktree, venv at C:/skv2, PR diff applied with git apply):

  • python/tests/unit/contents on main with the PR's tests: 8 failed, 394 passed. With the binary_content.py change: 402 passed. The failing tests on main include test_replace_image_data_uri and test_replace_data_uri_invalid_preserves_existing_data.
  • A probe of my own on main: ImageContent(data=b"old_image", ...) then image.data_uri = "data:image/png;base64,bmV3X2ltYWdl" raises binascii.Error: Only base64 data is allowed. On the PR the same code gives mime_type == "image/png", data == b"new_image", and to_dict() returns the new URI. That matches the description.
  • The existing test_update_data_uri (setting data_uri on an empty BinaryContent) still passes, since that path already used DataUri.from_data_uri.

The invalid-URI test passes because from_data_uri runs before _data_uri is reassigned, so the old content stays. I read that in the diff and the test confirms it.

The gap: the setter does self.metadata.update(self._data_uri.parameters), which merges and never removes parameters from the previous URI. Probe on the PR: start from BinaryContent(data_uri="data:text/plain;foo=old;base64,b2xk"), then set data_uri = "data:image/jpeg;base64,bmV3". Result: mime_type is image/jpeg and data is b'new', but metadata is still {'foo': 'old'} and the new data_uri string is data:image/jpeg;foo=old;base64,bmV3. So a replacement URI with no parameters inherits the old URI's parameters. The PR's test_replace_data_uri always replaces foo=old with foo=new, so it does not catch this. Whether metadata given at construction (the test's {"source": "test"}) should survive is a design choice, so I would only drop the keys that came from the old URI's parameters, if the maintainers care about this case. I did not try a fix.

I did not run the full Python suite or the multimodal connectors that consume these URIs.

This branch was successfully deployed

1 active deployment
github-app-auth — e4db1b43 Deployed Oct 15, 2026 by po-et via team_check #631
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

python Pull requests for the Python Semantic Kernel

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants