Skip to content

fix: keep mapping-key guidance off native hot paths #16

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

Merged
goblinmode2700 merged 1 commit into from
Aug 14, 2026
Merged

fix: keep mapping-key guidance off native hot paths #16

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 13 additions & 1 deletion python/msgspec_toon/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,18 @@

EncodeError: Final = msgspec.EncodeError

_NON_STRING_KEY_ERROR: Final = (
"object keys must be strings; convert with msgspec.to_builtins(..., str_keys=True)"
)


def _new_encode_error(message: str) -> msgspec.EncodeError:
"""Translate stable native error codes without changing native hot-path layout."""
if message == "object keys must be strings":
message = _NON_STRING_KEY_ERROR
return msgspec.EncodeError(message)


# Stable type identities and the exact-pinned msgspec datetime normalizer.
_NATIVE_SCALAR_TYPES: Final = (
datetime.datetime,
Expand Down Expand Up @@ -271,7 +283,7 @@ def __init__(
enc_hook=native_hook,
plan_source=encode_plan_for,
struct_base=msgspec.Struct,
encode_error=msgspec.EncodeError,
encode_error=_new_encode_error,
delimiter=delimiter,
indent=indent,
)
Expand Down
6 changes: 2 additions & 4 deletions src/encode.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,8 +26,6 @@ use crate::writer::Writer;
const CELL_WIDTH_ESTIMATE: usize = 10;

const MAX_HOOK_DEPTH: usize = 8;
const NON_STRING_KEY_ERROR: &str =
"object keys must be strings; convert with msgspec.to_builtins(..., str_keys=True)";

pub struct EncodeContext {
pub enc_hook: Option<Py<PyAny>>,
Expand Down Expand Up @@ -406,7 +404,7 @@ fn object_pairs<'value, 'py>(
let mut pairs = Vec::with_capacity(map.len());
for (key, item) in map.iter() {
let Ok(key_text) = key.cast_into::<PyString>() else {
return Err(encode_err(ctx, py, NON_STRING_KEY_ERROR));
return Err(encode_err(ctx, py, "object keys must be strings"));
};
pairs.push((EntryText::Object(key_text), item));
}
Expand Down Expand Up @@ -781,7 +779,7 @@ fn root_object_decision<'value, 'py>(
let mut rows = (map.len() >= 2).then(|| Vec::with_capacity(map.len()));
for (key, item) in map.iter() {
let Ok(key_text) = key.cast_into::<PyString>() else {
return Err(encode_err(ctx, py, NON_STRING_KEY_ERROR));
return Err(encode_err(ctx, py, "object keys must be strings"));
};
if let Some(candidate_rows) = rows.as_mut() {
if item.is_instance_of::<PyDict>() || item.is_instance(ctx.struct_base.bind(py))? {
Expand Down