adding curses.ascii, curses.panel and curses.textpad modules #1792

gossrock · 2017-12-17T20:54:57Z

adding these three stub files to complete the curses module stubs. Some notes on this in issue #1775.

gossrock · 2017-12-17T21:09:31Z

Any thoughts on why the python 2.7 tests failed when I was only working in python 3?

JelleZijlstra · 2017-12-17T21:57:55Z

The "python 2.7" tests are actually tests using pytype, which happens to run in Python 2.7. It seems to be angry because you're referring to stubs for _curses but it can't find any.

JelleZijlstra · 2017-12-17T21:58:12Z

stdlib/3/curses/ascii.pyi

@@ -0,0 +1,69 @@
+from typing import Sequence, Union, overload
+
+NUL: int = ...


You don't need the = ... part.

removed '= ...' from variable definitions

gossrock · 2017-12-18T11:03:45Z

inside of curses/__init__ it has a similar set of code that doesn't fail:

import _curses
from _curses import * # noqa: F403

I've tried multiple ways of emulating __init__'s code but all was fail in panel and textpad.

gossrock · 2017-12-18T13:11:35Z

Ah, I see now that curses/__init__.pyi is in tests/pytype_blacklist.txt.
Locally I placed curses/panel.pyi and curses/textpad.pyi in the list and I do not get the errors.

Should this be done?

…t.txt just like curses/__init__.pyi because they all import _curses. (This may not be the right thing to do)

JelleZijlstra · 2017-12-21T01:30:07Z

Yes, that makes sense (if one part of curses is already in the blacklist, it probably won't hurt pytype to add more).

JelleZijlstra · 2017-12-21T01:31:24Z

stdlib/3/curses/ascii.pyi

+SP: int
+DEL: int
+
+controlnames: Sequence[int]


It looks like a List[str] to me.

Okay, have been a bit fuzzy about when to be more specific and when to be more general ... Then again it could have been because I was just a bit 'fuzzy' in general. Now that you mention it, more specific sounds like the right choice here.

JelleZijlstra · 2017-12-21T01:32:05Z

stdlib/3/curses/ascii.pyi

+
+controlnames: Sequence[int]
+
+def isalnum(c: str) -> bool: ...


I think all of these also accept int arguments (_ctoi returns ints directly).

JelleZijlstra · 2017-12-21T01:32:48Z

stdlib/3/curses/ascii.pyi

+def isxdigit(c: str) -> bool: ...
+def isctrl(c: str) -> bool: ...
+def ismeta(c: str) -> bool: ...
+@overload


These could also be done with a TypeVar ranging over int and str. Using overloads is fine too though.

JelleZijlstra · 2017-12-21T01:37:34Z

stdlib/3/curses/textpad.pyi

+
+class Textbox:
+    stripspaces: bool
+    def __init__(self, w: _CursesWindow) -> None: ...


Missing the undocumented insert_before argument (quoting the code: def __init__(self, win, insert_mode=False):).

Yeah, I was just looking at the documentation. Makes sense to look at the source code to.

JelleZijlstra · 2017-12-21T01:38:26Z

stdlib/3/curses/textpad.pyi

+class Textbox:
+    stripspaces: bool
+    def __init__(self, w: _CursesWindow) -> None: ...
+    def edit(self, validator: Callable[[int], int]) -> str: ...


The argument is called validate and is both optional and Optional (i.e., it should be validate: Optional[Callable[[int], int]] = ...).

Ah, documentation said edit([validator]) both make sense but source code always wins.

changed controlnames variable to be declared as List[str] instead of Sequence[str]

ilevkivskyi · 2017-12-21T11:16:32Z

stdlib/3/curses/ascii.pyi

+@overload
+def ctrl(c: str) -> str: ...
+@overload
+def ctrl(c: int) -> str: ...


Shouldn't this one be int -> int (like other items around)?

Yes, that's correct. thank-you.

…ce code.

fixed flake8 issue related to needing and underscore before a private TypeVar

JelleZijlstra

Thanks for making the changes! Here are a few more comments.

JelleZijlstra · 2017-12-21T16:50:57Z

stdlib/3/curses/ascii.pyi

+def ascii(c: _Ch) -> _Ch: ...
+def ctrl(c: _Ch) -> _Ch: ...
+def alt(c: _Ch) -> _Ch: ...
+def unctrl(c: _Ch) -> str: ...


This should just be Union[str, int] instead a typevar, because it doesn't influence the return type.

Okay, Starting to understand the TypeVar now.

JelleZijlstra · 2017-12-21T16:51:15Z

stdlib/3/curses/ascii.pyi

+
+controlnames: List[int]
+
+def isalnum(c: str) -> bool: ...


all these is* functions take Union[str, int] (as mentioned in the previous review)

also change unctrl to also take the same. (instead of the inapropriate TypeVar)

* python/master: (269 commits) allow Optional[float] for asyncio.wait() timeout arg (python#1860) Clean up the pytype blacklist. (python#1851) filter function: make the callable of the first overload non-optional so that mypy is able to select the second overload for the case. (python#1855) Accept Text in distutils *Version classes (python#1854) Add attrs library (python#1838) Add type stub for the lzma module (python#1844) Add ImportError attributes name, path for Python 3.3+ (python#1849) Add 'message' to click.decorators.version_option (python#1845) PEP 553 and PEP 564 (python#1846) Adding py36 additions to datetime module (python#1848) Remove incomplete thrift stubs that cause false positives. (python#1827) adding curses.ascii, curses.panel and curses.textpad modules (python#1792) Fix requests session hooks type (python#1794) Add StringIO.name and BytesIO.name (python#1802) Fix werkzeug environ type (python#1831) Change the return type of unittest.TestCase.fail() to NoReturn (python#1843) _curses.tparm works on bytes, not str (python#1828) Refine types for distutils.version (python#1835) Add stub for stat.filemode (python#1837) modify pytype_test to run from within pytype too, and support python3 (python#1817) ...

gossrock added 3 commits December 17, 2017 20:26

adding ascii, panal and textpad modules to the curses module.

aa86122

made a few flake8 changes

ea5870e

remove a couple of unnessisary imports

bfc0865

JelleZijlstra reviewed Dec 17, 2017

View reviewed changes

Update ascii.pyi

f5f8b4d

removed '= ...' from variable definitions

added curses/panel.pyi and curses/textpad.pyi to test/pytype_blacklis…

76b3276

…t.txt just like curses/__init__.pyi because they all import _curses. (This may not be the right thing to do)

JelleZijlstra requested changes Dec 21, 2017

View reviewed changes

Update ascii.pyi

4b7fec6

changed controlnames variable to be declared as List[str] instead of Sequence[str]

ilevkivskyi reviewed Dec 21, 2017

View reviewed changes

gossrock added 3 commits December 21, 2017 11:35

changed from using @overload to TypeVar

67f3b3c

in 'edit' method stub changed 'validator' to 'validate' to match sour…

e3a8f65

…ce code.

Update ascii.pyi

6dd2efc

fixed flake8 issue related to needing and underscore before a private TypeVar

JelleZijlstra requested changes Dec 21, 2017

View reviewed changes

changed 'is' functions to take Union[str, int] instead of only str.

f5f480d

also change unctrl to also take the same. (instead of the inapropriate TypeVar)

JelleZijlstra merged commit 79e0b94 into python:master Jan 26, 2018

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

adding curses.ascii, curses.panel and curses.textpad modules #1792

adding curses.ascii, curses.panel and curses.textpad modules #1792

gossrock commented Dec 17, 2017

gossrock commented Dec 17, 2017

JelleZijlstra commented Dec 17, 2017

JelleZijlstra Dec 17, 2017

gossrock commented Dec 18, 2017 •

edited

Loading

gossrock commented Dec 18, 2017 •

edited

Loading

JelleZijlstra commented Dec 21, 2017

JelleZijlstra Dec 21, 2017

gossrock Dec 21, 2017

JelleZijlstra Dec 21, 2017

JelleZijlstra Dec 21, 2017

JelleZijlstra Dec 21, 2017

gossrock Dec 21, 2017

JelleZijlstra Dec 21, 2017

gossrock Dec 21, 2017

ilevkivskyi Dec 21, 2017

gossrock Dec 21, 2017

JelleZijlstra left a comment

JelleZijlstra Dec 21, 2017

gossrock Dec 21, 2017

JelleZijlstra Dec 21, 2017

		@@ -0,0 +1,69 @@
		from typing import Sequence, Union, overload

		NUL: int = ...

adding curses.ascii, curses.panel and curses.textpad modules #1792

adding curses.ascii, curses.panel and curses.textpad modules #1792

Conversation

gossrock commented Dec 17, 2017

gossrock commented Dec 17, 2017

JelleZijlstra commented Dec 17, 2017

Choose a reason for hiding this comment

gossrock commented Dec 18, 2017 • edited Loading

gossrock commented Dec 18, 2017 • edited Loading

JelleZijlstra commented Dec 21, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

JelleZijlstra left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

gossrock commented Dec 18, 2017 •

edited

Loading

gossrock commented Dec 18, 2017 •

edited

Loading