Thanks to visit codestin.com
Credit goes to github.com

Skip to content

bpo-41818: Add termios.tcgetwinsize(), termios.tcsetwinsize(). Update docs. #23686

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

Merged
merged 9 commits into from
Aug 27, 2021
Merged

bpo-41818: Add termios.tcgetwinsize(), termios.tcsetwinsize(). Update docs. #23686

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
78aaac7
Add termios.tcgetwinsize(), termios.tcsetwinsize(). Update docs.
8vasu Dec 8, 2020
0553063
Add news, clinic generated code.
8vasu Dec 8, 2020
0d2d35b
Improve termios.tcsetwinsize().
8vasu Dec 10, 2020
628b7dc
Add TIOCGSIZE support to termios.tcgetwinsize()
8vasu Dec 14, 2020
6ef8a29
Add TIOCSSIZE support to termios.tcsetwinsize()
8vasu Dec 14, 2020
91374ea
The SunOS struct ttysize had fields of type "int"; update termios.tcg…
8vasu Dec 15, 2020
bb0b2b1
termios.tcgetwinsize() and termios.tcsetwinsize() should return/accep…
8vasu Aug 14, 2021
eb0be09
Refactor tcsetwinsize to share common code and accept any two item se…
gpshead Aug 27, 2021
5ab0d4c
parenthesis on my if statements :)
gpshead Aug 27, 2021
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
Prev Previous commit
Next Next commit
termios.tcgetwinsize() and termios.tcsetwinsize() should return/accep… 
…t two-item tuples instead of lists.
  • Loading branch information
@8vasu
8vasu committed Aug 14, 2021
commit bb0b2b16daf01650f001295e470ec28d28a78470
7 changes: 4 additions & 3 deletions Doc/library/termios.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,16 +76,17 @@ The module defines the following functions:

.. function:: tcgetwinsize(fd)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

one follow up PR as I forgot to fix it up here, these need versionadded tags. I'll take care of it.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@gpshead Thank you for making the improvements!


Return a list ``[ws_row, ws_col]`` containing the tty window size for file
Return a tuple ``(ws_row, ws_col)`` containing the tty window size for file
descriptor *fd*. Requires :const:`termios.TIOCGWINSZ` or
:const:`termios.TIOCGSIZE`.


.. function:: tcsetwinsize(fd, winsize)

Set the tty window size for file descriptor *fd* from *winsize*, which is
a list like the one returned by :func:`tcgetwinsize`. Requires at least
one of the pairs (:const:`termios.TIOCGWINSZ`, :const:`termios.TIOCSWINSZ`);
a two-item tuple ``(ws_row, ws_col)`` like the one returned by
:func:`tcgetwinsize`. Requires at least one of the pairs
(:const:`termios.TIOCGWINSZ`, :const:`termios.TIOCSWINSZ`);
(:const:`termios.TIOCGSIZE`, :const:`termios.TIOCSSIZE`) to be defined.


Expand Down
6 changes: 3 additions & 3 deletions Modules/clinic/termios.c.h
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

36 changes: 18 additions & 18 deletions Modules/termios.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -323,12 +323,12 @@ termios.tcgetwinsize

Get the tty winsize for file descriptor fd.

Returns a list [ws_row, ws_col].
Returns a tuple (ws_row, ws_col).
[clinic start generated code]*/

static PyObject *
termios_tcgetwinsize_impl(PyObject *module, int fd)
/*[clinic end generated code: output=31825977d5325fb6 input=c7ed8aa957d108c0]*/
/*[clinic end generated code: output=31825977d5325fb6 input=5706c379d7fd984d]*/
{
#if defined(TIOCGWINSZ)
termiosmodulestate *state = PyModule_GetState(module);
Expand All @@ -338,12 +338,12 @@ termios_tcgetwinsize_impl(PyObject *module, int fd)
}

PyObject *v;
if (!(v = PyList_New(2))) {
if (!(v = PyTuple_New(2))) {
return NULL;
}

PyList_SetItem(v, 0, PyLong_FromLong((long)w.ws_row));
PyList_SetItem(v, 1, PyLong_FromLong((long)w.ws_col));
PyTuple_SetItem(v, 0, PyLong_FromLong((long)w.ws_row));
PyTuple_SetItem(v, 1, PyLong_FromLong((long)w.ws_col));
if (PyErr_Occurred()) {
Py_DECREF(v);
return NULL;
Expand All @@ -357,12 +357,12 @@ termios_tcgetwinsize_impl(PyObject *module, int fd)
}

PyObject *v;
if (!(v = PyList_New(2))) {
if (!(v = PyTuple_New(2))) {
return NULL;
}

PyList_SetItem(v, 0, PyLong_FromLong((long)s.ts_lines));
PyList_SetItem(v, 1, PyLong_FromLong((long)s.ts_cols));
PyTuple_SetItem(v, 0, PyLong_FromLong((long)s.ts_lines));
PyTuple_SetItem(v, 1, PyLong_FromLong((long)s.ts_cols));
if (PyErr_Occurred()) {
Py_DECREF(v);
return NULL;
Expand All @@ -385,17 +385,17 @@ termios.tcsetwinsize
Set the tty winsize for file descriptor fd.

The winsize to be set is taken from the winsize argument, which
is a list like the one returned by tcgetwinsize().
is a two-item tuple (ws_row, ws_col) like the one returned by tcgetwinsize().
[clinic start generated code]*/

static PyObject *
termios_tcsetwinsize_impl(PyObject *module, int fd, PyObject *winsz)
/*[clinic end generated code: output=2ac3c9bb6eda83e1 input=c495180b2b932a30]*/
/*[clinic end generated code: output=2ac3c9bb6eda83e1 input=4a06424465b24aee]*/
{
#if defined(TIOCGWINSZ) && defined(TIOCSWINSZ)
if (!PyList_Check(winsz) || PyList_Size(winsz) != 2) {
if (!PyTuple_Check(winsz) || PyTuple_Size(winsz) != 2) {
PyErr_SetString(PyExc_TypeError,
"tcsetwinsize, arg 2: must be 2 element list");
"tcsetwinsize, arg 2: must be a two-item tuple");
return NULL;
}

Expand All @@ -407,8 +407,8 @@ termios_tcsetwinsize_impl(PyObject *module, int fd, PyObject *winsz)
return PyErr_SetFromErrno(state->TermiosError);
}

w.ws_row = (unsigned short) PyLong_AsLong(PyList_GetItem(winsz, 0));
w.ws_col = (unsigned short) PyLong_AsLong(PyList_GetItem(winsz, 1));
w.ws_row = (unsigned short) PyLong_AsLong(PyTuple_GetItem(winsz, 0));
w.ws_col = (unsigned short) PyLong_AsLong(PyTuple_GetItem(winsz, 1));
if (PyErr_Occurred()) {
return NULL;
}
Expand All @@ -419,9 +419,9 @@ termios_tcsetwinsize_impl(PyObject *module, int fd, PyObject *winsz)

Py_RETURN_NONE;
#elif defined(TIOCGSIZE) && defined(TIOCSSIZE)
if (!PyList_Check(winsz) || PyList_Size(winsz) != 2) {
if (!PyTuple_Check(winsz) || PyTuple_Size(winsz) != 2) {
PyErr_SetString(PyExc_TypeError,
"tcsetwinsize, arg 2: must be 2 element list");
"tcsetwinsize, arg 2: must be a two-item tuple");
return NULL;
}

Expand All @@ -432,8 +432,8 @@ termios_tcsetwinsize_impl(PyObject *module, int fd, PyObject *winsz)
return PyErr_SetFromErrno(state->TermiosError);
}

s.ts_lines = (int) PyLong_AsLong(PyList_GetItem(winsz, 0));
s.ts_cols = (int) PyLong_AsLong(PyList_GetItem(winsz, 1));
s.ts_lines = (int) PyLong_AsLong(PyTuple_GetItem(winsz, 0));
s.ts_cols = (int) PyLong_AsLong(PyTuple_GetItem(winsz, 1));
if (PyErr_Occurred()) {
return NULL;
}
Expand Down