You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Handle unnamed winreg values in QueryValueEx - #9589
Let winreg.QueryValueEx(key, None) query the unnamed/default registry value, while keeping the name argument required.
Pass nullable names through both Windows API calls and preserve Python strings, including lone surrogates, through the UTF-16 conversion.
Emit CPython's winreg.QueryValue audit event after argument conversion and before the registry query; rebuild the audit name from the UTF-16 buffer as CPython does.
Return an initial registry failure immediately unless the result is ERROR_MORE_DATA, rather than retrying unrelated failures because the returned size is zero. Keep a nonzero buffer after a successful zero-length size query so a value that grows between calls can be retried.
The audit tuple and its name are only built when audit hooks are active. Invalid-name type-error wording remains a pre-existing difference; #9586 separately improves the HKEY conversion used here. This does not claim full winreg parity.
Validation
Independently source-reviewed against CPython v3.15.0 PC/winreg.c and PC/clinic/winreg.c.h, including conversion and audit order.
prek hooks and git diff --check passed.
No RustPython build or Windows execution was run locally; CI is needed.
Summary by CodeRabbit
New Features
winreg.QueryValueEx now accepts None as the value name, allowing queries of a registry key’s default value.
Registry value names that cannot be converted to Windows format are reported as errors before the query is performed.
Existing query results and error handling remain unchanged for valid value names.
Accept a required None value name, preserve UTF-16 strings, issue the CPython audit event, and return initial registry errors before retrying.
Assisted-by: dot:frontier-intelligence
No actionable comments were generated in the recent review.
Walkthrough
The registry query helper and Python QueryValueEx now accept an optional value name. The helper passes the optional name to both registry queries, and QueryValueEx converts a provided Python string to a Windows wide string.
Changes: Optional Registry Value Names
Layer / File(s)
Summary
Optional name in registry queries crates/host_env/src/winreg.rs
query_value_bytes accepts an optional value name and passes it to the size and data queries. The initial query error handling now returns nonzero errors before applying the zero-size buffer fallback.
Optional name in QueryValueEx crates/vm/src/stdlib/winreg.rs
QueryValueEx accepts an optional Python string name, converts a provided name to a Windows wide string, and passes the optional name to the registry query. It emits the winreg.QueryValue audit event with the handle, a None subkey, and the optional name.
No actionable merge-blocking issue remains. The nullable registry-name change is mergeable subject to normal checks, including Windows CI.
Pre-merge checks: 4 · 1
Failed checks: 1 warning
Check name
Status
Explanation
Resolution
Docstring Coverage
Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. Docstring coverage is scoped to functions touched by this diff with cyclomatic complexity of at least 2. Documentat…
Write docstrings for the functions missing them to satisfy the coverage threshold.
Passed checks: 4 passed
Check name
Status
Explanation
Description Check
Check skipped - CodeRabbit’s high-level summary is enabled.
Title check
The title "Handle unnamed winreg values in QueryValueEx" matches the main change. The PR lets winreg.QueryValueEx(key, None) query the unnamed default registry value. The QueryValueEx signature now ta…
Linked Issues check
Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check
Check skipped because no linked issues were found for this pull request.
Full details: Title check
Explanation
The title "Handle unnamed winreg values in QueryValueEx" matches the main change. The PR lets winreg.QueryValueEx(key, None) query the unnamed default registry value. The QueryValueEx signature now takes an optional name, and query_value_bytes passes the nullable name to both registry calls. The title names the function and the feature, so it is specific and clear. It does not mention the secondary buffer-handling and error-ordering fixes, which is acceptable.
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 with cyclomatic complexity of at least 2. Documentation-only edits and deletions within surviving functions are included; unchanged diff context and fully deleted functions are excluded. Analyzed 2 functions across 2 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.
Reviewing files that changed from the base of the PR and between 18fc82b and 0ae903d.
Files selected for processing: 2
crates/host_env/src/winreg.rs
crates/vm/src/stdlib/winreg.rs
Included review availability: This review used your included allowance. Your plan provides up to 10 included reviews per hour; 4 remain after this review.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
winreg.QueryValueEx(key, None)query the unnamed/default registry value, while keeping the name argument required.winreg.QueryValueaudit event after argument conversion and before the registry query; rebuild the audit name from the UTF-16 buffer as CPython does.ERROR_MORE_DATA, rather than retrying unrelated failures because the returned size is zero. Keep a nonzero buffer after a successful zero-length size query so a value that grows between calls can be retried.The audit tuple and its name are only built when audit hooks are active. Invalid-name type-error wording remains a pre-existing difference; #9586 separately improves the HKEY conversion used here. This does not claim full winreg parity.
Validation
PC/winreg.candPC/clinic/winreg.c.h, including conversion and audit order.prekhooks andgit diff --checkpassed.Summary by CodeRabbit
winreg.QueryValueExnow acceptsNoneas the value name, allowing queries of a registry key’s default value.