gh-83395: Add curses.window.in_wch by asottile · Pull Request #17825 · python/cpython

asottile · 2020-01-04T23:56:24Z

https://bugs.python.org/issue39214

Issue: Add curses.window.in_wch #83395

krmaxson · 2022-08-29T13:35:44Z

Providing this wide character method in the Python binding would let me ditch a soup of custom code. It is aggravating to have to duplicate the curses backing store to print non-ASCII! I've been staring at this pull request for two years -- I really hope it eventually gets merged. Thanks for tackling this!

asottile · 2022-08-29T13:41:54Z

I've rebased this against 3.12 (I originally targeted 3.9!)

asottile · 2022-08-29T13:47:21Z

Providing this wide character method in the Python binding would let me ditch a soup of custom code. It is aggravating to have to duplicate the curses backing store to print non-ASCII! I've been staring at this pull request for two years -- I really hope it eventually gets merged. Thanks for tackling this!

fwiw, I've seen even outside reviews move things forward -- if you want to review the code

GiorgosXou · 2022-08-29T14:40:19Z

I've been staring at this pull request for two years

@krmaxson me too, same thing, although at some point i got bored and I eventually diched the curses module and turned to the uni-curses module (which I recently started maintaning and made this with it)

asottile · 2023-07-02T01:13:03Z

aaaand rebased on 3.13

asottile · 2024-09-28T18:40:40Z

sure why not, let's do our yearly rebase -- now onto 3.14

picnixz

Some comments for this (I'm currently refactoring the curses module). By the way, is the term "color pair" documented on the page?

picnixz · 2024-09-28T18:44:02Z

+   Return the wide character at the given position in the window.  The return
+   value is a 3-tuple ``(character, attributes, color_pair)``.


Suggested change

Return the wide character at the given position in the window. The return

value is a 3-tuple ``(character, attributes, color_pair)``.

Return the wide character at the given position in the window as

a triplet ``(character, attributes, color_pair)``.

picnixz · 2024-09-28T18:45:27Z

+   .. note::
+
+      ``inch`` only works for ASCII characters.  Use :meth:`in_wch` instead
+      for unicode support.


Suggested change

.. note::

``inch`` only works for ASCII characters. Use :meth:`in_wch` instead

for unicode support.

.. note::

This method only works for ASCII characters. Use :meth:`in_wch`

instead to retrieve the Unicode character at a given position.

picnixz · 2024-09-28T18:45:52Z

+
+.. method:: window.in_wch([x, y])


Suggested change

.. method:: window.in_wch([x, y])

.. method:: window.in_wch([x, y])

We separate methods by 2 blank lines (just check that my suggestion is correct before committing it).

picnixz · 2024-09-28T18:46:07Z

+
+.. method:: window.in_wch([x, y])


Suggested change

.. method:: window.in_wch([x, y])

.. method:: window.in_wch([y, x])

picnixz · 2024-09-28T18:47:17Z

+        if not hasattr(stdscr, 'in_wch'):
+            raise unittest.SkipTest('requires curses.window.in_wch')


Do you need this kind of check or can you use @requires_curses_window_meth('in_wch')?

picnixz · 2024-09-28T18:48:44Z

@@ -0,0 +1 @@
+Add :func:`curses.window.in_wch` function - by Anthony Sottile.


Suggested change

Add :func:`curses.window.in_wch` function - by Anthony Sottile.

Add :func:`curses.window.in_wch` function to get the Unicode character

at a given position. Patch by Anthony Sottile.

picnixz · 2024-09-28T18:49:14Z

+    y: int
+        Starting Y-coordinate.
+    x: int
+        Starting X-coordinate.
+    ]


Suggested change

y: int

Starting Y-coordinate.

x: int

Starting X-coordinate.

]

y: int

Y-coordinate.

x: int

X-coordinate.

]

Let's use the same wording as for inch.

picnixz · 2024-09-28T18:49:30Z

+    ]
+    /
+
+Retrieve the wide character at the gven position in the window.


Suggested change

Retrieve the wide character at the gven position in the window.

Retrieve the Unicode character at the given position in the window.

Ah, wait, should we say wide character or Unicode character here (it's a wchar_t but we use it to indicate "Unicode" range so...)

picnixz · 2024-09-28T18:52:57Z

+    if (PyCursesCheckERR(ret, "getcchar") == NULL) {
+        return NULL;
+    }


Suggested change

if (PyCursesCheckERR(ret, "getcchar") == NULL) {

return NULL;

}

if (ret == ERR) {

PyErr_SetString(PyCursesError, "getcchar() returned ERR");

return NULL;

}

picnixz · 2024-09-28T18:54:35Z

+    if (group_right_1) {
+        ret = mvwin_wch(self->win, y, x, &wcval);
+    } else {
+        ret = win_wch(self->win, &wcval);
+    }
+    if (PyCursesCheckERR(ret, "in_wch") == NULL) {
+        return NULL;
+    }


Suggested change

if (group_right_1) {

ret = mvwin_wch(self->win, y, x, &wcval);

} else {

ret = win_wch(self->win, &wcval);

}

if (PyCursesCheckERR(ret, "in_wch") == NULL) {

return NULL;

}

if (group_right_1) {

ret = mvwin_wch(self->win, y, x, &wcval);

if (ret == ERR) {

PyErr_SetString(PyCursesError, "mvwin_wch() returned ERR");

return NULL;

}

}

else {

ret = win_wch(self->win, &wcval);

if (ret == ERR) {

PyErr_SetString(PyCursesError, "win_wch() returned ERR");

return NULL;

}

}

asottile · 2024-09-28T19:00:00Z

nevermind. seriously not worth my time at this point

picnixz

There are also a bunch of tests that fail. I can't check them now but I'll have a look tomorrow.

picnixz · 2024-09-28T18:59:13Z

+                           int y, int x)
+/*[clinic end generated code: output=846ca8a82f2ecab4 input=5c20d96b592b0e0b]*/
+{
+    int ret;


Ah maybe I should have said it in the other review, but I think we use rtn in general and not ret.

picnixz · 2024-09-28T19:02:21Z

+    ]
+    /
+
+Retrieve the wide character at the gven position in the window.


Ah, wait, should we say wide character or Unicode character here (it's a wchar_t but we use it to indicate "Unicode" range so...)

the-knights-who-say-ni added the CLA signed label Jan 4, 2020

bedevere-bot added the awaiting review label Jan 4, 2020

asottile changed the title ~~bpo-39214: Add curses.windows.in_wch~~ bpo-39214: Add curses.window.in_wch Jan 4, 2020

asottile force-pushed the bpo_39214 branch 2 times, most recently from 4a656ab to 1368b75 Compare January 8, 2020 03:13

asottile force-pushed the bpo_39214 branch 2 times, most recently from 90b1918 to 131a2f9 Compare November 2, 2021 23:56

asottile mannequin mentioned this pull request Apr 10, 2022

Add curses.window.in_wch #83395

Open

ezio-melotti removed the CLA signed label Jul 13, 2022

asottile force-pushed the bpo_39214 branch from 131a2f9 to a1f238a Compare August 29, 2022 13:41

asottile force-pushed the bpo_39214 branch from a1f238a to 6928777 Compare October 5, 2022 21:17

erlend-aasland changed the title ~~bpo-39214: Add curses.window.in_wch~~ gh-83395: Add curses.window.in_wch Jun 27, 2023

asottile force-pushed the bpo_39214 branch 2 times, most recently from 3374b82 to f16f2b8 Compare July 2, 2023 01:09

Add curses.window.in_wch

e67966e

asottile force-pushed the bpo_39214 branch from f16f2b8 to e67966e Compare September 28, 2024 18:39

picnixz reviewed Sep 28, 2024

View reviewed changes

asottile closed this Sep 28, 2024

picnixz reviewed Sep 28, 2024

View reviewed changes

asottile mentioned this pull request Jun 23, 2026

Add wide-character (cchar_t) support to the curses module #151757

Closed

serhiy-storchaka mentioned this pull request Jun 25, 2026

Add the cchar_t (complex character) API to the curses module #152233

Open

		Return the wide character at the given position in the window. The return
		value is a 3-tuple ``(character, attributes, color_pair)``.


	.. method:: window.in_wch([x, y])


	.. method:: window.in_wch([x, y])


	.. method:: window.in_wch([x, y])

	.. method:: window.in_wch([y, x])

		if not hasattr(stdscr, 'in_wch'):
		raise unittest.SkipTest('requires curses.window.in_wch')

		@@ -0,0 +1 @@
		Add :func:`curses.window.in_wch` function - by Anthony Sottile.

	Add :func:`curses.window.in_wch` function - by Anthony Sottile.
	Add :func:`curses.window.in_wch` function to get the Unicode character
	at a given position. Patch by Anthony Sottile.

	Retrieve the wide character at the gven position in the window.
	Retrieve the Unicode character at the given position in the window.

Uh oh!

Uh oh!

Conversation

asottile commented Jan 4, 2020 • edited by bedevere-bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

krmaxson commented Aug 29, 2022

Uh oh!

asottile commented Aug 29, 2022

Uh oh!

asottile commented Aug 29, 2022

Uh oh!

GiorgosXou commented Aug 29, 2022

Uh oh!

asottile commented Jul 2, 2023

Uh oh!

asottile commented Sep 28, 2024

Uh oh!

picnixz left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

asottile commented Sep 28, 2024

Uh oh!

picnixz left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

asottile commented Jan 4, 2020 •

edited by bedevere-bot

Loading