Skip to content

Fix UnicodeDecodeError when non-ASCII text falls past the sniffed charset prefix - #2337

Open
sesharif wants to merge 1 commit into
microsoft:mainfrom
sesharif:fix/charset-beyond-sniffed-prefix
Open

Fix UnicodeDecodeError when non-ASCII text falls past the sniffed charset prefix#2337
sesharif wants to merge 1 commit into
microsoft:mainfrom
sesharif:fix/charset-beyond-sniffed-prefix

Conversation

@sesharif

Copy link
Copy Markdown

Problem

The charset is sniffed from the first 4k of a stream but then used to decode all of it, so a mostly-ASCII document whose first non-ASCII character appears beyond that window fails to convert.

This repo's own README reproduces it — its first em dash sits at byte 5030:

$ markitdown README.md
markitdown._exceptions.FileConversionException: File conversion failed after 1 attempts:
 - PlainTextConverter threw UnicodeDecodeError with message: 'ascii' codec can't decode byte 0xe2 in position 5030: ordinal not in range(128)

Fix

Two layers, because the bug has two halves.

Detection — widen an ASCII guess to UTF-8 in _get_stream_info_guesses. ASCII is a strict subset of UTF-8, so genuine ASCII decodes identically, while UTF-8 content beyond the sniffed prefix now decodes correctly. This layer matters beyond decoding: the charset is part of the StreamInfo identity used to decide which guesses are compatible, so it also affects which converters get tried.

Decoding — add decode_bytes() in a new _charset_utils module: try the declared charset, re-detect over the full data if that fails, and fall back to a lossy decode as a last resort. A charset can also arrive already declared — from a Content-Type header, or from the caller — in which case it is trusted without being sniffed and can be wrong in the same way.

Wired into the three converters that decode a whole stream with such a charset: plain text, CSV, and ipynb. The HTML-family converters (_html_converter, _bing_serp_converter, _wikipedia_converter, _youtube_converter) pass the charset to BeautifulSoup as from_encoding, which recovers on its own, so they are left alone.

_normalize_charset now delegates to the shared helper rather than duplicating it.

Tests

New tests/test_charset.py (16 tests) covering the sniffed-prefix regression, a too-narrow declared charset through each of the three converters, and the decode_bytes fallback chain. Verified they catch the bug: with the fix reverted, 4 fail; restored, all pass.

Full suite goes from 335 to 351 passing, with no new failures.

One expectation changed

Two vectors in _test_vectors.py asserted charset="ascii" for test.json and test_notebook.ipynb. Both fixtures are pure ASCII, so UTF-8 decodes them byte-identically; the expectations are updated to match the widened guess. Flagging it explicitly since it is an assertion change rather than a code fix — happy to take a different approach if you would rather the widening not be observable in _get_stream_info_guesses output.

🤖 Generated with Claude Code

The charset is sniffed from the first 4k of a stream but then used to
decode all of it, so a mostly-ASCII document whose first non-ASCII
character appears beyond that window fails to convert. Running
`markitdown README.md` in this repo reproduces it: the first em dash sits
at byte 5030, the prefix sniffs as ASCII, and the conversion dies with
"'ascii' codec can't decode byte 0xe2 in position 5030".

Fixed in two places:

- Widen an ASCII guess to UTF-8 in _get_stream_info_guesses. ASCII is a
  strict subset of UTF-8, so genuine ASCII decodes identically, while
  UTF-8 content beyond the sniffed prefix now decodes correctly. This
  also matters because the charset is part of the StreamInfo identity
  used to decide which guesses are compatible, not just how bytes are
  decoded.

- Add decode_bytes(), which tries the declared charset, re-detects over
  the full data if that fails, and finally falls back to a lossy decode.
  A charset can also arrive already declared -- from a Content-Type
  header, or from the caller -- in which case it is trusted without being
  sniffed, and can be wrong in the same way. Wired into the three
  converters that decode a whole stream with such a charset: plain text,
  CSV, and ipynb. The HTML-family converters pass the charset to
  BeautifulSoup as from_encoding, which recovers on its own, and are
  left alone.

_normalize_charset now delegates to the shared helper rather than
duplicating it.

Two test vectors asserted charset="ascii" for test.json and
test_notebook.ipynb. Both fixtures are pure ASCII, so UTF-8 decodes them
identically; the expectations are updated to match the widened guess.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
@microsoft-github-policy-service

Copy link
Copy Markdown

sesharif 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