Skip to content

autogen-studio: pin utf-8 encoding on production text-file open() calls (refs #5566)#7723

Open
adv0r wants to merge 1 commit into
microsoft:mainfrom
adv0r:tokenburn/autogen-5566-studio
Open

autogen-studio: pin utf-8 encoding on production text-file open() calls (refs #5566)#7723
adv0r wants to merge 1 commit into
microsoft:mainfrom
adv0r:tokenburn/autogen-5566-studio

Conversation

@adv0r
Copy link
Copy Markdown

@adv0r adv0r commented May 20, 2026

Dear maintainer — this PR has a permanent home with methodology + opt-out at tokens-for-good. A one-line "no thanks" → auto-close + blacklist. Sorry for the notification this edit caused.


Why

Refs #5566. Continuation of the encoding sweep started in #6094
(playwright_controller.py) and continued in
the magentic-one-cli PR.

The original report explicitly flagged that "there will be some
similar issues in the codebase while using open function"
. On a
non-UTF-8 default locale (cp950 on Traditional Chinese Windows, cp1252
on Western European Windows, …), Python's open(..., \"r\") falls back
to the platform encoding and crashes with UnicodeDecodeError on any
non-ASCII byte.

This PR closes the autogen-studio production code paths that read
or write text files without an explicit encoding.

What changed

5 files, 11 open() call sites, all of the same shape:

- with open(path, \"r\") as f:
+ with open(path, \"r\", encoding=\"utf-8\") as f:
File sites
autogenstudio/cli.py 1 (writes runtime .env)
autogenstudio/lite/studio.py 1 (writes runtime .env)
autogenstudio/database/schema_manager.py 6 (Alembic env.py / script.py.mako / alembic.ini)
autogenstudio/web/auth/manager.py 1 (user-supplied YAML config)
autogenstudio/gallery/builder.py 1 (writes gallery_default.json)

Why these specific sites

  • Alembic templates and env.py can legitimately contain non-ASCII
    comments / paths and are read+rewritten on schema upgrades.
  • .env writers are called with the user's project path. Folder
    names with accented characters (very common on Windows) would crash
    the first run.
  • YAML auth config is user-supplied.
  • gallery_default.json can contain non-ASCII strings.

Scope deliberately narrowed

  • Production-code only. Test fixtures left out for a separate PR.
  • Skipped aiofiles.open in teammanager.py — async API signature
    is slightly different, deserves its own audited PR.
  • Did NOT sweep agbench/benchmarks/* — those are scenario scripts
    that consume JSONL produced by other agents; forcing UTF-8 there
    could mask issues upstream.

Verification

  • ast.parse(...) clean on all 5 touched files (no syntax break).
  • No encoding=...encoding= (double-add) anywhere.
  • 11 insertions, 11 deletions (same-line edits only).
  • No behaviour change for users already on UTF-8 locales.

Recommended next sweep (for a separate PR)

  • agbench (mixed: some files read agent-emitted JSONL, others are
    user scripts — needs case-by-case audit)
  • async aiofiles.open sites

AI-assisted via Cursor (Claude Opus 4.7). Personal token-burn
initiative by @adv0r to use up an expiring Cursor subscription budget on
small, useful upstream contributions.

Made with Cursor

Refs microsoft#5566.

Continuation of the same encoding sweep started in microsoft#6094 (which fixed
the original `playwright_controller.py` site) and continued in the
`magentic-one-cli` PR. The reporter of microsoft#5566 explicitly flagged that
*"there will be some similar issues in the codebase while using open
function"* — this PR closes the autogen-studio production code paths
that read or write text files without specifying an encoding.

On a non-UTF-8 default locale (e.g. cp950 on Traditional Chinese
Windows, cp1252 on Western European Windows), Python's `open(...,
"r")` falls back to the platform encoding and crashes with
`UnicodeDecodeError` on any non-ASCII byte. For autogen-studio that
manifests every time:

- `schema_manager.py` reads or writes Alembic templates (`env.py`,
  `script.py.mako`, `alembic.ini`) that may contain non-ASCII paths or
  comments
- `cli.py` / `lite/studio.py` write the runtime `.env` file (project
  paths can contain user/folder names with accented characters)
- `web/auth/manager.py` loads a user-supplied YAML config
- `gallery/builder.py` writes `gallery_default.json`

Files touched (11 lines, 5 files):

| File | open() sites fixed |
|------|--------------------|
| autogenstudio/cli.py | 1 |
| autogenstudio/lite/studio.py | 1 |
| autogenstudio/database/schema_manager.py | 6 |
| autogenstudio/web/auth/manager.py | 1 |
| autogenstudio/gallery/builder.py | 1 |

For every site the change is the same shape:

```python
- with open(path, "r") as f:
+ with open(path, "r", encoding="utf-8") as f:
```

Scope deliberately narrowed:

- **Production-code only** — no test fixtures.
- **Skipped `aiofiles.open` in `teammanager.py`** — the API is slightly
  different and that one deserves its own audited PR.
- **Did NOT sweep `agbench/benchmarks/*`** — those are user-facing
  scenario scripts that read JSONL produced by other agents; forcing
  UTF-8 there could mask issues upstream.

No behaviour change for already-UTF-8-locale users (UTF-8 IS what
Python opens these as on macOS/Linux today). All five files re-parsed
cleanly via `ast.parse(...)` after the rewrite.

AI-assisted via Cursor (Claude Opus 4.7). Personal token-burn
initiative by @adv0r to use up an expiring Cursor subscription budget
on small, useful upstream contributions.

Co-authored-by: Cursor <cursoragent@cursor.com>
@adv0r
Copy link
Copy Markdown
Author

adv0r commented May 20, 2026

Heads up: the CLA reply needs to come from the human account holder (@adv0r) directly, which I can't auto-post on their behalf in good conscience — the magic-phrase reply is a binding legal acceptance. I've flagged it on the user's side as a manual TODO and the CLA acceptance should land here shortly. The companion PR #7722 already shows license/cla: SUCCESS, so this looks like a per-PR re-acknowledgment after the initial sign.

@microsoft-github-policy-service
Copy link
Copy Markdown
Contributor

@adv0r 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