fix: clamp n to len(pwcs) in wcswidth/wcstwidth to avoid IndexError#227
Closed
gaoflow wants to merge 2 commits into
Closed
fix: clamp n to len(pwcs) in wcswidth/wcstwidth to avoid IndexError#227gaoflow wants to merge 2 commits into
gaoflow wants to merge 2 commits into
Conversation
Passing n > len(pwcs) to wcswidth() or wcstwidth() causes an IndexError when the loop index reaches the end of the string, because `end` was set to n directly. Fix: `end = min(n, len(pwcs))` so that n larger than the string length is treated the same as measuring the whole string, which is the natural Python semantics for sized strings. Adds a regression test covering ASCII, wide characters, and ZWJ clusters.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #227 +/- ##
===========================================
- Coverage 100.00% 99.79% -0.21%
===========================================
Files 27 27
Lines 1924 1967 +43
Branches 456 462 +6
===========================================
+ Hits 1924 1963 +39
- Misses 0 2 +2
- Partials 0 2 +2 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
Contributor
Author
|
Pushed
Local verification:
|
Owner
|
Thanks, this will be in next release #228 Not sure if you caught this bug from integration, or from linting, but in general this argument is not recommended to be used, #208 (comment) but I have since removed this recommendation |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Bug
`wcswidth()` and `wcstwidth()` raise `IndexError` when the `n` parameter is larger than the length of the string.
```python
Root cause: The `end` variable is set directly to `n`:
```python
end = len(pwcs) if n is None else n
```
When `n > len(pwcs)`, the `while idx < end` loop tries to access `pwcs[idx]` past the end of the string.
Fix
Clamp `end` to `len(pwcs)`:
```python
end = len(pwcs) if n is None else min(n, len(pwcs))
```
This is the natural Python semantics for sized strings: `n` larger than the string length is equivalent to measuring the whole string. The same fix applies to `wcstwidth()`.
Test
Added `test_wcswidth_n_exceeds_length` covering ASCII, wide characters, and ZWJ clusters.
```
1316 passed, 10 skipped
```