classification
Title: Clarify public name of curses.window
Type: enhancement Stage:
Components: Documentation Versions: Python 3.10, Python 3.9
process
Status: open Resolution:
Dependencies: Superseder:
Assigned To: docs@python Nosy List: docs@python, rmccampbell7, serhiy.storchaka
Priority: normal Keywords:

Created on 2021-04-05 23:37 by rmccampbell7, last changed 2021-04-06 07:44 by serhiy.storchaka.

Messages (2)
msg390266 - (view) Author: Ryan McCampbell (rmccampbell7) Date: 2021-04-05 23:37
Until 3.8 the curses window class was not directly available in code, but now it is available as `_curses.window`. This is not explicitly stated in the documentation (although it is consistent with how the method signatures are written). It is useful to have a public name for the type to aid IDE's with explicit type annotations, i.e.

@curses.wrapper
def main(stdscr: curses.window):
    stdscr.addstr(...)

See https://github.com/python/typeshed/pull/5180, which adds this name to type hints in the typeshed project.

This name should be more clearly documented so programmers can annotate the type without worrying that it may change (which will cause a runtime error unless it is quoted).
msg390289 - (view) Author: Serhiy Storchaka (serhiy.storchaka) * (Python committer) Date: 2021-04-06 07:44
It could help also in help().
History
Date User Action Args
2021-04-06 07:44:00serhiy.storchakasetnosy: + serhiy.storchaka
messages: + msg390289
2021-04-05 23:37:41rmccampbell7create