Skip to content

Python: Preserve unordered equality when hashing set-valued content - #14704

Draft
yunyv wants to merge 3 commits into
microsoft:mainfrom
yunyv:fix/python-unordered-set-hashing
Draft

yunyv wants to merge 3 commits into
microsoft:mainfrom
yunyv:fix/python-unordered-set-hashing

Conversation

@yunyv

@yunyv yunyv commented Nov 1, 2026

Copy link
Copy Markdown

Motivation and Context

make_hashable converts sets to tuples in their iteration order. Equal sets need not have the same iteration order, so equal FunctionResultContent and ChatMessageContent instances can have different hashes. For example, results constructed from set([0, 8]) and set([8, 0]) compare equal but do not deduplicate in a set.

This also affects ChatHistoryChannel.invoke: when an agent records a message in history and returns an equal message with an equivalently valued set, the channel's mutated_history membership check can miss it and append/yield the same result twice. A regression test exercises that actual channel path using a local agent double; no model service is called.

This was found through source inspection and local reproduction, not a reported production incident. No matching open issue or competing PR was found. The contribution guide allows skipping an issue for trivial changes.

Description

  • Convert sets and frozensets to frozensets of their recursively hashable elements, preserving unordered equality and set/frozenset equality.
  • Keep list and tuple conversion ordered and retain existing visited-object tracking.
  • Add four content hashing regressions and one real channel deduplication regression, covering different iteration orders, nested sets, set/frozenset equality and mixed element types.

Validation

Python 3.12.14, using the actual SDK and installed dependencies:

  • Contents and chat-completion agent unit suites, including the five added tests: unchanged source 5 failed, 451 passed; patched source 456 passed. Both runs emitted the same 74 existing deprecation warnings.
  • Ruff check and format check on all three changed files: passed.
  • Focused mypy for hashing.py with the repository config and skipped imported modules: passed. This is not a whole-SDK type check.
  • Syntax compilation, dependency consistency and git diff --check: passed.
  • Built the sdist and wheel and verified the packaged hashing.py bytes match the tested source.

An earlier broader run had two Azure client initialization failures because the environment lacked the optional SOCKS transport dependency. Installing socksio resolved both; network or proxy settings were not changed.

The full repository suite, other Python versions and live provider/model integration tests were not run. This does not attempt to change dictionary-key handling or every possible custom-object hashing behavior.

AI assistance was used for investigation, implementation and testing. A separate automated review ran 15 additional cases: baseline 10 failed and 5 passed; patched 15 passed. No human review is claimed.

Contribution Checklist

  • Python sdist and wheel build successfully.
  • Relevant Ruff formatting and lint checks pass.
  • Relevant unit tests pass and regression coverage was added.
  • Full repository unit suite and live-provider validation (not run).

@yunyv
yunyv deployed to github-app-auth November 1, 2026 04:33 — with GitHub Actions Active
@semantic-kernel-automation semantic-kernel-automation Bot added the python Pull requests for the Python Semantic Kernel label Nov 1, 2026
@microsoft-github-policy-service

Copy link
Copy Markdown

yunyv 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.

This branch was successfully deployed

1 active deployment
github-app-auth — 412ab53e Deployed Nov 1, 2026 by yunyv via add_label #29526
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.

1 participant