8000 Improve invalid input type handling in `tomllib.loads` · Issue #124835 · python/cpython · GitHub
[go: up one dir, main page]
Skip to content

Improve invalid input type handling in tomllib.loads #124835

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.

Sign up for GitHub

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

Jump to bottom
Closed
hukkin opened this issue Oct 1, 2024 · 2 comments
Closed

Improve invalid input type handling in tomllib.loads #124835

hukkin opened this issue Oct 1, 2024 · 2 comments
Labels
type-feature A feature request or enhancement

Comments

@hukkin
Copy link
Contributor
hukkin commented Oct 1, 2024 •
edited
Loading

Feature or enhancement

Proposal:

tomllib.loads only accepts str as input. Given bytes, it throws

TypeError: a bytes-like object is required, not 'str'

This is a bubbled up exception from the replace method on line

cpython/Lib/tomllib/_parser.py

Line 74 in 4129a74

src = s.replace("\r\n", "\n")
which is otherwise fine, but the message has bytes and str the wrong way around, which can be very confusing. I propose catching the exception and raising a new TypeError with an improved message.

While at it, I also propose catching any AttributeErrors from this line of code and raising the same new TypeError instead. As a result, a sensible TypeError is raised in nearly all cases where incorrect type is passed in.

Has this already been discussed elsewhere?

This is a minor feature, which does not need previous discussion elsewhere

Links to previous discussion of this feature:

Original issue report by @mechsin on Tomli's issue tracker: hukkin/tomli#223
PR: #124587

Linked PRs
@hukkin hukkin added the type-feature A feature request or enhancement label Oct 1, 2024
@bedevere-app bedevere-app bot mentioned this issue Oct 1, 2024
Merged
hauntsaninja pushed a commit that referenced this issue Oct 2, 2024
@hukkin
gh-124835: tomllib.loads: Raise TypeError not AttributeError. Impro…
9ce9020 
…ve message (#124587)
@StanFromIreland StanFromIreland mentioned this issue Apr 17, 2025
Closed
@StanFromIreland
Copy link
Contributor

Do we want to backport this change? It is partly a bug fix (error message is flipped). Maybe it could be split?

See also: #132655

@hauntsaninja
Copy link
Contributor
hauntsaninja commented Apr 17, 2025 •
edited
Loading

I didn't backport because it can change the exception type (also because slightly less confusing error messages that aren't super critical are little more feature than bug, changes to error messages do sometimes break folks)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
type-feature A feature request or enhancement
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@hukkin @hauntsaninja @StanFromIreland
0