Skip to content

New: width() terminal-aware string measurement #166

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
Merged
jquast merged 21 commits into from
Jan 17, 2026
Merged

New: width() terminal-aware string measurement #166

jquast merged 21 commits into from
Jan 17, 2026

Conversation

@jquast
Copy link
Owner

@jquast jquast commented Jan 15, 2026 •
edited
Loading

  • Add new width() function for measuring terminal-aware strings, with support for control codes, escape sequences (SGR, OSC, CSI), cursor movement, and tab stops.
  • Add iter_sequences() function to iterate with text containing escape sequences
  • New file, control_codes.py for control characters, categorized
  • New file escape_sequences.py for terminal sequence patterns, categorized
  • extract _bisearch , duplicates New: iter_graphemes() #165

A few examples from docs/intro.rst:

>>> wcwidth.width('\x1b[38;2;255;150;100mWARN\x1b[0m')
4

>>> list(wcwidth.iter_sequences('\x1b[31mred\x1b[0m'))
[('\x1b[31m', True), ('red', False), ('\x1b[0m', True)]

>>> wcwidth.width('\U0001F1FF\U0001F1FC')
2

jquast added 14 commits January 14, 2026 16:34
@jquast
Add width() function for terminal-aware string measurement
ebadd90 
New width() function handles:
- Terminal escape sequences (SGR, OSC, CSI, etc.)
- Control codes with parse/strict/ignore modes
- Tab stops and cursor movement
- Always returns non-negative integer (never -1)

New exports: width
@jquast
Merge remote-tracking branch 'origin/master' into jq/next-new-width
2dfd19e
@jquast
commit code generation .. before deleting it!
636d223
@jquast
big refactor, delete code generation
6f69091
@jquast
first size reduction
52c7ff8
@jquast
whittling down
5bbcbd7
@jquast
refactor, reduce, document
3d7d1db
@jquast
document iter_sequences
206d11a
@jquast
checkpoint
2a68d69
@jquast
match original behavior, almost changed types!
dd01315 
its a private function, anyway, still ok.

Below the turtles, 0/1 is very much the definition of Falsey and Truthy.
@jquast
minor docs
fc66150
@jquast
A missing VIF (very important file)
792584f
@jquast
docfix
76ffb2b
@jquast
Add tests to achieve 100% coverage
50f941a 
- Test lone ESC character handling in iter_sequences and width
- Test backspace at column 0 (no negative position)
- Test carriage return column reset
- Test tab with tabstop=0 in parse mode
- Test vertical control (LF) in parse mode
@jquast jquast changed the title Add width() function for terminal-aware string measurement New: width() terminal-aware string measurement Jan 15, 2026
This was referenced Jan 15, 2026
Closed
Closed
Closed
Closed
This was referenced Jan 16, 2026
Merged
Merged
@jquast jquast merged commit bbb0e47 into master Jan 17, 2026
36 checks passed
@jquast jquast deleted the jq/next-new-width branch January 17, 2026 18:08
jquast added a commit that referenced this pull request Jan 17, 2026
@jquast
New: ljust(), rjust(), center() justify text (#168)
6668301 
Justify text with control-code and sequence-awareness, requires #166 

Example,

        >>> wcwidth.center('hi', 6)
        '  hi  '
        >>> wcwidth.center('\\x1b[31mhi\\x1b[0m', 6)
        '  \\x1b[31mhi\\x1b[0m  '
        >>> wcwidth.center('\\U0001F468\\u200D\\U0001F469\\u200D\\U0001F467', 6)
        '  👨‍👩‍👧  '
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@jquast