Skip to content

Add PyOS_vsnprintf & PyOS_snprintf to the capi - #9409

Merged
youknowone merged 1 commit into
RustPython:mainfrom
bschoenmaeckers:c-api-snprintf
Oct 27, 2026
Merged

youknowone merged 1 commit into
RustPython:mainfrom
bschoenmaeckers:c-api-snprintf

Conversation

@bschoenmaeckers

@bschoenmaeckers bschoenmaeckers commented Oct 27, 2026 •

Copy link
Copy Markdown
Contributor
  • Closes #xxxx

One of checkbox below must be checked.

  • I did not use AI to write the code of this patch.
  • This PR follows our AI policy

Summary

Summary by CodeRabbit

  • New Features
    • Added formatted-output APIs for applications using the C interface, including support for both variadic and pre-prepared argument lists.
    • Output can be written to a caller-provided buffer with a specified size, making these APIs available for bounded string formatting.

@bschoenmaeckers bschoenmaeckers changed the title Add PyOS_vsnprintf % PyOS_snprintf to the capi Add PyOS_vsnprintf & PyOS_snprintf to the capi Oct 27, 2026
@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Oct 27, 2026 •

Copy link
Copy Markdown

Codex Review Summary

This comment shows the latest Codex review activity on this pull request.

Review Status Commit Review trigger
📝 Code Review ✅ Completed 2026-10-27T15:56:48.235009Z 5b6a5cc PR opened
ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review" or "@codex security review".

Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings.

@coderabbitai

coderabbitai Bot commented Oct 27, 2026 •

Copy link
Copy Markdown
Contributor

Review in Change Stack →

No actionable comments were generated in the recent review.

Recent review info
Run configuration
Commits

Reviewing files that changed from the base of the PR and between b25ab5e and 5b6a5cc.

Files selected for processing: 1
  • crates/capi/src/pyerrors.rs

Included review availability: This review used your included allowance. Your plan provides up to 10 included reviews per hour; 8 remain after this review.

Walkthrough

This change adds PyOS_snprintf and PyOS_vsnprintf to the C API. The variadic function forwards its arguments to the va_list function, which calls vsnprintf when the size is within the supported limit.

Changes: Formatted string output API

Layer / File(s) Summary
Add snprintf wrappers
crates/capi/src/pyerrors.rs
Adds PyOS_snprintf and PyOS_vsnprintf. The latter returns -666 when size exceeds c_int::MAX - 1. When size > 0 and the destination is non-null, it writes a terminating NUL at str[size - 1].

Priority: Normal

Estimated code review effort: 2 (Simple) | ~10 minutes

Change: Feature

Suggested reviewers: youknowone

Merge Risk: Minimal · up to 5b6a5

No merge-blocking risk is established; normal build and test checks remain appropriate.

Pre-merge checks: Passed 4 · Failed 1

Failed Failed checks: 1 warning

Check name Status Explanation Resolution
Docstring Coverage Warning Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. Docstring coverage is scoped to functions touched by this diff. Documentation-only edits and deletions within survi… Write docstrings for the functions missing them to satisfy the coverage threshold.
Passed Passed checks: 4 passed
Check name Status Explanation
Description Check Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check Passed The title names the two C APIs the PR adds, PyOS_vsnprintf and PyOS_snprintf, and the raw summary confirms both are added to crates/capi/src/pyerrors.rs. The title matches the main change and the comm…
Linked Issues check Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check Passed Check skipped because no linked issues were found for this pull request.
Full details: Title check

Explanation

The title names the two C APIs the PR adds, PyOS_vsnprintf and PyOS_snprintf, and the raw summary confirms both are added to crates/capi/src/pyerrors.rs. The title matches the main change and the commit message.

Full details: Docstring Coverage

Explanation

Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. Docstring coverage is scoped to functions touched by this diff. Documentation-only edits and deletions within surviving functions are included; unchanged diff context and fully deleted functions are excluded. Analyzed 2 functions across 1 files.

Resolution

Write docstrings for the functions missing them to satisfy the coverage threshold.

Finishing Touches
🧪 Generate unit tests (beta)
  • Create a new PR
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@youknowone
youknowone enabled auto-merge (squash) October 27, 2026 16:21
@youknowone
youknowone merged commit 77046cf into RustPython:main Oct 27, 2026
20 checks passed
@bschoenmaeckers
bschoenmaeckers deleted the c-api-snprintf branch October 28, 2026 08:00
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.

2 participants