8000 bpo-30176: add missing curses cell attributes constants by zhangyangyu · Pull Request #1302 · python/cpython · GitHub
[go: up one dir, main page]

Skip to content

bpo-30176: add missing curses cell attributes constants #1302

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.

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

Merged
merged 5 commits into from
Jun 16, 2017
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
56 changes: 46 additions & 10 deletions Doc/library/curses.rst
8000
Original file line number Diff line number Diff line change
Expand Up @@ -1271,34 +1271,70 @@ The :mod:`curses` module defines the following data members:
A string representing the current version of the module. Also available as
:const:`__version__`.

Several constants are available to specify character cell attributes:
Some constants are available to specify character cell attributes.
The exact constants available are system dependent.

+------------------+-------------------------------+
| Attribute | Meaning |
+==================+===============================+
| ``A_ALTCHARSET`` | Alternate character set mode. |
| ``A_ALTCHARSET`` | Alternate character set mode |
+------------------+-------------------------------+
| ``A_BLINK`` | Blink mode. |
| ``A_BLINK`` | Blink mode |
+------------------+-------------------------------+
| ``A_BOLD`` | Bold mode. |
| ``A_BOLD`` | Bold mode |
+------------------+-------------------------------+
| ``A_ITALIC`` | Italic mode. |
| ``A_DIM`` | Dim mode |
+------------------+-------------------------------+
| ``A_DIM`` | Dim mode. |
| ``A_INVIS`` | Invisible or blank mode |
+------------------+-------------------------------+
| ``A_NORMAL`` | Normal attribute. |
| ``A_ITALIC`` | Italic mode |
+------------------+-------------------------------+
| ``A_NORMAL`` | Normal attribute |
+------------------+-------------------------------+
| ``A_PROTECT`` | Protected mode |
+------------------+-------------------------------+
| ``A_REVERSE`` | Reverse background and |
| | foreground colors. |
| | foreground colors |
+------------------+-------------------------------+
| ``A_STANDOUT`` | Standout mode |
+------------------+-------------------------------+
| ``A_UNDERLINE`` | Underline mode |
+------------------+-------------------------------+
| ``A_HORIZONTAL`` | Horizontal highlight |
+------------------+-------------------------------+
| ``A_LEFT`` | Left highlight |
+------------------+-------------------------------+
| ``A_LOW`` | Low highlight |
+------------------+-------------------------------+
| ``A_RIGHT`` | Right highlight |
+------------------+-------------------------------+
| ``A_STANDOUT`` | Standout mode. |
| ``A_TOP`` | Top highlight |
+------------------+-------------------------------+
| ``A_UNDERLINE`` | Underline mode. |
| ``A_VERTICAL`` | Vertical highlight |
+------------------+-------------------------------+
| ``A_CHARTEXT`` | Bit-mask to extract a |
| | character |
+------------------+-------------------------------+

.. versionadded:: 3.7
``A_ITALIC`` was added.

Several constants are available to extract corresponding attributes returned
by some methods.

+------------------+-------------------------------+
| Bit-mask | Meaning |
+==================+===============================+
| ``A_ATTRIBUTES`` | Bit-mask to extract |
| | attributes |
+------------------+-------------------------------+
| ``A_CHARTEXT`` | Bit-mask to extract a |
| | character |
+------------------+-------------------------------+
| ``A_COLOR`` | Bit-mask to extract |
| | color-pair field information |
+------------------+-------------------------------+

Keys are referred to by integer constants with names starting with ``KEY_``.
The exact keycaps available are system dependent.

Expand Down
4 changes: 3 additions & 1 deletion Misc/NEWS
Original file line number Diff line number Diff line change
Expand Up @@ -445,7 +445,7 @@ Library
- bpo-30149: inspect.signature() now supports callables with
variable-argument parameters wrapped with partialmethod.
Patch by Dong-hee Na.

- bpo-30436: importlib.find_spec() raises ModuleNotFoundError instead of
AttributeError if the specified parent module is not a package
(i.e. lacks a __path__ attribute).
Expand Down Expand Up @@ -1216,6 +1216,8 @@ C API
Documentation
-------------

- bpo-30176: Add missing attribute related constants in curses documentation.

- Issue #30052: the link targets for :func:`bytes` and
:func:`bytearray` are now their respective type definitions, rather
than the corresponding builtin function entries. Use :ref:`bytes <func-bytes>`
Expand Down
8 changes: 5 additions & 3 deletions Modules/_cursesmodule.c
Original file line number Diff line number Diff line change
Expand Up @@ -3335,9 +3335,6 @@ PyInit__curses(void)
SetDictInt("A_BLINK", A_BLINK);
SetDictInt("A_DIM", A_DIM);
SetDictInt("A_BOLD", A_BOLD);
#ifdef A_ITALIC
SetDictInt("A_ITALIC", A_ITALIC);
#endif
SetDictInt("A_ALTCHARSET", A_ALTCHARSET);
#if !defined(__NetBSD__)
SetDictInt("A_INVIS", A_INVIS);
Expand Down Expand Up @@ -3366,6 +3363,11 @@ PyInit__curses(void)
SetDictInt("A_VERTICAL", A_VERTICAL);
#endif

/* ncurses extension */
#ifdef A_ITALIC
SetDictInt("A_ITALIC", A_ITALIC);
#endif

SetDictInt("COLOR_BLACK", COLOR_BLACK);
SetDictInt("COLOR_RED", COLOR_RED);
SetDictInt("COLOR_GREEN", COLOR_GREEN);
Expand Down
0