summaryrefslogtreecommitdiffstats
path: root/Doc/library/curses.rst
diff options
context:
space:
mode:
authorSerhiy Storchaka <storchaka@gmail.com>2018-10-30 11:22:42 (GMT)
committerGitHub <noreply@github.com>2018-10-30 11:22:42 (GMT)
commitb232df9197a19e78d0e2a751e56e0e62547354ec (patch)
tree851cc39c2b33019a4c88cf828349eccdcb892b7f /Doc/library/curses.rst
parent3e429dcc242e48fa4cbb1a91cf7c416c37b97b4e (diff)
downloadcpython-b232df9197a19e78d0e2a751e56e0e62547354ec.zip
cpython-b232df9197a19e78d0e2a751e56e0e62547354ec.tar.gz
cpython-b232df9197a19e78d0e2a751e56e0e62547354ec.tar.bz2
bpo-31680: Add curses.ncurses_version. (GH-4217)
Use curses.ncurses_version for conditionally skipping a test.
Diffstat (limited to 'Doc/library/curses.rst')
-rw-r--r--Doc/library/curses.rst13
1 files changed, 13 insertions, 0 deletions
diff --git a/Doc/library/curses.rst b/Doc/library/curses.rst
index 2a2ee2b..2a4d9ce 100644
--- a/Doc/library/curses.rst
+++ b/Doc/library/curses.rst
@@ -1291,6 +1291,19 @@ The :mod:`curses` module defines the following data members:
A bytes object representing the current version of the module. Also available as
:const:`__version__`.
+
+.. data:: ncurses_version
+
+ A named tuple containing the three components of the ncurses library
+ version: *major*, *minor*, and *patch*. All values are integers. The
+ components can also be accessed by name, so ``curses.ncurses_version[0]``
+ is equivalent to ``curses.ncurses_version.major`` and so on.
+
+ Availability: if the ncurses library is used.
+
+ .. versionadded:: 3.8
+
+
Some constants are available to specify character cell attributes.
The exact constants available are system dependent.